public interface IProfile
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 | Method and Description |
---|---|
IProfileContext |
createContext()
Retrieves profile context.
|
IProfileInput |
createProfileInput(java.lang.String id,
java.lang.String inputClassId,
NameValuePairs nvp)
Creates a input policy.
|
IProfileOutput |
createProfileOutput(java.lang.String id,
java.lang.String outputClassId,
NameValuePairs nvp)
Creates a output policy.
|
IProfilePolicy |
createProfilePolicy(java.lang.String setId,
java.lang.String id,
java.lang.String defaultClassId,
java.lang.String constraintClassId)
Creates a profile policy.
|
IRequest[] |
createRequests(IProfileContext ctx,
java.util.Locale locale)
Creates one or more requests.
|
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.
|
IProfileAuthenticator |
getAuthenticator()
Retrieves the associated authenticator instance.
|
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)
Retrieves the profile description.
|
java.lang.String |
getId()
Returns the identifier of this profile.
|
java.lang.String |
getName(java.util.Locale locale)
Retrieves the profile name.
|
java.lang.String |
getPolicySetId(IRequest req)
Retrieves a default set id for the given request.
|
IProfileInput |
getProfileInput(java.lang.String id)
Retrieves input policy by id.
|
java.util.Enumeration |
getProfileInputIds()
Retrieves a list of input policy IDs.
|
IProfileOutput |
getProfileOutput(java.lang.String id)
Retrieves output policy by id.
|
java.util.Enumeration |
getProfileOutputIds()
Retrieves a list of output policy IDs.
|
java.util.Enumeration |
getProfilePolicies(java.lang.String setId)
Returns a list of profile policies.
|
IProfilePolicy |
getProfilePolicy(java.lang.String setId,
java.lang.String id)
Retrieves a policy.
|
java.util.Enumeration |
getProfilePolicyIds(java.lang.String setId)
Retrieves all the policy id within a set.
|
java.util.Enumeration |
getProfilePolicySetIds()
Returns the profile policy set identifiers.
|
java.lang.String |
getRequestorDN(IRequest request)
Retrieves a localized string that represents
requestor's distinguished name.
|
IRequestQueue |
getRequestQueue()
Retrieves the request queue that is associated with
this profile.
|
void |
init(IProfileSubsystem owner,
IConfigStore config)
Initializes this profile.
|
java.lang.String |
isRenewal() |
boolean |
isVisible()
Checks if this profile is end-user profile or not.
|
java.lang.String |
isXmlOutput() |
void |
populate(IRequest request)
Passes the request to the set of default policies that
populate the profile information against the profile.
|
void |
populateInput(IProfileContext 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 |
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 |
setName(java.util.Locale locale,
java.lang.String name)
Returns the profile name.
|
void |
setVisible(boolean v)
Sets this profile end-user profile or not.
|
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.
|
void init(IProfileSubsystem owner, IConfigStore config) throws EBaseException
owner
- profile subsystemconfig
- configuration store for this profileEBaseException
- failed to initializeIRequestQueue getRequestQueue()
void setId(java.lang.String id)
id
- profile identifierjava.lang.String getId()
java.lang.String getRequestorDN(IRequest request)
request
- requestIConfigStore getConfigStore()
java.lang.String getAuthenticatorId()
java.lang.String getAuthzAcl()
void setAuthenticatorId(java.lang.String id)
id
- authenticator instance idIProfileAuthenticator getAuthenticator() throws EProfileException
EProfileException
- failed to retrievejava.util.Enumeration getProfileInputIds()
IProfileInput getProfileInput(java.lang.String id)
id
- input policy idjava.util.Enumeration getProfileOutputIds()
IProfileOutput getProfileOutput(java.lang.String id)
id
- output policy idboolean isVisible()
void setVisible(boolean v)
v
- end-user profile or notjava.lang.String getApprovedBy()
java.lang.String isRenewal()
java.lang.String isXmlOutput()
void setName(java.util.Locale locale, java.lang.String name)
locale
- end-user localename
- profile namejava.lang.String getName(java.util.Locale locale)
locale
- end-user localevoid setDescription(java.util.Locale locale, java.lang.String desc)
locale
- end-user localedesc
- profile descriptionjava.lang.String getDescription(java.util.Locale locale)
locale
- end-user localeIProfileContext createContext()
java.util.Enumeration getProfilePolicySetIds()
IProfilePolicy 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 policyvoid deleteProfileInput(java.lang.String inputId) throws EProfileException
inputId
- id of the input policyEProfileException
- failed to deletevoid deleteProfileOutput(java.lang.String outputId) throws EProfileException
outputId
- id of the output policyEProfileException
- failed to deleteIProfileInput createProfileInput(java.lang.String id, java.lang.String inputClassId, NameValuePairs nvp) throws EProfileException
id
- input policy idinputClassId
- id of the registered input implementationnvp
- default parametersEProfileException
- failed to createIProfileOutput createProfileOutput(java.lang.String id, java.lang.String outputClassId, NameValuePairs nvp) throws EProfileException
id
- output policy idoutputClassId
- id of the registered output implementationnvp
- default parametersEProfileException
- failed to createvoid deleteProfilePolicy(java.lang.String setId, java.lang.String policyId) throws EProfileException
setId
- id of the policy setpolicyId
- id of policy to deleteEProfileException
- failed to deleteIProfilePolicy getProfilePolicy(java.lang.String setId, java.lang.String id)
setId
- set idid
- policy idjava.util.Enumeration getProfilePolicyIds(java.lang.String setId)
setId
- set idjava.lang.String getPolicySetId(IRequest req)
req
- requestjava.util.Enumeration getProfilePolicies(java.lang.String setId)
setId
- set idIRequest[] createRequests(IProfileContext ctx, java.util.Locale locale) throws EProfileException
ctx
- profile contextlocale
- user localeEProfileException
- failed to create requestsvoid populateInput(IProfileContext ctx, IRequest request) throws EProfileException
ctx
- profile contextrequest
- requestEProfileException
- failed to populatevoid populate(IRequest request) throws EProfileException
request
- requestEProfileException
- failed to populate default valuesvoid validate(IRequest request) throws ERejectException
request
- requestERejectException
- validation violationvoid execute(IRequest request) throws EProfileException
request
- request to be processedEProfileException
- failed to processvoid submit(IAuthToken token, IRequest request) throws EDeferException, EProfileException
token
- authentication tokenrequest
- request to be processedEDeferException
- defer requestEProfileException
- failed to submit