AtmosEncryptionClient (atmos-client 3.1.0 API)

java.lang.Object
- com.emc.atmos.api.encryption.AtmosEncryptionClient

All Implemented Interfaces:

AtmosApi
```
public class AtmosEncryptionClient
extends java.lang.Object
implements AtmosApi
```
Implements client-side "Envelope Encryption" on top of the Atmos API. With envelope encryption, a master asymmetric (RSA) key is used to encrypt and decrypt a per-object symmetric (AES) key. This means that every object is encrypted using a unique key so breaking any one object's key does not compromise the encryption on other objects. Key rotation can also be accomplished by creating a new asymmetric key and re-encrypting the object keys without re-encrypting the actual object content.
To use this class, you will first need to create a keystore, set a password, and then create an RSA key to use as your master encryption key. This can be accomplished using the 'keytool' application that comes with Java In this example, we create a 2048-bit RSA key and call it "masterkey". If the keystore does not already exist, it will be created an you will be prompted for a keystore password.
```
 $ keytool -genkeypair -keystore keystore.jks -alias masterkey -keyalg RSA \ 
   -keysize 2048 -dname "CN=My Name, OU=My Division, O=My Company, L=My Location, ST=MA, C=US"
 Enter keystore password: changeit
 Re-enter new password: changeit
 Enter key password for 
   (RETURN if same as keystore password):  
 
```
Inside your application, you can then construct and load a Keystore object, KeyStore.load(InputStream, char[]) Once the keystore has been loaded, you then construct a EncryptionConfig object with the keystore:
```
 EncryptionConfig ec = new EncryptionConfig(keystore, 
             keystorePassword.toCharArray(), "masterkey", provider, 128);
 
```
The "provider" argument is used to specify the security provider to be used for cryptographic operations. You can set it to null to use the default provider(s) as specified in your jre/lib/security/java.security file. The final argument is the AES encryption key size. Note that most JDKs only support 128-bit AES encryption by default and required the "unlimited strength jurisdiction policy files" to be installed to achieve 256-bit support. See your JRE/JDK download page for details.
Next, if you want to compress your data, you can create a CompressionConfig object to select the compression algorithm and level:
```
 CompressionConfig cc = new CompressionConfig(CompressionMode.Deflate, 5);
 
```
In this instance, you can see that we created a CompressionConfig specifying the Deflate algorithm, and level 5 (medium) compression. LZMA compression is also available but note that while it provides superior compression it also has high memory requirements and can cause OutOfMemoryErrors if you select a level that will not fit in your Java heap.
Once you have your EncryptionConfig and/or CompressionConfig objects, you will construct an implmentation of AtmosApi to handle the "transport", e.g. AtmosApiClient. You will then create an instance of the AtmosEncryptionClient that "wraps" the AtmosApi instance to perform encryption operations:
```
 AtmosApi api = new AtmosApiClient(atmosConfig);
 AtmosEncryptionClient eclient = new AtmosEncryptionClient(api, ec, cc);
 
```
You may pass null to the encryption or compression arguments to use only one or the other.
After you have your AtmosEncryptionClient constructed, you may use it like any other AtmosApi instance with the following limitations:
- Byte range (partial) reads are not supported
- Byte range (partial) updates including appends are not supported.
- Shareable URLs and access tokens are not supported because there is no way to decompress and/or decrypt the content for the receiver.

Constructor Summary

