wt.services
Class ManagerEvent

java.lang.Object
  extended bywt.services.ManagerEvent

public class ManagerEvent
extends Object



Supported API: false

Extendable: false


Field Summary
private static String CLASSNAME
           
static String EMERGENCY_SHUTDOWN_COMPLETE
          

Supported API: false
static String EMERGENCY_SHUTTING_DOWN
          

Supported API: false
private static String eventClass
           
private  String eventType
           
private  Manager manager
           
private static String RESOURCE
           
static String SHUTDOWN
          

Supported API: false
static String SHUTDOWN_ERRORS
          

Supported API: false
static String SHUTDOWN_FAILURE
          

Supported API: false
static String SHUTDOWN_SUCCESS
          

Supported API: false
static String SHUTTING_DOWN
          

Supported API: false
static String STARTED
          Final field used to classify all manager events.
static String STARTED_ERRORS
          

Supported API: false
static String STARTING_UP
          

Supported API: false
static String STARTUP_FAILURE
          

Supported API: false
 
Constructor Summary
ManagerEvent(String eventType, Manager manager)
          

Supported API: false
 
Method Summary
 String generateEventKey(String eventType, Class managerClass)
          Generate event keys which are used to either subscribe to an event or to dispatch an event.
 String getEventKey()
          Generate an event key for this instance of a manager event.
 String getEventType()
          Gets the value of the attribute: eventType; The event type, can be SHUTDOWN, STARTING_UP, STARTED, ...
 Manager getManager()
          Gets the object for the association that plays role: manager.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

RESOURCE

private static final String RESOURCE
See Also:
Constant Field Values

CLASSNAME

private static final String CLASSNAME

STARTED

public static final String STARTED
Final field used to classify all manager events. This field is used to construct event keys which are used to subscribe to or dispatch events. All manager events are prefixed by "*.Manager".

Supported API: false

See Also:
Constant Field Values

SHUTDOWN

public static final String SHUTDOWN


Supported API: false

See Also:
Constant Field Values

STARTING_UP

public static final String STARTING_UP


Supported API: false

See Also:
Constant Field Values

SHUTTING_DOWN

public static final String SHUTTING_DOWN


Supported API: false

See Also:
Constant Field Values

STARTED_ERRORS

public static final String STARTED_ERRORS


Supported API: false

See Also:
Constant Field Values

STARTUP_FAILURE

public static final String STARTUP_FAILURE


Supported API: false

See Also:
Constant Field Values

SHUTDOWN_ERRORS

public static final String SHUTDOWN_ERRORS


Supported API: false

See Also:
Constant Field Values

SHUTDOWN_FAILURE

public static final String SHUTDOWN_FAILURE


Supported API: false

See Also:
Constant Field Values

SHUTDOWN_SUCCESS

public static final String SHUTDOWN_SUCCESS


Supported API: false

See Also:
Constant Field Values

EMERGENCY_SHUTTING_DOWN

public static final String EMERGENCY_SHUTTING_DOWN


Supported API: false

See Also:
Constant Field Values

EMERGENCY_SHUTDOWN_COMPLETE

public static final String EMERGENCY_SHUTDOWN_COMPLETE


Supported API: false

See Also:
Constant Field Values

eventClass

private static final String eventClass
See Also:
Constant Field Values

eventType

private String eventType

manager

private Manager manager
Constructor Detail

ManagerEvent

public ManagerEvent(String eventType,
                    Manager manager)


Supported API: false

Parameters:
eventType -
manager -
Method Detail

getEventType

public String getEventType()
Gets the value of the attribute: eventType; The event type, can be SHUTDOWN, STARTING_UP, STARTED, ...

Supported API: false

Returns:
String

getManager

public Manager getManager()
Gets the object for the association that plays role: manager.

Supported API: false

Returns:
Manager

getEventKey

public String getEventKey()
Generate an event key for this instance of a manager event. Used to dispatch the event to its listeners.

Supported API: false

Returns:
a string which can be used to identify this event.

generateEventKey

public String generateEventKey(String eventType,
                               Class managerClass)
Generate event keys which are used to either subscribe to an event or to dispatch an event. For example, the following code can be used to subscribe to the Manger.STARTED event:

String eventKey = MangerEvent.generateEventKey( Manager.STARTED, CRUDManager.class );
ManagerServiceFactory.getDefault().addEventListener( aListener, eventKey );

In this example the value of field eventKey might be "Manager/STARTED/wt.crud.CRUDManager". The listener will only be notified if the Manager.STARTED event applies to an instance of wt.crud.CRUDManager.

Supported API: false

Parameters:
eventType -
managerClass -
Returns:
a string which can be used to identify the event.