com.vordel.circuit

Class CircuitImpl

java.lang.Object

com.vordel.circuit.CircuitImpl

All Implemented Interfaces:

com.vordel.config.Circuit

Direct Known Subclasses:

SyntheticCircuit

public class CircuitImpl
extends java.lang.Object
implements com.vordel.config.Circuit

Consists of a network of FilterContainerImpls, linked as they will be executed by the server.

In addition to a nominally connected network of nodes, a Circuit may also be configured with a specific filter designated its "Fault Handler", which will be passed the message during server processing if an exception is raised by the circuit while processing that message.

The underlying type of each FilterContainerImpl is dictated by the factory with which the Circuit is initially constructed. Generally, all FilterContainers in a Circuit will implement a specific interface required by the user of the Circuit. (For example, VordelSecure server will attach appropriate MessageProcessor objects for each filter.)

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	name
protected FilterContainerImpl	start

Constructor Summary

Constructors

Constructor and Description
CircuitImpl()

Method Summary

Methods

Modifier and Type	Method and Description
void	configure(com.vordel.config.ConfigContext factory, com.vordel.es.Entity circuitEntity) Load the filter containers for each configured filter in this circuit
void	flushCache() Remove all filters from this circuit
java.lang.String	getDescription()
com.vordel.es.Entity	getEntity() Get the Entity that is used to configure this circuit
java.lang.String	getErrorStatus()
com.vordel.config.FilterContainer	getFaultHandler() Retrieve the fault handler for this circuit
java.util.Collection<FilterContainerImpl>	getFilterContainers() Get all the FilterContainers in this circuit
java.util.Map<com.vordel.es.ESPK,FilterContainerImpl>	getFilterContainersMap() Get all the filter containers in this circuit
java.util.Set<com.vordel.common.util.PropDef>	getGeneratedProperties() Gets the set of properties required by all of the filters in this circuit, including delegates.
java.lang.String	getName() Get the name of the circuit
java.util.Set<com.vordel.common.util.PropDef>	getRequiredProperties()
MessageProcessor	getStartProcessor() Locate the starting point for injecting messages into this circuit.
void	setFaultHandler(FilterContainerImpl handler) Set the fault handler for this circuit

Methods inherited from class java.lang.Object

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

Field Detail

start

protected FilterContainerImpl start

name

protected java.lang.String name

Constructor Detail

CircuitImpl

public CircuitImpl()

Method Detail

getErrorStatus

public java.lang.String getErrorStatus()

Specified by:

getErrorStatus in interface com.vordel.config.Circuit

getFaultHandler

public com.vordel.config.FilterContainer getFaultHandler()

Retrieve the fault handler for this circuit

Specified by:

getFaultHandler in interface com.vordel.config.Circuit

Returns:

a filter container for the fault handler

setFaultHandler

public void setFaultHandler(FilterContainerImpl handler)

Set the fault handler for this circuit

Parameters:

handler - The filter container of the fault handler

getEntity

public com.vordel.es.Entity getEntity()

Get the Entity that is used to configure this circuit

getRequiredProperties

public java.util.Set<com.vordel.common.util.PropDef> getRequiredProperties()

getGeneratedProperties

public java.util.Set<com.vordel.common.util.PropDef> getGeneratedProperties()

Gets the set of properties required by all of the filters in this circuit, including delegates.

Returns:

the set of all properties required by all filters in this circuit.

configure

public void configure(com.vordel.config.ConfigContext factory,
             com.vordel.es.Entity circuitEntity)
               throws com.vordel.es.EntityStoreException

Load the filter containers for each configured filter in this circuit

Parameters:

factory - The factory to use for creating filter containers for this circuit

circuitEntity - The entity representing this circuit in "store"

Throws:

com.vordel.es.EntityStoreException

getFilterContainersMap

public java.util.Map<com.vordel.es.ESPK,FilterContainerImpl> getFilterContainersMap()

Get all the filter containers in this circuit

Returns:

A Map of all FilterContainers in this Circuit, keyed by ESPK

getFilterContainers

public java.util.Collection<FilterContainerImpl> getFilterContainers()

Get all the FilterContainers in this circuit

Returns:

A Collection of all FilterContainers in this Circuit.

getStartProcessor

public MessageProcessor getStartProcessor()

Locate the starting point for injecting messages into this circuit.

Specified by:

getStartProcessor in interface com.vordel.config.Circuit

Returns:

The filter container marked as the starting point for this circuit.

getName

public java.lang.String getName()

Get the name of the circuit

Specified by:

getName in interface com.vordel.config.Circuit

Returns:

The circuit name

flushCache

public void flushCache()

Remove all filters from this circuit

getDescription

public java.lang.String getDescription()