com.tailf.ncs

Class PlanComponent

Object

com.tailf.ncs.PlanComponent

public class PlanComponent
extends Object

This class represents a plan component with its states. The usage of this class in in conjunction with a service that uses a reactive fastmap pattern. With a plan the service states can be tracked and controlled. A service plan can consist of one or many PlanComponents. This is operational data that is stored together with the service config.

Constructor Summary

Constructors

Constructor and Description
PlanComponent(NavuNode service, String name, String componentType) Creation of a plan component.
PlanComponent(NavuNode service, String name, String componentType, ConfObjectRef serviceReference)

Method Summary

Modifier and Type	Method and Description
PlanComponent	appendState(String stateName) This method supplies a state to the specific component.
PlanComponent	appendState(String stateName, String createMonitor, String createTriggerExpr)
PlanComponent	appendState(String stateName, String createMonitor, String createTriggerExpr, String deleteMonitor, String deleteTriggerExpr)
PlanComponent	backTrack()
PlanComponent	backTrack(boolean isBacktracking)
PlanComponent	setFailed(String stateName) Setting status to ncs:failed for a specific state in the plan component
PlanComponent	setNotReached(String stateName) Setting status to ncs:not-reached for a specific state in the plan component
PlanComponent	setReached(String stateName) Setting status to ncs:reached for a specific state in the plan component

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PlanComponent

public PlanComponent(NavuNode service,
                     String name,
                     String componentType)
              throws NavuException

Creation of a plan component. It uses a NavuNode pointing to the service. This is normally the same NavuNode as supplied as an argument to the service create() method.

Parameters:

service -

name -

componentType -

Throws:

NavuException

PlanComponent

public PlanComponent(NavuNode service,
                     String name,
                     String componentType,
                     ConfObjectRef serviceReference)
              throws NavuException

Throws:

NavuException

Method Detail

appendState

public PlanComponent appendState(String stateName)
                          throws NavuException

This method supplies a state to the specific component. The initial status for this state can be ncs:reached or ncs:not-reached and is indicated by setting the reached boolean to true or false respectively

Parameters:

stateName -

Returns:

PlanComponent

Throws:

NavuException

appendState

public PlanComponent appendState(String stateName,
                                 String createMonitor,
                                 String createTriggerExpr)
                          throws NavuException

Throws:

NavuException

appendState

public PlanComponent appendState(String stateName,
                                 String createMonitor,
                                 String createTriggerExpr,
                                 String deleteMonitor,
                                 String deleteTriggerExpr)
                          throws NavuException

Throws:

NavuException

setNotReached

public PlanComponent setNotReached(String stateName)
                            throws NavuException

Setting status to ncs:not-reached for a specific state in the plan component

Parameters:

stateName -

Returns:

PlanComponent

Throws:

NavuException

setReached

public PlanComponent setReached(String stateName)
                         throws NavuException

Setting status to ncs:reached for a specific state in the plan component

Parameters:

stateName -

Returns:

PlanComponent

Throws:

NavuException

setFailed

public PlanComponent setFailed(String stateName)
                        throws NavuException

Setting status to ncs:failed for a specific state in the plan component

Parameters:

stateName -

Returns:

PlanComponent

Throws:

NavuException

backTrack

public PlanComponent backTrack()
                        throws NavuException

Throws:

NavuException

backTrack

public PlanComponent backTrack(boolean isBacktracking)
                        throws NavuException

Throws:

NavuException