|
Oracle Secure Enterprise Search Java API Reference 11g Release 1 (11.1.2.0.0) E14433-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IdentityPlugin
An interface for identity-based security.
IdentityPluginManager
Method Summary | |
---|---|
String |
authenticate(String username, char[] password) Authenticates a user and returns the value of the canonical attribute representing the authenticated user. |
void |
close() Called to indicate that this plug-in object will no longer be used. |
String[] |
getAllGroups(String username) Returns the groups or roles for a given user. |
String[] |
getAttribute(String attrName, String username, String identityAttr) Returns the value or values of an attribute for a given user. |
String |
getAuthenticationAttribute() Returns the authentication attribute name, which was configured in the call to IdentityPluginManager.init . |
String[] |
getGroupAttribute(String attrName, String groupname, String identityAttr) Returns the value or values of an attribute for a given group. |
boolean |
isValidAttribute(String attrName) Indicates if the given attribute name is valid. |
String |
validateGroup(String group, String attrName) Indicates if the given group is valid. |
String |
validateUser(String username, String attrName) Indicates if the given user is valid. |
Method Detail |
---|
String authenticate(String username, char[] password) throws PluginException
null
.username
- the username for the search user, in the format of the authentication attribute configured in the call to IdentityPluginManager.init
password
- the user's passwordnull
PluginException
- if an error occursString[] getAttribute(String attrName, String username, String identityAttr) throws PluginException
attrName
- the name of the attribute. For example, AD_NAME
username
- the username for the search useridentityAttr
- the attribute name (format) of the username
parameterPluginException
- if an error occursString[] getGroupAttribute(String attrName, String groupname, String identityAttr) throws PluginException
attrName
- the name of the attribute. For example, AD_NAME
groupname
- the group nameidentityAttr
- the attribute name (format) of the groupname
parameterPluginException
- if an error occursString[] getAllGroups(String username) throws PluginException
username
- the username for the search user in the format of the canonical attribute (for example, as returned by a call to authenticate
).PluginException
- if an error occursString validateUser(String username, String attrName) throws PluginException
username
- the username identity string in the format of the attrName
parameterattrName
- the name of the attribute (format) of the username
parameternull
PluginException
- if an error occursString validateGroup(String group, String attrName) throws PluginException
group
- the group identity string in the format of the attrName
parameterattrName
- the name of the attribute (format) for the group
parameternull
PluginException
- if an error occursboolean isValidAttribute(String attrName)
attrName
- the name of the attributetrue
if the given attribute is valid (is known to the identity management system), false
otherwiseString getAuthenticationAttribute()
IdentityPluginManager.init
.void close()
|
Oracle Secure Enterprise Search Java API Reference 11g Release 1 (11.1.2.0.0) E14433-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |