| java.lang.Object
 org.ejbca.core.model.UpgradeableDataHashMap
org.ejbca.core.model.ra.raadmin.EndEntityProfile
| EndEntityProfile | | public class EndEntityProfile extends UpgradeableDataHashMap implements java.io.Serializable,Cloneable(Code) | | The model representation of an end entity profile, used in in the ra module
of ejbca web interface.
The algorithm for constants in the EndEntityProfile is:
Values are stored as 100*parameternumber+parameter, so the first COMMONNAME value is 105, the second 205 etc.
Use flags are stored as 10000+100*parameternumber+parameter, so the first USE_COMMONNAME value is 10105, the second 10205 etc.
Required flags are stored as 20000+100*parameternumber+parameter, so the first REQUIRED_COMMONNAME value is 20105, the second 20205 etc.
Modifyable flags are stored as 30000+100*parameternumber+parameter, so the first MODIFYABLE_COMMONNAME value is 30105, the second 30205 etc.
author:
Philip Vendil
version:
$Id: EndEntityProfile.java,v 1.28 2008/01/03 12:52:41 anatom Exp $ |
| Constructor Summary | |
| public | EndEntityProfile()
| | public | EndEntityProfile(boolean emptyprofile)
Creates a default empty end entity profile with all standard fields added to it. |
| Method Summary | |
| public void | addField(String parameter)
| | public void | addField(int parameter)
Function that adds a field to the profile. | | public void | addUserNotification(UserNotification notification)
| | public Object | clone()
| | public void | doesPasswordFulfillEndEntityProfile(String password, boolean clearpwd)
| | public void | doesUserFullfillEndEntityProfile(String username, String password, String dn, String subjectaltname, String subjectdirattr, String email, int certificateprofileid, boolean clearpwd, boolean administrator, boolean keyrecoverable, boolean sendnotification, int tokentype, int hardwaretokenissuerid, int caid, ExtendedInformation ei)
| | public void | doesUserFullfillEndEntityProfileWithoutPassword(String username, String dn, String subjectaltname, String subjectdirattr, String email, int certificateprofileid, boolean administrator, boolean keyrecoverable, boolean sendnotification, int tokentype, int hardwaretokenissuerid, int caid, ExtendedInformation ei)
| | public String | getAutoGeneratedPasswd()
| | public Collection | getAvailableCAs()
Gets a Collection of available CA Ids (as Strings). | | public Collection | getAvailableCertificateProfileIds()
| | public int | getDefaultCA()
| | public float | getLatestVersion()
| | public int | getNumberOfField(String parameter)
Function that returns the number of one kind of field. | | public int | getNumberOfField(int parameter)
| | public int | getPrintedCopies()
| | public String | getPrinterName()
| | public String | getPrinterSVGData()
| | public String | getPrinterSVGFileName()
| | public boolean | getPrintingDefault()
| | public boolean | getPrintingRequired()
| | public boolean | getReUseKeyRevoceredCertificate()
| | public boolean | getReverseFieldChecks()
| | public int | getSubjectAltNameFieldOrderLength()
| | public int[] | getSubjectAltNameFieldsInOrder(int index)
| | public static String[] | getSubjectAltnameProfileFields()
| | public int | getSubjectDNFieldOrderLength()
| | public int[] | getSubjectDNFieldsInOrder(int index)
returns two int : the first is the DN field which is a constant in DN field extractor,
the second is in which order the attribute is, 0 is first OU and 1 can mean second OU (if OU is specified in the first value). | | public static String[] | getSubjectDNProfileFields()
| | public int | getSubjectDirAttrFieldOrderLength()
| | public int[] | getSubjectDirAttrFieldsInOrder(int index)
| | public static String[] | getSubjectDirAttrProfileFields()
| | public boolean | getUse(int parameter, int number)
| | public boolean | getUse(String parameter, int number)
| | public boolean | getUsePrinting()
| | public List | getUserNotifications()
| | public String | getValue(int parameter, int number)
| | public String | getValue(String parameter, int number)
| | public static boolean | isFieldImplemented(int field)
| | public static boolean | isFieldImplemented(String field)
| | public static boolean | isFieldOfType(int fieldNumber, String fieldString)
| | public boolean | isModifyable(int parameter, int number)
| | public boolean | isModifyable(String parameter, int number)
| | public boolean | isRequired(int parameter, int number)
| | public boolean | isRequired(String parameter, int number)
| | public void | removeField(String parameter, int number)
| | public void | removeField(int parameter, int number)
Function that removes a field from the end entity profile. | | public void | removeUserNotification(UserNotification notification)
| | public void | setModifyable(int parameter, int number, boolean changeable)
| | public void | setModifyable(String parameter, int number, boolean changeable)
| | public void | setPrintedCopies(int copies)
| | public void | setPrinterName(String printerName)
| | public void | setPrinterSVGData(String sVGData)
| | public void | setPrinterSVGFileName(String printerSVGFileName)
| | public void | setPrintingDefault(boolean printDefault)
| | public void | setPrintingRequired(boolean printRequired)
| | public void | setReUseKeyRevoceredCertificate(boolean reuse)
| | public void | setRequired(int parameter, int number, boolean isrequired)
| | public void | setRequired(String parameter, int number, boolean isrequired)
| | public void | setReverseFieldChecks(boolean reverse)
| | public void | setUse(int parameter, int number, boolean use)
| | public void | setUse(String parameter, int number, boolean use)
| | public void | setUsePrinting(boolean use)
| | public void | setUserNotifications(List notifications)
| | public void | setValue(int parameter, int number, String value)
| | public void | setValue(String parameter, int number, String value)
| | public void | upgrade()
Implemtation of UpgradableDataHashMap function upgrade. | | public boolean | useAutoGeneratedPasswd()
|
| ALLOWEDREQUESTS | | final public static String ALLOWEDREQUESTS(Code) | | A maximum value of the (optional) counter specifying how many certificate requests can be processed
before user is finalized (status set to GENERATED). Counter is only used when finishUser is
enabled in the CA (by default it is)
|
| AVAILCERTPROFILES | | final public static String AVAILCERTPROFILES(Code) | | A list of available certificate profile names can be retrieved with getAvailableCertificateProfileNames()
|
| AVAILTOKENISSUER | | final public static String AVAILTOKENISSUER(Code) | | |
| CLEARTEXTPASSWORD | | final public static String CLEARTEXTPASSWORD(Code) | | |
| DEFAULTCERTPROFILE | | final public static String DEFAULTCERTPROFILE(Code) | | |
| DEFAULTTOKENISSUER | | final public static String DEFAULTTOKENISSUER(Code) | | |
| FIELDTYPE | | final public static int FIELDTYPE(Code) | | |
| KEYRECOVERABLE | | final public static String KEYRECOVERABLE(Code) | | |
| LATEST_VERSION | | final public static float LATEST_VERSION(Code) | | |
| NUMBER | | final public static int NUMBER(Code) | | |
| SENDNOTIFICATION | | final public static String SENDNOTIFICATION(Code) | | |
| EndEntityProfile | | public EndEntityProfile()(Code) | | Creates a new instance of EndEntity Profile
|
| EndEntityProfile | | public EndEntityProfile(boolean emptyprofile)(Code) | | Creates a default empty end entity profile with all standard fields added to it.
|
| addField | | public void addField(int parameter)(Code) | | Function that adds a field to the profile.
Parameters:
paramter - is the field and one of the field constants. |
| doesUserFullfillEndEntityProfile | | public void doesUserFullfillEndEntityProfile(String username, String password, String dn, String subjectaltname, String subjectdirattr, String email, int certificateprofileid, boolean clearpwd, boolean administrator, boolean keyrecoverable, boolean sendnotification, int tokentype, int hardwaretokenissuerid, int caid, ExtendedInformation ei) throws UserDoesntFullfillEndEntityProfile(Code) | | |
| doesUserFullfillEndEntityProfileWithoutPassword | | public void doesUserFullfillEndEntityProfileWithoutPassword(String username, String dn, String subjectaltname, String subjectdirattr, String email, int certificateprofileid, boolean administrator, boolean keyrecoverable, boolean sendnotification, int tokentype, int hardwaretokenissuerid, int caid, ExtendedInformation ei) throws UserDoesntFullfillEndEntityProfile(Code) | | |
| getAutoGeneratedPasswd | | public String getAutoGeneratedPasswd()(Code) | | |
| getAvailableCAs | | public Collection getAvailableCAs()(Code) | | Gets a Collection of available CA Ids (as Strings).
Use String.valueOf(caidstring) to get the int value of the CA id.
a Collection of String, where the string is an integer. |
| getAvailableCertificateProfileIds | | public Collection getAvailableCertificateProfileIds()(Code) | | Gets a Collection of available certificate profile ids
Use String.valueOf(caidstring) to get the int value
a Collection of String, where the string is an integer. |
| getDefaultCA | | public int getDefaultCA()(Code) | | |
| getLatestVersion | | public float getLatestVersion()(Code) | | Implemtation of UpgradableDataHashMap function getLatestVersion
|
| getNumberOfField | | public int getNumberOfField(String parameter)(Code) | | Function that returns the number of one kind of field.
|
| getNumberOfField | | public int getNumberOfField(int parameter)(Code) | | |
| getPrintedCopies | | public int getPrintedCopies()(Code) | | the number of copies that should be printeddefault is 1. |
| getPrinterName | | public String getPrinterName()(Code) | | the name of the printer that should be used |
| getPrinterSVGData | | public String getPrinterSVGData()(Code) | | the data of the SVG file, if no content havebeen uploaded null is returned |
| getPrinterSVGFileName | | public String getPrinterSVGFileName()(Code) | | filename of the uploaded |
| getPrintingDefault | | public boolean getPrintingDefault()(Code) | | indicationg printing of userdata should be donedefault is false. |
| getPrintingRequired | | public boolean getPrintingRequired()(Code) | | indicationg printing of userdata should be donedefault is false. |
| getReUseKeyRevoceredCertificate | | public boolean getReUseKeyRevoceredCertificate()(Code) | | indicationg if the keyreccovered certificate should be reused or not. |
| getReverseFieldChecks | | public boolean getReverseFieldChecks()(Code) | | indicationg if the profile checks should be reversed or not.default is false. |
| getSubjectAltNameFieldOrderLength | | public int getSubjectAltNameFieldOrderLength()(Code) | | |
| getSubjectAltNameFieldsInOrder | | public int[] getSubjectAltNameFieldsInOrder(int index)(Code) | | |
| getSubjectAltnameProfileFields | | public static String[] getSubjectAltnameProfileFields()(Code) | | |
| getSubjectDNFieldOrderLength | | public int getSubjectDNFieldOrderLength()(Code) | | |
| getSubjectDNFieldsInOrder | | public int[] getSubjectDNFieldsInOrder(int index)(Code) | | returns two int : the first is the DN field which is a constant in DN field extractor,
the second is in which order the attribute is, 0 is first OU and 1 can mean second OU (if OU is specified in the first value).
|
| getSubjectDNProfileFields | | public static String[] getSubjectDNProfileFields()(Code) | | |
| getSubjectDirAttrFieldOrderLength | | public int getSubjectDirAttrFieldOrderLength()(Code) | | |
| getSubjectDirAttrFieldsInOrder | | public int[] getSubjectDirAttrFieldsInOrder(int index)(Code) | | |
| getSubjectDirAttrProfileFields | | public static String[] getSubjectDirAttrProfileFields()(Code) | | |
| getUse | | public boolean getUse(int parameter, int number)(Code) | | |
| getUse | | public boolean getUse(String parameter, int number)(Code) | | |
| getUsePrinting | | public boolean getUsePrinting()(Code) | | indicationg printing of userdata should be donedefault is false. |
| getUserNotifications | | public List getUserNotifications()(Code) | | |
| getValue | | public String getValue(int parameter, int number)(Code) | | |
| isFieldImplemented | | public static boolean isFieldImplemented(int field)(Code) | | |
| isFieldImplemented | | public static boolean isFieldImplemented(String field)(Code) | | |
| isFieldOfType | | public static boolean isFieldOfType(int fieldNumber, String fieldString)(Code) | | |
| isModifyable | | public boolean isModifyable(int parameter, int number)(Code) | | |
| isModifyable | | public boolean isModifyable(String parameter, int number)(Code) | | |
| isRequired | | public boolean isRequired(int parameter, int number)(Code) | | |
| isRequired | | public boolean isRequired(String parameter, int number)(Code) | | |
| removeField | | public void removeField(String parameter, int number)(Code) | | |
| removeField | | public void removeField(int parameter, int number)(Code) | | Function that removes a field from the end entity profile.
Parameters:
parameter - is the field to remove.
Parameters:
number - is the number of field. |
| setModifyable | | public void setModifyable(int parameter, int number, boolean changeable)(Code) | | |
| setModifyable | | public void setModifyable(String parameter, int number, boolean changeable)(Code) | | |
| setPrintedCopies | | public void setPrintedCopies(int copies)(Code) | | |
| setPrinterName | | public void setPrinterName(String printerName)(Code) | | |
| setPrinterSVGData | | public void setPrinterSVGData(String sVGData)(Code) | | |
| setPrinterSVGFileName | | public void setPrinterSVGFileName(String printerSVGFileName)(Code) | | |
| setPrintingDefault | | public void setPrintingDefault(boolean printDefault)(Code) | | |
| setPrintingRequired | | public void setPrintingRequired(boolean printRequired)(Code) | | |
| setReUseKeyRevoceredCertificate | | public void setReUseKeyRevoceredCertificate(boolean reuse)(Code) | | |
| setRequired | | public void setRequired(int parameter, int number, boolean isrequired)(Code) | | |
| setRequired | | public void setRequired(String parameter, int number, boolean isrequired)(Code) | | |
| setReverseFieldChecks | | public void setReverseFieldChecks(boolean reverse)(Code) | | |
| setUse | | public void setUse(int parameter, int number, boolean use)(Code) | | |
| setUse | | public void setUse(String parameter, int number, boolean use)(Code) | | |
| setUsePrinting | | public void setUsePrinting(boolean use)(Code) | | |
| setUserNotifications | | public void setUserNotifications(List notifications)(Code) | | |
| setValue | | public void setValue(int parameter, int number, String value)(Code) | | |
| upgrade | | public void upgrade()(Code) | | Implemtation of UpgradableDataHashMap function upgrade.
|
| useAutoGeneratedPasswd | | public boolean useAutoGeneratedPasswd()(Code) | | |
|
|