com.sitewhere.spi.server.lifecycle

Interface ILifecycleComponent

All Known Subinterfaces:

IAssetManagement, IAssetManagementCacheProvider, IAssetModule<T>, IAssetModuleManager, IAssignmentStateManager, IBatchOperationManager, ICommandDeliveryParameterExtractor<T>, ICommandDeliveryProvider<T,P>, ICommandDestination<T,P>, ICommandExecutionBuilder, ICommandExecutionEncoder<T>, ICommandProcessingStrategy, ICommandTargetResolver, ICompositeDeviceEventDecoder<T>, ICompositeDeviceEventDecoder.IDecoderChoice<T>, ICompositeDeviceEventDecoder.IMessageMetadataExtractor<T>, IDeviceCommunication, IDeviceEventDecoder<T>, IDeviceEventFilter, IDeviceEventManagement, IDeviceEventMulticaster<T>, IDeviceEventSearchProvider, IDeviceManagement, IDeviceManagementCacheProvider, IDevicePresenceManager, IDeviceStreamManager, IDiscoverableTenantLifecycleComponent, IEventProcessing, IFilteredOutboundEventProcessor, IInboundEventProcessor, IInboundEventProcessorChain, IInboundEventReceiver<T>, IInboundEventSource<T>, IInboundProcessingStrategy, IMulticastingOutboundEventProcessor<T>, IOutboundCommandRouter, IOutboundEventProcessor, IOutboundEventProcessorChain, IOutboundProcessingStrategy, IRegistrationManager, IResourceManager, IScheduleManagement, IScheduleManager, ISearchProvider, ISearchProviderManager, ISocketInteractionHandlerFactory<T>, ISymbolGenerator, ISymbolGeneratorManager, ITenantLifecycleComponent, ITenantManagement, IUserManagement

public interface ILifecycleComponent

Lifecycle methods used in SiteWhere components.

Method Summary

Modifier and Type	Method and Description
boolean	canPause() Indicates to framework whether component can be paused.
java.util.List<ILifecycleComponent>	findComponentsOfType(LifecycleComponentType type) Find components (including this component and nested components) that are of the given type.
java.lang.String	getComponentId() Get the unique component id.
java.lang.String	getComponentName() Get human-readable name shown for component.
LifecycleComponentType	getComponentType() Get component type.
java.util.Date	getCreatedDate() Get date the component was created.
java.util.Map<java.lang.String,ILifecycleComponent>	getLifecycleComponents() Get map of contained ILifecycleComponent elements by unique id.
SiteWhereException	getLifecycleError() Gets the last lifecycle error that occurred.
LifecycleStatus	getLifecycleStatus() Get current lifecycle status.
org.apache.logging.log4j.Logger	getLogger() Get component logger.
void	initialize(ILifecycleProgressMonitor monitor) Initialize the component.
void	initializeNestedComponent(ILifecycleComponent component, ILifecycleProgressMonitor monitor) Initialize a nested component.
void	lifecycleInitialize(ILifecycleProgressMonitor monitor) Initializes the component while keeping up with lifeycle information.
void	lifecyclePause(ILifecycleProgressMonitor monitor) Pauses the component while keeping up with lifecycle information.
void	lifecycleStart(ILifecycleProgressMonitor monitor) Starts the component while keeping up with lifecycle information.
void	lifecycleStop(ILifecycleProgressMonitor monitor) Stops the component while keeping up with lifecycle information.
void	lifecycleStop(ILifecycleProgressMonitor monitor, ILifecycleConstraints constraints) Stops the component while keeping up with lifecycle information.
void	logState() Logs the state of this component and all nested components.
void	pause(ILifecycleProgressMonitor monitor) Pause the component.
void	start(ILifecycleProgressMonitor monitor) Start the component.
void	startNestedComponent(ILifecycleComponent component, ILifecycleProgressMonitor monitor, java.lang.String errorMessage, boolean require) Start component as a nested lifecycle component.
void	stop(ILifecycleProgressMonitor monitor) Stop the component.
void	stop(ILifecycleProgressMonitor monitor, ILifecycleConstraints constraints) Stop the component.

