org.jumpi.spi
Interface Manageable

All Known Subinterfaces:

Component, Connector, Controller, Jumpi, Logger, SequenceGenerator, TaskScheduler, ThreadFactory, Timer, Transformer

All Known Implementing Classes:

AbstractConnector, AbstractController, AbstractTransformer, DaemonThreadFactory, JumpiImpl, SequenceGeneratorImpl, SystemLoggerImpl, TaskSchedulerImpl, TcpConnectionAcceptor, ThreadFactoryImpl, TimerImpl, UdpTransceiver

public interface Manageable

The Manageable interface provides a means for managing a Jumpi component at runtime, and providing lifecycle support.

The component lifecycle starts with a LINK, and then STARTUP operation. The lifecycle is ended with a two phase shutdown, using the SHUTDOWN, JOIN and then UNLINK operations. It is intended that a Jumpi component instance can be reusable by being able to go through multiple lifecycles with re-configuration when the instance is not active.

The MANAGE operation allows management of specific components or sets of components within the Jumpi component tree. The operation to be performed during the MANAGE operation is defined by the given parameters.

The INFO operation allows information to be given from the Jumpi components to the caller of the INFO operation. This may give transparency to internal state of the Jumpi instance. Each Jumpi component shall place textual information pertaining to the state of the component in a Hashtable provided as parameters, referenced under the fully qualified name of the component. This can be used to find all the names of the internal components. This is useful later for the MANAGE operation.

See Also:

Operation, Parameters

Method Summary

void	manage(Component root, Component parent, java.lang.String operation, java.util.Hashtable parameters) Perform a recursive management operation through the Jumpi component tree, using the parameters provided.

Method Detail

manage

public void manage(Component root,
                   Component parent,
                   java.lang.String operation,
                   java.util.Hashtable parameters)
            throws java.lang.Exception

Perform a recursive management operation through the Jumpi component tree, using the parameters provided.

The following management actions must be handled:

• LINK. Link the instance with a Jumpi instance at the root of the Jumpi component tree and possibly the parent component.
• STARTUP. Perform initialization actions and be able to handle normal send and receive operations thereafter.
• SHUTDOWN. Note that instance is shutting down. Send and Recv operations can no longer be started. Pending send and receive operations are should be forcibly failed.
• JOIN. Return only when the shutdown is truly complete. There are several reasons why a shutdown is not immediately complete after the SHUTDOWN. Firstly in the interests of performance, the management operations do not strictly synchronize with normal send and receive operations. Therefore there are race conditions on shutdown and a clean shutdown end state can only be reached after the race conditions are guaranteed to be completed. Secondly, threads may be blocked in operating system calls until a timeout, in which case a shutdown only completes after the threads have timed-out.
• UNLINK. Remove the link to the Jumpi instance and any parent.
• INFO. Adds an textual information to the Parameters.INFO_RESULT_SET using the component's fully qualified name as key.
• MANAGE. Specific component implementation dependent management operations.

Parameters:

root - the Jumpi instance at the root of the component tree.

parent - the immediate parent of the component.

operation - the operation.

parameters - the operation parameters.

Throws:

java.lang.Exception - if any failure to perform management occurs.

java.lang.IllegalArgumentException - when parameters are missing.