Package com.akamai.edgegrid.signer

Class ClientCredential

java.lang.Object

com.akamai.edgegrid.signer.ClientCredential

All Implemented Interfaces:

Comparable<ClientCredential>

public class ClientCredential
extends Object
implements Comparable<ClientCredential>

This is a representation of client credential used to sign an EdgeGrid request. This object is immutable, so you probably want to build an instance using ClientCredential.ClientCredentialBuilder or one of the static methods that reads from an EdgeRc file.

Author:

[email protected], [email protected]

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ClientCredential.ClientCredentialBuilder	Defines ClientCredential.ClientCredentialBuilder which is used to build instance of ClientCredential.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_MAX_BODY_SIZE_IN_BYTES	This is the default maxBodySize to apply if not explicitly set in a credential.

Method Summary

Modifier and Type	Method	Description
static ClientCredential.ClientCredentialBuilder	builder()	Returns a new builder.
int	compareTo(ClientCredential that)
boolean	equals(Object o)
String	getAccessToken()	Retrieves access token.
String	getClientSecret()	Retrieves client secret.
String	getClientToken()	Retrieves client token.
Set<String>	getHeadersToSign()	Retrieves set of headers for signing.
String	getHost()	Retrieves host.
int	getMaxBodySize()	Defines maximum body size defined in bytes.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

DEFAULT_MAX_BODY_SIZE_IN_BYTES

public static final int DEFAULT_MAX_BODY_SIZE_IN_BYTES

This is the default maxBodySize to apply if not explicitly set in a credential.

See Also:

• Constant Field Values

Method Details

builder

public static ClientCredential.ClientCredentialBuilder builder()

Returns a new builder. The returned builder is equivalent to the builder generated by ClientCredential.ClientCredentialBuilder.

Returns:

a fresh ClientCredential.ClientCredentialBuilder

compareTo

public int compareTo(ClientCredential that)

Specified by:

compareTo in interface Comparable<ClientCredential>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

getAccessToken

public String getAccessToken()

Retrieves access token.

Returns:

accessToken

getClientSecret

public String getClientSecret()

Retrieves client secret.

Returns:

clientSecret

getClientToken

public String getClientToken()

Retrieves client token.

Returns:

clientToken

getHeadersToSign

public Set<String> getHeadersToSign()

Retrieves set of headers for signing.

Returns:

headersToSign

getHost

public String getHost()

Retrieves host.

Returns:

host

getMaxBodySize

public int getMaxBodySize()

Defines maximum body size defined in bytes.

Returns:

maxBodySize

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object