com.ibm.cloud.objectstorage.auth

Class SignerFactory

java.lang.Object

com.ibm.cloud.objectstorage.auth.SignerFactory

public final class SignerFactory
extends Object

Signer factory.

Field Summary

Fields

Modifier and Type	Field and Description
static String	NO_OP_SIGNER
static String	QUERY_STRING_SIGNER
static String	VERSION_FOUR_SIGNER
static String	VERSION_FOUR_UNSIGNED_PAYLOAD_SIGNER
static String	VERSION_THREE_SIGNER

Method Summary

Modifier and Type	Method and Description
static Signer	createSigner(String signerType, SignerParams params) Create an instance of the given signer type and initialize it with the given parameters.
static Signer	getSigner(String serviceName, String regionName) Returns a non-null signer for the specified service and region according to the internal configuration which provides a basic default algorithm used for signer determination.
static Signer	getSignerByTypeAndService(String signerType, String serviceName) Returns an instance of the given signer type and configures it with the given service name (if applicable).
static void	registerSigner(String signerType, Class<? extends Signer> signerClass) Register an implementation class for the given signer type.

Methods inherited from class java.lang.Object

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

Field Detail

QUERY_STRING_SIGNER

public static final String QUERY_STRING_SIGNER

See Also:

Constant Field Values

VERSION_THREE_SIGNER

public static final String VERSION_THREE_SIGNER

See Also:

Constant Field Values

VERSION_FOUR_SIGNER

public static final String VERSION_FOUR_SIGNER

See Also:

Constant Field Values

VERSION_FOUR_UNSIGNED_PAYLOAD_SIGNER

public static final String VERSION_FOUR_UNSIGNED_PAYLOAD_SIGNER

See Also:

Constant Field Values

NO_OP_SIGNER

public static final String NO_OP_SIGNER

See Also:

Constant Field Values

Method Detail

registerSigner

public static void registerSigner(String signerType,
                                  Class<? extends Signer> signerClass)

Register an implementation class for the given signer type.

Parameters:

signerType - The name of the signer type to register.

signerClass - The class implementing the given signature protocol.

getSigner

public static Signer getSigner(String serviceName,
                               String regionName)

Returns a non-null signer for the specified service and region according to the internal configuration which provides a basic default algorithm used for signer determination.

Parameters:

serviceName - The name of the service to talk to.

regionName - The name of the region to talk to; not necessarily the region used for signing.

getSignerByTypeAndService

public static Signer getSignerByTypeAndService(String signerType,
                                               String serviceName)

Returns an instance of the given signer type and configures it with the given service name (if applicable).

Parameters:

signerType - The type of signer to create.

serviceName - The name of the service to configure on the signer.

Returns:

a non-null signer.

createSigner

public static Signer createSigner(String signerType,
                                  SignerParams params)

Create an instance of the given signer type and initialize it with the given parameters.

Parameters:

signerType - The signer type.

params - The parameters to intialize the signer with.

Returns:

The new signer instance.