com.ibm.cloud.objectstorage

Interface HandlerContextAware

All Known Subinterfaces:

Request<T>

All Known Implementing Classes:

AbortMultipartUploadRequest, AbstractPutObjectRequest, AddLegalHoldRequest, AmazonWebServiceRequest, CompleteMultipartUploadRequest, CopyObjectRequest, CopyPartRequest, CreateBucketRequest, DefaultRequest, DeleteBucketAnalyticsConfigurationRequest, DeleteBucketCrossOriginConfigurationRequest, DeleteBucketInventoryConfigurationRequest, DeleteBucketLifecycleConfigurationRequest, DeleteBucketMetricsConfigurationRequest, DeleteBucketPolicyRequest, DeleteBucketReplicationConfigurationRequest, DeleteBucketRequest, DeleteBucketWebsiteConfigurationRequest, DeleteLegalHoldRequest, DeleteObjectRequest, DeleteObjectsRequest, DeletePublicAccessBlockRequest, DeleteVersionRequest, EncryptedGetObjectRequest, EncryptedInitiateMultipartUploadRequest, EncryptedPutObjectRequest, ExtendObjectRetentionRequest, GeneratePresignedUrlRequest, GenericBucketRequest, GetBucketAccelerateConfigurationRequest, GetBucketAclRequest, GetBucketAnalyticsConfigurationRequest, GetBucketCrossOriginConfigurationRequest, GetBucketFaspConnectionInfoRequest, GetBucketInventoryConfigurationRequest, GetBucketLifecycleConfigurationRequest, GetBucketLocationRequest, GetBucketLoggingConfigurationRequest, GetBucketMetricsConfigurationRequest, GetBucketNotificationConfigurationRequest, GetBucketPolicyRequest, GetBucketProtectionConfigurationRequest, GetBucketReplicationConfigurationRequest, GetBucketVersioningConfigurationRequest, GetBucketWebsiteConfigurationRequest, GetObjectAclRequest, GetObjectLegalHoldRequest, GetObjectLockConfigurationRequest, GetObjectMetadataRequest, GetObjectRequest, GetObjectRetentionRequest, GetPublicAccessBlockRequest, GetS3AccountOwnerRequest, HeadBucketRequest, InitiateMultipartUploadRequest, ListBucketAnalyticsConfigurationsRequest, ListBucketInventoryConfigurationsRequest, ListBucketMetricsConfigurationsRequest, ListBucketsExtendedRequest, ListBucketsRequest, ListLegalHoldsRequest, ListMultipartUploadsRequest, ListNextBatchOfObjectsRequest, ListObjectsRequest, ListObjectsV2Request, ListPartsRequest, PresignedUrlDownloadRequest, PresignedUrlUploadRequest, PresignerFacade.PresigningRequest, PutInstructionFileRequest, PutObjectRequest, RestoreObjectRequest, SetBucketAccelerateConfigurationRequest, SetBucketAclRequest, SetBucketAnalyticsConfigurationRequest, SetBucketCrossOriginConfigurationRequest, SetBucketInventoryConfigurationRequest, SetBucketLifecycleConfigurationRequest, SetBucketLoggingConfigurationRequest, SetBucketMetricsConfigurationRequest, SetBucketNotificationConfigurationRequest, SetBucketPolicyRequest, SetBucketProtectionConfigurationRequest, SetBucketReplicationConfigurationRequest, SetBucketVersioningConfigurationRequest, SetBucketWebsiteConfigurationRequest, SetObjectAclRequest, SetObjectLegalHoldRequest, SetObjectLockConfigurationRequest, SetObjectRetentionRequest, SetPublicAccessBlockRequest, UploadObjectRequest, UploadPartRequest, WriteGetObjectResponseRequest

public interface HandlerContextAware

An implementing object is capable of storing context that is visible to all RequestHandler2.

This interface is subject to change and should not be implemented by users of the SDK.

Method Summary

Modifier and Type	Method and Description
<X> void	addHandlerContext(HandlerContextKey<X> key, X value) Adds a context to that is visible to all RequestHandler2s.
<X> X	getHandlerContext(HandlerContextKey<X> key) Return the context for the given key if present; else return null.

Method Detail

addHandlerContext

<X> void addHandlerContext(HandlerContextKey<X> key,
                           X value)

Adds a context to that is visible to all RequestHandler2s. Note that, context added here will available only for the scope of the request execution and will not be marshalled over the wire.

Parameters:

key - the key for the property being set in the request.

value - the value for the property being set in the request.

getHandlerContext

<X> X getHandlerContext(HandlerContextKey<X> key)

Return the context for the given key if present; else return null.

Parameters:

key - the key for the context

Returns:

the context if present else null.