Skip navigation links

oracle.search.sdk.security
Interface AuthorizationManager

public interface AuthorizationManager

An interface to manage authorization plug-ins for extensible authorization.

See Also:

QueryFilterPlugin, ResultFilterPlugin, IdentityPlugin

Field Summary

static String

VERSION

Method Summary

boolean	areAttributesSufficient(SecurityAttributeInfo[] attributes) Returns true if this authorization plug-in supports all of the security attributes exposed by the crawler plug-in, and if these are sufficient to determine authorization.
String	getBaseAPIVersion() Returns the version string of the plug-in API.
String	getPluginDescription() Returns the description of the authorization manager plug-in.
String	getPluginName() Returns the name of the authorization manager plug-in.
List	getPluginParameters() Returns the parameters for the authorization manager plug-in.
String	getPluginVersion() Returns the version string of the authorization manager plug-in.
QueryFilterPlugin	getQueryFilterPlugin(String username, ServletRequest req) Returns an instance of QueryFilterPlugin.
ResultFilterPlugin	getResultFilterPlugin() Returns an instance of ResultFilterPlugin.
void	init(ParameterValues params, IdentityPluginManager identityPluginManager, Logger logger) Initializes the authorization manager plug-in with parameter values provided in the admin UI.
boolean	isQueryFilterAvailable() Returns true if this manager provides a QueryFilterPlugin.
boolean	isResultFilterAvailable() Returns true if this manager provides a ResultFilterPlugin.
boolean	validateParams(ParameterValues params) 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

getBaseAPIVersion

public String getBaseAPIVersion()

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

Returns:

the plug-in API version string

getPluginName

public String getPluginName()

Returns the name of the authorization manager plug-in.

Returns:

name of the plug-in

getPluginDescription

public String getPluginDescription()

Returns the description of the authorization manager plug-in.

Returns:

description of the plug-in

getPluginVersion

public String getPluginVersion()

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

Returns:

version of the plug-in

getPluginParameters

public List getPluginParameters()

Returns the parameters for the authorization manager plug-in.

Returns:

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

validateParams

public boolean validateParams(ParameterValues params)
                       throws PluginException

Validates the parameter values that will later be used by the admin, crawler, or query to call init.

Parameters:

params - the parameter values

Returns:

true if the parameters are valid, false otherwise

Throws:

PluginException - if an error occurs

init

public void init(ParameterValues params,
                 IdentityPluginManager identityPluginManager,
                 Logger logger)
          throws PluginException

Initializes the authorization manager plug-in with parameter values provided in the admin UI.

Parameters:

params - the parameter values

identityPluginManager - an active identity plug-in manager

logger - logger interface

Throws:

PluginException - if an error occurs

isQueryFilterAvailable

public boolean isQueryFilterAvailable()

Returns true if this manager provides a QueryFilterPlugin.

isResultFilterAvailable

public boolean isResultFilterAvailable()

Returns true if this manager provides a ResultFilterPlugin.

areAttributesSufficient

public boolean areAttributesSufficient(SecurityAttributeInfo[] attributes)

Returns true if this authorization plug-in supports all of the security attributes exposed by the crawler plug-in, and if these are sufficient to determine authorization. If this authorization manager does not provide a query filter plug-in, then this method will not be called.

Parameters:

attributes - the security attributes

Returns:

true if the attributes are sufficient, false otherwise

getQueryFilterPlugin

public QueryFilterPlugin getQueryFilterPlugin(String username,
                                              ServletRequest req)

Returns an instance of QueryFilterPlugin.

Parameters:

username - the username

req - the servlet request

Returns:

an instance of QueryFilterPlugin

getResultFilterPlugin

public ResultFilterPlugin getResultFilterPlugin()

Returns an instance of ResultFilterPlugin.

Returns:

an instance of ResultFilterPlugin

Skip navigation links