|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The CustomRegistry interface provides an API that supports the following registry entry types:
Method Summary | |
java.lang.String |
checkPassword(java.lang.String userId,
java.lang.String password)
Checks the password of the user. |
java.lang.String |
getGroupDisplayName(java.lang.String groupName)
Returns the display name for a group. |
java.util.List |
getGroups()
Returns names of all the groups in the registry. |
java.util.List |
getGroups(java.lang.String pattern)
Returns names of the groups in the registry that match a pattern. |
java.lang.String |
getGroupSecurityName(java.lang.String uniqueGroupId)
Returns the name for a group given its uniqueId. |
java.util.List |
getGroupsForUser(java.lang.String userName)
Returns the names of the groups to which userName belongs. |
java.lang.String |
getRealm()
Returns the realm of the registry. |
java.lang.String |
getUniqueGroupId(java.lang.String groupName)
Returns the Unique id for a group. |
java.util.List |
getUniqueGroupIds(java.lang.String uniqueUserId)
Returns the Unique ids for all the groups that contain the UniqueId of a user. |
java.lang.String |
getUniqueUserId(java.lang.String userName)
Returns the UniqueId for a userName. |
java.util.List |
getUniqueUserIds(java.lang.String uniqueGroupId)
Returns the UniqueIds for all the users that belong to a group. |
java.lang.String |
getUserDisplayName(java.lang.String userName)
Returns the display name for the user specified by userName. |
java.util.List |
getUsers()
Returns names of all the users in the registry. |
java.util.List |
getUsers(java.lang.String pattern)
Returns names of the users in the registry that match a pattern. |
java.lang.String |
getUserSecurityName(java.lang.String uniqueUserId)
Returns the name for a user given its uniqueId. |
java.util.List |
getUsersForGroup(java.lang.String groupName)
Returns the names of the all the users in a group. |
void |
initialize(java.util.Properties props)
Initializes the registry. |
boolean |
isValidGroup(java.lang.String groupName)
Determines if a group exists. |
boolean |
isValidUser(java.lang.String userName)
Determines if a user exists. |
java.lang.String |
mapCertificate(java.security.cert.X509Certificate cert)
Maps a Certificate (of X509 format) to a valid userId in the Registry. |
Method Detail |
public void initialize(java.util.Properties props) throws CustomRegistryException
props
- the registry-specific properties with which to initialize the
registry object.CustomRegistryException
- if the registry is "bad".public java.lang.String checkPassword(java.lang.String userId, java.lang.String password) throws PasswordCheckFailedException, CustomRegistryException
userId
- the username whose password needs to be checked.password
- the password of the userId.CheckPasswordFailedException
- if userId/password
combination does not exist in the registry.CustomRegistryException
- if the registry is "bad".public java.lang.String mapCertificate(java.security.cert.X509Certificate cert) throws CertificateMapNotSupportedException, CertificateMapFailedException, CustomRegistryException
cert
- the certificate that needs to be mapped.CertificateMapNotSupportedException
- if the particular
certificate is not supported.CertificateMapFailedException
- if the mapping of the
certificate fails.CustomRegistryException
- if the registry is "bad".public java.lang.String getRealm() throws CustomRegistryException
CustomRegistryException
- if the registry is "bad".public java.util.List getUsers() throws CustomRegistryException
CustomRegistryException
- if the registry is "bad".public java.util.List getUsers(java.lang.String pattern) throws CustomRegistryException
pattern
- the pattern to match. (For e.g., a* will match all
userNames starting with a)CustomRegistryException
- if the registry is "bad".public java.util.List getUsersForGroup(java.lang.String groupName) throws EntryNotFoundException, CustomRegistryException
groupName
- the name of the group.EntryNotFoundException
- if groupName does not exist.CustomRegistryException
- if the registry is "bad".public java.lang.String getUserDisplayName(java.lang.String userName) throws EntryNotFoundException, CustomRegistryException
userName
- the name of the user.EntryNotFoundException
- if userName does not exist.CustomRegistryException
- if the registry is "bad".public java.lang.String getUniqueUserId(java.lang.String userName) throws EntryNotFoundException, CustomRegistryException
userName
- the name of the user.EntryNotFoundException
- if userName does not exist.CustomRegistryException
- if the registry is "bad".public java.util.List getUniqueUserIds(java.lang.String uniqueGroupId) throws EntryNotFoundException, CustomRegistryException
uniqueGroupId
- the uniqueId of the group.EntryNotFoundException
- if uniqueGroupId does not exist.CustomRegistryException
- if the registry is "bad".public java.lang.String getUserSecurityName(java.lang.String uniqueUserId) throws EntryNotFoundException, CustomRegistryException
uniqueUserId
- the UniqueId of the user.EntryNotFoundException
- if the uniqueUserId does not exist.CustomRegistryException
- if the registry is "bad".public boolean isValidUser(java.lang.String userName) throws CustomRegistryException
userName
- the name of the user.CustomRegistryException
- if the registry is "bad".public java.util.List getGroups() throws CustomRegistryException
CustomRegistryException
- if the registry is "bad".public java.util.List getGroups(java.lang.String pattern) throws CustomRegistryException
pattern
- the pattern to match.CustomRegistryException
- if the registry is "bad".public java.util.List getGroupsForUser(java.lang.String userName) throws EntryNotFoundException, CustomRegistryException
userName
- the username of the user.EntryNotFoundException
- if userName does not exist.CustomRegistryException
- if the registry is "bad".public java.lang.String getGroupDisplayName(java.lang.String groupName) throws EntryNotFoundException, CustomRegistryException
groupName
- the name of the group.EntryNotFoundException
- if the groupName does not exist.CustomRegistryException
- if the registry is "bad".public java.lang.String getUniqueGroupId(java.lang.String groupName) throws EntryNotFoundException, CustomRegistryException
groupName
- the name of the group.EntryNotFoundException
- if groupName does not exist.CustomRegistryException
- if the registry is "bad".public java.util.List getUniqueGroupIds(java.lang.String uniqueUserId) throws EntryNotFoundException, CustomRegistryException
uniqueUserId
- the uniqueId of the user.EntryNotFoundException
- if uniqueUserId does not exist.CustomRegistryException
- if the registry is "bad".public java.lang.String getGroupSecurityName(java.lang.String uniqueGroupId) throws EntryNotFoundException, CustomRegistryException
uniqueGroupId
- the UniqueId of the group.EntryNotFoundException
- if the uniqueGroupId does not exist.CustomRegistryException
- if the registry is "bad".public boolean isValidGroup(java.lang.String groupName) throws CustomRegistryException
groupName
- the name of the group.CustomRegistryException
- if the registry is "bad".
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |