com.tibco.amf.platform.runtime.extension.context
Class LifeCycleEvent

java.lang.Object
  extended by java.util.EventObject
      extended by com.tibco.amf.platform.runtime.extension.context.LifeCycleEvent
All Implemented Interfaces:
java.io.Serializable

public class LifeCycleEvent
extends java.util.EventObject

An event from the Framework describing a component or bundle life cycle change.

See Also:
Serialized Form

Nested Class Summary
static class LifeCycleEvent.Mode
           
static class LifeCycleEvent.Scope
           
static class LifeCycleEvent.Type
           
 
Field Summary
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
LifeCycleEvent(BaseContext baseContext, LifeCycleEvent.Type type)
           Creates a life cycle event of the specified type.
LifeCycleEvent(BaseContext baseContext, LifeCycleEvent.Type type, java.lang.String adminToken)
           Creates a life cycle event of the specified type.
LifeCycleEvent(java.lang.Object source, LifeCycleEvent.Type type)
           Creates a life cycle event of the specified type.
LifeCycleEvent(java.lang.Object source, LifeCycleEvent.Type type, LifeCycleEvent.Mode mode, LifeCycleEvent.Scope scope)
           Creates a life cycle event of the specified type, mode and scope.
LifeCycleEvent(java.lang.Object source, LifeCycleEvent.Type type, LifeCycleEvent.Mode mode, LifeCycleEvent.Scope scope, java.lang.String adminToken)
           Creates a life cycle event of the specified type, mode and scope.
LifeCycleEvent(java.lang.Object source, LifeCycleEvent.Type type, java.lang.String adminToken)
           Creates a life cycle event of the specified type.
 
Method Summary
 java.lang.String getAdminToken()
           Returns the token sent by TIBCO Matrix Administrator, if this life cycle event was triggered by TIBCO Matrix Administrator, null otherwise
 LifeCycleEvent.Mode getMode()
           Returns the mode of the life cycle event.
 LifeCycleEvent.Scope getScope()
           Returns the scope of the life cycle event.
 LifeCycleEvent.Type getType()
           Returns the type of the life cycle event.
 java.lang.String toString()
           
 
Methods inherited from class java.util.EventObject
getSource
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

LifeCycleEvent

public LifeCycleEvent(BaseContext baseContext,
                      LifeCycleEvent.Type type)

Creates a life cycle event of the specified type.

Parameters:
baseContext - the component/endpoint which had a life cycle change
type - the life cycle event type

LifeCycleEvent

public LifeCycleEvent(BaseContext baseContext,
                      LifeCycleEvent.Type type,
                      java.lang.String adminToken)

Creates a life cycle event of the specified type.

Parameters:
baseContext - the component/endpoint which had a life cycle change
type - the life cycle event type
adminToken - the token sent by admin

LifeCycleEvent

public LifeCycleEvent(java.lang.Object source,
                      LifeCycleEvent.Type type)

Creates a life cycle event of the specified type.

Parameters:
source - the origin of the event
type - the life cycle event type

LifeCycleEvent

public LifeCycleEvent(java.lang.Object source,
                      LifeCycleEvent.Type type,
                      java.lang.String adminToken)

Creates a life cycle event of the specified type.

Parameters:
source - the origin of the event
type - the life cycle event type
adminToken - the token sent by admin

LifeCycleEvent

public LifeCycleEvent(java.lang.Object source,
                      LifeCycleEvent.Type type,
                      LifeCycleEvent.Mode mode,
                      LifeCycleEvent.Scope scope)

Creates a life cycle event of the specified type, mode and scope.

Parameters:
source - the origin of the event
type - the life cycle event type
mode - the life cycle event mode
scope - the life cycle event scope

LifeCycleEvent

public LifeCycleEvent(java.lang.Object source,
                      LifeCycleEvent.Type type,
                      LifeCycleEvent.Mode mode,
                      LifeCycleEvent.Scope scope,
                      java.lang.String adminToken)

Creates a life cycle event of the specified type, mode and scope.

Parameters:
source - the origin of the event
type - the life cycle event type
mode - the life cycle event mode
scope - the life cycle event scope
adminToken - the token sent by admin
Method Detail

getType

public LifeCycleEvent.Type getType()

Returns the type of the life cycle event.

Returns:
the type of the life cycle event

getScope

public LifeCycleEvent.Scope getScope()

Returns the scope of the life cycle event. Scope is available for LifeCycleEvent.Type.STOP and LifeCycleEvent.Type.UNINSTALL life cycle events. For other types, returns null.

Returns:
the scope of the life cycle event

getMode

public LifeCycleEvent.Mode getMode()

Returns the mode of the life cycle event. Mode is available for LifeCycleEvent.Type.STOP and LifeCycleEvent.Type.UNINSTALL life cycle events. For other types, returns null.

Returns:
the scope of the life cycle event

getAdminToken

public java.lang.String getAdminToken()

Returns the token sent by TIBCO Matrix Administrator, if this life cycle event was triggered by TIBCO Matrix Administrator, null otherwise

Returns:
the adminToken

toString

public java.lang.String toString()
Overrides:
toString in class java.util.EventObject


Copyright © 2010 TIBCO Software Inc. All Rights Reserved.