Constructors
Constructor and Description
`AtmosEncryptionClient(AtmosApi delegate, java.util.Collection<com.emc.vipr.transform.TransformFactory<com.emc.vipr.transform.OutputTransform,com.emc.vipr.transform.InputTransform>> transformations)` Creates a new AtmosEncryptionClient.
`AtmosEncryptionClient(AtmosApi delegate, EncryptionConfig encryptionConfig, CompressionConfig compressionConfig)` Creates a new AtmosEncryptionClient.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`calculateServerClockSkew()` Calculates rough clock skew.
`CreateAccessTokenResponse`	`createAccessToken(CreateAccessTokenRequest request)` Access tokens are unsupported for transformed content since there is no way for the SDK to transform the content since communication goes directly to and from Atmos.
`ObjectId`	`createDirectory(ObjectPath path)` Creates a directory in the subtenant namespace using the specified path.
`ObjectId`	`createDirectory(ObjectPath path, Acl acl, Metadata... metadata)` Creates a directory in the subtenant namespace using the specified path, acl and metadata.
`CreateObjectResponse`	`createObject(CreateObjectRequest request)` Creates a new object in the cloud using all of the options provided in the request object.
`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.
`java.lang.String`	`createSubtenant(CreateSubtenantRequest request)` Creates a new Atmos Subtenant in ECS.
`ObjectId`	`createVersion(ObjectIdentifier identifier)` Creates a new immutable version (snapshot) of the specified object from its current state.
`void`	`delete(ObjectIdentifier identifier)` Deletes an object from the cloud
`void`	`deleteAccessToken(java.lang.String accessTokenId)` Access tokens are unsupported for transformed content since there is no way for the SDK to transform the content since communication goes directly to and from Atmos.
`void`	`deleteAccessToken(java.net.URL url)` Access tokens are unsupported for transformed content since there is no way for the SDK to transform the content since communication goes directly to and from Atmos.
`void`	`deleteSubtenant(java.lang.String subtenantId)` Deletes an Atmos Subtenant in ECS.
`void`	`deleteUserMetadata(ObjectIdentifier identifier, java.lang.String... names)` Deletes metadata associated with the specified object.
`void`	`deleteVersion(ObjectId versionId)` Deletes the specified object version.
`<T> GenericResponse<T>`	`execute(PreSignedRequest request, java.lang.Class<T> resultType, java.lang.Object content)` Presigned requests are unsupported for transformed content since there is no way for the SDK to transform the content since communication may go directly to and from Atmos.
`GetAccessTokenResponse`	`getAccessToken(java.lang.String accessTokenId)` Access tokens are unsupported for transformed content since there is no way for the SDK to transform the content since communication goes directly to and from Atmos.
`GetAccessTokenResponse`	`getAccessToken(java.net.URL url)` Access tokens are unsupported for transformed content since there is no way for the SDK to transform the content since communication goes directly to and from Atmos.
`Acl`	`getAcl(ObjectIdentifier identifier)` Gets the ACL for the specified object.
`int`	`getBufferSize()`
`ObjectInfo`	`getObjectInfo(ObjectIdentifier identifier)` Gets storage information for the specified object.
`ObjectMetadata`	`getObjectMetadata(ObjectIdentifier identifier)` Gets an object's metadata, ACL and content-type all in one call.
`ServiceInformation`	`getServiceInformation()`
`java.net.URL`	`getShareableUrl(ObjectIdentifier identifier, java.util.Date expirationDate)` Getting shareable URLs for transformed content is not supported since there is no way to transform the stream since it's streamed directly from Atmos and does not go through the SDK.
`java.net.URL`	`getShareableUrl(ObjectIdentifier identifier, java.util.Date expirationDate, java.lang.String disposition)` Getting shareable URLs for transformed content is not supported since there is no way to transform the stream since it's streamed directly from Atmos and does not go through the SDK.
`java.util.Map<java.lang.String,Metadata>`	`getSystemMetadata(ObjectIdentifier identifier, java.lang.String... metadataNames)` Gets the system metadata associated with the specified object.
`java.util.Map<java.lang.String,Metadata>`	`getUserMetadata(ObjectIdentifier identifier, java.lang.String... metadataNames)` Gets the user metadata associated with the specified object.
`java.util.Map<java.lang.String,java.lang.Boolean>`	`getUserMetadataNames(ObjectIdentifier identifier)` Lists the names of all metadata associated with the specified object.
`ListAccessTokensResponse`	`listAccessTokens(ListAccessTokensRequest request)` Access tokens are unsupported for transformed content since there is no way for the SDK to transform the content since communication goes directly to and from Atmos.
`ListDirectoryResponse`	`listDirectory(ListDirectoryRequest request)` Lists the contents of a directory in the namespace.
`java.util.Set<java.lang.String>`	`listMetadata(java.lang.String metadataName)` Lists the children of the specified metadata path in the hierarchy of listable metadata for the subtenant.
`ListObjectsResponse`	`listObjects(ListObjectsRequest request)` Lists all objects that are assigned the specified listable metadata using all of the options provided in the request object.
`ListVersionsResponse`	`listVersions(ListVersionsRequest request)` Lists all versions (snapshots) of the specified object using all of the options provided in the request object.
`void`	`move(ObjectPath oldPath, ObjectPath newPath, boolean overwrite)` Moves an object in the namespace to a new location.
`boolean`	`objectExists(ObjectIdentifier identifier)` Determines whether an object exists with the specified identifier.
`PreSignedRequest`	`preSignRequest(Request request, java.util.Date expiration)` Presigned requests are unsupported for transformed content since there is no way for the SDK to transform the content since communication may go directly to and from Atmos.
`<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.
`<T> ReadObjectResponse<T>`	`readObject(ReadObjectRequest request, java.lang.Class<T> objectType)` Reads an object's content from the cloud using all of the options provided in the request object.
`ReadObjectResponse<java.io.InputStream>`	`readObjectStream(ObjectIdentifier identifier, Range range)` Provides an InputStream to read an object's content from the cloud.
`void`	`rekey(ObjectIdentifier identifier)` "Rekeys" an object.
`void`	`restoreVersion(ObjectId objectId, ObjectId versionId)` Restores the specified version (snapshot) of the specified object so that the object's current state reflects that of the version.
`void`	`setAcl(ObjectIdentifier identifier, Acl acl)` Sets the ACL for the specified object.
`void`	`setBufferSize(int bufferSize)`
`void`	`setUserMetadata(ObjectIdentifier identifier, Metadata... metadata)` Adds or replaces user metadata associated with the specified object.
`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.
`BasicResponse`	`updateObject(UpdateObjectRequest request)` Updates an object's content in the cloud using all of the options provided in the request object.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AtmosEncryptionClient
```
public AtmosEncryptionClient(AtmosApi delegate,
                             EncryptionConfig encryptionConfig,
                             CompressionConfig compressionConfig)
