|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.netscape.cms.profile.common.BasicProfile
public abstract class BasicProfile
This class implements a basic profile.
Field Summary | |
---|---|
protected IProfileAuthenticator |
mAuthenticator
|
protected java.lang.String |
mAuthInstanceId
|
protected java.lang.String |
mAuthzAcl
|
protected IConfigStore |
mConfig
|
protected java.lang.String |
mId
|
protected java.util.Vector |
mInputIds
|
protected java.util.Vector |
mInputNames
|
protected java.util.Hashtable |
mInputs
|
protected java.util.Vector |
mOutputIds
|
protected java.util.Hashtable |
mOutputs
|
protected IProfileSubsystem |
mOwner
|
protected java.util.Hashtable |
mPolicySet
|
protected IPluginRegistry |
mRegistry
|
protected ILogger |
mSignedAuditLogger
|
protected java.util.Vector |
mUpdaterIds
|
protected java.util.Hashtable |
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
|
Constructor Summary | |
---|---|
BasicProfile()
|
Method Summary | |
---|---|
void |
addInputName(java.lang.String name)
|
protected void |
audit(java.lang.String msg)
Signed Audit Log This method is inherited by all extended "BasicProfile"s, and is called to store messages to the signed audit log. |
protected java.lang.String |
auditSubjectID()
Signed Audit Log Subject ID This method is inherited by all extended "BasicProfile"s, and is called to obtain the "SubjectID" for a signed audit log message. |
abstract IProfileContext |
createContext()
Retrieves profile context. |
IProfileInput |
createProfileInput(java.lang.String id,
java.lang.String inputId,
NameValuePairs nvps)
Creates a input policy. |
IProfileInput |
createProfileInput(java.lang.String id,
java.lang.String inputId,
NameValuePairs nvps,
boolean createConfig)
|
IProfileOutput |
createProfileOutput(java.lang.String id,
java.lang.String outputId,
NameValuePairs nvps)
Creates a output policy. |
IProfileOutput |
createProfileOutput(java.lang.String id,
java.lang.String outputId,
NameValuePairs nvps,
boolean createConfig)
|
IProfilePolicy |
createProfilePolicy(java.lang.String setId,
java.lang.String id,
java.lang.String defaultClassId,
java.lang.String constraintClassId)
Creates a profile policy |
IProfilePolicy |
createProfilePolicy(java.lang.String setId,
java.lang.String id,
java.lang.String defaultClassId,
java.lang.String constraintClassId,
boolean createConfig)
|
abstract IRequest[] |
createRequests(IProfileContext ctx,
java.util.Locale locale)
Creates request. |
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)
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 |
getInputNames()
|
java.lang.String |
getName(java.util.Locale locale)
Returns the profile name. |
java.util.Vector |
getPolicies(java.lang.String setId)
|
IProfileInput |
getProfileInput(java.lang.String name)
Retrieves input policy by id. |
java.util.Enumeration |
getProfileInputIds()
Retrieves a list of input policy IDs. |
IProfileOutput |
getProfileOutput(java.lang.String name)
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. |
IProfileUpdater |
getProfileUpdater(java.lang.String name)
|
java.util.Enumeration |
getProfileUpdaterIds()
|
java.lang.String |
getRequestorDN(IRequest request)
Retrieves a localized string that represents requestor's distinguished name. |
void |
init(IProfileSubsystem owner,
IConfigStore config)
Initializes this profile. |
boolean |
isEnable()
|
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 |
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 |
setVisible(boolean v)
Sets this profile end-user profile or not. |
void |
validate(IRequest request)
Passes the request to the set of constraint policies that validate the request against the profile. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.netscape.certsrv.profile.IProfile |
---|
getPolicySetId, getRequestQueue, submit |
Field Detail |
---|
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 IProfileSubsystem mOwner
protected IConfigStore mConfig
protected IPluginRegistry mRegistry
protected java.util.Vector mInputNames
protected java.util.Hashtable mInputs
protected java.util.Vector mInputIds
protected java.util.Hashtable mOutputs
protected java.util.Vector mOutputIds
protected java.util.Hashtable mUpdaters
protected java.util.Vector mUpdaterIds
protected IProfileAuthenticator mAuthenticator
protected java.lang.String mAuthInstanceId
protected java.lang.String mId
protected java.lang.String mAuthzAcl
protected java.util.Hashtable mPolicySet
protected ILogger mSignedAuditLogger
Constructor Detail |
---|
public BasicProfile()
Method Detail |
---|
public boolean isEnable()
public java.lang.String isRenewal()
isRenewal
in interface IProfile
public java.lang.String isXmlOutput()
isXmlOutput
in interface IProfile
public java.lang.String getApprovedBy()
IProfile
getApprovedBy
in interface IProfile
public void setId(java.lang.String id)
IProfile
setId
in interface IProfile
id
- profile identifierpublic java.lang.String getId()
IProfile
getId
in interface IProfile
public IProfileAuthenticator getAuthenticator() throws EProfileException
IProfile
getAuthenticator
in interface IProfile
EProfileException
- failed to retrievepublic java.lang.String getRequestorDN(IRequest request)
IProfile
getRequestorDN
in interface IProfile
request
- request
public java.lang.String getAuthenticatorId()
IProfile
getAuthenticatorId
in interface IProfile
public void setAuthenticatorId(java.lang.String id)
IProfile
setAuthenticatorId
in interface IProfile
id
- authenticator instance idpublic java.lang.String getAuthzAcl()
getAuthzAcl
in interface IProfile
public void init(IProfileSubsystem owner, IConfigStore config) throws EBaseException
init
in interface IProfile
owner
- profile subsystemconfig
- configuration store for this profile
EBaseException
- failed to initializepublic IConfigStore getConfigStore()
IProfile
getConfigStore
in interface IProfile
public java.util.Enumeration getInputNames()
public java.util.Enumeration getProfileUpdaterIds()
public IProfileUpdater getProfileUpdater(java.lang.String name)
public java.util.Enumeration getProfileOutputIds()
IProfile
getProfileOutputIds
in interface IProfile
public IProfileOutput getProfileOutput(java.lang.String name)
IProfile
getProfileOutput
in interface IProfile
name
- output policy id
public java.util.Enumeration getProfileInputIds()
IProfile
getProfileInputIds
in interface IProfile
public IProfileInput getProfileInput(java.lang.String name)
IProfile
getProfileInput
in interface IProfile
name
- input policy id
public 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 getProfilePolicySetIds()
IProfile
getProfilePolicySetIds
in interface IProfile
public void deleteProfilePolicy(java.lang.String setId, java.lang.String policyId) throws EProfileException
IProfile
deleteProfilePolicy
in interface IProfile
setId
- id of the policy setpolicyId
- id of policy to delete
EProfileException
- failed to deletepublic void deleteProfileInput(java.lang.String inputId) throws EProfileException
IProfile
deleteProfileInput
in interface IProfile
inputId
- id of the input policy
EProfileException
- failed to deletepublic void deleteProfileOutput(java.lang.String outputId) throws EProfileException
IProfile
deleteProfileOutput
in interface IProfile
outputId
- id of the output policy
EProfileException
- failed to deletepublic IProfileOutput createProfileOutput(java.lang.String id, java.lang.String outputId, NameValuePairs nvps) throws EProfileException
IProfile
createProfileOutput
in interface IProfile
id
- output policy idoutputId
- id of the registered output implementationnvps
- default parameters
EProfileException
- failed to createpublic IProfileOutput createProfileOutput(java.lang.String id, java.lang.String outputId, NameValuePairs nvps, boolean createConfig) throws EProfileException
EProfileException
public IProfileInput createProfileInput(java.lang.String id, java.lang.String inputId, NameValuePairs nvps) throws EProfileException
IProfile
createProfileInput
in interface IProfile
id
- input policy idinputId
- id of the registered input implementationnvps
- default parameters
EProfileException
- failed to createpublic IProfileInput createProfileInput(java.lang.String id, java.lang.String inputId, NameValuePairs nvps, boolean createConfig) throws EProfileException
EProfileException
public IProfilePolicy createProfilePolicy(java.lang.String setId, java.lang.String id, java.lang.String defaultClassId, java.lang.String constraintClassId) throws EProfileException
createProfilePolicy
in interface IProfile
setId
- id of the policy set that owns this policyid
- policy iddefaultClassId
- id of the registered default implementationconstraintClassId
- id of the registered constraint implementation
EProfileException
- failed to create policypublic IProfilePolicy createProfilePolicy(java.lang.String setId, java.lang.String id, java.lang.String defaultClassId, java.lang.String constraintClassId, boolean createConfig) throws EProfileException
EProfileException
public IProfilePolicy getProfilePolicy(java.lang.String setId, java.lang.String id)
IProfile
getProfilePolicy
in interface IProfile
setId
- set idid
- policy id
public boolean isVisible()
IProfile
isVisible
in interface IProfile
public void setVisible(boolean v)
IProfile
setVisible
in interface IProfile
v
- end-user profile or notpublic java.lang.String getName(java.util.Locale locale)
getName
in interface IProfile
locale
- end-user locale
public void setName(java.util.Locale locale, java.lang.String name)
IProfile
setName
in interface IProfile
locale
- end-user localename
- profile namepublic abstract IProfileContext createContext()
IProfile
createContext
in interface IProfile
public abstract IRequest[] createRequests(IProfileContext ctx, java.util.Locale locale) throws EProfileException
createRequests
in interface IProfile
ctx
- profile contextlocale
- user locale
EProfileException
- failed to create requestspublic java.lang.String getDescription(java.util.Locale locale)
getDescription
in interface IProfile
locale
- end-user locale
public void setDescription(java.util.Locale locale, java.lang.String desc)
IProfile
setDescription
in interface IProfile
locale
- end-user localedesc
- profile descriptionpublic void populateInput(IProfileContext ctx, IRequest request) throws EProfileException
IProfile
populateInput
in interface IProfile
ctx
- profile contextrequest
- request
EProfileException
- failed to populatepublic java.util.Vector getPolicies(java.lang.String setId)
public void populate(IRequest request) throws EProfileException
populate
in interface IProfile
request
- request
EProfileException
- failed to populate default valuespublic void validate(IRequest request) throws ERejectException
validate
in interface IProfile
request
- request
ERejectException
- validation violationpublic java.util.Enumeration getProfilePolicies(java.lang.String setId)
IProfile
getProfilePolicies
in interface IProfile
setId
- set id
public java.util.Enumeration getProfilePolicyIds(java.lang.String setId)
IProfile
getProfilePolicyIds
in interface IProfile
setId
- set id
public void execute(IRequest request) throws EProfileException
IProfile
execute
in interface IProfile
request
- request to be processed
EProfileException
- failed to processprotected void audit(java.lang.String msg)
msg
- signed audit log messageprotected java.lang.String auditSubjectID()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |