com.emc.atmos.api

Class RestUtil

java.lang.Object

com.emc.atmos.api.RestUtil

public final class RestUtil
extends java.lang.Object

See Also:

HttpUtil

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	METADATA_KEY_EXPIRATION_ENABLE
static java.lang.String	METADATA_KEY_EXPIRATION_END
static java.lang.String	METADATA_KEY_RETENTION_ENABLE
static java.lang.String	METADATA_KEY_RETENTION_END
static java.lang.String	PROP_ENABLE_EXPECT_100_CONTINUE
static java.lang.String	TYPE_APPLICATION_OCTET_STREAM
static java.lang.String	TYPE_DEFAULT
static java.lang.String	TYPE_MULTIPART
static java.lang.String	TYPE_MULTIPART_BYTE_RANGES
static java.lang.String	TYPE_PARAM_BOUNDARY
static java.lang.String	XHEADER_CONTENT_CHECKSUM
static java.lang.String	XHEADER_DATE
static java.lang.String	XHEADER_EXPIRES
static java.lang.String	XHEADER_FEATURES
static java.lang.String	XHEADER_FORCE
static java.lang.String	XHEADER_GENERATE_CHECKSUM
static java.lang.String	XHEADER_GROUP_ACL
static java.lang.String	XHEADER_INCLUDE_META
static java.lang.String	XHEADER_LIMIT
static java.lang.String	XHEADER_LISTABLE_META
static java.lang.String	XHEADER_LISTABLE_TAGS
static java.lang.String	XHEADER_META
static java.lang.String	XHEADER_OBJECT_ID
static java.lang.String	XHEADER_OBJECT_VPOOL
static java.lang.String	XHEADER_OBJECTID
static java.lang.String	XHEADER_PATH
static java.lang.String	XHEADER_POOL
static java.lang.String	XHEADER_RETENTION_PERIOD
static java.lang.String	XHEADER_RETENTION_POLICY
static java.lang.String	XHEADER_SIGNATURE
static java.lang.String	XHEADER_SUBTENANT_ID
static java.lang.String	XHEADER_SUPPORT_UTF8
static java.lang.String	XHEADER_SYSTEM_TAGS
static java.lang.String	XHEADER_TAGS
static java.lang.String	XHEADER_TOKEN
static java.lang.String	XHEADER_UID
static java.lang.String	XHEADER_USER_ACL
static java.lang.String	XHEADER_USER_TAGS
static java.lang.String	XHEADER_UTF8
static java.lang.String	XHEADER_VERSION_OID
static java.lang.String	XHEADER_WSCHECKSUM

Method Summary

Modifier and Type	Method and Description
static void	addValue(java.util.Map<java.lang.String,java.util.List<java.lang.Object>> multiValueMap, java.lang.String key, java.lang.Object value) Initializes new keys with an empty ArrayList.
static java.lang.String	join(java.lang.Iterable<?> list, java.lang.String delimiter)
static java.lang.String	lastPathElement(java.lang.String path)
static java.lang.String	normalizeSpace(java.lang.String str)
static java.util.Map<java.lang.String,Permission>	parseAclHeader(java.lang.String headerValue)
static java.util.Map<java.lang.String,Metadata>	parseMetadataHeader(java.lang.String headerValue, boolean listable, boolean decodeUtf8)
static ObjectId	parseObjectId(java.lang.String path)
static java.lang.String	sign(java.lang.String string, byte[] hashKey)
static void	signRequest(java.lang.String method, java.lang.String path, java.lang.String query, java.util.Map<java.lang.String,java.util.List<java.lang.Object>> headers, java.lang.String uid, byte[] hashKey, long serverClockSkew) Generates the HMAC-SHA1 signature used to authenticate the request using the Java security APIs, then adds the uid and signature to the headers.

Methods inherited from class java.lang.Object

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

Field Detail

XHEADER_CONTENT_CHECKSUM

public static final java.lang.String XHEADER_CONTENT_CHECKSUM

See Also:

Constant Field Values

XHEADER_DATE

public static final java.lang.String XHEADER_DATE

See Also:

Constant Field Values

XHEADER_EXPIRES

public static final java.lang.String XHEADER_EXPIRES

See Also:

Constant Field Values

XHEADER_FEATURES

public static final java.lang.String XHEADER_FEATURES

See Also:

Constant Field Values

XHEADER_FORCE

public static final java.lang.String XHEADER_FORCE

See Also:

Constant Field Values

XHEADER_GENERATE_CHECKSUM

public static final java.lang.String XHEADER_GENERATE_CHECKSUM

See Also:

Constant Field Values

XHEADER_GROUP_ACL

public static final java.lang.String XHEADER_GROUP_ACL

See Also:

Constant Field Values

XHEADER_INCLUDE_META

public static final java.lang.String XHEADER_INCLUDE_META

See Also:

Constant Field Values

XHEADER_LIMIT

public static final java.lang.String XHEADER_LIMIT

See Also:

Constant Field Values

XHEADER_LISTABLE_META

public static final java.lang.String XHEADER_LISTABLE_META

See Also:

Constant Field Values

XHEADER_LISTABLE_TAGS

public static final java.lang.String XHEADER_LISTABLE_TAGS

See Also:

Constant Field Values

XHEADER_META

public static final java.lang.String XHEADER_META

See Also:

Constant Field Values

XHEADER_OBJECT_ID

public static final java.lang.String XHEADER_OBJECT_ID