```
    Creates a new AtmosEncryptionClient.
    
    Parameters:
    
    delegate - This is the AtmosApi instance that will be used for communicating with the server.
    
    encryptionConfig - The encryption configuration for the client. If null, no encryption will be performed.
    
    compressionConfig - The compression configuration for the client. If null, no compression will be performed.
  - AtmosEncryptionClient
```
public AtmosEncryptionClient(AtmosApi delegate,
                             java.util.Collection<com.emc.vipr.transform.TransformFactory<com.emc.vipr.transform.OutputTransform,com.emc.vipr.transform.InputTransform>> transformations)
```
    Creates a new AtmosEncryptionClient. This version allows you to fine-tune the collection of TransformFactories that will be applied to objects (and allow you to use custom TransformFactories if required).
    
    Parameters:
    
    delegate - This is the AtmosApi instance that will be used for communicating with the server.
    
    transformations - the collection of TransformFactory instances that will be applied to objects. Note that order of transforms will be determined by the factory's priority.
    
    See Also:
    
    TransformFactory.getPriority()
- Method Detail
  - rekey
```
public void rekey(ObjectIdentifier identifier)
           throws com.emc.vipr.transform.encryption.DoesNotNeedRekeyException
```
    "Rekeys" an object. This operation re-encrypts the object's key with the most current master key and is used to implement key rotation. Note that when you create a new master key, your EncryptionConfig should keep all of the old master key(s) until you have rekeyed all of the objects so you can decrypt the old objects.
    
    Parameters:
    
    identifier - the object to be rekeyed.
    
    Throws:
    
    com.emc.vipr.transform.encryption.DoesNotNeedRekeyException - if the object is already using the current master encryption key.
  - getServiceInformation
```
public ServiceInformation getServiceInformation()
```
    Specified by:
    
    getServiceInformation in interface AtmosApi
  - calculateServerClockSkew
```
public long calculateServerClockSkew()
```
    Description copied from interface: AtmosApi
    
    Calculates rough clock skew. Implementations will likely use the date response header from an inert HTTP request.
    
    Specified by:
    
    calculateServerClockSkew in interface AtmosApi
    
    Returns:
    
    The clock skew between the target Atmos node and the local machine.
  - 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.
  - createObject
```
public CreateObjectResponse createObject(CreateObjectRequest request)
```
    Description copied from interface: AtmosApi
    
    Creates a new object in the cloud using all of the options provided in the request object.
    
    Specified by:
    
    createObject in interface AtmosApi
    
    Parameters:
    
    request - The request object (click on the class name to get more information).
    
    Returns:
    
    The response received from Atmos. This object contains the ObjectId of the newly created object plus additional details about the response, such as headers (click on the class name to get more information).
  - 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).
  - readObject
```
public <T> ReadObjectResponse<T> readObject(ReadObjectRequest request,
                                            java.lang.Class<T> objectType)
                                     throws java.io.IOException