Method Detail

getComponentId

java.lang.String getComponentId()

Get the unique component id.

Returns:

getComponentName

java.lang.String getComponentName()

Get human-readable name shown for component.

Returns:

getComponentType

LifecycleComponentType getComponentType()

Get component type.

Returns:

getLifecycleStatus

LifecycleStatus getLifecycleStatus()

Get current lifecycle status.

Returns:

getLifecycleError

SiteWhereException getLifecycleError()

Gets the last lifecycle error that occurred.

Returns:

getLifecycleComponents

java.util.Map<java.lang.String,ILifecycleComponent> getLifecycleComponents()

Get map of contained ILifecycleComponent elements by unique id.

Returns:

lifecycleInitialize

void lifecycleInitialize(ILifecycleProgressMonitor monitor)

Initializes the component while keeping up with lifeycle information.

Parameters:

monitor -

initialize

void initialize(ILifecycleProgressMonitor monitor)
         throws SiteWhereException

Initialize the component.

Parameters:

monitor -

Throws:

SiteWhereException

initializeNestedComponent

void initializeNestedComponent(ILifecycleComponent component,
                               ILifecycleProgressMonitor monitor)
                        throws SiteWhereException

Initialize a nested component.

Parameters:

component -

monitor -

Throws:

SiteWhereException

lifecycleStart

void lifecycleStart(ILifecycleProgressMonitor monitor)

Starts the component while keeping up with lifecycle information.

start

void start(ILifecycleProgressMonitor monitor)
    throws SiteWhereException

Start the component.

Throws:

SiteWhereException

startNestedComponent

void startNestedComponent(ILifecycleComponent component,
                          ILifecycleProgressMonitor monitor,
                          java.lang.String errorMessage,
                          boolean require)
                   throws SiteWhereException

Start component as a nested lifecycle component.

Parameters:

component -

monitor -

errorMessage -

require -

Throws:

SiteWhereException

lifecyclePause

void lifecyclePause(ILifecycleProgressMonitor monitor)

Pauses the component while keeping up with lifecycle information.

canPause

boolean canPause()
          throws SiteWhereException

Indicates to framework whether component can be paused.

Returns:

Throws:

SiteWhereException

pause

void pause(ILifecycleProgressMonitor monitor)
    throws SiteWhereException

Pause the component.

Throws:

SiteWhereException

lifecycleStop

void lifecycleStop(ILifecycleProgressMonitor monitor)

Stops the component while keeping up with lifecycle information.

Parameters:

monitor -

lifecycleStop

void lifecycleStop(ILifecycleProgressMonitor monitor,
                   ILifecycleConstraints constraints)

Stops the component while keeping up with lifecycle information. This version allows constraints to be passed to the operation.

Parameters:

monitor -

constraints -

stop

void stop(ILifecycleProgressMonitor monitor)
   throws SiteWhereException

Stop the component.

Throws:

SiteWhereException

stop

void stop(ILifecycleProgressMonitor monitor,
          ILifecycleConstraints constraints)
   throws SiteWhereException

Stop the component. This version allows constraints to be passed to the operation.

Throws:

SiteWhereException

findComponentsOfType

java.util.List<ILifecycleComponent> findComponentsOfType(LifecycleComponentType type)
                                                  throws SiteWhereException

Find components (including this component and nested components) that are of the given type.

Parameters:

type -

Returns:

Throws:

SiteWhereException

getCreatedDate

java.util.Date getCreatedDate()

Get date the component was created.

Returns:

getLogger

org.apache.logging.log4j.Logger getLogger()

Get component logger.

Returns:

logState

void logState()

Logs the state of this component and all nested components.