Index (Akamai NetStorageKit 3.6.6 API)

A B C D E G H K M N P Q R S U V

A

APIEventBean - Class in com.akamai.netstorage: The APIEvent bean holds the necessary paramters for execution of the various invocation actions
APIEventBean() - Constructor for class com.akamai.netstorage.APIEventBean
asQueryParams() - Method in class com.akamai.netstorage.APIEventBean

B

BooleanValueFormatter - Class in com.akamai.netstorage.parameter: Boolean Value Formatter which represents boolean values as either 1 or null.
BooleanValueFormatter() - Constructor for class com.akamai.netstorage.parameter.BooleanValueFormatter
ByteArrayValueFormatter - Class in com.akamai.netstorage.parameter: ByteArray Value Formatter which hex encodes a bytearray
ByteArrayValueFormatter() - Constructor for class com.akamai.netstorage.parameter.ByteArrayValueFormatter

C

ClientCredential - Interface in com.akamai.auth: Interface representing the client credential that is used in service requests.
CMS - Class in com.akamai.netstorage.cli: Command Line sample application to demonstrate the utilization of the NetstorageKit.
CMS() - Constructor for class com.akamai.netstorage.cli.CMS
com.akamai.auth - package com.akamai.auth
com.akamai.netstorage - package com.akamai.netstorage
com.akamai.netstorage.cli - package com.akamai.netstorage.cli
com.akamai.netstorage.parameter - package com.akamai.netstorage.parameter
computeHash(InputStream, Utils.HashAlgorithm) - Static method in class com.akamai.netstorage.Utils: Computes the hash of a given InputStream.
computeHeaders(ClientCredential) - Method in class com.akamai.netstorage.NetStorageCMSv35Signer: Assmembles the HTTP Headers necessary for API communication
computeKeyedHash(byte[], String, Utils.KeyedHashAlgorithm) - Static method in class com.akamai.netstorage.Utils: Computes the HMAC hash of a given byte[].
convertMapAsQueryParams(Map<String, String>) - Static method in class com.akamai.netstorage.Utils: Convert Map<String, String> into a name=value query params string.
convertObjectAsMap(Object) - Static method in class com.akamai.netstorage.Utils: Convert a POJO object into a primitive name-value pair or Map<String, String>.

D

DateValueFormatter - Class in com.akamai.netstorage.parameter: Date Value Formatter which represents dates in epoch seconds
DateValueFormatter() - Constructor for class com.akamai.netstorage.parameter.DateValueFormatter
DefaultCredential - Class in com.akamai.netstorage: Default implementation of the ClientCredential.
DefaultCredential(String, String, String) - Constructor for class com.akamai.netstorage.DefaultCredential: Default constructor
DefaultValueFormatter - Class in com.akamai.netstorage.parameter: Default Value Formatter which uses the .toString() to derive default object formatting
DefaultValueFormatter() - Constructor for class com.akamai.netstorage.parameter.DefaultValueFormatter
delete(String) - Method in class com.akamai.netstorage.NetStorage
dir(String) - Method in class com.akamai.netstorage.NetStorage
dir(String, String) - Method in class com.akamai.netstorage.NetStorage
dir(String, String, Map<String, String>) - Method in class com.akamai.netstorage.NetStorage
download(String) - Method in class com.akamai.netstorage.NetStorage
du(String) - Method in class com.akamai.netstorage.NetStorage
du(String, String) - Method in class com.akamai.netstorage.NetStorage

E

encodeBase64(byte[]) - Static method in class com.akamai.netstorage.Utils: Base64-encode a byte array.
encodeHex(byte[]) - Static method in class com.akamai.netstorage.Utils: Hex encoding wrapper for a byte array.
execute(HttpURLConnection, ClientCredential) - Method in interface com.akamai.auth.RequestSigner
execute(ClientCredential) - Method in interface com.akamai.auth.RequestSigner
execute(String, String, String, String, String, String, String, String, boolean) - Static method in class com.akamai.netstorage.cli.CMS
execute(String, String, APIEventBean, InputStream, Long) - Method in class com.akamai.netstorage.NetStorage
execute(String, String, APIEventBean) - Method in class com.akamai.netstorage.NetStorage
execute(HttpURLConnection, ClientCredential) - Method in class com.akamai.netstorage.NetStorageCMSv35Signer: Opens the connection to Netstorage, assembles the signing headers and uploads any files.
execute(ClientCredential) - Method in class com.akamai.netstorage.NetStorageCMSv35Signer

