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 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 the parameters for the identity plug-in manager.
String	getPluginVersion() Returns the version string of the identity plug-in manager.
String[]	getSupportedAuthenticationAttributes() Returns 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 admin UI.
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 admin, crawler, or query to call init.

Field Detail

VERSION

public static final String VERSION

See Also:

Constant Field Values

Method Detail

setLocale

public 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

public 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

public String getPluginName()

Returns the name of the identity plug-in manager.

Returns:

name of the plug-in

getPluginDescription

public String getPluginDescription()

Returns the description of the identity plug-in manager.

Returns:

description of the plug-in

getPluginVersion

public String getPluginVersion()

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

Returns:

version of the plug-in

getPluginParameters

public List getPluginParameters()

Returns the parameters for the identity plug-in manager. These parameters are used to call init.

Returns:

list of oracle.search.sdk.common.ParameterInfo objects

getCanonicalAttribute

public String getCanonicalAttribute()

Returns 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 canonical attribute

getSupportedAuthenticationAttributes

public String[] getSupportedAuthenticationAttributes()

Returns the attributes that are supported for authentication.

Returns:

a String array of the supported authentication attributes

validateParams

public boolean validateParams(ParameterValues params,
                              String authenAttr)
                       throws PluginException

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

Parameters:

params - the parameter values

authenAttr - the authentication attribute that was selected by the administrator.

Returns:

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

Throws:

PluginException - if an error occurs

init

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

Initializes the identity plug-in manager with parameter values provided in the admin UI. The arguments will already have been validated with a call to validateParams. This method should NOT be called with parameters which have not been approved by a prior call to validateParams(). However, validateParams need not be called on the same object (just any object of this class).

Parameters:

params - the parameter values

authenAttr - the authentication attribute that was selected by the administrator.

logger - logger interface

Throws:

PluginException - if an error occurs

getIdentityPlugin

public IdentityPlugin getIdentityPlugin()
                                 throws PluginException

Returns an instance of IdentityPlugin associated with this IdentityPluginManager.

Returns:

an instance of IdentityPlugin

Throws:

PluginException - if init() has not been called

Skip navigation links