AtmosConfig (atmos-client 3.2.1 API)

java.lang.Object
- com.emc.atmos.AbstractConfig
- - com.emc.atmos.api.AtmosConfig

```
public class AtmosConfig
extends AbstractConfig
```
Holds configuration parameters for an AtmosApi instance.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String DEFAULT_CONTEXT

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`DEFAULT_CONTEXT`

Constructor Summary

Constructors
Constructor and Description
`AtmosConfig()` Creates a new instance with default parameters.
`AtmosConfig(java.lang.String tokenId, java.lang.String secretKey, java.net.URI... endpoints)` Creates a new instance with default parameters and the specified tokenId, secretKey and endpoint(s).

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getMaxRetries()` Returns the maximum number of retry attempts before bubbling the exception back to calling code.
`java.lang.String`	`getProxyPassword()` Gets the password to use for the HTTP proxy
`java.net.URI`	`getProxyUri()` Returns the HTTP proxy used for communication to Atmos
`java.lang.String`	`getProxyUser()` Gets the username to use for the HTTP proxy
`int`	`getRetryBufferSize()` Returns the buffer size used for non-repeatable object content (input streams) when retry is enabled.
`int`	`getRetryDelayMillis()` Returns the delay in milliseconds to wait between retry attempts.
`byte[]`	`getSecretKey()` Returns the secret key as a byte array.
`long`	`getServerClockSkew()` Returns the estimated clock skew between the local machine and the Atmos cloud (if set).
`java.lang.String`	`getTokenId()` Returns the full Atmos token ID
`boolean`	`isEnableExpect100Continue()` Returns whether the Expect: 100-continue header is enabled for object write requests
`boolean`	`isEnableRetry()` Returns whether 500 errors and IOExceptions should be automatically retried.
`boolean`	`isEncodeUtf8()` Gets whether UTF-8 encoding is enabled
`void`	`setEnableExpect100Continue(boolean enableExpect100Continue)` Sets whether the Expect: 100-continue header should be used for object write requests.
`void`	`setEnableRetry(boolean enableRetry)` Sets whether 500 errors and IOExceptions should be automatically retried.
`void`	`setEncodeUtf8(boolean encodeUtf8)` Sets whether to encode metadata and keys using HTTP UTF-8 escape sequences to allow extended character use.
`void`	`setMaxRetries(int maxRetries)` Sets the maximum number of retry attempts before bubbling the exception back to calling code.
`void`	`setProxyPassword(java.lang.String proxyPassword)` Sets the password to use for the HTTP proxy
`void`	`setProxyUri(java.net.URI proxyUri)` Sets the HTTP proxy used for communication to Atmos
`void`	`setProxyUser(java.lang.String proxyUser)` Sets the username to use for the HTTP proxy
`void`	`setRetryBufferSize(int retryBufferSize)` Sets the buffer size used for non-repeatable object content (input streams) when retry is enabled.
`void`	`setRetryDelayMillis(int retryDelayMillis)` Sets the delay in milliseconds to wait between retry attempts.
`void`	`setSecretKey(byte[] secretKey)` Sets the secret key as a byte array.
`void`	`setSecretKey(java.lang.String secretKey)` Set the secret key from a base64 encoded string (this is the format typically provided to users)
`void`	`setServerClockSkew(long serverClockSkew)` Sets the estimated clock skew between the local machine and the Atmos cloud.
`void`	`setTokenId(java.lang.String tokenId)` Sets the full Atmos token ID

Methods inherited from class com.emc.atmos.AbstractConfig
getContext, getEndpoints, getLoadBalancingAlgorithm, isDisableSslValidation, resolveHost, resolveHostAndPath, resolvePath, setContext, setDisableSslValidation, setEndpoints, setLoadBalancingAlgorithm

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

- Field Detail
  - DEFAULT_CONTEXT
```
public static final java.lang.String DEFAULT_CONTEXT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AtmosConfig
```
public AtmosConfig()
```
    Creates a new instance with default parameters. tokenId, secretKey and at least one endpoint must be provided separately. Intended for use in IoC containers such as Spring.
  - AtmosConfig
```
public AtmosConfig(java.lang.String tokenId,
                   java.lang.String secretKey,
                   java.net.URI... endpoints)
```
    Creates a new instance with default parameters and the specified tokenId, secretKey and endpoint(s). This is the minimum configuration necessary for an AtmosApi instance. The secretKey here should be base64 encoded.
- Method Detail
  - isEnableExpect100Continue
```
public boolean isEnableExpect100Continue()
```
    Returns whether the Expect: 100-continue header is enabled for object write requests
  - setEnableExpect100Continue