G

getAction() - Method in class com.akamai.netstorage.APIEventBean
getActionHeaderValue() - Method in class com.akamai.netstorage.NetStorageCMSv35Signer: Computes the value for the the X-Akamai-ACS-Action: header.
getAdditionalParams() - Method in class com.akamai.netstorage.APIEventBean
getAlgorithm() - Method in enum com.akamai.netstorage.NetStorageCMSv35Signer.SignType
getAlgorithm() - Method in enum com.akamai.netstorage.Utils.HashAlgorithm
getAlgorithm() - Method in enum com.akamai.netstorage.Utils.KeyedHashAlgorithm
getAuthDataHeaderValue(ClientCredential) - Method in class com.akamai.netstorage.NetStorageCMSv35Signer: Constructs the X-Akamai-ACS-Auth-Data header which contains the signing version, the current time, a random number and the username that is used to sign the data.
getAuthSignHeaderValue(String, String, ClientCredential) - Method in class com.akamai.netstorage.NetStorageCMSv35Signer: Computes the X-Akamai-ACS-Auth-Sign header for a given Action and Data header values.
getDestination() - Method in class com.akamai.netstorage.APIEventBean
getFormat() - Method in class com.akamai.netstorage.APIEventBean
getHostname() - Method in class com.akamai.netstorage.DefaultCredential: Gets the client hostname.
getIndexZip() - Method in class com.akamai.netstorage.APIEventBean
getKey() - Method in interface com.akamai.auth.ClientCredential: Gets the secret associated with the client token.
getKey() - Method in class com.akamai.netstorage.DefaultCredential: Gets the secret associated with the client token.
getMd5() - Method in class com.akamai.netstorage.APIEventBean
getMethod() - Method in class com.akamai.netstorage.NetStorageCMSv35Signer
getMtime() - Method in class com.akamai.netstorage.APIEventBean
getNetStorageType() - Method in class com.akamai.netstorage.NetStorage
getNetstorageUri(String) - Method in class com.akamai.netstorage.NetStorage
getParams() - Method in class com.akamai.netstorage.NetStorageCMSv35Signer
getQuickDelete() - Method in class com.akamai.netstorage.APIEventBean
getResponseCode() - Method in exception com.akamai.netstorage.NetStorageException
getSha1() - Method in class com.akamai.netstorage.APIEventBean
getSha256() - Method in class com.akamai.netstorage.APIEventBean
getSignVersion() - Method in class com.akamai.netstorage.NetStorageCMSv35Signer
getSize() - Method in class com.akamai.netstorage.APIEventBean
getTarget() - Method in class com.akamai.netstorage.APIEventBean
getUploadSize() - Method in class com.akamai.netstorage.NetStorageCMSv35Signer
getUploadStream() - Method in class com.akamai.netstorage.NetStorageCMSv35Signer
getUrl() - Method in class com.akamai.netstorage.NetStorageCMSv35Signer
getUsername() - Method in interface com.akamai.auth.ClientCredential: Gets the access token.
getUsername() - Method in class com.akamai.netstorage.DefaultCredential: Gets the username .
getValue() - Method in enum com.akamai.netstorage.NetStorageCMSv35Signer.SignType
getVersion() - Method in class com.akamai.netstorage.APIEventBean

H

HOSTNAME_PROPERTY - Static variable in class com.akamai.netstorage.DefaultCredential

K

KEY_PROPERTY - Static variable in class com.akamai.netstorage.DefaultCredential

M

main(String[]) - Static method in class com.akamai.netstorage.cli.CMS: Implement the command-line client.
mkdir(String) - Method in class com.akamai.netstorage.NetStorage
mtime(String) - Method in class com.akamai.netstorage.NetStorage
mtime(String, Date) - Method in class com.akamai.netstorage.NetStorage

N

