com.ibm.cloud.objectstorage.handlers

Class HandlerContextKey<T>

java.lang.Object

com.ibm.cloud.objectstorage.handlers.HandlerContextKey<T>

public class HandlerContextKey<T>
extends Object

A type safe key used for setting and retrieving context in a Request object.

     final HandlerContextKey METRICS_KEY = new HandlerContextKey("METRICS_KEY");

      new RequestHandler2(){

Field Summary

Fields

Modifier and Type	Field and Description
static HandlerContextKey<AdvancedConfig>	ADVANCED_CONFIG Advanced client configuration.
static HandlerContextKey<AWSCredentials>	AWS_CREDENTIALS The key under which the request credentials are set.
static HandlerContextKey<URI>	CLIENT_ENDPOINT The endpoint configured on the client.
static HandlerContextKey<Boolean>	ENDPOINT_OVERRIDDEN A boolean value indicating if an endpoint is overridden or not
static HandlerContextKey<Boolean>	HAS_STREAMING_INPUT A boolean value indicating if the input of the operation has a streaming member.
static HandlerContextKey<Boolean>	HAS_STREAMING_OUTPUT A boolean value indicating if the output of the operation has a streaming member.
static HandlerContextKey<String>	OPERATION_NAME The name of the operation for the request.
static HandlerContextKey<Boolean>	REQUIRES_LENGTH A boolean value indicating if Content-Length header is required by the operation
static HandlerContextKey<String>	SERVICE_ID The unique identifier for a service to which the request is being sent.
static HandlerContextKey<String>	SIGNING_NAME The optional service name to sign the request.
static HandlerContextKey<String>	SIGNING_REGION The region used to sign the request.

Constructor Summary

Constructors

Constructor and Description
HandlerContextKey(String name)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getName()
int	hashCode()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

AWS_CREDENTIALS

public static final HandlerContextKey<AWSCredentials> AWS_CREDENTIALS

The key under which the request credentials are set.

SIGNING_REGION

public static final HandlerContextKey<String> SIGNING_REGION

The region used to sign the request.

SIGNING_NAME

public static final HandlerContextKey<String> SIGNING_NAME

The optional service name to sign the request. If present, it will override the service name in the client

OPERATION_NAME

public static final HandlerContextKey<String> OPERATION_NAME

The name of the operation for the request.

SERVICE_ID

public static final HandlerContextKey<String> SERVICE_ID

The unique identifier for a service to which the request is being sent.

REQUIRES_LENGTH

public static final HandlerContextKey<Boolean> REQUIRES_LENGTH

A boolean value indicating if Content-Length header is required by the operation

HAS_STREAMING_INPUT

public static final HandlerContextKey<Boolean> HAS_STREAMING_INPUT

A boolean value indicating if the input of the operation has a streaming member. If an input shape in operation has streaming trait, then it is a streaming op

HAS_STREAMING_OUTPUT

public static final HandlerContextKey<Boolean> HAS_STREAMING_OUTPUT

A boolean value indicating if the output of the operation has a streaming member.

ADVANCED_CONFIG

public static final HandlerContextKey<AdvancedConfig> ADVANCED_CONFIG

Advanced client configuration. Contents will be service specific.

ENDPOINT_OVERRIDDEN

public static final HandlerContextKey<Boolean> ENDPOINT_OVERRIDDEN

A boolean value indicating if an endpoint is overridden or not

CLIENT_ENDPOINT

public static final HandlerContextKey<URI> CLIENT_ENDPOINT

The endpoint configured on the client.

Constructor Detail

HandlerContextKey

public HandlerContextKey(String name)

Method Detail

equals

public boolean equals(Object o)

Overrides:

equals in class Object

getName

public String getName()

hashCode

public int hashCode()

Overrides:

hashCode in class Object