diff options
Diffstat (limited to 'pki/base/common/src/com/netscape/certsrv/listeners')
3 files changed, 47 insertions, 32 deletions
diff --git a/pki/base/common/src/com/netscape/certsrv/listeners/EListenersException.java b/pki/base/common/src/com/netscape/certsrv/listeners/EListenersException.java index c498ca3dc..82ac529e4 100644 --- a/pki/base/common/src/com/netscape/certsrv/listeners/EListenersException.java +++ b/pki/base/common/src/com/netscape/certsrv/listeners/EListenersException.java @@ -17,13 +17,12 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.listeners; - import com.netscape.certsrv.base.EBaseException; - /** * A class represents a listener exception. * <P> + * * @version $Revision$, $Date$ */ public class EListenersException extends EBaseException { @@ -35,13 +34,15 @@ public class EListenersException extends EBaseException { /** * CA resource class name. */ - private static final String LISTENERS_RESOURCES = ListenersResources.class.getName(); + private static final String LISTENERS_RESOURCES = ListenersResources.class + .getName(); /** * Constructs a listeners exception. * <P> + * * @param msgFormat The error message resource key. - */ + */ public EListenersException(String msgFormat) { super(msgFormat); } @@ -49,6 +50,7 @@ public class EListenersException extends EBaseException { /** * Constructs a listeners exception. * <P> + * * @param msgFormat exception details in message string format. * @param param message string parameter. */ @@ -59,27 +61,31 @@ public class EListenersException extends EBaseException { /** * Constructs a Listeners exception. * <P> + * * @param msgFormat The resource key. * @param e The parameter as an exception. */ public EListenersException(String msgFormat, Exception e) { super(msgFormat, e); } - + /** * Constructs a Listeners exception. * <P> + * * @param msgFormat The resource key. * @param params Array of params. */ public EListenersException(String msgFormat, Object params[]) { super(msgFormat, params); } + /** * get the listener resource class name. * <P> + * * @return the class name of the resource. - */ + */ protected String getBundleName() { return LISTENERS_RESOURCES; } diff --git a/pki/base/common/src/com/netscape/certsrv/listeners/IRequestListenerPlugin.java b/pki/base/common/src/com/netscape/certsrv/listeners/IRequestListenerPlugin.java index b0cb173cb..2f93f69b4 100644 --- a/pki/base/common/src/com/netscape/certsrv/listeners/IRequestListenerPlugin.java +++ b/pki/base/common/src/com/netscape/certsrv/listeners/IRequestListenerPlugin.java @@ -17,62 +17,71 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.listeners; - import com.netscape.certsrv.base.EBaseException; import com.netscape.certsrv.base.IConfigStore; /** - * This interface represents a plug-in listener. Implement this class to - * add the listener to an ARequestNotifier of a subsystem. + * This interface represents a plug-in listener. Implement this class to add the + * listener to an ARequestNotifier of a subsystem. * <P> + * * @version $Revision$, $Date$ */ public interface IRequestListenerPlugin { - + /** * get the registered class name set in the init() method. * <P> - * @return the Name. + * + * @return the Name. */ public String getName(); - + /** * get the plugin implementaion name set in the init() method. * <P> + * * @return the plugin implementation name. */ public String getImplName(); - + /** * the subsystem call this method to initialize the plug-in. * <P> + * * @param name the registered class name of the plug-in. * @param implName the implemetnation name of the plug-in. - * @param config the configuration store where the. - * properties of the plug-in are stored. - * @exception EBaseException throws base exception in the certificate server. + * @param config the configuration store where the. properties of the + * plug-in are stored. + * @exception EBaseException throws base exception in the certificate + * server. */ - public void init(String name, String implName, IConfigStore config) - throws EBaseException; + public void init(String name, String implName, IConfigStore config) + throws EBaseException; + /** * shutdown the plugin. */ public void shutdown(); + /** * get the configuration parameters of the plug-in. * <P> + * * @return the configuration parameters. - * @exception EBaseException throws base exception in the certificate server. + * @exception EBaseException throws base exception in the certificate + * server. */ - public String[] getConfigParams() - throws EBaseException; + public String[] getConfigParams() throws EBaseException; + /** - * get the configuration store of the plugin where the - * configuration parameters of the plug-in are stored. + * get the configuration store of the plugin where the configuration + * parameters of the plug-in are stored. * <P> + * * @return the configuration store. */ - + public IConfigStore getConfigStore(); - + } diff --git a/pki/base/common/src/com/netscape/certsrv/listeners/ListenersResources.java b/pki/base/common/src/com/netscape/certsrv/listeners/ListenersResources.java index 199941be9..8e3bc0f38 100644 --- a/pki/base/common/src/com/netscape/certsrv/listeners/ListenersResources.java +++ b/pki/base/common/src/com/netscape/certsrv/listeners/ListenersResources.java @@ -17,13 +17,11 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.listeners; - import java.util.ListResourceBundle; /** - * A class represents a resource bundle for the - * listeners package. - * + * A class represents a resource bundle for the listeners package. + * * @version $Revision$, $Date$ */ public class ListenersResources extends ListResourceBundle { @@ -31,11 +29,13 @@ public class ListenersResources extends ListResourceBundle { /** * get the content of the resource. * <P> - * @return the content of this resource is a value pairs array of keys and values. + * + * @return the content of this resource is a value pairs array of keys and + * values. */ public Object[][] getContents() { return contents; } - static final Object[][] contents = { - }; + + static final Object[][] contents = {}; } |