NetStorage - Class in com.akamai.netstorage: The Netstorage class is the preferred interface for calling libraries indending to leverage the Netstorage API.
NetStorage(DefaultCredential) - Constructor for class com.akamai.netstorage.NetStorage
NetStorageCMSv35Signer - Class in com.akamai.netstorage: The NetStorageCMSv35Signer is responsible for brokering the communication between the software layer and the API.
NetStorageCMSv35Signer(String, URL, APIEventBean) - Constructor for class com.akamai.netstorage.NetStorageCMSv35Signer: Primary invocation for an API communication.
NetStorageCMSv35Signer(String, URL, APIEventBean, InputStream, long) - Constructor for class com.akamai.netstorage.NetStorageCMSv35Signer: Primary invocation for an API communication.
NetStorageCMSv35Signer.NetStorageType - Enum in com.akamai.netstorage: There are multiple types of Net Storage.
NetStorageCMSv35Signer.SignType - Enum in com.akamai.netstorage: Currently only 3 signing hash types are supported.
NetStorageException - Exception in com.akamai.netstorage: Netstorage Exceptions are intended to differentiate between IO (Networking and File) exceptions
NetStorageException(String) - Constructor for exception com.akamai.netstorage.NetStorageException
NetStorageException(Throwable) - Constructor for exception com.akamai.netstorage.NetStorageException
NetStorageException(String, int) - Constructor for exception com.akamai.netstorage.NetStorageException
NetStorageException(String, Throwable) - Constructor for exception com.akamai.netstorage.NetStorageException

P

Parameter - Annotation Type in com.akamai.netstorage.parameter: Paramter Annotation used to self declare the appropriate formatter necessary for API serialization
ParameterValueFormatter - Interface in com.akamai.netstorage.parameter: Interface for ParameterValueFormatter

Q

quickDelete(String) - Method in class com.akamai.netstorage.NetStorage

R

readIniSection(File, String) - Static method in class com.akamai.netstorage.Utils: Convenience method to read Properties in Ini format
readIniSection(InputStream, String) - Static method in class com.akamai.netstorage.Utils: Convenience method to read Properties in Ini format
readToEnd(InputStream) - Static method in class com.akamai.netstorage.Utils: Simple utility to read to the end of a stream when you don't particularly care for the contents of the stream.
rename(String, String) - Method in class com.akamai.netstorage.NetStorage
RequestSigner - Interface in com.akamai.auth: Interface describing a request signer that signs service requests.
RequestSigningException - Exception in com.akamai.auth: Exception representing errors during request signing.
RequestSigningException(String) - Constructor for exception com.akamai.auth.RequestSigningException
RequestSigningException(Throwable) - Constructor for exception com.akamai.auth.RequestSigningException
RequestSigningException(String, Throwable) - Constructor for exception com.akamai.auth.RequestSigningException
rmdir(String) - Method in class com.akamai.netstorage.NetStorage

S

setAction(String) - Method in class com.akamai.netstorage.APIEventBean
setAdditionalParams(Map<String, String>) - Method in class com.akamai.netstorage.APIEventBean
setDestination(String) - Method in class com.akamai.netstorage.APIEventBean
setFormat(String) - Method in class com.akamai.netstorage.APIEventBean
setIndexZip(Boolean) - Method in class com.akamai.netstorage.APIEventBean
setmd(String, Map<String, String>) - Method in class com.akamai.netstorage.NetStorage
setMd5(byte[]) - Method in class com.akamai.netstorage.APIEventBean
setMethod(String) - Method in class com.akamai.netstorage.NetStorageCMSv35Signer
setMtime(Date) - Method in class com.akamai.netstorage.APIEventBean
setParams(APIEventBean) - Method in class com.akamai.netstorage.NetStorageCMSv35Signer
setQuickDelete() - Method in class com.akamai.netstorage.APIEventBean
setSha1(byte[]) - Method in class com.akamai.netstorage.APIEventBean
setSha256(byte[]) - Method in class com.akamai.netstorage.APIEventBean
setSignVersion(NetStorageCMSv35Signer.SignType) - Method in class com.akamai.netstorage.NetStorageCMSv35Signer
setSize(Long) - Method in class com.akamai.netstorage.APIEventBean
setTarget(String) - Method in class com.akamai.netstorage.APIEventBean
setUploadSize(long) - Method in class com.akamai.netstorage.NetStorageCMSv35Signer
setUploadStream(InputStream) - Method in class com.akamai.netstorage.NetStorageCMSv35Signer
setUrl(URL) - Method in class com.akamai.netstorage.NetStorageCMSv35Signer
sign(HttpURLConnection, ClientCredential) - Method in interface com.akamai.auth.RequestSigner: Signs a request with the client credential.
sign(HttpURLConnection, ClientCredential) - Method in class com.akamai.netstorage.NetStorageCMSv35Signer
stat(String) - Method in class com.akamai.netstorage.NetStorage
stat(String, String) - Method in class com.akamai.netstorage.NetStorage
symlink(String, String) - Method in class com.akamai.netstorage.NetStorage