```
public void setEnableExpect100Continue(boolean enableExpect100Continue)
```
    Sets whether the Expect: 100-continue header should be used for object write requests. When enabled, all object create and update requests will post the headers first (including Expect: 100-continue) and wait for a 100 Continue response before sending object data. This will allow Atmos to determine if the request is valid before sending a potentially large payload over the network. Default is true.
  - isEnableRetry
```
public boolean isEnableRetry()
```
    Returns whether 500 errors and IOExceptions should be automatically retried.
  - setEnableRetry
```
public void setEnableRetry(boolean enableRetry)
```
    Sets whether 500 errors and IOExceptions should be automatically retried. When enabled, these requests will be retried up to maxRetries times with a retryDelayMillis ms delay between retry attempts. Default is true.
  - getMaxRetries
```
public int getMaxRetries()
```
    Returns the maximum number of retry attempts before bubbling the exception back to calling code.
  - setMaxRetries
```
public void setMaxRetries(int maxRetries)
```
    Sets the maximum number of retry attempts before bubbling the exception back to calling code. Default is 2 retries.
  - getRetryBufferSize
```
public int getRetryBufferSize()
```
    Returns the buffer size used for non-repeatable object content (input streams) when retry is enabled.
  - setRetryBufferSize
```
public void setRetryBufferSize(int retryBufferSize)
```
    Sets the buffer size used for non-repeatable object content (input streams) when retry is enabled. Once the amount of data transferred surpasses this number, the request can no longer be retried. The implementation may be as simple as calling inputStream.mark( bufferSize ), so input streams that do not support mark might not be retried. Default is 1MB.
  - getRetryDelayMillis
```
public int getRetryDelayMillis()
```
    Returns the delay in milliseconds to wait between retry attempts.
  - setRetryDelayMillis
```
public void setRetryDelayMillis(int retryDelayMillis)
```
    Sets the delay in milliseconds to wait between retry attempts. Default is 0 (no wait).
  - getSecretKey
```
public byte[] getSecretKey()
```
    Returns the secret key as a byte array.
  - setSecretKey
```
public void setSecretKey(byte[] secretKey)
```
    Sets the secret key as a byte array.
  - setSecretKey
```
public void setSecretKey(java.lang.String secretKey)
```
    Set the secret key from a base64 encoded string (this is the format typically provided to users)
  - getServerClockSkew
```
public long getServerClockSkew()
```
    Returns the estimated clock skew between the local machine and the Atmos cloud (if set).
  - setServerClockSkew
```
public void setServerClockSkew(long serverClockSkew)
```
    Sets the estimated clock skew between the local machine and the Atmos cloud. This number can be calculated by calling AtmosApi.calculateServerClockSkew(). Implementations should set this automatically on their local config instances when this method is called.
  - getTokenId
```
public java.lang.String getTokenId()
```
    Returns the full Atmos token ID
  - setTokenId
```
public void setTokenId(java.lang.String tokenId)
```
    Sets the full Atmos token ID
  - getProxyUri
```
public java.net.URI getProxyUri()
```
    Returns the HTTP proxy used for communication to Atmos
  - setProxyUri
```
public void setProxyUri(java.net.URI proxyUri)
```
    Sets the HTTP proxy used for communication to Atmos
  - getProxyUser
```
public java.lang.String getProxyUser()
```
    Gets the username to use for the HTTP proxy
  - setProxyUser
```
public void setProxyUser(java.lang.String proxyUser)
```
    Sets the username to use for the HTTP proxy
  - getProxyPassword
```
public java.lang.String getProxyPassword()
```
    Gets the password to use for the HTTP proxy
  - setProxyPassword
```
public void setProxyPassword(java.lang.String proxyPassword)
```
    Sets the password to use for the HTTP proxy
  - isEncodeUtf8
```
public boolean isEncodeUtf8()
```
    Gets whether UTF-8 encoding is enabled
  - setEncodeUtf8
```
public void setEncodeUtf8(boolean encodeUtf8)
```
    Sets whether to encode metadata and keys using HTTP UTF-8 escape sequences to allow extended character use. Default is true.

Class AtmosConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.emc.atmos.AbstractConfig

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_CONTEXT

Constructor Detail

AtmosConfig

AtmosConfig

Method Detail

isEnableExpect100Continue

setEnableExpect100Continue

isEnableRetry

setEnableRetry

getMaxRetries

setMaxRetries

getRetryBufferSize

setRetryBufferSize

getRetryDelayMillis

setRetryDelayMillis

getSecretKey

setSecretKey

setSecretKey

getServerClockSkew

setServerClockSkew

getTokenId

setTokenId

getProxyUri

setProxyUri

getProxyUser

setProxyUser

getProxyPassword

setProxyPassword

isEncodeUtf8

setEncodeUtf8