com.akamai.edgegrid.signer

Interface ClientCredentialProvider

All Known Implementing Classes:

DefaultClientCredentialProvider, EdgeRcClientCredentialProvider

public interface ClientCredentialProvider

This interface provides a mechanism to select a ClientCredential. Implementations of AbstractEdgeGridRequestSigner will call getClientCredential(Request) during the request signing phase to select the ClientCredential to be used.

If you are looking for a basic implementation of this interface, see DefaultClientCredentialProvider. If you would like to read your configuration from an EdgeRc file, see EdgeRcClientCredentialProvider.

Author:

mmeyer@akamai.com

Method Summary

Modifier and Type	Method and Description
ClientCredential	getClientCredential(Request request) Gets a ClientCredential that is appropriate for signing request.

Method Detail

getClientCredential

ClientCredential getClientCredential(Request request)
                              throws NoMatchingCredentialException

Gets a ClientCredential that is appropriate for signing request. The result of this method may be null if no reasonable ClientCredential can be located.

Parameters:

request - a Request

Returns:

a ClientCredential (can be null)

Throws:

NoMatchingCredentialException - if no ClientCredential can be selected