com.ibm.cloud.objectstorage.services.s3.internal

Class AmazonS3ExceptionBuilder

java.lang.Object

com.ibm.cloud.objectstorage.services.s3.internal.AmazonS3ExceptionBuilder

public class AmazonS3ExceptionBuilder
extends Object

Builder class that builds the AmazonS3Exception

Constructor Summary

Constructors

Constructor and Description
AmazonS3ExceptionBuilder()

Method Summary

Modifier and Type	Method and Description
void	addAdditionalDetail(String key, String detail) Adds an entry to the additional information map.
AmazonS3Exception	build() Creates a new AmazonS3Exception object with the values set.
Map<String,String>	getAdditionalDetails() Returns any additional information retrieved in the error response.
String	getCloudFrontId() Gets Amazon S3's CloudFront ID when the request is performed in the accelerate mode.
String	getErrorCode() Returns the Amazon Web Services error code represented by this exception.
String	getErrorMessage() Returns the human-readable error message provided by the service
String	getErrorResponseXml() Returns the original error response XML received from Amazon S3
String	getExtendedRequestId() Gets Amazon S3's extended request ID.
String	getRequestId() Returns the Amazon Web Services request ID that uniquely identifies the service request the caller made.
int	getStatusCode() Returns the HTTP status code that was returned with this service exception.
void	setAdditionalDetails(Map<String,String> additionalDetails) Sets additional information about the response.
void	setCloudFrontId(String cloudFrontId) Sets Amazon S3's CloudFront ID when the request is performed in the accelerate mode.
void	setErrorCode(String errorCode) Sets the Amazon Web Services error code represented by this exception.
void	setErrorMessage(String errorMessage) Sets the human-readable error message provided by the service
void	setErrorResponseXml(String errorResponseXml) Sets the error response XML received from Amazon S3
void	setExtendedRequestId(String extendedRequestId) Sets Amazon S3's extended request ID.
void	setProxyHost(String proxyHost) Sets proxy host.
void	setRequestId(String requestId) Sets the Amazon Web Services requestId for this exception.
void	setStatusCode(int statusCode) Sets the HTTP status code that was returned with this service exception.

Methods inherited from class java.lang.Object

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

Constructor Detail

AmazonS3ExceptionBuilder

public AmazonS3ExceptionBuilder()

Method Detail

getRequestId

public String getRequestId()

Returns the Amazon Web Services request ID that uniquely identifies the service request the caller made.

Returns:

The Amazon Web Services request ID that uniquely identifies the service request the caller made.

setRequestId

public void setRequestId(String requestId)

Sets the Amazon Web Services requestId for this exception.

Parameters:

requestId - The unique identifier for the service request the caller made.

setErrorCode

public void setErrorCode(String errorCode)

Sets the Amazon Web Services error code represented by this exception.

Parameters:

errorCode - The Amazon Web Services error code represented by this exception.

getErrorCode

public String getErrorCode()

Returns the Amazon Web Services error code represented by this exception.

Returns:

The Amazon Web Services error code represented by this exception.

getErrorMessage

public String getErrorMessage()

Returns the human-readable error message provided by the service

setErrorMessage

public void setErrorMessage(String errorMessage)

Sets the human-readable error message provided by the service

setStatusCode

public void setStatusCode(int statusCode)

Sets the HTTP status code that was returned with this service exception.

Parameters:

statusCode - The HTTP status code that was returned with this service exception.

getStatusCode

public int getStatusCode()

Returns the HTTP status code that was returned with this service exception.

Returns:

The HTTP status code that was returned with this service exception.

getExtendedRequestId

public String getExtendedRequestId()

Gets Amazon S3's extended request ID. This ID is required debugging information in the case the user needs to contact Amazon about an issue where Amazon S3 is incorrectly handling a request.

Returns:

Amazon S3's extended request ID.

See Also:

AmazonS3Exception.setExtendedRequestId(String), AmazonS3Exception.getExtendedRequestId()

setExtendedRequestId

public void setExtendedRequestId(String extendedRequestId)

Sets Amazon S3's extended request ID.

Parameters:

extendedRequestId - S3's extended request ID.

See Also:

AmazonS3Exception.setExtendedRequestId(String), AmazonS3Exception.getExtendedRequestId()

getCloudFrontId

public String getCloudFrontId()

Gets Amazon S3's CloudFront ID when the request is performed in the accelerate mode.

Returns:

Amazon S3's CloudFront ID when in accelerate mode.

setCloudFrontId

public void setCloudFrontId(String cloudFrontId)

Sets Amazon S3's CloudFront ID when the request is performed in the accelerate mode.

Parameters:

cloudFrontId - Amazon S3's CloudFront ID.

getAdditionalDetails

public Map<String,String> getAdditionalDetails()

Returns any additional information retrieved in the error response.

setAdditionalDetails

public void setAdditionalDetails(Map<String,String> additionalDetails)

Sets additional information about the response.

addAdditionalDetail

public void addAdditionalDetail(String key,
                                String detail)

Adds an entry to the additional information map.

getErrorResponseXml

public String getErrorResponseXml()

Returns the original error response XML received from Amazon S3

setErrorResponseXml

public void setErrorResponseXml(String errorResponseXml)

Sets the error response XML received from Amazon S3

setProxyHost

public void setProxyHost(String proxyHost)

Sets proxy host.

Parameters:

proxyHost - the proxy host to set

build

public AmazonS3Exception build()

Creates a new AmazonS3Exception object with the values set.