diff options
Diffstat (limited to 'base/common/src/com/netscape/certsrv/usrgrp')
11 files changed, 80 insertions, 80 deletions
diff --git a/base/common/src/com/netscape/certsrv/usrgrp/Certificates.java b/base/common/src/com/netscape/certsrv/usrgrp/Certificates.java index fdfa3cd38..c8719b509 100644 --- a/base/common/src/com/netscape/certsrv/usrgrp/Certificates.java +++ b/base/common/src/com/netscape/certsrv/usrgrp/Certificates.java @@ -22,7 +22,7 @@ import java.security.cert.X509Certificate; /** * This class defines the strong authentication basic elements, * the X509 certificates. - * + * * @version $Revision$, $Date$ */ public class Certificates { @@ -31,7 +31,7 @@ public class Certificates { /** * Constructs strong authenticator. - * + * * @param certs a list of X509Certificates */ public Certificates(X509Certificate certs[]) { @@ -40,7 +40,7 @@ public class Certificates { /** * Retrieves certificates. - * + * * @return a list of X509Certificates */ public X509Certificate[] getCertificates() { diff --git a/base/common/src/com/netscape/certsrv/usrgrp/EUsrGrpException.java b/base/common/src/com/netscape/certsrv/usrgrp/EUsrGrpException.java index a25a1a6b3..bae8ba085 100644 --- a/base/common/src/com/netscape/certsrv/usrgrp/EUsrGrpException.java +++ b/base/common/src/com/netscape/certsrv/usrgrp/EUsrGrpException.java @@ -22,7 +22,7 @@ import com.netscape.certsrv.base.EBaseException; /** * A class represents a Identity exception. * <P> - * + * * @version $Revision$, $Date$ */ public class EUsrGrpException extends EBaseException { @@ -38,7 +38,7 @@ public class EUsrGrpException extends EBaseException { /** * Constructs a usr/grp management exception - * + * * @param msgFormat exception details in message string format * <P> */ @@ -48,7 +48,7 @@ public class EUsrGrpException extends EBaseException { /** * Constructs a Identity exception. - * + * * @param msgFormat exception details in message string format * @param param message string parameter * <P> @@ -59,7 +59,7 @@ public class EUsrGrpException extends EBaseException { /** * Constructs a Identity exception. - * + * * @param e system exception * <P> */ @@ -69,7 +69,7 @@ public class EUsrGrpException extends EBaseException { /** * Constructs a Identity exception. - * + * * @param msgFormat exception details in message string format * @param params list of message format parameters * <P> diff --git a/base/common/src/com/netscape/certsrv/usrgrp/ICertUserLocator.java b/base/common/src/com/netscape/certsrv/usrgrp/ICertUserLocator.java index dbbd068c4..ccf504229 100644 --- a/base/common/src/com/netscape/certsrv/usrgrp/ICertUserLocator.java +++ b/base/common/src/com/netscape/certsrv/usrgrp/ICertUserLocator.java @@ -24,14 +24,14 @@ import com.netscape.certsrv.ldap.ELdapException; /** * This interface defines a certificate mapping strategy to locate * a user - * + * * @version $Revision$, $Date$ */ public interface ICertUserLocator { /** * Returns a user whose certificates match with the given certificates - * + * * @return an user interface * @exception EUsrGrpException thrown when failed to build user * @exception LDAPException thrown when LDAP internal database is not available @@ -42,7 +42,7 @@ public interface ICertUserLocator { /** * Retrieves description. - * + * * @return description */ public String getDescription(); diff --git a/base/common/src/com/netscape/certsrv/usrgrp/IGroup.java b/base/common/src/com/netscape/certsrv/usrgrp/IGroup.java index 522d0fc89..86bf5c878 100644 --- a/base/common/src/com/netscape/certsrv/usrgrp/IGroup.java +++ b/base/common/src/com/netscape/certsrv/usrgrp/IGroup.java @@ -24,35 +24,35 @@ import com.netscape.certsrv.base.IAttrSet; /** * This interface defines the basic interfaces for * an identity group. (get/set methods for a group entry attributes) - * + * * @version $Revision$, $Date$ */ public interface IGroup extends IAttrSet, IGroupConstants { /** * Retrieves the group name. - * + * * @return the group name */ public String getName(); /** * Retrieves group identifier. - * + * * @return the group id */ public String getGroupID(); /** * Retrieves group description. - * + * * @return description */ public String getDescription(); /** * Checks if the given name is member of this group. - * + * * @param name the given name * @return true if the given name is the member of this group; otherwise false. */ @@ -60,14 +60,14 @@ public interface IGroup extends IAttrSet, IGroupConstants { /** * Adds new member. - * + * * @param name the given name. */ public void addMemberName(String name); /** * Retrieves a list of member names. - * + * * @return a list of member names for this group. */ public Enumeration<String> getMemberNames(); diff --git a/base/common/src/com/netscape/certsrv/usrgrp/IGroupConstants.java b/base/common/src/com/netscape/certsrv/usrgrp/IGroupConstants.java index 22d89455c..7118db230 100644 --- a/base/common/src/com/netscape/certsrv/usrgrp/IGroupConstants.java +++ b/base/common/src/com/netscape/certsrv/usrgrp/IGroupConstants.java @@ -19,7 +19,7 @@ package com.netscape.certsrv.usrgrp; /** * This interface defines the attribute names for a group entry - * + * * @version $Revision$, $Date$ */ public interface IGroupConstants { diff --git a/base/common/src/com/netscape/certsrv/usrgrp/IIdEvaluator.java b/base/common/src/com/netscape/certsrv/usrgrp/IIdEvaluator.java index 41209b4b9..5c4885573 100644 --- a/base/common/src/com/netscape/certsrv/usrgrp/IIdEvaluator.java +++ b/base/common/src/com/netscape/certsrv/usrgrp/IIdEvaluator.java @@ -20,7 +20,7 @@ package com.netscape.certsrv.usrgrp; /** * A class represents an ID evaluator. * <P> - * + * * @version $Revision$, $Date$ */ public interface IIdEvaluator { @@ -28,7 +28,7 @@ public interface IIdEvaluator { /** * Evaluates if the given value satisfies the ID evaluation: * is a user a member of a group - * + * * @param type the type of evaluator, in this case, it is group * @param id the user id for the given user * @param op operator, only "=" and "!=" are supported diff --git a/base/common/src/com/netscape/certsrv/usrgrp/IUGSubsystem.java b/base/common/src/com/netscape/certsrv/usrgrp/IUGSubsystem.java index 282d672f1..aa8b65575 100644 --- a/base/common/src/com/netscape/certsrv/usrgrp/IUGSubsystem.java +++ b/base/common/src/com/netscape/certsrv/usrgrp/IUGSubsystem.java @@ -28,7 +28,7 @@ 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. - * + * * @version $Revision$, $Date$ */ public interface IUGSubsystem extends ISubsystem, IUsrGrp { @@ -45,7 +45,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 */ @@ -53,7 +53,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,7 +62,7 @@ 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 @@ -71,7 +71,7 @@ public interface IUGSubsystem extends ISubsystem, IUsrGrp { /** * 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 @@ -91,7 +91,7 @@ public interface IUGSubsystem extends ISubsystem, IUsrGrp { * 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 @@ -100,7 +100,7 @@ public interface IUGSubsystem extends ISubsystem, IUsrGrp { /** * Removes identity. - * + * * @param userid the given user id * @exception EUsrGrpException thrown when failed to remove user */ @@ -108,7 +108,7 @@ public interface IUGSubsystem extends ISubsystem, IUsrGrp { /** * 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 @@ -117,7 +117,7 @@ public interface IUGSubsystem extends ISubsystem, IUsrGrp { /** * Finds groups that match the filter. - * + * * @param filter the search filter * @return a list of groups that match the given search filter */ @@ -125,7 +125,7 @@ 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 */ @@ -135,7 +135,7 @@ public interface IUGSubsystem extends ISubsystem, IUsrGrp { * 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. @@ -145,7 +145,7 @@ public interface IUGSubsystem extends ISubsystem, IUsrGrp { /** * Retrieves a group from LDAP for the given group name - * + * * @param name the given group name * @return a group interface */ @@ -153,7 +153,7 @@ public interface IUGSubsystem extends ISubsystem, IUsrGrp { /** * Retrieves a group from LDAP for the given DN. - * + * * @param DN the given DN * @return a group interface for the given DN. */ @@ -161,7 +161,7 @@ public interface IUGSubsystem extends ISubsystem, IUsrGrp { /** * 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. */ @@ -169,7 +169,7 @@ public interface IUGSubsystem extends ISubsystem, IUsrGrp { /** * 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 @@ -181,7 +181,7 @@ public interface IUGSubsystem extends ISubsystem, IUsrGrp { /** * Adds a group of identities. - * + * * @param group the given group * @exception EUsrGrpException thrown when failed to add group. */ @@ -189,7 +189,7 @@ public interface IUGSubsystem extends ISubsystem, IUsrGrp { /** * 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 */ @@ -197,7 +197,7 @@ public interface IUGSubsystem extends ISubsystem, IUsrGrp { /** * Modifies a group. - * + * * @param group the given group which contain all group attributes being * modified. * @exception EUsrGrpException thrown when failed to modify group. @@ -206,7 +206,7 @@ public interface IUGSubsystem extends ISubsystem, IUsrGrp { /** * 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 @@ -217,7 +217,7 @@ public interface IUGSubsystem extends ISubsystem, IUsrGrp { /** * Create user with the given id. - * + * * @param id the user with the given id. * @return a new user */ @@ -225,7 +225,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 */ @@ -233,7 +233,7 @@ 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 */ @@ -242,7 +242,7 @@ public interface IUGSubsystem extends ISubsystem, IUsrGrp { /** * 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 @@ -253,7 +253,7 @@ public interface IUGSubsystem extends ISubsystem, IUsrGrp { /** * Get user locator which does the mapping between the user and the certificate. - * + * * @return CertUserLocator */ public ICertUserLocator getCertUserLocator(); diff --git a/base/common/src/com/netscape/certsrv/usrgrp/IUser.java b/base/common/src/com/netscape/certsrv/usrgrp/IUser.java index 9370a6718..7c957fd8a 100644 --- a/base/common/src/com/netscape/certsrv/usrgrp/IUser.java +++ b/base/common/src/com/netscape/certsrv/usrgrp/IUser.java @@ -24,147 +24,147 @@ import com.netscape.certsrv.base.IAttrSet; /** * This interface defines the basic interfaces for * a user identity. (get/set methods for a user entry attributes) - * + * * @version $Revision$, $Date$ */ public interface IUser extends IAttrSet, IUserConstants { /** * Retrieves name. - * + * * @return user name */ public String getName(); /** * Retrieves user identifier. - * + * * @return user id */ public String getUserID(); /** * Retrieves user full name. - * + * * @return user fullname */ public String getFullName(); /** * Retrieves user phonenumber. - * + * * @return user phonenumber */ public String getPhone(); /** * Retrieves user state - * + * * @return user state */ public String getState(); /** * Sets user full name. - * + * * @param name the given full name */ public void setFullName(String name); /** * Sets user ldap DN. - * + * * @param userdn the given user DN */ public void setUserDN(String userdn); /** * Gets user ldap dn - * + * * @return user DN */ public String getUserDN(); /** * Retrieves user password. - * + * * @return user password */ public String getPassword(); /** * Sets user password. - * + * * @param p the given password */ public void setPassword(String p); /** * Sets user phonenumber - * + * * @param p user phonenumber */ public void setPhone(String p); /** * Sets user state - * + * * @param p the given user state */ public void setState(String p); /** * Sets user type - * + * * @param userType the given user type */ public void setUserType(String userType); /** * Gets user email address. - * + * * @return email address */ public String getEmail(); /** * Sets user email address. - * + * * @param email the given email address */ public void setEmail(String email); /** * Gets list of certificates from this user - * + * * @return list of certificates */ public X509Certificate[] getX509Certificates(); /** * Sets list of certificates in this user - * + * * @param certs list of certificates */ public void setX509Certificates(X509Certificate certs[]); /** * Get certificate DN - * + * * @return certificate DN */ public String getCertDN(); /** * Set certificate DN - * + * * @param userdn the given DN */ public void setCertDN(String userdn); /** * Get user type - * + * * @return user type. */ public String getUserType(); diff --git a/base/common/src/com/netscape/certsrv/usrgrp/IUserConstants.java b/base/common/src/com/netscape/certsrv/usrgrp/IUserConstants.java index f66f01c73..dbfe9a38b 100644 --- a/base/common/src/com/netscape/certsrv/usrgrp/IUserConstants.java +++ b/base/common/src/com/netscape/certsrv/usrgrp/IUserConstants.java @@ -19,7 +19,7 @@ package com.netscape.certsrv.usrgrp; /** * This interface defines the attribute names for a user entry - * + * * @version $Revision$, $Date$ */ public interface IUserConstants { diff --git a/base/common/src/com/netscape/certsrv/usrgrp/IUsrGrp.java b/base/common/src/com/netscape/certsrv/usrgrp/IUsrGrp.java index f6cef0d46..d5d37614e 100644 --- a/base/common/src/com/netscape/certsrv/usrgrp/IUsrGrp.java +++ b/base/common/src/com/netscape/certsrv/usrgrp/IUsrGrp.java @@ -22,28 +22,28 @@ import netscape.ldap.LDAPException; /** * This interface defines the basic capabilities of * a usr/group manager. (get/add/modify/remove users or groups) - * + * * @version $Revision$, $Date$ */ public interface IUsrGrp extends IIdEvaluator { /** * Retrieves usr/grp manager identifier. - * + * * @return id */ public String getId(); /** * Retrieves the description - * + * * @return description */ public String getDescription(); /** * Retrieves an identity - * + * * @param userid the user id for the given user * @return user interface */ @@ -56,7 +56,7 @@ public interface IUsrGrp extends IIdEvaluator { * user.setPassword("secret"); * usrgrp.addUser(user); * </code> - * + * * @param user an user interface * @exception EUsrGrpException thrown when some of the user attribute values * are null @@ -67,7 +67,7 @@ public interface IUsrGrp extends IIdEvaluator { /** * Removes a user. - * + * * @param userid the user id for the given user * @exception EUsrGrpException thrown when failed to remove user */ @@ -75,7 +75,7 @@ public interface IUsrGrp extends IIdEvaluator { /** * Modifies user. - * + * * @param user the user interface which contains the modified information * @exception EUsrGrpException thrown when failed to modify user */ @@ -83,7 +83,7 @@ public interface IUsrGrp extends IIdEvaluator { /** * Retrieves an identity group - * + * * @param groupid the given group id. * @return the group interface */ @@ -91,7 +91,7 @@ public interface IUsrGrp extends IIdEvaluator { /** * Adds a group - * + * * @param group the given group * @exception EUsrGrpException thrown when failed to add the group. */ @@ -99,7 +99,7 @@ public interface IUsrGrp extends IIdEvaluator { /** * Modifies a group - * + * * @param group the given group contains the new information for modification. * @exception EUsrGrpException thrown when failed to modify the group. */ @@ -107,7 +107,7 @@ public interface IUsrGrp extends IIdEvaluator { /** * Removes a group - * + * * @param name the group name * @exception EUsrGrpException thrown when failed to remove the given * group. diff --git a/base/common/src/com/netscape/certsrv/usrgrp/UsrGrpResources.java b/base/common/src/com/netscape/certsrv/usrgrp/UsrGrpResources.java index 11a3da23b..f85f7116c 100644 --- a/base/common/src/com/netscape/certsrv/usrgrp/UsrGrpResources.java +++ b/base/common/src/com/netscape/certsrv/usrgrp/UsrGrpResources.java @@ -22,7 +22,7 @@ import java.util.ListResourceBundle; /** * A class represents a resource bundle for the * user/group manager - * + * * @deprecated * @version $Revision$, $Date$ */ @@ -30,7 +30,7 @@ public class UsrGrpResources extends ListResourceBundle { /** * Returns the content of this resource. - * + * * @return the content of this resource. */ public Object[][] getContents() { |