Package com.netscape.cmscore.request
Class RequestNotifier
java.lang.Object
com.netscape.cmscore.request.RequestNotifier
The RequestNotifier can be registered with a RequestQueue,
so it will be invoked when a request is completely serviced
by the IService object, then it will notify all registered
request listeners.
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Notifies all registered listeners about request.boolean
Checks for available publishing connectionsgetListener
(String name) Gets listener from the list of registered listeners.Gets list of listener names.Gets list of listeners.int
Gets number of requests in publishing queue.Gets request from publishing queue.boolean
Checks if publishing queue is enabled.void
Provides notification that a request has been completed.void
Recovers publishing queue.void
registerListener
(RequestListener listener) Registers a request listener.void
registerListener
(String name, RequestListener listener) Registers a request listener.void
removeListener
(RequestListener listener) Removes listener from the list of registered listeners.void
removeListener
(String name) Removes listener from the list of registered listeners.void
removeNotifierThread
(Thread notifierThread) Removes a notifier thread from the pool of publishing queue threads.void
setCMSEngine
(CMSEngine engine) void
setPublishingQueue
(boolean isPublishingQueueEnabled, int publishingQueuePriorityLevel, int maxNumberOfPublishingThreads, int publishingQueuePageSize, int savePublishingStatus) Sets publishing queue parameters.void
-
Field Details
-
logger
public static org.slf4j.Logger logger -
engine
-
-
Constructor Details
-
RequestNotifier
public RequestNotifier()
-
-
Method Details
-
getCMSEngine
-
setCMSEngine
-
setPublishingQueue
public void setPublishingQueue(boolean isPublishingQueueEnabled, int publishingQueuePriorityLevel, int maxNumberOfPublishingThreads, int publishingQueuePageSize, int savePublishingStatus) Sets publishing queue parameters.- Parameters:
isPublishingQueueEnabled
- publishing queue switchpublishingQueuePriorityLevel
- publishing queue priority levelmaxNumberOfPublishingThreads
- maximum number of publishing threadspublishingQueuePageSize
- publishing queue page size
-
registerListener
Registers a request listener.- Parameters:
listener
- listener to be registered
-
registerListener
Registers a request listener.- Parameters:
name
- listener namelistener
- listener to be registered
-
removeListener
Removes listener from the list of registered listeners.- Parameters:
listener
- listener to be removed from the list
-
getListenerNames
Gets list of listener names.- Returns:
- enumeration of listener names
-
removeListener
Removes listener from the list of registered listeners.- Parameters:
name
- listener name to be removed from the list
-
getListener
Gets listener from the list of registered listeners.- Parameters:
name
- listener name- Returns:
- listener
-
getListeners
Gets list of listeners.- Returns:
- enumeration of listeners
-
updatePublishingStatus
-
getRequest
Gets request from publishing queue.- Returns:
- request
-
getNumberOfRequests
public int getNumberOfRequests()Gets number of requests in publishing queue.- Returns:
- number of requests in publishing queue
-
isPublishingQueueEnabled
public boolean isPublishingQueueEnabled()Checks if publishing queue is enabled.- Returns:
- true if publishing queue is enabled, false otherwise
-
removeNotifierThread
Removes a notifier thread from the pool of publishing queue threads.- Parameters:
notifierThread
- Thread
-
notify
Provides notification that a request has been completed. The implementation may use values stored in the Request object, and may implement any type publishing (such as email or writing values into a directory)- Parameters:
r
- the request that is completed.
-
checkAvailablePublishingConnections
public boolean checkAvailablePublishingConnections()Checks for available publishing connections- Returns:
- true if there are available publishing connections, false otherwise
-
addToNotify
Notifies all registered listeners about request.- Parameters:
r
- request
-
recoverPublishingQueue
Recovers publishing queue.- Parameters:
id
- request request
-