diff options
Diffstat (limited to 'pki/base/common/src/com/netscape/certsrv/profile/IPolicyDefault.java')
-rw-r--r-- | pki/base/common/src/com/netscape/certsrv/profile/IPolicyDefault.java | 81 |
1 files changed, 47 insertions, 34 deletions
diff --git a/pki/base/common/src/com/netscape/certsrv/profile/IPolicyDefault.java b/pki/base/common/src/com/netscape/certsrv/profile/IPolicyDefault.java index a904eb543..018054926 100644 --- a/pki/base/common/src/com/netscape/certsrv/profile/IPolicyDefault.java +++ b/pki/base/common/src/com/netscape/certsrv/profile/IPolicyDefault.java @@ -17,6 +17,7 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.profile; + import java.util.Enumeration; import java.util.Locale; @@ -26,28 +27,36 @@ import com.netscape.certsrv.property.IConfigTemplate; import com.netscape.certsrv.property.IDescriptor; import com.netscape.certsrv.request.IRequest; + /** - * This represents a default policy that populates the request with additional - * values. + * This represents a default policy that populates + * the request with additional values. * <p> - * - * During request submission process, a default policy is invoked to populate - * the default values in the request. The default values will later on be used - * for execution. The default values are like the parameters for the request. + * + * During request submission process, a default + * policy is invoked to populate the default values + * in the request. The default values will later + * on be used for execution. The default values + * are like the parameters for the request. * <p> - * - * This policy is called in 2 places. For automated enrollment request, this - * policy is invoked to populate the HTTP parameters into the request. For - * request that cannot be executed immediately, this policy will be invoked - * again right after the agent's approval. + * + * This policy is called in 2 places. For + * automated enrollment request, this policy + * is invoked to populate the HTTP parameters + * into the request. For request that cannot + * be executed immediately, this policy will be + * invoked again right after the agent's + * approval. * <p> - * - * Each default policy may contain zero or more properties that describe the - * default value. For example, a X509 Key can be described by its key type, key - * length, and key data. The properties help to describe the default value into - * human readable values. + * + * Each default policy may contain zero or more + * properties that describe the default value. + * For example, a X509 Key can be described by + * its key type, key length, and key data. The + * properties help to describe the default value + * into human readable values. * <p> - * + * * @version $Revision$, $Date$ */ public interface IPolicyDefault extends IConfigTemplate { @@ -60,26 +69,27 @@ public interface IPolicyDefault extends IConfigTemplate { * @exception EProfileException failed to initialize */ public void init(IProfile profile, IConfigStore config) - throws EProfileException; + throws EProfileException; /** * Retrieves the configuration store of this default. - * + * * @return configuration store of this default policy */ public IConfigStore getConfigStore(); /** * Populates the request with this policy default. - * + * * @param request request to be populated * @exception EProfileException failed to populate */ - public void populate(IRequest request) throws EProfileException; - + public void populate(IRequest request) + throws EProfileException; + /** * Retrieves the localizable name of this policy. - * + * * @param locale locale of the end user * @return localized name of this default policy */ @@ -95,15 +105,17 @@ public interface IPolicyDefault extends IConfigTemplate { /** * Retrieves a list of names of the property. - * - * @return a list of property names. The values are of type java.lang.String + * + * @return a list of property names. The values are + * of type java.lang.String */ public Enumeration getValueNames(); /** - * Retrieves the descriptor of the given property by name. The descriptor - * contains syntax information. - * + * Retrieves the descriptor of the given property + * by name. The descriptor contains syntax + * information. + * * @param locale locale of the end user * @param name name of property * @return descriptor of the property @@ -112,24 +124,25 @@ public interface IPolicyDefault extends IConfigTemplate { /** * Sets the value of the given value property by name. - * + * * @param name name of property * @param locale locale of the end user * @param request request * @param value value to be set in the given request * @exception EPropertyException failed to set property */ - public void setValue(String name, Locale locale, IRequest request, - String value) throws EPropertyException; + public void setValue(String name, Locale locale, IRequest request, + String value) throws EPropertyException; /** - * Retrieves the value of the given value property by name. - * + * Retrieves the value of the given value + * property by name. + * * @param name name of property * @param locale locale of the end user * @param request request * @exception EPropertyException failed to get property */ public String getValue(String name, Locale locale, IRequest request) - throws EPropertyException; + throws EPropertyException; } |