com.emc.atmos.api

Class AbstractAtmosApi

java.lang.Object

com.emc.atmos.AbstractJerseyClient<AtmosConfig>

com.emc.atmos.api.AbstractAtmosApi

All Implemented Interfaces:

AtmosApi

Direct Known Subclasses:

AtmosApiClient

public abstract class AbstractAtmosApi
extends AbstractJerseyClient<AtmosConfig>
implements AtmosApi

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_CONTENT_TYPE

Fields inherited from class com.emc.atmos.AbstractJerseyClient

client, config

Constructor Summary

Constructors

Constructor and Description
AbstractAtmosApi(AtmosConfig config)

Method Summary

Modifier and Type	Method and Description
ObjectId	createObject(ObjectIdentifier identifier, java.lang.Object content, java.lang.String contentType) Creates a new object in the cloud with the specified identifier.
ObjectId	createObject(java.lang.Object content, java.lang.String contentType) Creates a new object in the cloud.
void	deleteAccessToken(java.net.URL url) Deletes the specified access token.
GetAccessTokenResponse	getAccessToken(java.net.URL url) Retrieves details about the specified access token.
java.net.URL	getShareableUrl(ObjectIdentifier identifier, java.util.Date expirationDate) Constructs a pre-signed URL to an object, which anyone can then use to retrieve the object.
java.net.URL	getShareableUrl(ObjectIdentifier identifier, java.util.Date expirationDate, java.lang.String disposition) Constructs a shareable URL with a specific content-disposition.
PreSignedRequest	preSignRequest(Request request, java.util.Date expiration) Pre-signs a request with a specified expiration time.
<T> T	readObject(ObjectIdentifier identifier, java.lang.Class<T> objectType) Reads an object's entire content from the cloud.
<T> T	readObject(ObjectIdentifier identifier, Range range, java.lang.Class<T> objectType) Reads an object's content from the cloud.
void	updateObject(ObjectIdentifier identifier, java.lang.Object content) Updates an object's content in the cloud.
void	updateObject(ObjectIdentifier identifier, java.lang.Object content, Range range) Updates an object's content in the cloud.

Methods inherited from class com.emc.atmos.AbstractJerseyClient

buildRequest, createClient, executeAndClose, fillResponse

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.emc.atmos.api.AtmosApi

calculateServerClockSkew, createAccessToken, createDirectory, createDirectory, createObject, createSubtenant, createVersion, delete, deleteAccessToken, deleteSubtenant, deleteUserMetadata, deleteVersion, execute, getAccessToken, getAcl, getObjectInfo, getObjectMetadata, getServiceInformation, getSystemMetadata, getUserMetadata, getUserMetadataNames, listAccessTokens, listDirectory, listMetadata, listObjects, listVersions, move, objectExists, readObject, readObjectStream, restoreVersion, setAcl, setUserMetadata, updateObject

Field Detail

DEFAULT_CONTENT_TYPE

public static final java.lang.String DEFAULT_CONTENT_TYPE

See Also:

Constant Field Values

Constructor Detail

AbstractAtmosApi

public AbstractAtmosApi(AtmosConfig config)

Method Detail

createObject

public ObjectId createObject(java.lang.Object content,
                             java.lang.String contentType)

Description copied from interface: AtmosApi

Creates a new object in the cloud.

Specified by:

createObject in interface AtmosApi

Parameters:

content - The initial content of the object. May be appended to later. May be null to create an object with no content. The content object can be any object type that is supported by the implementation.

contentType - the MIME type of the content. Optional, may be null. If null, defaults to application/octet-stream.

Returns:

ObjectId of the newly created object.

createObject

public ObjectId createObject(ObjectIdentifier identifier,
                             java.lang.Object content,
                             java.lang.String contentType)

Description copied from interface: AtmosApi

Creates a new object in the cloud with the specified identifier.

Specified by:

createObject in interface AtmosApi

Parameters:

identifier - The identifier to use for the new object. This may be an ObjectPath or an ObjectKey.

content - The initial content of the object. May be appended to later. May be null to create an object with no content. The content object can be any object type that is supported by the implementation.

contentType - the MIME type of the content. Optional, may be null. If null, defaults to application/octet-stream.

Returns:

ObjectId of the newly created object.

readObject

public <T> T readObject(ObjectIdentifier identifier,
                        java.lang.Class<T> objectType)
                 throws java.io.IOException

Description copied from interface: AtmosApi

Reads an object's entire content from the cloud.

Specified by:

readObject in interface AtmosApi

Parameters:

identifier - The identifier of the object to read. May be any ObjectIdentifier.

objectType - The type of object to return. This can be any object type supported by the implementation.

Returns:

An object (of type objectType) representing the content of the object in the cloud.

Throws:

java.io.IOException - if an exception occurs while reading the object. Note that IOExceptions are generally retried automatically (configured in AtmosConfig).

readObject

public <T> T readObject(ObjectIdentifier identifier,
                        Range range,
                        java.lang.Class<T> objectType)
                 throws java.io.IOException

Description copied from interface: AtmosApi

Reads an object's content from the cloud.

Specified by:

readObject in interface AtmosApi

Parameters:

identifier - The identifier of the object to read. May be any ObjectIdentifier.

range - (optional) The range of bytes to read from the object. A null value will read the entire object.

objectType - The type of object to return. This can be any object type supported by the implementation.

Returns:

An object (of type objectType) representing the content of the object in the cloud.

Throws:

java.io.IOException - if an exception occurs while reading the object. Note that IOExceptions are generally retried automatically (configured in AtmosConfig).

updateObject

public void updateObject(ObjectIdentifier identifier,
                         java.lang.Object content)

Description copied from interface: AtmosApi

Updates an object's content in the cloud.

Specified by:

updateObject in interface AtmosApi

Parameters:

identifier - The identifier of the object to update. May be any ObjectIdentifier.

content - The new content of the object. The content object can be any object type that is supported by the implementation.

updateObject

public void updateObject(ObjectIdentifier identifier,
                         java.lang.Object content,
                         Range range)

Description copied from interface: AtmosApi

Updates an object's content in the cloud.

Specified by:

updateObject in interface AtmosApi

Parameters:

identifier - The identifier of the object to update. May be any ObjectIdentifier.

content - The new content of the object. The content object can be any object type that is supported by the implementation.

range - (optional) The portion of the object to update (expressed as a range of bytes). A null value will overwrite the entire object.

getShareableUrl

public java.net.URL getShareableUrl(ObjectIdentifier identifier,
                                    java.util.Date expirationDate)
                             throws java.net.MalformedURLException

Description copied from interface: AtmosApi

Constructs a pre-signed URL to an object, which anyone can then use to retrieve the object. The URL expires at the specified time and is tamper proof. However, it does reveal the full tokenId of the user. If this is undesirable and the Atmos cloud is at version 2.1 and above, look at AtmosApi.createAccessToken(com.emc.atmos.api.request.CreateAccessTokenRequest).

Specified by:

getShareableUrl in interface AtmosApi

Parameters:

identifier - The identifier of the object. Can be any ObjectIdentifier.

expirationDate - The date at which the generated URL will no longer be valid.

Returns:

A public URL that will retrieve the contents of the specified object until expirationDate.

Throws:

java.net.MalformedURLException - if the configured Atmos endpoint is syntactically invalid.

getShareableUrl

public java.net.URL getShareableUrl(ObjectIdentifier identifier,
                                    java.util.Date expirationDate,
                                    java.lang.String disposition)
                             throws java.net.MalformedURLException

Description copied from interface: AtmosApi

Constructs a shareable URL with a specific content-disposition. The disposition value will be set in the Content-Disposition header of the response when the URL is accessed. Requires the browser-compat feature, check ServiceInformation for supported features.

Specified by:

getShareableUrl in interface AtmosApi

Parameters:

identifier - The identifier of the object. Can be any ObjectIdentifier.

expirationDate - The date at which the generated URL will no longer be valid.

disposition - the value of the Content-Disposition header, e.g. "attachment; filename=\"filename.txt\""

Returns:

A public URL that will retrieve the contents of the specified object and set the specified content-disposition until expirationDate.

Throws:

java.net.MalformedURLException - if the configured Atmos endpoint is syntactically invalid.

getAccessToken

public GetAccessTokenResponse getAccessToken(java.net.URL url)

Description copied from interface: AtmosApi

Retrieves details about the specified access token. Implementation simply extracts the token ID from the URL and calls AtmosApi.getAccessToken(String).

Specified by:

getAccessToken in interface AtmosApi

Parameters:

url - The URL of the access token.

Returns:

The response received from Atmos. This object contains the AccessToken, plus details about the response, such as headers (click on the class name to get more information).

deleteAccessToken

public void deleteAccessToken(java.net.URL url)

Description copied from interface: AtmosApi

Deletes the specified access token. Implementation simply extracts the token ID from the URL and calls AtmosApi.deleteAccessToken(String).

Specified by:

deleteAccessToken in interface AtmosApi

Parameters:

url - The URL of the access token.

preSignRequest

public PreSignedRequest preSignRequest(Request request,
                                       java.util.Date expiration)
                                throws java.net.MalformedURLException

Description copied from interface: AtmosApi

Pre-signs a request with a specified expiration time. The pre-signed request can be executed at a later time via the AtmosApi.execute(com.emc.atmos.api.request.PreSignedRequest, Class, Object) method. This feature is useful if you intend to serialize the pre-signed request to some other system which does not have access to Atmos credentials.

Specified by:

preSignRequest in interface AtmosApi

Parameters:

request - the request to pre-sign (can be executed at a later time)

expiration - the date at which the pre-signed request becomes invalid and will no longer be accepted

Returns:

a pre-signed request that can be executed at a later time and expires at expiration

Throws:

java.net.MalformedURLException - if the configured Atmos endpoint is syntactically invalid.