Index

A B C D E G H M N R S T U
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AbstractEdgeGridRequestSigner<RequestT,MutableRequestT> - Class in com.akamai.edgegrid.signer

This is an abstract base class for implementing EdgeGrid request signing in a library-specific way.

AbstractEdgeGridRequestSigner(ClientCredential) - Constructor for class com.akamai.edgegrid.signer.AbstractEdgeGridRequestSigner

Creates an EdgeGrid request signer that will always sign requests with the same ClientCredential.

AbstractEdgeGridRequestSigner(ClientCredentialProvider) - Constructor for class com.akamai.edgegrid.signer.AbstractEdgeGridRequestSigner

Creates an EdgeGrid request signer selecting a ClientCredential via ClientCredentialProvider.getClientCredential(Request) for each request.

accessToken(String) - Method in class com.akamai.edgegrid.signer.ClientCredential.ClientCredentialBuilder

Sets an access token representing authorizations a client has for OPEN API service.

B

body(byte[]) - Method in class com.akamai.edgegrid.signer.Request.RequestBuilder

Sets a content of HTTP request body.

build() - Method in class com.akamai.edgegrid.signer.ClientCredential.ClientCredentialBuilder

Returns a newly-created immutable client credential.

build() - Method in class com.akamai.edgegrid.signer.Request.RequestBuilder

Returns a newly-created immutable HTTP request.

builder() - Static method in class com.akamai.edgegrid.signer.ClientCredential

Returns a new builder.

builder() - Static method in class com.akamai.edgegrid.signer.Request

Returns a new builder.

C

ClientCredential - Class in com.akamai.edgegrid.signer

This is a representation of client credential used to sign an EdgeGrid request.

ClientCredential.ClientCredentialBuilder - Class in com.akamai.edgegrid.signer

Defines ClientCredential.ClientCredentialBuilder which is used to build instance of ClientCredential.

ClientCredentialBuilder() - Constructor for class com.akamai.edgegrid.signer.ClientCredential.ClientCredentialBuilder

Creates a new builder.

ClientCredentialProvider - Interface in com.akamai.edgegrid.signer

This interface provides a mechanism to select a ClientCredential.

clientSecret(String) - Method in class com.akamai.edgegrid.signer.ClientCredential.ClientCredentialBuilder

Sets a secret associated with a client token.

clientToken(String) - Method in class com.akamai.edgegrid.signer.ClientCredential.ClientCredentialBuilder

Sets a token representing an OPEN API service client.

com.akamai.edgegrid.signer - package com.akamai.edgegrid.signer

com.akamai.edgegrid.signer.exceptions - package com.akamai.edgegrid.signer.exceptions

compare(T, T) - Method in class com.akamai.edgegrid.signer.NullSafeComparator

compareTo(ClientCredential) - Method in class com.akamai.edgegrid.signer.ClientCredential

compareTo(Request) - Method in class com.akamai.edgegrid.signer.Request

D

DEFAULT_MAX_BODY_SIZE_IN_BYTES - Static variable in class com.akamai.edgegrid.signer.ClientCredential

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

DefaultClientCredentialProvider - Class in com.akamai.edgegrid.signer

This is a basic implementation of ClientCredentialProvider that returns the same ClientCredential for every request.

DefaultClientCredentialProvider(ClientCredential) - Constructor for class com.akamai.edgegrid.signer.DefaultClientCredentialProvider

Creates a DefaultClientCredentialProvider using ClientCredential.

E

EdgeGridV1Signer - Class in com.akamai.edgegrid.signer

This class implements the EdgeGrid Request Signature algorithm described by API Client Authentication.

EdgeGridV1Signer() - Constructor for class com.akamai.edgegrid.signer.EdgeGridV1Signer

Creates signer with default configuration.

equals(Object) - Method in class com.akamai.edgegrid.signer.ClientCredential

equals(Object) - Method in class com.akamai.edgegrid.signer.Request

G

getAccessToken() - Method in class com.akamai.edgegrid.signer.ClientCredential

Retrieves access token.

getClientCredential(Request) - Method in interface com.akamai.edgegrid.signer.ClientCredentialProvider

Gets a ClientCredential that is appropriate for signing request.

getClientCredential(Request) - Method in class com.akamai.edgegrid.signer.DefaultClientCredentialProvider

getClientCredentialProvider() - Method in class com.akamai.edgegrid.signer.AbstractEdgeGridRequestSigner

Retrieves ClientCredentialProvider.

getClientSecret() - Method in class com.akamai.edgegrid.signer.ClientCredential

Retrieves client secret.

getClientToken() - Method in class com.akamai.edgegrid.signer.ClientCredential

Retrieves client token.

getHeadersToSign() - Method in class com.akamai.edgegrid.signer.ClientCredential

Retrieves set of headers for signing.

getHost() - Method in class com.akamai.edgegrid.signer.ClientCredential

Retrieves host.