```
    Description copied from interface: AtmosApi
    
    Reads an object's content from the cloud using all of the options provided in the request object.
    
    Specified by:
    
    readObject in interface AtmosApi
    
    Parameters:
    
    request - The request object (click on the class name to get more information)
    
    objectType - The type of object to return. This can be any object type supported by the implementation.
    
    Returns:
    
    The response received from Atmos. This object contains an object (of type objectType) representing the content of the object in the cloud, plus additional details about the response, such as headers (click on the class name to get more information).
    
    Throws:
    
    java.io.IOException - if an exception occurs while reading the object. Note that IOExceptions are generally retried automatically (configured in AtmosConfig).
  - readObjectStream
```
public ReadObjectResponse<java.io.InputStream> readObjectStream(ObjectIdentifier identifier,
                                                                Range range)
```
    Description copied from interface: AtmosApi
    
    Provides an InputStream to read an object's content from the cloud.
    
    Specified by:
    
    readObjectStream 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.
    
    Returns:
    
    The response received from Atmos. This object contains the InputStream to read the object from the cloud, plus additional details about the response, such as headers (click on the class name to get more information).
  - 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.
  - updateObject
```
public BasicResponse updateObject(UpdateObjectRequest request)
```
    Description copied from interface: AtmosApi
    
    Updates an object's content in the cloud using all of the options provided in the request object.
    
    Specified by:
    
    updateObject in interface AtmosApi
    
    Parameters:
    
    request - The request object (click on the class name to get more information)
    
    Returns:
    
    The response received from Atmos. This object contains details about the response, such as headers (click on the class name to get more information).
  - delete
```
public void delete(ObjectIdentifier identifier)
```
    Description copied from interface: AtmosApi
    
    Deletes an object from the cloud
    
    Specified by:
    
    delete in interface AtmosApi
    
    Parameters:
    
    identifier - The identifier of the object to delete. May be any ObjectIdentifier.
  - createDirectory
```
public ObjectId createDirectory(ObjectPath path)
```
    Description copied from interface: AtmosApi
    
    Creates a directory in the subtenant namespace using the specified path.
    
    Specified by:
    
    createDirectory in interface AtmosApi
    
    Parameters:
    
    path - The path of the directory to create.
    
    Returns:
    
    The ObjectId of the newly created directory.
  - createDirectory
```
public ObjectId createDirectory(ObjectPath path,
                                Acl acl,
                                Metadata... metadata)
```
    Description copied from interface: AtmosApi
    
    Creates a directory in the subtenant namespace using the specified path, acl and metadata.
    
    Specified by:
    
    createDirectory in interface AtmosApi
    
    Parameters:
    
    path - The path of the directory to create.
    
    acl - The ACL to assign to the new directory.
    
    metadata - The metadata to associate with the new directory.
    
    Returns:
    
    The ObjectId of the newly created directory.
  - listDirectory
```
public ListDirectoryResponse listDirectory(ListDirectoryRequest request)
```
    Description copied from interface: AtmosApi
    
    Lists the contents of a directory in the namespace.
    
    Specified by:
    
    listDirectory in interface AtmosApi
    
    Parameters:
    
    request - The request object (click on the class name to get more information)
    
    Returns:
    
    The response received from Atmos. This object contains the list of directory entries, plus details about the response, such as headers (click on the class name to get more information). Note that if a paging token is present in the response, it will be set on the request object.
  - move
```
public void move(ObjectPath oldPath,
                 ObjectPath newPath,
                 boolean overwrite)
