diff options
Diffstat (limited to 'pki/base/common/src/com/netscape/certsrv/request/IRequestSubsystem.java')
| -rw-r--r-- | pki/base/common/src/com/netscape/certsrv/request/IRequestSubsystem.java | 106 |
1 files changed, 60 insertions, 46 deletions
diff --git a/pki/base/common/src/com/netscape/certsrv/request/IRequestSubsystem.java b/pki/base/common/src/com/netscape/certsrv/request/IRequestSubsystem.java index aa568f082..c32c66985 100644 --- a/pki/base/common/src/com/netscape/certsrv/request/IRequestSubsystem.java +++ b/pki/base/common/src/com/netscape/certsrv/request/IRequestSubsystem.java @@ -17,75 +17,89 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.request; + import com.netscape.certsrv.base.EBaseException; + /** - * This interface defines storage of request objects in the local database. + * This interface defines storage of request objects + * in the local database. * <p> - * * @version $Revision$, $Date$ */ public interface IRequestSubsystem { public static final String SUB_ID = "request"; /** - * Creates a new request queue. (Currently unimplemented. Just use - * getRequestQueue to create an in-memory queue.) + * Creates a new request queue. + * (Currently unimplemented. Just use getRequestQueue to create + * an in-memory queue.) * <p> - * - * @param name The name of the queue object. This name can be used in - * getRequestQueue to retrieve the queue later. + * @param name The name of the queue object. This name can be used + * in getRequestQueue to retrieve the queue later. * @exception EBaseException failed to create request queue */ - public void createRequestQueue(String name) throws EBaseException; + public void createRequestQueue(String name) + throws EBaseException; /** - * Retrieves a request queue. This operation should only be done once on - * each queue. For example, the RA subsystem should retrieve its queue, and - * store it somewhere for use by related services, and servlets. + * Retrieves a request queue. This operation should only be done + * once on each queue. For example, the RA subsystem should retrieve + * its queue, and store it somewhere for use by related services, and + * servlets. * <p> - * WARNING: retrieving the same queue twice with result in multi-thread race - * conditions. + * WARNING: retrieving the same queue twice with result in multi-thread + * race conditions. * <p> - * - * @param name the name of the request queue. (Ex: "ca" "ra") - * @param p A policy enforcement module. This object is called to make - * adjustments to the request, and decide whether it needs agent - * approval. - * @param s The service object. This object actually performs the request - * after it is finalized and approved. - * @param n A notifier object (optional). The notify() method of this object - * is invoked when the request is completed (COMPLETE, REJECTED - * or CANCELED states). + * @param name + * the name of the request queue. (Ex: "ca" "ra") + * @param p + * A policy enforcement module. This object is called to make + * adjustments to the request, and decide whether it needs agent + * approval. + * @param s + * The service object. This object actually performs the request + * after it is finalized and approved. + * @param n + * A notifier object (optional). The notify() method of this object + * is invoked when the request is completed (COMPLETE, REJECTED or + * CANCELED states). * @exception EBaseException failed to retrieve request queue */ - public IRequestQueue getRequestQueue(String name, int increment, IPolicy p, - IService s, INotify n) throws EBaseException; + public IRequestQueue + getRequestQueue(String name, int increment, IPolicy p, IService s, INotify n) + throws EBaseException; /** - * Retrieves a request queue. This operation should only be done once on - * each queue. For example, the RA subsystem should retrieve its queue, and - * store it somewhere for use by related services, and servlets. + * Retrieves a request queue. This operation should only be done + * once on each queue. For example, the RA subsystem should retrieve + * its queue, and store it somewhere for use by related services, and + * servlets. * <p> - * WARNING: retrieving the same queue twice with result in multi-thread race - * conditions. + * WARNING: retrieving the same queue twice with result in multi-thread + * race conditions. * <p> - * - * @param name the name of the request queue. (Ex: "ca" "ra") - * @param p A policy enforcement module. This object is called to make - * adjustments to the request, and decide whether it needs agent - * approval. - * @param s The service object. This object actually performs the request - * after it is finalized and approved. - * @param n A notifier object (optional). The notify() method of this object - * is invoked when the request is completed (COMPLETE, REJECTED - * or CANCELED states). - * @param pendingNotifier A notifier object (optional). Like the 'n' - * argument, except the notification happens if the request is - * made PENDING. May be the same as the 'n' argument if desired. + * @param name + * the name of the request queue. (Ex: "ca" "ra") + * @param p + * A policy enforcement module. This object is called to make + * adjustments to the request, and decide whether it needs agent + * approval. + * @param s + * The service object. This object actually performs the request + * after it is finalized and approved. + * @param n + * A notifier object (optional). The notify() method of this object + * is invoked when the request is completed (COMPLETE, REJECTED or + * CANCELED states). + * @param pendingNotifier + * A notifier object (optional). Like the 'n' argument, except the + * notification happens if the request is made PENDING. May be the + * same as the 'n' argument if desired. * @exception EBaseException failed to retrieve request queue */ - public IRequestQueue getRequestQueue(String name, int increment, IPolicy p, - IService s, INotify n, INotify pendingNotifier) - throws EBaseException; + public IRequestQueue + getRequestQueue(String name, int increment, IPolicy p, IService s, INotify n, + INotify pendingNotifier) + throws EBaseException; } |