diff options
Diffstat (limited to 'pki/base/common/src/com/netscape/certsrv/usrgrp/IUGSubsystem.java')
| -rw-r--r-- | pki/base/common/src/com/netscape/certsrv/usrgrp/IUGSubsystem.java | 99 |
1 files changed, 63 insertions, 36 deletions
diff --git a/pki/base/common/src/com/netscape/certsrv/usrgrp/IUGSubsystem.java b/pki/base/common/src/com/netscape/certsrv/usrgrp/IUGSubsystem.java index e575c58b..7ab4dac8 100644 --- a/pki/base/common/src/com/netscape/certsrv/usrgrp/IUGSubsystem.java +++ b/pki/base/common/src/com/netscape/certsrv/usrgrp/IUGSubsystem.java @@ -17,7 +17,6 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.usrgrp; - import java.security.cert.X509Certificate; import java.util.Enumeration; @@ -25,12 +24,10 @@ import netscape.ldap.LDAPException; import com.netscape.certsrv.base.ISubsystem; - /** - * This class defines low-level LDAP usr/grp management - * usr/grp information is located remotely on another - * LDAP server. - * + * This class defines low-level LDAP usr/grp management usr/grp information is + * located remotely on another LDAP server. + * * @version $Revision$, $Date$ */ public interface IUGSubsystem extends ISubsystem, IUsrGrp { @@ -47,6 +44,7 @@ public interface IUGSubsystem extends ISubsystem, IUsrGrp { /** * Retrieves a user from LDAP + * * @param userid the given user id * @exception EUsrGrpException thrown when failed to find the user */ @@ -54,6 +52,7 @@ public interface IUGSubsystem extends ISubsystem, IUsrGrp { /** * Searches for users that matches the filter. + * * @param filter search filter for efficiency * @return list of users * @exception EUsrGrpException thrown when any internal error occurs @@ -62,48 +61,57 @@ public interface IUGSubsystem extends ISubsystem, IUsrGrp { /** * Adds the given user to the internal database + * * @param identity the given user * @exception EUsrGrpException thrown when failed to add user to the group - * @exception LDAPException thrown when the LDAP internal database is not available + * @exception LDAPException thrown when the LDAP internal database is not + * available */ public void addUser(IUser identity) throws EUsrGrpException, LDAPException; /** * Adds a user certificate to user + * * @param identity user interface - * @exception EUsrGrpException thrown when failed to add the user certificate to the given user - * @exception LDAPException thrown when the LDAP internal database is not available + * @exception EUsrGrpException thrown when failed to add the user + * certificate to the given user + * @exception LDAPException thrown when the LDAP internal database is not + * available */ public void addUserCert(IUser identity) throws EUsrGrpException, LDAPException; /** - * 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 - * @param identity the given user whose user certificate is going to be - * be removed. + * 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 + * + * @param identity the given user whose user certificate is going to be be + * removed. * @exception EUsrGrpException thrown when failed to remove user certificate */ public void removeUserCert(IUser identity) throws EUsrGrpException; /** * Removes identity. + * * @param userid the given user id * @exception EUsrGrpException thrown when failed to remove user */ public void removeUser(String userid) throws EUsrGrpException; /** - * Modifies user attributes. Certs are handled separately - * @param identity the given identity which contains all the user - * attributes being modified + * Modifies user attributes. Certs are handled separately + * + * @param identity the given identity which contains all the user attributes + * being modified * @exception EUsrGrpException thrown when modification failed */ public void modifyUser(IUser identity) throws EUsrGrpException; /** * Finds groups that match the filter. + * * @param filter the search filter * @return a list of groups that match the given search filter */ @@ -111,24 +119,27 @@ public interface IUGSubsystem extends ISubsystem, IUsrGrp { /** * Find a group for the given name + * * @param name the given name * @return a group that matched the given name */ public IGroup findGroup(String name); /** - * List groups. This method is more efficient than findGroups because - * this method retrieves group names and description only. Each - * retrieved group just contains group name and description. + * List groups. This method is more efficient than findGroups because this + * method retrieves group names and description only. Each retrieved group + * just contains group name and description. + * * @param filter the search filter - * @return a list of groups, each group just contains group name and - * its description. + * @return a list of groups, each group just contains group name and its + * description. * @exception EUsrGrpException thrown when failed to list groups */ public Enumeration listGroups(String filter) throws EUsrGrpException; /** * Retrieves a group from LDAP for the given group name + * * @param name the given group name * @return a group interface */ @@ -136,37 +147,44 @@ public interface IUGSubsystem extends ISubsystem, IUsrGrp { /** * Retrieves a group from LDAP for the given DN. - * @param DN the given DN + * + * @param DN the given DN * @return a group interface for the given DN. */ public IGroup getGroup(String DN); /** * Checks if the given group exists. + * * @param name the given group name - * @return true if the given group exists in the internal database; otherwise false. + * @return true if the given group exists in the internal database; + * otherwise false. */ public boolean isGroupPresent(String name); /** * Checks if the given context is a member of the given group + * * @param uid the given user id * @param name the given group name - * @return true if the user with the given user id is a member of the given - * group + * @return true if the user with the given user id is a member of the given + * group */ public boolean isMemberOf(String uid, String name); + public boolean isMemberOf(IUser id, String name); /** * Adds a group of identities. + * * @param group the given group * @exception EUsrGrpException thrown when failed to add group. */ public void addGroup(IGroup group) throws EUsrGrpException; /** - * Removes a group. Can't remove SUPER_CERT_ADMINS + * Removes a group. Can't remove SUPER_CERT_ADMINS + * * @param name the given group name * @exception EUsrGrpException thrown when the given group failed to remove */ @@ -174,24 +192,27 @@ public interface IUGSubsystem extends ISubsystem, IUsrGrp { /** * Modifies a group. + * * @param group the given group which contain all group attributes being - * modified. + * modified. * @exception EUsrGrpException thrown when failed to modify group. */ public void modifyGroup(IGroup group) throws EUsrGrpException; /** * Removes the user with the given id from the given group + * * @param grp the given group * @param userid the given user id * @exception EUsrGrpException thrown when failed to remove the user from - * the given group + * the given group */ public void removeUserFromGroup(IGroup grp, String userid) - throws EUsrGrpException; + throws EUsrGrpException; /** * Create user with the given id. + * * @param id the user with the given id. * @return a new user */ @@ -199,6 +220,7 @@ public interface IUGSubsystem extends ISubsystem, IUsrGrp { /** * Create group with the given id. + * * @param id the group with the given id. * @return a new group */ @@ -206,24 +228,29 @@ public interface IUGSubsystem extends ISubsystem, IUsrGrp { /** * Get string representation of the given certificate + * * @param cert given certificate * @return the string representation of the given certificate */ public String getCertificateString(X509Certificate cert); /** - * Searchs for identities that matches the certificate locater - * generated filter. + * Searchs for identities that matches the certificate locater generated + * filter. + * * @param filter search filter * @return an user * @exception EUsrGrpException thrown when failed to find user - * @exception LDAPException thrown when the internal database is not available + * @exception LDAPException thrown when the internal database is not + * available */ - public IUser findUsersByCert(String filter) throws - EUsrGrpException, LDAPException; + public IUser findUsersByCert(String filter) throws EUsrGrpException, + LDAPException; /** - * Get user locator which does the mapping between the user and the certificate. + * Get user locator which does the mapping between the user and the + * certificate. + * * @return CertUserLocator */ public ICertUserLocator getCertUserLocator(); |