```
    Description copied from interface: AtmosApi
    
    Moves an object in the namespace to a new location.
    
    Specified by:
    
    move in interface AtmosApi
    
    Parameters:
    
    oldPath - The existing path of the object.
    
    newPath - The new path that the object should have.
    
    overwrite - If true and an object already exists at newPath, this call will overwrite that object.
  - getUserMetadataNames
```
public java.util.Map<java.lang.String,java.lang.Boolean> getUserMetadataNames(ObjectIdentifier identifier)
```
    Description copied from interface: AtmosApi
    
    Lists the names of all metadata associated with the specified object.
    
    Specified by:
    
    getUserMetadataNames in interface AtmosApi
    
    Parameters:
    
    identifier - The identifier of the object. Can be any ObjectIdentifier.
    
    Returns:
    
    A list of the names of all user metadata associated with the object.
  - getUserMetadata
```
public java.util.Map<java.lang.String,Metadata> getUserMetadata(ObjectIdentifier identifier,
                                                                java.lang.String... metadataNames)
```
    Description copied from interface: AtmosApi
    
    Gets the user metadata associated with the specified object.
    
    Specified by:
    
    getUserMetadata in interface AtmosApi
    
    Parameters:
    
    identifier - The identifier of the object. Can be any ObjectIdentifier.
    
    metadataNames - (optional) Constrains the result to include only the metadata named in this list.
    
    Returns:
    
    A map of metadata names to Metadata objects.
  - getSystemMetadata
```
public java.util.Map<java.lang.String,Metadata> getSystemMetadata(ObjectIdentifier identifier,
                                                                  java.lang.String... metadataNames)
```
    Description copied from interface: AtmosApi
    
    Gets the system metadata associated with the specified object.
    
    Specified by:
    
    getSystemMetadata in interface AtmosApi
    
    Parameters:
    
    identifier - The identifier of the object. Can be any ObjectIdentifier.
    
    metadataNames - (optional) Constrains the result to include only the metadata named in this list.
    
    Returns:
    
    A map of metadata names to Metadata objects.
  - objectExists
```
public boolean objectExists(ObjectIdentifier identifier)
```
    Description copied from interface: AtmosApi
    
    Determines whether an object exists with the specified identifier. Implementations will probably make a get-system-metadata call and return false if the server returns a 404.
    
    Specified by:
    
    objectExists in interface AtmosApi
    
    Parameters:
    
    identifier - The identifier of the object. Can be any ObjectIdentifier.
    
    Returns:
    
    true if an object exists in the cloud with the specified identifier.
  - getObjectMetadata
```
public ObjectMetadata getObjectMetadata(ObjectIdentifier identifier)
```
    Description copied from interface: AtmosApi
    
    Gets an object's metadata, ACL and content-type all in one call.
    
    Specified by:
    
    getObjectMetadata in interface AtmosApi
    
    Parameters:
    
    identifier - The identifier of the object. Can be any ObjectIdentifier.
    
    Returns:
    
    Object metadata (click on the class for more information).
  - setUserMetadata
```
public void setUserMetadata(ObjectIdentifier identifier,
                            Metadata... metadata)
```
    Description copied from interface: AtmosApi
    
    Adds or replaces user metadata associated with the specified object. Note that this method will not delete metadata. That must be done via AtmosApi.deleteUserMetadata(ObjectIdentifier, String...).
    
    Specified by:
    
    setUserMetadata in interface AtmosApi
    
    Parameters:
    
    identifier - The identifier of the object. Can be any ObjectIdentifier.
    
    metadata - The metadata to add to or replace on the object.
  - deleteUserMetadata
```
public void deleteUserMetadata(ObjectIdentifier identifier,
                               java.lang.String... names)
```
    Description copied from interface: AtmosApi
    
    Deletes metadata associated with the specified object.
    
    Specified by:
    
    deleteUserMetadata in interface AtmosApi
    
    Parameters:
    
    identifier - The identifier of the object. Can be any ObjectIdentifier.
    
    names - The names of the metadata to delete/remove from the object.
  - listMetadata
```
public java.util.Set<java.lang.String> listMetadata(java.lang.String metadataName)
```
    Description copied from interface: AtmosApi
    
    Lists the children of the specified metadata path in the hierarchy of listable metadata for the subtenant. For example, if a hierarchy of listable metadata exists as such: /ford/mustang/gt, then listing "ford" would probably yield "mustang", "f150", "crown victoria", etc.
    
    Specified by:
    
    listMetadata in interface AtmosApi
    
    Parameters:
    
    metadataName - The metadata name (sometime called a "tag") whose children should be returned. If null, all root-level names will be returned (i.e. "ford", "chevy", "chrysler").
    
    Returns:
    
    The names of all children of the specified listable metadata path.
  - listObjects
```
public ListObjectsResponse listObjects(ListObjectsRequest request)
```
    Description copied from interface: AtmosApi
    
    Lists all objects that are assigned the specified listable metadata using all of the options provided in the request object.
    
    Specified by:
    
    listObjects in interface AtmosApi
    
    Parameters:
    
    request - The request object (click on the class name to get more information)
    
    Returns:
    
    The response received from Atmos. This object contains the list of object entries, plus details about the response, such as headers (click on the class name to get more information). Note that if a paging token is present in the response, it will be set on the request object.
  - getAcl
```
public Acl getAcl(ObjectIdentifier identifier)
```
    Description copied from interface: AtmosApi
    
    Gets the ACL for the specified object.
    
    Specified by:
    
    getAcl in interface AtmosApi
    
    Parameters:
    
    identifier - The identifier of the object. Can be any ObjectIdentifier.
    
    Returns:
    
    The ACL for the specified object.
  - setAcl
```
public void setAcl(ObjectIdentifier identifier,
                   Acl acl)
```
    Description copied from interface: AtmosApi
    
    Sets the ACL for the specified object.
    
    Specified by:
    
    setAcl in interface AtmosApi
    
    Parameters:
    
    identifier - The identifier of the object. Can be any ObjectIdentifier.
    
    acl - The new ACL for the specified object.
  - getObjectInfo
```
public ObjectInfo getObjectInfo(ObjectIdentifier identifier)
```
    Description copied from interface: AtmosApi
    
    Gets storage information for the specified object.
    
    Specified by:
    
    getObjectInfo in interface AtmosApi
    
    Parameters:
    
    identifier - The identifier of the object. Can be any ObjectIdentifier.
    
    Returns:
    
    Storage information for the specified object.
  - createVersion
```
public ObjectId createVersion(ObjectIdentifier identifier)
```
    Description copied from interface: AtmosApi
    
    Creates a new immutable version (snapshot) of the specified object from its current state.
    
    Specified by:
    
    createVersion in interface AtmosApi
    
    Parameters:
    
    identifier - The identifier of the object. Can be any ObjectIdentifier.
    
    Returns:
    
    The ObjectId of the new version. Use this identifier to retrieve the snapshot created by this call.
  - listVersions
```
public ListVersionsResponse listVersions(ListVersionsRequest request)
```
    Description copied from interface: AtmosApi
    
    Lists all versions (snapshots) of the specified object using all of the options provided in the request object.
    
    Specified by:
    
    listVersions in interface AtmosApi
    
    Parameters:
    
    request - The request object (click on the class name to get more information)
    
    Returns:
    
    The response received from Atmos. This object contains the list of object versions, plus details about the response, such as headers (click on the class name to get more information). Note that if a paging token is present in the response, it will be set on the request object.
  - restoreVersion
```
public void restoreVersion(ObjectId objectId,
                           ObjectId versionId)
```
    Description copied from interface: AtmosApi
    
    Restores the specified version (snapshot) of the specified object so that the object's current state reflects that of the version. Note this will overwrite the current state of the object.
    
    Specified by:
    
    restoreVersion in interface AtmosApi
    
    Parameters:
    
    objectId - The ObjectId of the object.
    
    versionId - The ObjectId of the version (must be a version of the specified object).
  - deleteVersion
```
public void deleteVersion(ObjectId versionId)
```
    Description copied from interface: AtmosApi
    
    Deletes the specified object version.
    
    Specified by:
    
    deleteVersion in interface AtmosApi
    
    Parameters:
    
    versionId - The ObjectId of the version to delete (must point to a version and not an object).
  - getShareableUrl
```
public java.net.URL getShareableUrl(ObjectIdentifier identifier,
                                    java.util.Date expirationDate)
                             throws java.net.MalformedURLException
