diff options
Diffstat (limited to 'pki/base/common/src/com/netscape/certsrv/listeners')
3 files changed, 202 insertions, 0 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 new file mode 100644 index 000000000..40dad6eb9 --- /dev/null +++ b/pki/base/common/src/com/netscape/certsrv/listeners/EListenersException.java @@ -0,0 +1,84 @@ +// --- BEGIN COPYRIGHT BLOCK --- +// This program is free software; you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation; version 2 of the License. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License along +// with this program; if not, write to the Free Software Foundation, Inc., +// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. +// +// (C) 2007 Red Hat, Inc. +// All rights reserved. +// --- END COPYRIGHT BLOCK --- +package com.netscape.certsrv.listeners; + + +import java.util.*; +import com.netscape.certsrv.base.*; +import com.netscape.certsrv.logging.*; + + +/** + * A class represents a listener exception. + * <P> + * @version $Revision$, $Date$ + */ +public class EListenersException extends EBaseException { + + /** + * CA resource class name. + */ + 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); + } + + /** + * Constructs a listeners exception. + * <P> + * @param msgFormat exception details in message string format. + * @param param message string parameter. + */ + public EListenersException(String msgFormat, String param) { + super(msgFormat, param); + } + + /** + * 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 new file mode 100644 index 000000000..83f6bd68d --- /dev/null +++ b/pki/base/common/src/com/netscape/certsrv/listeners/IRequestListenerPlugin.java @@ -0,0 +1,77 @@ +// --- BEGIN COPYRIGHT BLOCK --- +// This program is free software; you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation; version 2 of the License. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License along +// with this program; if not, write to the Free Software Foundation, Inc., +// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. +// +// (C) 2007 Red Hat, Inc. +// All rights reserved. +// --- END COPYRIGHT BLOCK --- +package com.netscape.certsrv.listeners; + + +import com.netscape.certsrv.base.*; + +/** + * 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. + */ + 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. + */ + 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. + */ + public String[] getConfigParams() + throws EBaseException; + /** + * 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 new file mode 100644 index 000000000..7fae366d8 --- /dev/null +++ b/pki/base/common/src/com/netscape/certsrv/listeners/ListenersResources.java @@ -0,0 +1,41 @@ +// --- BEGIN COPYRIGHT BLOCK --- +// This program is free software; you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation; version 2 of the License. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License along +// with this program; if not, write to the Free Software Foundation, Inc., +// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. +// +// (C) 2007 Red Hat, Inc. +// All rights reserved. +// --- END COPYRIGHT BLOCK --- +package com.netscape.certsrv.listeners; + + +import java.util.*; + +/** + * A class represents a resource bundle for the + * listeners package. + * + * @version $Revision$, $Date$ + */ +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. + */ + public Object[][] getContents() { + return contents; + } + static final Object[][] contents = { + }; +} |