public abstract class Profile
extends java.lang.Object
The input policy is for building the enrollment page.
The default policy is for populating user-supplied and system-supplied values into the request.
The constraint policy is for validating the request before processing.
The output policy is for building the result page.
Each profile can have multiple policy set. Each set is composed of zero or more default policies and zero or more constraint policies.
Modifier and Type | Field and Description |
---|---|
static org.slf4j.Logger |
logger |
protected java.lang.String |
mAuthInstanceId |
protected java.lang.String |
mAuthzAcl |
protected IConfigStore |
mConfig |
protected java.lang.String |
mId |
protected java.util.Vector<java.lang.String> |
mInputIds |
protected java.util.Vector<java.lang.String> |
mInputNames |
protected java.util.Hashtable<java.lang.String,ProfileInput> |
mInputs |
protected java.util.Vector<java.lang.String> |
mOutputIds |
protected java.util.Hashtable<java.lang.String,ProfileOutput> |
mOutputs |
protected java.util.Hashtable<java.lang.String,java.util.Vector<ProfilePolicy>> |
mPolicySet |
protected java.util.Vector<java.lang.String> |
mUpdaterIds |
protected java.util.Hashtable<java.lang.String,IProfileUpdater> |
mUpdaters |
static java.lang.String |
PROP_CLASS_ID |
static java.lang.String |
PROP_CONSTRAINT |
static java.lang.String |
PROP_DEFAULT |
static java.lang.String |
PROP_DESC |
static java.lang.String |
PROP_ENABLE |
static java.lang.String |
PROP_ENABLE_BY |
static java.lang.String |
PROP_GENERIC_EXT_DEFAULT |
static java.lang.String |
PROP_INPUT |
static java.lang.String |
PROP_INPUT_LIST |
static java.lang.String |
PROP_INSTANCE_ID |
static java.lang.String |
PROP_IS_RENEWAL |
static java.lang.String |
PROP_NAME |
static java.lang.String |
PROP_NO_CONSTRAINT |
static java.lang.String |
PROP_NO_DEFAULT |
static java.lang.String |
PROP_OUTPUT |
static java.lang.String |
PROP_OUTPUT_LIST |
static java.lang.String |
PROP_PARAMS |
static java.lang.String |
PROP_POLICY_LIST |
static java.lang.String |
PROP_UPDATER_LIST |
static java.lang.String |
PROP_VISIBLE |
static java.lang.String |
PROP_XML_OUTPUT |
protected com.netscape.cmscore.registry.PluginRegistry |
registry |
protected static Logger |
signedAuditLogger |
Constructor and Description |
---|
Profile() |
Modifier and Type | Method and Description |
---|---|
void |
addInputName(java.lang.String name) |
protected java.lang.String |
auditSubjectID()
Signed Audit Log Subject ID
This method is used to obtain the "SubjectID" for
a signed audit log message.
|
ProfileInput |
createProfileInput(java.lang.String id,
java.lang.String inputID,
NameValuePairs nvps)
Creates a input policy.
|
ProfileInput |
createProfileInput(java.lang.String id,
java.lang.String inputId,
NameValuePairs nvps,
boolean createConfig) |
ProfileOutput |
createProfileOutput(java.lang.String id,
java.lang.String outputID,
NameValuePairs nvps)
Creates a output policy.
|
ProfileOutput |
createProfileOutput(java.lang.String id,
java.lang.String outputId,
NameValuePairs nvps,
boolean createConfig) |
ProfilePolicy |
createProfilePolicy(java.lang.String setId,
java.lang.String id,
java.lang.String defaultClassId,
java.lang.String constraintClassId)
Creates a profile policy.
|
ProfilePolicy |
createProfilePolicy(java.lang.String setId,
java.lang.String id,
java.lang.String defaultClassId,
java.lang.String constraintClassId,
boolean createConfig) |
abstract IRequest[] |
createRequests(java.util.Map<java.lang.String,java.lang.String> ctx,
java.util.Locale locale)
Creates one or more requests.
|
void |
deleteAllProfileInputs()
Delete all profile inputs
|
void |
deleteAllProfileOutputs()
Delete all profile inputs
|
void |
deleteAllProfilePolicies()
Delete all profile policies
|
void |
deleteProfileInput(java.lang.String inputId)
Deletes input policy by id.
|
void |
deleteProfileOutput(java.lang.String outputId)
Deletes output policy by id.
|
void |
deleteProfilePolicy(java.lang.String setId,
java.lang.String policyId)
Deletes a policy.
|
void |
execute(IRequest request)
Process a request after validation.
|
java.lang.String |
getApprovedBy()
Retrieves the user id of the person who
approves this profile.
|
java.lang.String |
getAuthenticatorId()
Retrieves the instance id of the authenticator for this profile.
|
java.lang.String |
getAuthzAcl() |
IConfigStore |
getConfigStore()
Retrieves the configuration store of this profile.
|
java.lang.String |
getDescription(java.util.Locale locale)
Returns the profile description.
|
java.lang.String |
getId()
Returns the identifier of this profile.
|
java.lang.String |
getInput(java.lang.String name,
java.util.Locale locale,
IRequest request) |
IDescriptor |
getInputDescriptor(java.lang.String name) |
java.util.Enumeration<java.lang.String> |
getInputNames() |
java.lang.String |
getName(java.util.Locale locale)
Returns the profile name.
|
java.util.Vector<ProfilePolicy> |
getPolicies(java.lang.String setId) |
abstract java.lang.String |
getPolicySetId(IRequest req)
Retrieves a default set id for the given request.
|
ProfileInput |
getProfileInput(java.lang.String id)
Retrieves input policy by id.
|
java.util.Enumeration<java.lang.String> |
getProfileInputIds()
Retrieves a list of input policy IDs.
|
ProfileOutput |
getProfileOutput(java.lang.String id)
Retrieves output policy by id.
|
java.util.Enumeration<java.lang.String> |
getProfileOutputIds()
Retrieves a list of output policy IDs.
|
java.util.Enumeration<ProfilePolicy> |
getProfilePolicies(java.lang.String setId)
Returns a list of profile policies.
|
ProfilePolicy |
getProfilePolicy(java.lang.String setId,
java.lang.String id)
Retrieves a policy.
|
java.util.Enumeration<java.lang.String> |
getProfilePolicyIds(java.lang.String setId)
Retrieves all the policy id within a set.
|
java.util.Enumeration<java.lang.String> |
getProfilePolicySetIds()
Returns the profile policy set identifiers.
|
IProfileUpdater |
getProfileUpdater(java.lang.String name) |
java.util.Enumeration<java.lang.String> |
getProfileUpdaterIds() |
java.lang.String |
getRequestorDN(IRequest request)
Retrieves a localized string that represents
requestor's distinguished name.
|
abstract IRequestQueue |
getRequestQueue()
Retrieves the request queue that is associated with
this profile.
|
void |
init(IConfigStore config)
Initializes this profile.
|
boolean |
isEnable() |
java.lang.String |
isRenewal()
Is this a renewal profile
|
boolean |
isVisible()
Checks if this profile is end-user profile or not.
|
java.lang.String |
isXmlOutput()
is output going to be in xml?
|
void |
populate(IRequest request)
Passes the request to the set of default policies that
populate the profile information against the profile.
|
void |
populateInput(java.util.Map<java.lang.String,java.lang.String> ctx,
IRequest request)
Populates user-supplied input values into the requests.
|
void |
setAuthenticatorId(java.lang.String id)
Sets the instance id of the authenticator for this profile.
|
void |
setAuthzAcl(java.lang.String id) |
void |
setDescription(java.util.Locale locale,
java.lang.String desc)
Returns the profile description.
|
void |
setId(java.lang.String id)
Sets id of this profile.
|
void |
setInput(java.lang.String name,
java.util.Locale locale,
IRequest request,
java.lang.String value) |
void |
setName(java.util.Locale locale,
java.lang.String name)
Returns the profile name.
|
void |
setRenewal(boolean renewal) |
void |
setVisible(boolean v)
Sets this profile end-user profile or not.
|
void |
setXMLOutput(boolean xmlOutput) |
abstract void |
submit(IAuthToken token,
IRequest request)
Handles end-user request submission.
|
void |
validate(IRequest request)
Passes the request to the set of constraint policies
that validate the request against the profile.
|
public static org.slf4j.Logger logger
protected static Logger signedAuditLogger
public static final java.lang.String PROP_ENABLE
public static final java.lang.String PROP_ENABLE_BY
public static final java.lang.String PROP_IS_RENEWAL
public static final java.lang.String PROP_XML_OUTPUT
public static final java.lang.String PROP_VISIBLE
public static final java.lang.String PROP_INPUT_LIST
public static final java.lang.String PROP_OUTPUT_LIST
public static final java.lang.String PROP_UPDATER_LIST
public static final java.lang.String PROP_POLICY_LIST
public static final java.lang.String PROP_DEFAULT
public static final java.lang.String PROP_CONSTRAINT
public static final java.lang.String PROP_INPUT
public static final java.lang.String PROP_OUTPUT
public static final java.lang.String PROP_CLASS_ID
public static final java.lang.String PROP_INSTANCE_ID
public static final java.lang.String PROP_PARAMS
public static final java.lang.String PROP_NAME
public static final java.lang.String PROP_DESC
public static final java.lang.String PROP_NO_DEFAULT
public static final java.lang.String PROP_NO_CONSTRAINT
public static final java.lang.String PROP_GENERIC_EXT_DEFAULT
protected IConfigStore mConfig
protected com.netscape.cmscore.registry.PluginRegistry registry
protected java.util.Vector<java.lang.String> mInputNames
protected java.util.Hashtable<java.lang.String,ProfileInput> mInputs
protected java.util.Vector<java.lang.String> mInputIds
protected java.util.Hashtable<java.lang.String,ProfileOutput> mOutputs
protected java.util.Vector<java.lang.String> mOutputIds
protected java.util.Hashtable<java.lang.String,IProfileUpdater> mUpdaters
protected java.util.Vector<java.lang.String> mUpdaterIds
protected java.lang.String mAuthInstanceId
protected java.lang.String mId
protected java.lang.String mAuthzAcl
protected java.util.Hashtable<java.lang.String,java.util.Vector<ProfilePolicy>> mPolicySet
public boolean isEnable()
public java.lang.String isRenewal()
public void setRenewal(boolean renewal)
public java.lang.String isXmlOutput()
public void setXMLOutput(boolean xmlOutput)
public java.lang.String getApprovedBy()
public void setId(java.lang.String id)
id
- profile identifierpublic java.lang.String getId()
public java.lang.String getRequestorDN(IRequest request)
request
- requestpublic java.lang.String getAuthenticatorId()
public void setAuthenticatorId(java.lang.String id)
id
- authenticator instance idpublic void setAuthzAcl(java.lang.String id)
public java.lang.String getAuthzAcl()
public void init(IConfigStore config) throws EBaseException
config
- configuration store for this profileEBaseException
- failed to initializepublic abstract IRequestQueue getRequestQueue()
public IConfigStore getConfigStore()
public java.util.Enumeration<java.lang.String> getInputNames()
public java.util.Enumeration<java.lang.String> getProfileUpdaterIds()
public IProfileUpdater getProfileUpdater(java.lang.String name)
public java.util.Enumeration<java.lang.String> getProfileOutputIds()
public ProfileOutput getProfileOutput(java.lang.String id)
id
- output policy idpublic java.util.Enumeration<java.lang.String> getProfileInputIds()
public ProfileInput getProfileInput(java.lang.String id)
id
- input policy idpublic void addInputName(java.lang.String name)
public IDescriptor getInputDescriptor(java.lang.String name)
public java.lang.String getInput(java.lang.String name, java.util.Locale locale, IRequest request) throws EProfileException
EProfileException
public void setInput(java.lang.String name, java.util.Locale locale, IRequest request, java.lang.String value) throws EProfileException
EProfileException
public java.util.Enumeration<java.lang.String> getProfilePolicySetIds()
public void deleteProfilePolicy(java.lang.String setId, java.lang.String policyId) throws EProfileException
setId
- id of the policy setpolicyId
- id of policy to deleteEProfileException
- failed to deletepublic void deleteAllProfilePolicies() throws EProfileException
EProfileException
public void deleteProfileInput(java.lang.String inputId) throws EProfileException
inputId
- id of the input policyEProfileException
- failed to deletepublic void deleteAllProfileInputs() throws EProfileException
EProfileException
public void deleteProfileOutput(java.lang.String outputId) throws EProfileException
outputId
- id of the output policyEProfileException
- failed to deletepublic void deleteAllProfileOutputs() throws EProfileException
EProfileException
public ProfileOutput createProfileOutput(java.lang.String id, java.lang.String outputID, NameValuePairs nvps) throws EProfileException
id
- output policy idoutputID
- id of the registered output implementationnvps
- default parametersEProfileException
- failed to createpublic ProfileOutput createProfileOutput(java.lang.String id, java.lang.String outputId, NameValuePairs nvps, boolean createConfig) throws EProfileException
EProfileException
public ProfileInput createProfileInput(java.lang.String id, java.lang.String inputID, NameValuePairs nvps) throws EProfileException
id
- input policy idinputID
- id of the registered input implementationnvps
- default parametersEProfileException
- failed to createpublic ProfileInput createProfileInput(java.lang.String id, java.lang.String inputId, NameValuePairs nvps, boolean createConfig) throws EProfileException
EProfileException
public ProfilePolicy createProfilePolicy(java.lang.String setId, java.lang.String id, java.lang.String defaultClassId, java.lang.String constraintClassId) throws EProfileException
setId
- id of the policy set that owns this policyid
- policy iddefaultClassId
- id of the registered default implementationconstraintClassId
- id of the registered constraint implementationEProfileException
- failed to create policypublic ProfilePolicy createProfilePolicy(java.lang.String setId, java.lang.String id, java.lang.String defaultClassId, java.lang.String constraintClassId, boolean createConfig) throws EProfileException
EProfileException
public ProfilePolicy getProfilePolicy(java.lang.String setId, java.lang.String id)
setId
- set idid
- policy idpublic boolean isVisible()
public void setVisible(boolean v)
v
- end-user profile or notpublic java.lang.String getName(java.util.Locale locale)
locale
- end-user localepublic void setName(java.util.Locale locale, java.lang.String name)
locale
- end-user localename
- profile namepublic abstract IRequest[] createRequests(java.util.Map<java.lang.String,java.lang.String> ctx, java.util.Locale locale) throws java.lang.Exception
ctx
- profile contextlocale
- user localejava.lang.Exception
- failed to create requestspublic java.lang.String getDescription(java.util.Locale locale)
locale
- end-user localepublic void setDescription(java.util.Locale locale, java.lang.String desc)
locale
- end-user localedesc
- profile descriptionpublic void populateInput(java.util.Map<java.lang.String,java.lang.String> ctx, IRequest request) throws java.lang.Exception
ctx
- profile contextrequest
- requestjava.lang.Exception
- failed to populatepublic java.util.Vector<ProfilePolicy> getPolicies(java.lang.String setId)
public abstract java.lang.String getPolicySetId(IRequest req)
req
- requestpublic void populate(IRequest request) throws EProfileException
request
- requestEProfileException
- failed to populate default valuespublic void validate(IRequest request) throws ERejectException
request
- requestERejectException
- validation violationpublic java.util.Enumeration<ProfilePolicy> getProfilePolicies(java.lang.String setId)
setId
- set idpublic java.util.Enumeration<java.lang.String> getProfilePolicyIds(java.lang.String setId)
setId
- set idpublic void execute(IRequest request) throws EProfileException
request
- request to be processedEProfileException
- failed to processpublic abstract void submit(IAuthToken token, IRequest request) throws EDeferException, EProfileException
token
- authentication tokenrequest
- request to be processedEDeferException
- defer requestEProfileException
- failed to submitprotected java.lang.String auditSubjectID()