com.akamai.edgegrid.signer

Class EdgeRcClientCredentialProvider

java.lang.Object

com.akamai.edgegrid.signer.EdgeRcClientCredentialProvider

All Implemented Interfaces:

ClientCredentialProvider

public class EdgeRcClientCredentialProvider
extends Object
implements ClientCredentialProvider

This is a ClientCredentialProvider implementation that reads from EdgeRc files. A variety static methods are available to initially create the object. A default section name is required at creation time, and sub-classes may override pickSectionName(Request) in order to make a more complicated decision on a per-request basis.

Author:

mmeyer

Constructor Summary

Constructors

Constructor and Description
EdgeRcClientCredentialProvider(Reader reader, String section) Loads an EdgeRc configuration file and returns an EdgeRcClientCredentialProvider to read ClientCredentials from it.

Method Summary

Modifier and Type	Method and Description
static EdgeRcClientCredentialProvider	fromEdgeRc(File file, String section) Loads an EdgeRc configuration file and returns an EdgeRcClientCredentialProvider to read ClientCredentials from it.
static EdgeRcClientCredentialProvider	fromEdgeRc(InputStream inputStream, String section) Loads an EdgeRc configuration file and returns an EdgeRcClientCredentialProvider to read ClientCredentials from it.
static EdgeRcClientCredentialProvider	fromEdgeRc(Reader reader, String section) Loads an EdgeRc configuration file and returns an EdgeRcClientCredentialProvider to read ClientCredentials from it.
static EdgeRcClientCredentialProvider	fromEdgeRc(String filename, String section) Loads an EdgeRc configuration file and returns an EdgeRcClientCredentialProvider to read ClientCredentials from it.
ClientCredential	getClientCredential(Request request) Gets a ClientCredential that is appropriate for signing request.
protected ClientCredential	getClientCredential(String sectionName) Gets the ClientCredential defined in section sectionName.
protected String	pickSectionName(Request request) Picks an appropriate section name from the configuration to sign request.

Methods inherited from class java.lang.Object

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

Constructor Detail

EdgeRcClientCredentialProvider

public EdgeRcClientCredentialProvider(Reader reader,
                                      String section)
                               throws org.apache.commons.configuration2.ex.ConfigurationException,
                                      IOException

Loads an EdgeRc configuration file and returns an EdgeRcClientCredentialProvider to read ClientCredentials from it.

Parameters:

reader - an open Reader to an EdgeRc file

section - a config section (null for the default section)

Throws:

org.apache.commons.configuration2.ex.ConfigurationException - If an error occurs while reading the configuration

IOException - if an I/O error occurs

Method Detail

fromEdgeRc

public static EdgeRcClientCredentialProvider fromEdgeRc(File file,
                                                        String section)
                                                 throws org.apache.commons.configuration2.ex.ConfigurationException,
                                                        IOException

Loads an EdgeRc configuration file and returns an EdgeRcClientCredentialProvider to read ClientCredentials from it.

Parameters:

file - a File pointing to an EdgeRc file

section - a config section (null for the default section)

Returns:

a EdgeRcClientCredentialProvider

Throws:

org.apache.commons.configuration2.ex.ConfigurationException - If an error occurs while reading the configuration

IOException - if an I/O error occurs

fromEdgeRc

public static EdgeRcClientCredentialProvider fromEdgeRc(InputStream inputStream,
                                                        String section)
                                                 throws org.apache.commons.configuration2.ex.ConfigurationException,
                                                        IOException

Loads an EdgeRc configuration file and returns an EdgeRcClientCredentialProvider to read ClientCredentials from it.

Parameters:

inputStream - an open InputStream to an EdgeRc file

section - a config section (null for the default section)

Returns:

a EdgeRcClientCredentialProvider

Throws:

org.apache.commons.configuration2.ex.ConfigurationException - If an error occurs while reading the configuration

IOException - if an I/O error occurs

fromEdgeRc

public static EdgeRcClientCredentialProvider fromEdgeRc(Reader reader,
                                                        String section)
                                                 throws org.apache.commons.configuration2.ex.ConfigurationException,
                                                        IOException

Loads an EdgeRc configuration file and returns an EdgeRcClientCredentialProvider to read ClientCredentials from it.

Parameters:

reader - an open Reader to an EdgeRc file

section - a config section (null for the default section)

Returns:

a EdgeRcClientCredentialProvider

Throws:

org.apache.commons.configuration2.ex.ConfigurationException - If an error occurs while reading the configuration

IOException - if an I/O error occurs

fromEdgeRc

public static EdgeRcClientCredentialProvider fromEdgeRc(String filename,
                                                        String section)
                                                 throws org.apache.commons.configuration2.ex.ConfigurationException,
                                                        IOException

Loads an EdgeRc configuration file and returns an EdgeRcClientCredentialProvider to read ClientCredentials from it.

Parameters:

filename - a filename pointing to an EdgeRc file

section - a config section (null for the default section)

Returns:

a EdgeRcClientCredentialProvider

Throws:

org.apache.commons.configuration2.ex.ConfigurationException - If an error occurs while reading the configuration

IOException - if an I/O error occurs

getClientCredential

public ClientCredential getClientCredential(Request request)

Description copied from interface: ClientCredentialProvider

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

Specified by:

getClientCredential in interface ClientCredentialProvider

Parameters:

request - a Request

Returns:

a ClientCredential (can be null)

getClientCredential

protected ClientCredential getClientCredential(String sectionName)

Gets the ClientCredential defined in section sectionName.

Parameters:

sectionName - a section name (null for the default section)

Returns:

a ClientCredential

pickSectionName

protected String pickSectionName(Request request)

Picks an appropriate section name from the configuration to sign request. By default this method will always return defaultSectionName, which was provided as part the object construction. Users may extend this class and override this method to perform more complex decisions about how to decide which ClientCredential will be retrieved from the EdgeRc file.

Parameters:

request - a Request

Returns:

a section name (null for the default section)