U

upload(String, InputStream) - Method in class com.akamai.netstorage.NetStorage
upload(String, InputStream, Date, Long, byte[], byte[], byte[], boolean) - Method in class com.akamai.netstorage.NetStorage
upload(String, InputStream, Map<String, String>, Date, Long, byte[], byte[], byte[], boolean) - Method in class com.akamai.netstorage.NetStorage
upload(String, File) - Method in class com.akamai.netstorage.NetStorage
upload(String, File, Map<String, String>) - Method in class com.akamai.netstorage.NetStorage
upload(String, File, boolean) - Method in class com.akamai.netstorage.NetStorage
upload(String, File, Map<String, String>, boolean) - Method in class com.akamai.netstorage.NetStorage
USERNAME_PROPERTY - Static variable in class com.akamai.netstorage.DefaultCredential
Utils - Class in com.akamai.netstorage: General utility functions needed to implement the HTTP SDK.
Utils() - Constructor for class com.akamai.netstorage.Utils
Utils.HashAlgorithm - Enum in com.akamai.netstorage: An enum of the hash algorithms supported by Utils.computeHash(java.io.InputStream, com.akamai.netstorage.Utils.HashAlgorithm) Currently supported hashes include MD5; SHA1; SHA256 The string representation matches the java MessageDigest.getInstance(String) canonical names.
Utils.KeyedHashAlgorithm - Enum in com.akamai.netstorage: An enum of the keyed-hash algorithms supported by Utils.computeKeyedHash(byte[], String, com.akamai.netstorage.Utils.KeyedHashAlgorithm) Currently supported hashes include HMAC-MD5; HMAC-SHA1; HMAC-SHA256 The string representation matches the java Mac.getInstance(String)} cononical names.

V

validate(HttpURLConnection) - Method in class com.akamai.netstorage.NetStorageCMSv35Signer: Attempt to validate the response and detect common causes of errors.
valueOf(String) - Static method in enum com.akamai.netstorage.NetStorageCMSv35Signer.NetStorageType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.akamai.netstorage.NetStorageCMSv35Signer.SignType: Returns the enum constant of this type with the specified name.
valueOf(Object) - Method in class com.akamai.netstorage.parameter.BooleanValueFormatter
valueOf(Object) - Method in class com.akamai.netstorage.parameter.ByteArrayValueFormatter
valueOf(Object) - Method in class com.akamai.netstorage.parameter.DateValueFormatter
valueOf(Object) - Method in class com.akamai.netstorage.parameter.DefaultValueFormatter
valueOf(Object) - Method in interface com.akamai.netstorage.parameter.ParameterValueFormatter
valueOf(String) - Static method in enum com.akamai.netstorage.Utils.HashAlgorithm: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.akamai.netstorage.Utils.KeyedHashAlgorithm: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.akamai.netstorage.NetStorageCMSv35Signer.NetStorageType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.akamai.netstorage.NetStorageCMSv35Signer.SignType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.akamai.netstorage.Utils.HashAlgorithm: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.akamai.netstorage.Utils.KeyedHashAlgorithm: Returns an array containing the constants of this enum type, in the order they are declared.
VERSION - Static variable in class com.akamai.netstorage.APIEventBean

A B C D E G H K M N P Q R S U V