```
    Getting shareable URLs for transformed content is not supported since there is no way to transform the stream since it's streamed directly from Atmos and does not go through the SDK.
    
    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.
    
    See Also:
    
    AtmosApi.getShareableUrl(com.emc.atmos.api.ObjectIdentifier, java.util.Date)
  - getShareableUrl
```
public java.net.URL getShareableUrl(ObjectIdentifier identifier,
                                    java.util.Date expirationDate,
                                    java.lang.String disposition)
                             throws java.net.MalformedURLException
```
    Getting shareable URLs for transformed content is not supported since there is no way to transform the stream since it's streamed directly from Atmos and does not go through the SDK.
    
    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.
    
    See Also:
    
    AtmosApi.getShareableUrl(com.emc.atmos.api.ObjectIdentifier, java.util.Date, java.lang.String)
  - createAccessToken
```
public CreateAccessTokenResponse createAccessToken(CreateAccessTokenRequest request)
                                            throws java.net.MalformedURLException
```
    Access tokens are unsupported for transformed content since there is no way for the SDK to transform the content since communication goes directly to and from Atmos.
    
    Specified by:
    
    createAccessToken in interface AtmosApi
    
    Parameters:
    
    request - The request object (click on the class name to get more information)
    
    Returns:
    
    The response received from Atmos. This object contains the access token URL, plus details about the response, such as headers (click on the class name to get more information).
    
    Throws:
    
    java.net.MalformedURLException - if the configured Atmos endpoint is syntactically invalid.
    
    See Also:
    
    AtmosApi.createAccessToken(com.emc.atmos.api.request.CreateAccessTokenRequest)
  - getAccessToken
```
public GetAccessTokenResponse getAccessToken(java.net.URL url)
```
    Access tokens are unsupported for transformed content since there is no way for the SDK to transform the content since communication goes directly to and from Atmos.
    
    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).
    
    See Also:
    
    AtmosApi.getAccessToken(java.net.URL)
  - getAccessToken
```
public GetAccessTokenResponse getAccessToken(java.lang.String accessTokenId)
```
    Access tokens are unsupported for transformed content since there is no way for the SDK to transform the content since communication goes directly to and from Atmos.
    
    Specified by:
    
    getAccessToken in interface AtmosApi
    
    Parameters:
    
    accessTokenId - The ID 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).
    
    See Also:
    
    AtmosApi.getAccessToken(java.lang.String)
  - deleteAccessToken
```
public void deleteAccessToken(java.net.URL url)
```
    Access tokens are unsupported for transformed content since there is no way for the SDK to transform the content since communication goes directly to and from Atmos.
    
    Specified by:
    
    deleteAccessToken in interface AtmosApi
    
    Parameters:
    
    url - The URL of the access token.
    
    See Also:
    
    AtmosApi.deleteAccessToken(java.net.URL)
  - deleteAccessToken
```
public void deleteAccessToken(java.lang.String accessTokenId)
```
    Access tokens are unsupported for transformed content since there is no way for the SDK to transform the content since communication goes directly to and from Atmos.
    
    Specified by:
    
    deleteAccessToken in interface AtmosApi
    
    Parameters:
    
    accessTokenId - The ID of the access token.
    
    See Also:
    
    AtmosApi.deleteAccessToken(java.lang.String)
  - listAccessTokens
```
public ListAccessTokensResponse listAccessTokens(ListAccessTokensRequest request)
```
    Access tokens are unsupported for transformed content since there is no way for the SDK to transform the content since communication goes directly to and from Atmos.
    
    Specified by:
    
    listAccessTokens in interface AtmosApi
    
    Parameters:
    
    request - The request object (click on the class name to get more information)
    
    Returns:
    
    The response received from Atmos. This object contains the list of access tokens, plus details about the response, such as headers (click on the class name to get more information). Note that if a paging token is present in the response, it will be set on the request object.
    
    See Also:
    
    AtmosApi.listAccessTokens(com.emc.atmos.api.request.ListAccessTokensRequest)
  - preSignRequest
```
public PreSignedRequest preSignRequest(Request request,
                                       java.util.Date expiration)
                                throws java.net.MalformedURLException
