public interface IUGSubsystem extends ISubsystem, IUsrGrp
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ID
Constant for ID
|
static java.lang.String |
SUPER_CERT_ADMINS
Constant for super administrators
|
Modifier and Type | Method and Description |
---|---|
void |
addCertSubjectDN(IUser identity)
Add a certSubjectDN field to the user
|
void |
addGroup(IGroup group)
Adds a group of identities.
|
void |
addUser(IUser identity)
Adds the given user to the internal database
|
void |
addUserCert(IUser identity)
Adds a user certificate to user
|
IGroup |
createGroup(java.lang.String id)
Create group with the given id.
|
IUser |
createUser(java.lang.String id)
Create user with the given id.
|
IGroup |
findGroup(java.lang.String name)
Find a group for the given name
|
java.util.Enumeration |
findGroups(java.lang.String filter)
Finds groups that match the filter.
|
IUser |
findUsersByCert(java.lang.String filter)
Searchs for identities that matches the certificate locater
generated filter.
|
java.lang.String |
getCertificateString(java.security.cert.X509Certificate cert)
Get string representation of the given certificate
|
ICertUserLocator |
getCertUserLocator()
Get user locator which does the mapping between the user and the certificate.
|
IGroup |
getGroup(java.lang.String DN)
Retrieves a group from LDAP for the given DN.
|
IGroup |
getGroupFromName(java.lang.String name)
Retrieves a group from LDAP for the given group name
|
IUser |
getUser(java.lang.String userid)
Retrieves a user from LDAP
|
boolean |
isGroupPresent(java.lang.String name)
Checks if the given group exists.
|
boolean |
isMemberOf(IUser id,
java.lang.String name) |
boolean |
isMemberOf(java.lang.String uid,
java.lang.String name)
Checks if the given context is a member of the given group
|
java.util.Enumeration |
listGroups(java.lang.String filter)
List groups.
|
java.util.Enumeration |
listUsers(java.lang.String filter)
Searches for users that matches the filter.
|
void |
modifyGroup(IGroup group)
Modifies a group.
|
void |
modifyUser(IUser identity)
Modifies user attributes.
|
void |
removeGroup(java.lang.String name)
Removes a group.
|
void |
removeUser(java.lang.String userid)
Removes identity.
|
void |
removeUserCert(IUser identity)
Removes a user certificate for a user entry
given a user certificate DN (actually, a combination of version,
serialNumber, issuerDN, and SubjectDN), and it gets removed
|
void |
removeUserFromGroup(IGroup grp,
java.lang.String userid)
Removes the user with the given id from the given group
|
getConfigStore, getId, init, setId, shutdown, startup
getDescription, getId
evaluate
static final java.lang.String ID
static final java.lang.String SUPER_CERT_ADMINS
IUser getUser(java.lang.String userid) throws EUsrGrpException
getUser
in interface IUsrGrp
userid
- the given user idEUsrGrpException
- thrown when failed to find the userjava.util.Enumeration listUsers(java.lang.String filter) throws EUsrGrpException
filter
- search filter for efficiencyEUsrGrpException
- thrown when any internal error occursvoid addUser(IUser identity) throws EUsrGrpException, netscape.ldap.LDAPException
addUser
in interface IUsrGrp
identity
- the given userEUsrGrpException
- thrown when failed to add user to the groupnetscape.ldap.LDAPException
- thrown when the LDAP internal database is not availablevoid addUserCert(IUser identity) throws EUsrGrpException, netscape.ldap.LDAPException
identity
- user interfaceEUsrGrpException
- thrown when failed to add the user certificate to the given usernetscape.ldap.LDAPException
- thrown when the LDAP internal database is not availablevoid addCertSubjectDN(IUser identity) throws EUsrGrpException, netscape.ldap.LDAPException
identity
- EUsrGrpException
netscape.ldap.LDAPException
void removeUserCert(IUser identity) throws EUsrGrpException
identity
- the given user whose user certificate is going to be
be removed.EUsrGrpException
- thrown when failed to remove user certificatevoid removeUser(java.lang.String userid) throws EUsrGrpException
removeUser
in interface IUsrGrp
userid
- the given user idEUsrGrpException
- thrown when failed to remove uservoid modifyUser(IUser identity) throws EUsrGrpException
modifyUser
in interface IUsrGrp
identity
- the given identity which contains all the user
attributes being modifiedEUsrGrpException
- thrown when modification failedjava.util.Enumeration findGroups(java.lang.String filter)
filter
- the search filterIGroup findGroup(java.lang.String name)
name
- the given namejava.util.Enumeration listGroups(java.lang.String filter) throws EUsrGrpException
filter
- the search filterEUsrGrpException
- thrown when failed to list groupsIGroup getGroupFromName(java.lang.String name)
name
- the given group nameIGroup getGroup(java.lang.String DN)
boolean isGroupPresent(java.lang.String name)
name
- the given group nameboolean isMemberOf(java.lang.String uid, java.lang.String name)
uid
- the given user idname
- the given group nameboolean isMemberOf(IUser id, java.lang.String name)
void addGroup(IGroup group) throws EUsrGrpException
addGroup
in interface IUsrGrp
group
- the given groupEUsrGrpException
- thrown when failed to add group.void removeGroup(java.lang.String name) throws EUsrGrpException
removeGroup
in interface IUsrGrp
name
- the given group nameEUsrGrpException
- thrown when the given group failed to removevoid modifyGroup(IGroup group) throws EUsrGrpException
modifyGroup
in interface IUsrGrp
group
- the given group which contain all group attributes being
modified.EUsrGrpException
- thrown when failed to modify group.void removeUserFromGroup(IGroup grp, java.lang.String userid) throws EUsrGrpException
grp
- the given groupuserid
- the given user idEUsrGrpException
- thrown when failed to remove the user from
the given groupIUser createUser(java.lang.String id)
id
- the user with the given id.IGroup createGroup(java.lang.String id)
id
- the group with the given id.java.lang.String getCertificateString(java.security.cert.X509Certificate cert)
cert
- given certificateIUser findUsersByCert(java.lang.String filter) throws EUsrGrpException, netscape.ldap.LDAPException
filter
- search filterEUsrGrpException
- thrown when failed to find usernetscape.ldap.LDAPException
- thrown when the internal database is not availableICertUserLocator getCertUserLocator()