Package com.ibm.oauth.core.api.config

Class SampleComponentConfiguration

java.lang.Object

com.ibm.oauth.core.api.config.SampleComponentConfiguration

All Implemented Interfaces:

OAuthComponentConfiguration

public abstract class SampleComponentConfiguration
extends Object
implements OAuthComponentConfiguration

OAuthComponentConfiguration implementation seeded with default configuration values. Individual values can be overridden to customize the configuration. Classes extending this class must implement getUniqueID(), and also provide class names for OAUTH20_CLIENT_PROVIDER_CLASSNAME and OAUTH20_TOKEN_CACHE_CLASSNAME, at a minimum if using OAuth 2.0 features of the component. Extending this base class rather than directly implementing OAuthComponentConfiguration is highly recommended. New parameters added to the OAuthComponentConfigurationConstants may receive corresponding update in this class with reasonable default values, which minimizes future API incompatibility.

Field Summary

Fields

Modifier and Type	Field	Description
static final String[]	ACCESS_TOKEN_LENGTH	Sample config value for the OAuthComponentConfigurationConstants.OAUTH20_ACCESS_TOKEN_LENGTH property: 40
static final String[]	ACCESS_TOKENTYPEHANDLER_CLASSNAME	Sample config value for the OAuthComponentConfigurationConstants.OAUTH20_ACCESS_TOKENTYPEHANDLER_CLASSNAME property to use internal default token type handler.
static final String[]	ALLOW_PUBLIC_CLIENTS	Sample config value for the OAuthComponentConfigurationConstants.OAUTH20_ALLOW_PUBLIC_CLIENTS property: false
static final String[]	CODE_LENGTH	Sample config value for the OAuthComponentConfigurationConstants.OAUTH20_CODE_LENGTH property: 30
static final String[]	CODE_LIFETIME_SECONDS	Sample config value for the OAuthComponentConfigurationConstants.OAUTH20_CODE_LIFETIME_SECONDS property: 60
static final String[]	GRANT_TYPES_ALLOWED	Sample config value for the OAuthComponentConfigurationConstants.OAUTH20_GRANT_TYPES_ALLOWED property: allows all grant and token types
static final String[]	ISSUE_REFRESH_TOKEN	Sample config value for the OAuthComponentConfigurationConstants.OAUTH20_ISSUE_REFRESH_TOKEN property: true
static final String[]	MAX_AUTHORIZATION_GRANT_LIFEIMTE_SECONDS	Sample config value for the OAuthComponentConfigurationConstants.OAUTH20_MAX_AUTHORIZATION_GRANT_LIFETIME_SECONDS property: 604800
static final String[]	MEDIATOR_CLASSNAMES	Sample config value for the OAuthComponentConfigurationConstants.OAUTH20_MEDIATOR_CLASSNAMES property: null, to use internal default mediator which does nothing.
static final String[]	REFRESH_TOKEN_LENGTH	Sample config value for the OAuthComponentConfigurationConstants.OAUTH20_REFRESH_TOKEN_LENGTH property: 50
static final String[]	TOKEN_LIFETIME_SECONDS	Sample config value for the OAuthComponentConfigurationConstants.OAUTH20_TOKEN_LIFETIME_SECONDS property: 3600

Constructor Summary

Constructors

Constructor	Description
SampleComponentConfiguration()	Populates the configuration map with all our default values.

Method Summary

Modifier and Type	Method	Description
boolean	getConfigPropertyBooleanValue(String name)	The boolean value for the property.
int	getConfigPropertyIntValue(String name)	Returns the first integer value for the property if any.
String	getConfigPropertyValue(String name)	Returns the first string value for the property if any.
String[]	getConfigPropertyValues(String name)	The Array of string values for the property.
ClassLoader	getPluginClassLoader()	Return a class loader suitable for loading other customer plugin classes defined in the configuration.
abstract String	getUniqueId()	Returns a unique identifier representing this configuration instance.
void	putConfigPropertyValues(String property, String[] values)

Methods inherited from class java.lang.Object

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

Field Details

MAX_AUTHORIZATION_GRANT_LIFEIMTE_SECONDS

public static final String[] MAX_AUTHORIZATION_GRANT_LIFEIMTE_SECONDS

Sample config value for the OAuthComponentConfigurationConstants.OAUTH20_MAX_AUTHORIZATION_GRANT_LIFETIME_SECONDS property: 604800

CODE_LIFETIME_SECONDS

public static final String[] CODE_LIFETIME_SECONDS

