com.vordel.circuit

Class SoftCircuitReference

java.lang.Object

com.vordel.circuit.CircuitReference

com.vordel.circuit.SoftCircuitReference

public class SoftCircuitReference
extends CircuitReference

SoftCircuitReference will allow you to reference a circuit via an ESPK available from the global properties map, via the message whiteboard.

Field Summary

Fields inherited from class com.vordel.circuit.CircuitReference

isEnabled, label, pk

Constructor Summary

Constructors

Constructor and Description
SoftCircuitReference(java.lang.String prop)

Method Summary

Modifier and Type	Method and Description
Circuit	getCircuit(Message m) Call this from the processor.
ESPK	getCircuitPK(GlobalProperties gp)
java.lang.Object	getContext() For tracking the call path, retrieve the indexing information we used to lookup the circuit to execute.
java.lang.String	getProperty()
void	setCircuit(Circuit circuit)

Methods inherited from class com.vordel.circuit.CircuitReference

getCircuitPK, setEnabled, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SoftCircuitReference

public SoftCircuitReference(java.lang.String prop)

Method Detail

getProperty

public java.lang.String getProperty()

getCircuit

public Circuit getCircuit(Message m)
                   throws CircuitAbortException

Call this from the processor.

Overrides:

getCircuit in class CircuitReference

Parameters:

m - The Message to aid in locating the relevant Circuit this reference points to.

Returns:

The Circuit this object references.

Throws:

CircuitAbortException - If the referring Circuit cannot be identified.

getCircuitPK

public ESPK getCircuitPK(GlobalProperties gp)

setCircuit

public void setCircuit(Circuit circuit)

Overrides:

setCircuit in class CircuitReference

getContext

public java.lang.Object getContext()

Description copied from class: CircuitReference

For tracking the call path, retrieve the indexing information we used to lookup the circuit to execute. In the simple case, it will be the ESPK. For a soft reference, return the property value we used to indirect to the circuit.

Overrides:

getContext in class CircuitReference

Returns:

The index we used to lookup the circuit.