Package com.ibm.oauth.core.api.config
Interface OAuthComponentConfiguration
-
- All Known Implementing Classes:
SampleComponentConfiguration
public interface OAuthComponentConfiguration
OAuth component configuration interface. A consumer of the OAuth component is responsible for providing an implementation class and passing it to the ComponentInstance constructor. The configuration properties that must be supplied are described in theOAuthComponentConfigurationConstants
interface.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
getConfigPropertyBooleanValue(java.lang.String name)
The boolean value for the property.int
getConfigPropertyIntValue(java.lang.String name)
Returns the first integer value for the property if any.java.lang.String
getConfigPropertyValue(java.lang.String name)
Returns the first string value for the property if any.java.lang.String[]
getConfigPropertyValues(java.lang.String name)
The Array of string values for the property.java.lang.ClassLoader
getPluginClassLoader()
Return a class loader suitable for loading other customer plugin classes defined in the configuration.java.lang.String
getUniqueId()
Returns a unique identifier representing this configuration instance.
-
-
-
Method Detail
-
getUniqueId
java.lang.String getUniqueId()
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.- 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 .
-
getPluginClassLoader
java.lang.ClassLoader getPluginClassLoader()
Return a class loader suitable for loading other customer plugin classes defined in the configuration.- Returns:
- a class loader suitable for loading other customer plugin classes.
-
getConfigPropertyValue
java.lang.String getConfigPropertyValue(java.lang.String name)
Returns the first string value for the property if any.- Returns:
- the first string value for the property if any.
-
getConfigPropertyValues
java.lang.String[] getConfigPropertyValues(java.lang.String name)
The Array of string values for the property.- Returns:
- the array of string values for the property.
-
getConfigPropertyIntValue
int getConfigPropertyIntValue(java.lang.String name)
Returns the first integer value for the property if any.- Returns:
- the first integer value for the property if any.
-
getConfigPropertyBooleanValue
boolean getConfigPropertyBooleanValue(java.lang.String name)
The boolean value for the property.- Returns:
- the boolean value for the property.
-
-