public interface EventQueueProvider
Modifier and Type | Method and Description |
---|---|
<T extends Event> |
lookup(java.lang.String name,
Session sess,
boolean autoCreate)
Returns the event queue with the specified name in the
give session (i.e., the scope).
|
<T extends Event> |
lookup(java.lang.String name,
java.lang.String scope,
boolean autoCreate)
Returns the event queue with the specified name in the
specified scope.
|
<T extends Event> |
lookup(java.lang.String name,
WebApp wapp,
boolean autoCreate)
Returns the event queue with the specified name in the
give application (i.e., the scope).
|
boolean |
remove(java.lang.String name,
Session sess)
Removes the event queue of the specified session.
|
boolean |
remove(java.lang.String name,
java.lang.String scope)
Removes the event queue.
|
boolean |
remove(java.lang.String name,
WebApp wapp)
Removes the event queue of the specified application.
|
<T extends Event> EventQueue<T> lookup(java.lang.String name, java.lang.String scope, boolean autoCreate)
Note:
Executions.getCurrent()
not null.EventQueueProviderImpl
is used.
To customize it, refer to EventQueues
.
name
- the name of the event queue.scope
- the scope of the event queue.
It must support EventQueues.DESKTOP
and EventQueues.APPLICATION
.
Developers might extend it to support other types of event queues.autoCreate
- whether to create the event queue if not found.java.lang.IllegalStateException
- if not in an activated executionjava.lang.UnsupportedOperationException
- if the scope is not supported<T extends Event> EventQueue<T> lookup(java.lang.String name, Session sess, boolean autoCreate)
Unlike lookup(String, String, boolean)
, this method
can be called without an activated execution.
sess
- the session that the event queue is located (i.e.,
the scope)<T extends Event> EventQueue<T> lookup(java.lang.String name, WebApp wapp, boolean autoCreate)
Unlike lookup(String, String, boolean)
, this method
can be called without an activated execution.
wapp
- the Web application that the event queue is located (i.e.,
the scope)boolean remove(java.lang.String name, java.lang.String scope)
name
- the name of the event queue.scope
- the scope of the event queue.
It must support EventQueues.DESKTOP
and EventQueues.APPLICATION
.
Developers might extend it to support other types of event queues.boolean remove(java.lang.String name, Session sess)
Unlike remove(String, String)
, this method
can be called without an activated execution.
name
- the queue name.sess
- the session that the event queue is located (i.e.,
the session scope)boolean remove(java.lang.String name, WebApp wapp)
Unlike remove(String, String)
, this method
can be called without an activated execution.
name
- the queue name.wapp
- the Web application that the event queue is located (i.e.,
the application scope)Copyright © 2005-2023 Potix Corporation. All Rights Reserved.