public class Circuit
extends java.lang.Object
FilterContainer
s, 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 FilterContainer
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.)
Modifier and Type | Field and Description |
---|---|
protected java.lang.String |
name |
protected FilterContainer |
start |
Constructor and Description |
---|
Circuit() |
Modifier and Type | Method and Description |
---|---|
void |
configure(CircuitCache factory,
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() |
Entity |
getEntity()
Get the Entity that is used to configure this circuit
|
FilterContainer |
getFaultHandler()
Retrieve the fault handler for this circuit
|
java.util.Collection<FilterContainer> |
getFilterContainers()
Get all the FilterContainers in this circuit
|
java.util.Map<ESPK,FilterContainer> |
getFilterContainersMap()
Get all the filter containers in this circuit
|
java.util.Set<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<PropDef> |
getRequiredProperties() |
FilterContainer |
getStartFilter()
Locate the starting point for injecting messages into this circuit.
|
void |
setFaultHandler(FilterContainer handler)
Set the fault handler for this circuit
|
protected FilterContainer start
protected java.lang.String name
public FilterContainer getFaultHandler()
public void setFaultHandler(FilterContainer handler)
handler
- The filter container of the fault handlerpublic Entity getEntity()
public java.util.Set<PropDef> getRequiredProperties()
public java.util.Set<PropDef> getGeneratedProperties()
public void configure(CircuitCache factory, Entity circuitEntity) throws EntityStoreException
factory
- The factory to use for creating filter containers for this circuitcircuitEntity
- The entity representing this circuit in "store"EntityStoreException
public java.util.Map<ESPK,FilterContainer> getFilterContainersMap()
public java.util.Collection<FilterContainer> getFilterContainers()
public FilterContainer getStartFilter()
public java.lang.String getName()
public void flushCache()
public java.lang.String getDescription()
This documentation and all its contents and graphics, copyright © 1999 - 2011 Vordel