See Also:

Constant Field Values

XHEADER_OBJECTID

public static final java.lang.String XHEADER_OBJECTID

See Also:

Constant Field Values

XHEADER_PATH

public static final java.lang.String XHEADER_PATH

See Also:

Constant Field Values

XHEADER_POOL

public static final java.lang.String XHEADER_POOL

See Also:

Constant Field Values

XHEADER_RETENTION_PERIOD

public static final java.lang.String XHEADER_RETENTION_PERIOD

See Also:

Constant Field Values

XHEADER_RETENTION_POLICY

public static final java.lang.String XHEADER_RETENTION_POLICY

See Also:

Constant Field Values

XHEADER_SIGNATURE

public static final java.lang.String XHEADER_SIGNATURE

See Also:

Constant Field Values

XHEADER_SUBTENANT_ID

public static final java.lang.String XHEADER_SUBTENANT_ID

See Also:

Constant Field Values

XHEADER_SUPPORT_UTF8

public static final java.lang.String XHEADER_SUPPORT_UTF8

See Also:

Constant Field Values

XHEADER_SYSTEM_TAGS

public static final java.lang.String XHEADER_SYSTEM_TAGS

See Also:

Constant Field Values

XHEADER_TAGS

public static final java.lang.String XHEADER_TAGS

See Also:

Constant Field Values

XHEADER_TOKEN

public static final java.lang.String XHEADER_TOKEN

See Also:

Constant Field Values

XHEADER_UID

public static final java.lang.String XHEADER_UID

See Also:

Constant Field Values

XHEADER_USER_ACL

public static final java.lang.String XHEADER_USER_ACL

See Also:

Constant Field Values

XHEADER_USER_TAGS

public static final java.lang.String XHEADER_USER_TAGS

See Also:

Constant Field Values

XHEADER_UTF8

public static final java.lang.String XHEADER_UTF8

See Also:

Constant Field Values

XHEADER_VERSION_OID

public static final java.lang.String XHEADER_VERSION_OID

See Also:

Constant Field Values

XHEADER_WSCHECKSUM

public static final java.lang.String XHEADER_WSCHECKSUM

See Also:

Constant Field Values

XHEADER_OBJECT_VPOOL

public static final java.lang.String XHEADER_OBJECT_VPOOL

See Also:

Constant Field Values

METADATA_KEY_EXPIRATION_ENABLE

public static final java.lang.String METADATA_KEY_EXPIRATION_ENABLE

See Also:

Constant Field Values

METADATA_KEY_EXPIRATION_END

public static final java.lang.String METADATA_KEY_EXPIRATION_END

See Also:

Constant Field Values

METADATA_KEY_RETENTION_ENABLE

public static final java.lang.String METADATA_KEY_RETENTION_ENABLE

See Also:

Constant Field Values

METADATA_KEY_RETENTION_END

public static final java.lang.String METADATA_KEY_RETENTION_END

See Also:

Constant Field Values

TYPE_MULTIPART

public static final java.lang.String TYPE_MULTIPART

See Also:

Constant Field Values

TYPE_MULTIPART_BYTE_RANGES

public static final java.lang.String TYPE_MULTIPART_BYTE_RANGES

See Also:

Constant Field Values

TYPE_APPLICATION_OCTET_STREAM

public static final java.lang.String TYPE_APPLICATION_OCTET_STREAM

See Also:

Constant Field Values

TYPE_DEFAULT

public static final java.lang.String TYPE_DEFAULT

See Also:

Constant Field Values

TYPE_PARAM_BOUNDARY

public static final java.lang.String TYPE_PARAM_BOUNDARY

See Also:

Constant Field Values

PROP_ENABLE_EXPECT_100_CONTINUE

public static final java.lang.String PROP_ENABLE_EXPECT_100_CONTINUE

See Also:

Constant Field Values

Method Detail

sign

public static java.lang.String sign(java.lang.String string,
                                    byte[] hashKey)

signRequest

public static void signRequest(java.lang.String method,
                               java.lang.String path,
                               java.lang.String query,
                               java.util.Map<java.lang.String,java.util.List<java.lang.Object>> headers,
                               java.lang.String uid,
                               byte[] hashKey,
                               long serverClockSkew)

Generates the HMAC-SHA1 signature used to authenticate the request using the Java security APIs, then adds the uid and signature to the headers.

Parameters:

method - the HTTP method used

path - the resource path including any querystring

headers - the HTTP headers for the request

hashKey - the secret key to use when signing

normalizeSpace

public static java.lang.String normalizeSpace(java.lang.String str)

join

public static java.lang.String join(java.lang.Iterable<?> list,
                                    java.lang.String delimiter)

addValue

public static void addValue(java.util.Map<java.lang.String,java.util.List<java.lang.Object>> multiValueMap,
                            java.lang.String key,
                            java.lang.Object value)

Initializes new keys with an empty ArrayList. Convenience method for generating a header map.

lastPathElement

public static java.lang.String lastPathElement(java.lang.String path)

parseObjectId

public static ObjectId parseObjectId(java.lang.String path)

parseMetadataHeader

public static java.util.Map<java.lang.String,Metadata> parseMetadataHeader(java.lang.String headerValue,
                                                                           boolean listable,
                                                                           boolean decodeUtf8)

parseAclHeader

public static java.util.Map<java.lang.String,Permission> parseAclHeader(java.lang.String headerValue)