Sample config value for the OAuthComponentConfigurationConstants.OAUTH20_CODE_LIFETIME_SECONDS property: 60

CODE_LENGTH

public static final String[] CODE_LENGTH

Sample config value for the OAuthComponentConfigurationConstants.OAUTH20_CODE_LENGTH property: 30

TOKEN_LIFETIME_SECONDS

public static final String[] TOKEN_LIFETIME_SECONDS

Sample config value for the OAuthComponentConfigurationConstants.OAUTH20_TOKEN_LIFETIME_SECONDS property: 3600

ACCESS_TOKEN_LENGTH

public static final String[] ACCESS_TOKEN_LENGTH

Sample config value for the OAuthComponentConfigurationConstants.OAUTH20_ACCESS_TOKEN_LENGTH property: 40

ISSUE_REFRESH_TOKEN

public static final String[] ISSUE_REFRESH_TOKEN

Sample config value for the OAuthComponentConfigurationConstants.OAUTH20_ISSUE_REFRESH_TOKEN property: true

REFRESH_TOKEN_LENGTH

public static final String[] REFRESH_TOKEN_LENGTH

Sample config value for the OAuthComponentConfigurationConstants.OAUTH20_REFRESH_TOKEN_LENGTH property: 50

ACCESS_TOKENTYPEHANDLER_CLASSNAME

public static final String[] ACCESS_TOKENTYPEHANDLER_CLASSNAME

Sample config value for the OAuthComponentConfigurationConstants.OAUTH20_ACCESS_TOKENTYPEHANDLER_CLASSNAME property to use internal default token type handler. You should not use any other value for this property.

MEDIATOR_CLASSNAMES

public static final String[] MEDIATOR_CLASSNAMES

Sample config value for the OAuthComponentConfigurationConstants.OAUTH20_MEDIATOR_CLASSNAMES property: null, to use internal default mediator which does nothing.

ALLOW_PUBLIC_CLIENTS

public static final String[] ALLOW_PUBLIC_CLIENTS

Sample config value for the OAuthComponentConfigurationConstants.OAUTH20_ALLOW_PUBLIC_CLIENTS property: false

GRANT_TYPES_ALLOWED

public static final String[] GRANT_TYPES_ALLOWED

Sample config value for the OAuthComponentConfigurationConstants.OAUTH20_GRANT_TYPES_ALLOWED property: allows all grant and token types

Constructor Details

SampleComponentConfiguration

public SampleComponentConfiguration()

Populates the configuration map with all our default values.

Method Details

putConfigPropertyValues

public void putConfigPropertyValues(String property,
 String[] values)

getPluginClassLoader

public ClassLoader getPluginClassLoader()

Description copied from interface: OAuthComponentConfiguration

Return a class loader suitable for loading other customer plugin classes defined in the configuration.

Specified by:

getPluginClassLoader in interface OAuthComponentConfiguration

Returns:

a class loader suitable for loading other customer plugin classes.

getConfigPropertyValue

public String getConfigPropertyValue(String name)

Description copied from interface: OAuthComponentConfiguration

Returns the first string value for the property if any.

Specified by:

getConfigPropertyValue in interface OAuthComponentConfiguration

Returns:

the first string value for the property if any.

getConfigPropertyValues

public String[] getConfigPropertyValues(String name)

Description copied from interface: OAuthComponentConfiguration

The Array of string values for the property.

Specified by:

getConfigPropertyValues in interface OAuthComponentConfiguration

Returns:

the array of string values for the property.

getConfigPropertyIntValue

public int getConfigPropertyIntValue(String name)

Description copied from interface: OAuthComponentConfiguration

Returns the first integer value for the property if any.

Specified by:

getConfigPropertyIntValue in interface OAuthComponentConfiguration

Returns:

the first integer value for the property if any.

getConfigPropertyBooleanValue

public boolean getConfigPropertyBooleanValue(String name)

Description copied from interface: OAuthComponentConfiguration

The boolean value for the property.

Specified by:

getConfigPropertyBooleanValue in interface OAuthComponentConfiguration

Returns:

the boolean value for the property.

getUniqueId

public abstract String getUniqueId()

Description copied from interface: OAuthComponentConfiguration

Returns a unique identifier representing this configuration instance. This is used to logically separate instances of the OAuthComponentInstance.The implementation need ensure this UniqueId uniqueness if there are multiple OAuth service provider components.

Specified by:

getUniqueId in interface OAuthComponentConfiguration

Returns:

a unique identifier representing an instance of the OAuth component within an java process. Typically there will only be one instance per JVM however logically there could be more if there multiple OAuth components in one JVM .