Skip navigation links

oracle.search.sdk.security
Interface IdentityPluginManager

public interface IdentityPluginManager

An interface for a manager of identity-based security.

See Also:

IdentityPlugin

Field Summary

static String

VERSION

Method Summary

String	getBaseAPIVersion() Returns the version string of the plug-in API.
String	getCanonicalAttribute() Returns the name of the attribute that is stored in the index and returned by the methods in the IdentityPlugin interface.
IdentityPlugin	getIdentityPlugin() Returns an instance of IdentityPlugin associated with this IdentityPluginManager.
String	getPluginDescription() Returns the description of the identity plug-in manager.
String	getPluginName() Returns the name of the identity plug-in manager.
List	getPluginParameters() Returns a list of parameter objects for the identity plug-in manager.
String	getPluginVersion() Returns the version string of the identity plug-in manager.
String[]	getSupportedAuthenticationAttributes() Returns the names of the attributes that are supported for authentication.
void	init(ParameterValues params, String authenAttr, Logger logger) Initializes the identity plug-in manager with parameter values provided in the administration tool.
void	setLocale(Locale locale) Sets the locale to be used for this plug-in manager and all the plug-ins created by it.
boolean	validateParams(ParameterValues params, String authenAttr) Validates the parameter values that will later be used by the administration tool, crawler, or query application to call init.

Field Detail

VERSION

static final String VERSION

See Also:

Constant Field Values

Method Detail

setLocale

void setLocale(Locale locale)

Sets the locale to be used for this plug-in manager and all the plug-ins created by it.

Parameters:

locale - the Locale

getBaseAPIVersion

String getBaseAPIVersion()

Returns the version string of the plug-in API. This method should always return IdentityPluginManager.VERSION.

Returns:

the plug-in API version string

getPluginName

String getPluginName()

Returns the name of the identity plug-in manager.

Returns:

name of the plug-in

getPluginDescription

String getPluginDescription()

Returns the description of the identity plug-in manager. The description should respect the locale as set by setLocale.

Returns:

description of the plug-in

getPluginVersion

String getPluginVersion()

Returns the version string of the identity plug-in manager.

Returns:

version of the plug-in

getPluginParameters

List getPluginParameters()

Returns a list of parameter objects for the identity plug-in manager. The administration tool uses this list to collect values for each parameter, and those values are used to call init.

Returns:

list of ParameterInfo objects

getCanonicalAttribute

String getCanonicalAttribute()

Returns the name of the attribute that is stored in the index and returned by the methods in the IdentityPlugin interface. This should be hard-coded by the plug-in.

Returns:

the name of the canonical attribute

getSupportedAuthenticationAttributes

String[] getSupportedAuthenticationAttributes()

Returns the names of the attributes that are supported for authentication.

Returns:

a String array of the supported authentication attributes

validateParams

boolean validateParams(ParameterValues params,
                       String authenAttr)
                       throws PluginException

Validates the parameter values that will later be used by the administration tool, crawler, or query application to call init. This method is called when the plug-in is activated in the administration tool.

Parameters:

params - the parameter values

authenAttr - the name of the authentication attribute that was selected by the administrator. This is used to authenticate users at login time.

Returns:

true if the parameters and authentication attribute are valid, false otherwise

Throws:

PluginException - if an error occurs

init

void init(ParameterValues params,
          String authenAttr,
          Logger logger)
          throws PluginException

Initializes the identity plug-in manager with parameter values provided in the administration tool.

This method will only be called with parameters which have been approved by a prior call to validateParams. However, the prior call to validateParams may have been made on a different object (of this class).

Note: This method may not be called on every instance of this interface, and it is only guaranteed to be invoked before a call to getIdentityPlugin. As a result, the Logger object may not always be available.

Parameters:

params - the parameter values

authenAttr - the name of the authentication attribute that was selected by the administrator. This is used to authenticate users at login time.

logger - logger object

Throws:

PluginException - if an error occurs

getIdentityPlugin

IdentityPlugin getIdentityPlugin()
                                 throws PluginException

Returns an instance of IdentityPlugin associated with this IdentityPluginManager. As a precondition, this object will have been initialized with a call to init.

Returns:

an instance of IdentityPlugin

Throws:

PluginException - if an error occurs

Skip navigation links