com.oracle.sites.visitors.api.providers

Class BaseProvider

java.lang.Object

com.oracle.sites.visitors.api.providers.BaseProvider

Direct Known Subclasses:

BaseAccessProvider, BaseIdentityProvider, BaseProfileProvider

public abstract class BaseProvider
extends Object

BaseProvider class.

Constructor Summary

Constructors

Constructor and Description
BaseProvider(String providerBundleId) Constructor, which is called by provider implementation child classes.

Method Summary

Modifier and Type	Method and Description
String	getConfigProperty(String key)
Properties	getProviderConfig() Getter for the field providerConfig.
String	getProviderName() Getter for the field providerName.
void	setProviderConfig(Properties providerConfig) Setter for the field providerConfig.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseProvider

public BaseProvider(String providerBundleId)

Constructor, which is called by provider implementation child classes. The provider objects are instantiated by bundle Activator classes, generally.

Parameters:

providerBundleId - - The bundle Activator classes should pass-in context.getBundle().getLocation(), which is generally of the form 'providerType someSeparator providerName'profileProvider.LdapProfileProvider'. This format comes from the way SVS installs bundle, giving them unique bundle location.

Method Detail

getProviderName

public final String getProviderName()

Getter for the field providerName.

Returns:

a String object.

getProviderConfig

public Properties getProviderConfig()

Getter for the field providerConfig.

Returns:

a Properties object.

getConfigProperty

public String getConfigProperty(String key)

setProviderConfig

public void setProviderConfig(Properties providerConfig)

Setter for the field providerConfig.

Parameters:

providerConfig - a Properties object.