Packageflex.messaging.services
Classpublic class AbstractBootstrapService
InheritanceAbstractBootstrapService Inheritance Object

The purpose of AbstractBootstrapService is to enable creation of dynamic services, destinations, and adapters. MessageBroker creates an instance of this class and calls initialize after all of the server components are created but right before they are started. MessageBroker also calls start as server starts and stop as server stops. Subclasses should have their dynamic component creation code in one of initialize, start, and stop methods depending on when they want their components to be created.



Public Methods
 MethodDefined By
  
Default constructor which is no-op.
AbstractBootstrapService
  
String getId()
Returns the id of the AbstractBootstrapService.
AbstractBootstrapService
  
Returns the MessageBroker managing this AbstractBootstrapService.
AbstractBootstrapService
  
void initialize(String id, ConfigMap properties)
Called by the MessageBroker after all of the server components are created but right before they are started.
AbstractBootstrapService
  
boolean isManaged()
Always unmanaged.
AbstractBootstrapService
  
void setId(String id)
Sets the id of the AbstractBootstrapService.
AbstractBootstrapService
  
void setManaged(boolean enableManagement)
Management is always disabled.
AbstractBootstrapService
  
Sets the MessageBroker managing this AbstractBootstrapService.
AbstractBootstrapService
  
void start()
Called by the MessageBroker as server starts.
AbstractBootstrapService
  
void stop()
Called by the MessageBroker as server stops.
AbstractBootstrapService
Constructor Detail
AbstractBootstrapService()
public AbstractBootstrapService()

Default constructor which is no-op.

Method Detail
getId()
public String getId()

Returns the id of the AbstractBootstrapService.

Returns
The id of the AbstractBootstrapService.
getMessageBroker() 
public MessageBroker getMessageBroker()

Returns the MessageBroker managing this AbstractBootstrapService.

Returns
MessageBroker of the AbstractBootstrapService.
initialize() 
public void initialize(String id, ConfigMap properties)

Called by the MessageBroker after all of the server components are created but right before they are started. This is usually the place to create dynamic components.

Parameters

id — Id of the AbstractBootstrapService.
 
properties — Properties for the AbstractBootstrapService.

isManaged() 
public boolean isManaged()

Always unmanaged.

Returns
false.
setId() 
public void setId(String id)

Sets the id of the AbstractBootstrapService. If the AbstractBootstrapService has a MessageBroker already assigned, it also updates the id in the MessageBroker.

Parameters

id

setManaged() 
public void setManaged(boolean enableManagement)

Management is always disabled.

Parameters

enableManagement

setMessageBroker() 
public void setMessageBroker(MessageBroker broker)

Sets the MessageBroker managing this AbstractBootstrapService. Removes the AbstractService from the old broker (if there was one) and adds to the list of services in the new broker.

Parameters

brokerMessageBroker of the AbstractBootstrapService.

start() 
public void start()

Called by the MessageBroker as server starts. Useful for custom code that needs to run after all the components are initialized and the server is starting up.

stop() 
public void stop()

Called by the MessageBroker as server stops. Useful for custom code that needs to run as the server is shutting down.





 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/livecycle/8.2/programLC/programmer/javadoc/flex/messaging/services/AbstractBootstrapService.html