getMaxBodySize() - Method in class com.akamai.edgegrid.signer.ClientCredential

Defines maximum body size defined in bytes.

getSignature(Request, ClientCredential) - Method in class com.akamai.edgegrid.signer.EdgeGridV1Signer

Generates signature for a given HTTP request and client credential.

H

hashCode() - Method in class com.akamai.edgegrid.signer.ClientCredential

hashCode() - Method in class com.akamai.edgegrid.signer.Request

header(String, String) - Method in class com.akamai.edgegrid.signer.Request.RequestBuilder

Adds a single header for an HTTP request.

headers(Map<String, String>) - Method in class com.akamai.edgegrid.signer.Request.RequestBuilder

Sets headers of HTTP request.

headersToSign(Set<String>) - Method in class com.akamai.edgegrid.signer.ClientCredential.ClientCredentialBuilder

Adds all of headersToSign into the builder's internal collection.

headerToSign(String) - Method in class com.akamai.edgegrid.signer.ClientCredential.ClientCredentialBuilder

Adds headerName into the builder's internal collection.

host(String) - Method in class com.akamai.edgegrid.signer.ClientCredential.ClientCredentialBuilder

Sets a hostname to be used when making OPEN API requests with this credential.

M

map(RequestT) - Method in class com.akamai.edgegrid.signer.AbstractEdgeGridRequestSigner

Maps HTTP client-specific request to client-agnostic model of this request.

maxBodySize(int) - Method in class com.akamai.edgegrid.signer.ClientCredential.ClientCredentialBuilder

Sets the maximum body size that will be used for producing request signatures.

method(String) - Method in class com.akamai.edgegrid.signer.Request.RequestBuilder

Sets HTTP method: GET, PUT, POST, DELETE.

N

NoMatchingCredentialException - Exception Class in com.akamai.edgegrid.signer.exceptions

Exception representing failure to obtain a ClientCredential in order to sign a request.

NoMatchingCredentialException() - Constructor for exception class com.akamai.edgegrid.signer.exceptions.NoMatchingCredentialException

Creates a NoMatchingCredentialException with default message.

NoMatchingCredentialException(Exception) - Constructor for exception class com.akamai.edgegrid.signer.exceptions.NoMatchingCredentialException

Creates a NoMatchingCredentialException using Exception.

NullSafeComparator<T extends Comparable<T>> - Class in com.akamai.edgegrid.signer

This is a null-safe Comparator implementation to make the classes Comparable implementation simpler.

NullSafeComparator() - Constructor for class com.akamai.edgegrid.signer.NullSafeComparator

R

Request - Class in com.akamai.edgegrid.signer

Library-agnostic representation of an HTTP request.

Request.RequestBuilder - Class in com.akamai.edgegrid.signer

Creates an instance of Request.builder().

RequestBuilder() - Constructor for class com.akamai.edgegrid.signer.Request.RequestBuilder

RequestSigningException - Exception Class in com.akamai.edgegrid.signer.exceptions

Exception representing errors during request signing.

RequestSigningException() - Constructor for exception class com.akamai.edgegrid.signer.exceptions.RequestSigningException

Creates a default RequestSigningException .

RequestSigningException(String) - Constructor for exception class com.akamai.edgegrid.signer.exceptions.RequestSigningException

Creates a RequestSigningException using message.

RequestSigningException(String, Throwable) - Constructor for exception class com.akamai.edgegrid.signer.exceptions.RequestSigningException

Creates a RequestSigningException using Throwable and message.

RequestSigningException(Throwable) - Constructor for exception class com.akamai.edgegrid.signer.exceptions.RequestSigningException

Creates a RequestSigningException using Throwable.

requestUri(RequestT) - Method in class com.akamai.edgegrid.signer.AbstractEdgeGridRequestSigner

Returns Request-URI of an original request.

S

setAuthorization(MutableRequestT, String) - Method in class com.akamai.edgegrid.signer.AbstractEdgeGridRequestSigner

Updates a given HTTP request by adding Authorization header with a value containing request signature.

setHost(MutableRequestT, String, URI) - Method in class com.akamai.edgegrid.signer.AbstractEdgeGridRequestSigner

Updates a given HTTP request by replacing the request hostname with host instead.

sign(RequestT, MutableRequestT) - Method in class com.akamai.edgegrid.signer.AbstractEdgeGridRequestSigner

Signs request with appropriate credentials using EdgeGrid signer algorithm and replaces request's host name with the one specified by the credential.

T

toString() - Method in class com.akamai.edgegrid.signer.ClientCredential

toString() - Method in class com.akamai.edgegrid.signer.Request

U

uri(String) - Method in class com.akamai.edgegrid.signer.Request.RequestBuilder

Sets the URI of the HTTP request.

uri(URI) - Method in class com.akamai.edgegrid.signer.Request.RequestBuilder

Sets the URI of the HTTP request.

A B C D E G H M N R S T U
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form