```
    Presigned requests are unsupported for transformed content since there is no way for the SDK to transform the content since communication may go directly to and from Atmos.
    
    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.
    
    See Also:
    
    AtmosApi.preSignRequest(com.emc.atmos.api.request.Request, java.util.Date)
  - execute
```
public <T> GenericResponse<T> execute(PreSignedRequest request,
                                      java.lang.Class<T> resultType,
                                      java.lang.Object content)
                               throws java.net.URISyntaxException
```
    Presigned requests are unsupported for transformed content since there is no way for the SDK to transform the content since communication may go directly to and from Atmos.
    
    Specified by:
    
    execute in interface AtmosApi
    
    Parameters:
    
    request - A pre-signed request generated by calling AtmosApi.preSignRequest(com.emc.atmos.api.request.Request, java.util.Date).
    
    resultType - (optional) The type of object to return. This can be any object type supported by the implementation.
    
    content - (optional) The body content to send in the request (i.e. the object content for a create-object request). Can be any object type supported by the implementation.
    
    Returns:
    
    The response received from Atmos. This object contains an object (of type resultType) representing the content of the response (i.e. the object content of a read-object request), plus additional details about the response, such as headers (click on the class name to get more information).
    
    Throws:
    
    java.net.URISyntaxException - if the URL in the pre-signed request is syntactically invalid.
    
    See Also:
    
    AtmosApi.execute(com.emc.atmos.api.request.PreSignedRequest, java.lang.Class, java.lang.Object)
  - createSubtenant
```
public java.lang.String createSubtenant(CreateSubtenantRequest request)
```
    Description copied from interface: AtmosApi
    
    Creates a new Atmos Subtenant in ECS. This operation is not supported on pure Atmos systems.
    
    Specified by:
    
    createSubtenant in interface AtmosApi
    
    Parameters:
    
    request - The CreateSubtenantRequest containing the parameters for the new subtenant.
    
    Returns:
    
    The ID of the new subtenant, e.g. "75077194912140aaa95911c237103695"
    
    See Also:
    
    AtmosApi.createSubtenant(com.emc.atmos.api.request.CreateSubtenantRequest)
  - deleteSubtenant
```
public void deleteSubtenant(java.lang.String subtenantId)
```
    Description copied from interface: AtmosApi
    
    Deletes an Atmos Subtenant in ECS. This operation is not supported on pure Atmos systems. Note: the subtenant must be completely empty before deleting.
    
    Specified by:
    
    deleteSubtenant in interface AtmosApi
    
    See Also:
    
    AtmosApi.deleteSubtenant(String)
  - getBufferSize
```
public int getBufferSize()
```
    Returns:
    
    the bufferSize
  - setBufferSize
```
public void setBufferSize(int bufferSize)
```
    Parameters:
    
    bufferSize - the bufferSize to set

Class AtmosEncryptionClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AtmosEncryptionClient

AtmosEncryptionClient

Method Detail

rekey

getServiceInformation

calculateServerClockSkew

createObject

createObject

createObject

readObject

readObject

readObject

readObjectStream

updateObject

updateObject

updateObject

delete

createDirectory

createDirectory

listDirectory

move

getUserMetadataNames

getUserMetadata

getSystemMetadata

objectExists

getObjectMetadata

setUserMetadata

deleteUserMetadata

listMetadata

listObjects

getAcl

setAcl

getObjectInfo

createVersion

listVersions

restoreVersion

deleteVersion

getShareableUrl

getShareableUrl

createAccessToken

getAccessToken

getAccessToken

deleteAccessToken

deleteAccessToken

listAccessTokens

preSignRequest

execute

createSubtenant

deleteSubtenant

getBufferSize

setBufferSize