Interface IEnrollProfile
-
- All Superinterfaces:
IProfile
- All Known Implementing Classes:
CACertCAEnrollProfile
,CAEnrollProfile
,EnrollProfile
,ServerCertCAEnrollProfile
,UserCertCAEnrollProfile
public interface IEnrollProfile extends IProfile
This interface represents an enrollment profile.An enrollment profile contains a list of enrollment specific input plugins, default policies, constriant policies and output plugins.
This interface also defines a set of enrollment specific attribute names that can be used to retrieve values from an enrollment request.
- Version:
- $Revision$, $Date$
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
CTX_CERT_REQUEST
Name of request attribute that stores the User Supplied Certificate Request.static java.lang.String
CTX_CERT_REQUEST_TYPE
Name of request attribute that stores the User Supplied Certificate Request Type.static java.lang.String
CTX_RENEWAL
Name of request attribute to indicate if this is a renewalstatic java.lang.String
CTX_RENEWAL_SEQ_NUM
Name of the request attribute that stores the sequence number for a renewal request.static java.lang.String
REQ_TYPE_CMC
static java.lang.String
REQ_TYPE_CRMF
static java.lang.String
REQ_TYPE_KEYGEN
static java.lang.String
REQ_TYPE_PKCS10
Possible values for CTX_CERT_REQUEST_TYPE attribute.static java.lang.String
REQUEST_ALGORITHM_OID
Symmetric Key algorithm OID passed into DRM archival servicestatic java.lang.String
REQUEST_ALGORITHM_PARAMS
Symmetric key algorithm params passed into DRM archival servicestatic java.lang.String
REQUEST_ARCHIVE_OPTIONS
Name of request attribute that stores the End-User Supplied PKI Archive Option extension.static java.lang.String
REQUEST_AUTHORITY_ID
ID of requested certificate authority (absense implies host authority)static java.lang.String
REQUEST_CERTINFO
Name of request attribute that stores the certificate template that will be signed and then become a certificate.static java.lang.String
REQUEST_EXTENSIONS
Name of request attribute that stores the End-User Supplied Extensions.static java.lang.String
REQUEST_ISSUED_CERT
Name of request attribute that stores the issued certificate.static java.lang.String
REQUEST_KEY
Name of request attribute that stores the End-User Supplied Key.static java.lang.String
REQUEST_LOCALE
Name of request attribute that stores the End-User Locale.static java.lang.String
REQUEST_SECURITY_DATA
Session wrapped security data passed in to the DRM archival servicestatic java.lang.String
REQUEST_SEQ_NUM
Name of request attribute that stores the sequence number.static java.lang.String
REQUEST_SESSION_KEY
Transport Key wrapped session key passed into DRM archival service.static java.lang.String
REQUEST_SIGNING_ALGORITHM
Name of request attribute that stores the End-User Supplied Signing Algorithm.static java.lang.String
REQUEST_SUBJECT_NAME
Name of request attribute that stores the End-User Supplied Subject Name.static java.lang.String
REQUEST_TRANSPORT_CERT
Name of request attribute that stores the transport certificate.static java.lang.String
REQUEST_USER_DATA
Arbitrary user-supplied data.static java.lang.String
REQUEST_VALIDITY
Name of request attribute that stores the End-User Supplied Validity.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
setDefaultCertInfo(IRequest request)
Set Default X509CertInfo in the request.-
Methods inherited from interface com.netscape.certsrv.profile.IProfile
createContext, createProfileInput, createProfileOutput, createProfilePolicy, createRequests, deleteAllProfileInputs, deleteAllProfileOutputs, deleteAllProfilePolicies, deleteProfileInput, deleteProfileOutput, deleteProfilePolicy, execute, getApprovedBy, getAuthenticator, getAuthenticatorId, getAuthzAcl, getConfigStore, getDescription, getId, getName, getPolicySetId, getProfileInput, getProfileInputIds, getProfileOutput, getProfileOutputIds, getProfilePolicies, getProfilePolicy, getProfilePolicyIds, getProfilePolicySetIds, getRequestorDN, getRequestQueue, init, isRenewal, isVisible, isXmlOutput, populate, populateInput, setAuthenticatorId, setAuthzAcl, setDescription, setId, setName, setRenewal, setVisible, setXMLOutput, submit, validate
-
-
-
-
Field Detail
-
CTX_CERT_REQUEST_TYPE
static final java.lang.String CTX_CERT_REQUEST_TYPE
Name of request attribute that stores the User Supplied Certificate Request Type.- See Also:
- Constant Field Values
-
CTX_CERT_REQUEST
static final java.lang.String CTX_CERT_REQUEST
Name of request attribute that stores the User Supplied Certificate Request.- See Also:
- Constant Field Values
-
REQ_TYPE_PKCS10
static final java.lang.String REQ_TYPE_PKCS10
Possible values for CTX_CERT_REQUEST_TYPE attribute.- See Also:
- Constant Field Values
-
REQ_TYPE_CRMF
static final java.lang.String REQ_TYPE_CRMF
- See Also:
- Constant Field Values
-
REQ_TYPE_CMC
static final java.lang.String REQ_TYPE_CMC
- See Also:
- Constant Field Values
-
REQ_TYPE_KEYGEN
static final java.lang.String REQ_TYPE_KEYGEN
- See Also:
- Constant Field Values
-
REQUEST_LOCALE
static final java.lang.String REQUEST_LOCALE
Name of request attribute that stores the End-User Locale.The value is of type java.util.Locale.
- See Also:
- Constant Field Values
-
REQUEST_SEQ_NUM
static final java.lang.String REQUEST_SEQ_NUM
Name of request attribute that stores the sequence number. Consider a CRMF request that may contain multiple certificate request. The first sub certificate certificate request has a sequence number of 0, the next one has a sequence of 1, and so on.The value is of type java.lang.Integer.
- See Also:
- Constant Field Values
-
CTX_RENEWAL_SEQ_NUM
static final java.lang.String CTX_RENEWAL_SEQ_NUM
Name of the request attribute that stores the sequence number for a renewal request. Only one request at a time is permitted for a renewal. This value corresponds to the sequence number (and hence the appropriate certificate) of the original request- See Also:
- Constant Field Values
-
CTX_RENEWAL
static final java.lang.String CTX_RENEWAL
Name of request attribute to indicate if this is a renewal- See Also:
- Constant Field Values
-
REQUEST_KEY
static final java.lang.String REQUEST_KEY
Name of request attribute that stores the End-User Supplied Key.The value is of type netscape.security.x509.CertificateX509Key
- See Also:
- Constant Field Values
-
REQUEST_SUBJECT_NAME
static final java.lang.String REQUEST_SUBJECT_NAME
Name of request attribute that stores the End-User Supplied Subject Name.The value is of type netscape.security.x509.CertificateSubjectName
- See Also:
- Constant Field Values
-
REQUEST_VALIDITY
static final java.lang.String REQUEST_VALIDITY
Name of request attribute that stores the End-User Supplied Validity.The value is of type netscape.security.x509.CertificateValidity
- See Also:
- Constant Field Values
-
REQUEST_SIGNING_ALGORITHM
static final java.lang.String REQUEST_SIGNING_ALGORITHM
Name of request attribute that stores the End-User Supplied Signing Algorithm.The value is of type netscape.security.x509.CertificateAlgorithmId
- See Also:
- Constant Field Values
-
REQUEST_EXTENSIONS
static final java.lang.String REQUEST_EXTENSIONS
Name of request attribute that stores the End-User Supplied Extensions.The value is of type netscape.security.x509.CertificateExtensions
- See Also:
- Constant Field Values
-
REQUEST_ARCHIVE_OPTIONS
static final java.lang.String REQUEST_ARCHIVE_OPTIONS
Name of request attribute that stores the End-User Supplied PKI Archive Option extension. This extension is extracted from a CRMF request that has the user-provided private key.The value is of type byte []
- See Also:
- Constant Field Values
-
REQUEST_CERTINFO
static final java.lang.String REQUEST_CERTINFO
Name of request attribute that stores the certificate template that will be signed and then become a certificate.The value is of type netscape.security.x509.X509CertInfo
- See Also:
- Constant Field Values
-
REQUEST_ISSUED_CERT
static final java.lang.String REQUEST_ISSUED_CERT
Name of request attribute that stores the issued certificate.The value is of type netscape.security.x509.X509CertImpl
- See Also:
- Constant Field Values
-
REQUEST_TRANSPORT_CERT
static final java.lang.String REQUEST_TRANSPORT_CERT
Name of request attribute that stores the transport certificate.The value is of type String including base64 encoded certificate.
- See Also:
- Constant Field Values
-
REQUEST_SECURITY_DATA
static final java.lang.String REQUEST_SECURITY_DATA
Session wrapped security data passed in to the DRM archival service- See Also:
- Constant Field Values
-
REQUEST_SESSION_KEY
static final java.lang.String REQUEST_SESSION_KEY
Transport Key wrapped session key passed into DRM archival service.- See Also:
- Constant Field Values
-
REQUEST_ALGORITHM_OID
static final java.lang.String REQUEST_ALGORITHM_OID
Symmetric Key algorithm OID passed into DRM archival service- See Also:
- Constant Field Values
-
REQUEST_ALGORITHM_PARAMS
static final java.lang.String REQUEST_ALGORITHM_PARAMS
Symmetric key algorithm params passed into DRM archival service- See Also:
- Constant Field Values
-
REQUEST_AUTHORITY_ID
static final java.lang.String REQUEST_AUTHORITY_ID
ID of requested certificate authority (absense implies host authority)- See Also:
- Constant Field Values
-
REQUEST_USER_DATA
static final java.lang.String REQUEST_USER_DATA
Arbitrary user-supplied data.- See Also:
- Constant Field Values
-
-
Method Detail
-
setDefaultCertInfo
void setDefaultCertInfo(IRequest request) throws EProfileException
Set Default X509CertInfo in the request.- Parameters:
request
- profile-based certificate request.- Throws:
EProfileException
- failed to set the X509CertInfo.
-
-