SynapseEnvironment (Apache Synapse 3.0.1 API)
JavaScript is disabled on your browser.
Skip navigation links
Overview
Package
Class
Use
Tree
Deprecated
Index
Help
Prev Class
Next Class
Frames
No Frames
All Classes
Summary: 
Nested | 
Field | 
Constr | 
Method
Detail: 
Field | 
Constr | 
Method
org.apache.synapse.core
Interface SynapseEnvironment
All Known Implementing Classes:
Axis2SynapseEnvironment
public interface SynapseEnvironment
The SynapseEnvironment allows access into the the host SOAP engine. It allows
the sending of messages, class loader access etc.
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods 
Modifier and Type
Method and Description
MessageContext
createMessageContext()
Creates a new Synapse MessageContext instance.
org.apache.axiom.util.blob.OverflowBlob
createOverflowBlob()
Creates a new TemporaryData instance for the temp storage requirements
ExecutorService
getExecutorService()
This is used by anyone who needs access to a SynapseThreadPool.
ServerContextInformation
getServerContextInformation()
Get the information about the synapse environment.
StatisticsCollector
getStatisticsCollector()
This method returns the StatisticsCollector responsible for
collecting stats for this synapse instance.
SynapseConfiguration
getSynapseConfiguration()
Retrieves the SynapseConfiguration from the environment
SynapseTaskManager
getTaskManager()
Retrieve the SynapseTaskManager from the
environment.
Map<QName,SynapseXpathFunctionContextProvider>
getXpathFunctionExtensions()
Get all Xpath Extension objects for Function contexts
Map<QName,SynapseXpathVariableResolver>
getXpathVariableExtensions()
Get all Xpath Extension objects for Variable contexts
void
injectAsync(MessageContext smc,
SequenceMediator seq)
This method injects a new message into the Synapse engine for the mediation
by the specified sequence.
boolean
injectMessage(MessageContext smc)
This method injects a new message into the Synapse engine.
boolean
isInitialized()
Has the Synapse Environment properly initialized?
void
send(EndpointDefinition endpoint,
MessageContext smc)
This method allows a message to be sent through the underlying SOAP engine.
void
setInitialized(boolean state)
Set the environment as ready for message processing
void
setStatisticsCollector(StatisticsCollector statisticsCollector)
Deprecated. 
Method Detail
injectMessage
boolean injectMessage(MessageContext smc)
This method injects a new message into the Synapse engine. This is used by
the underlying SOAP engine to inject messages into Synapse for mediation.
e.g. The SynapseMessageReceiver used by Axis2 invokes this to inject new messages
Parameters:
smc - - Synapse MessageContext to be injected
Returns:
boolean true if the message processing should be continued
and false if it should be aborted
injectAsync
void injectAsync(MessageContext smc,
SequenceMediator seq)
This method injects a new message into the Synapse engine for the mediation
by the specified sequence. This is used by custom mediation tasks like splitting message
in EIP mediation. This method will do the mediation asynchronously using a separate
thread from the environment thread pool
Parameters:
smc - - Synapse message context to be injected
seq - - Sequence to be used for mediation
send
void send(EndpointDefinition endpoint,
MessageContext smc)
This method allows a message to be sent through the underlying SOAP engine. This will
send request messages on (forward), and send the response messages back to the client
Parameters:
endpoint - - Endpoint to be used for sending
smc - - Synapse MessageContext to be sent
createMessageContext
MessageContext createMessageContext()
Creates a new Synapse MessageContext instance.
Returns:
a MessageContext
createOverflowBlob
org.apache.axiom.util.blob.OverflowBlob createOverflowBlob()
Creates a new TemporaryData instance for the temp storage requirements
Returns:
a TemporaryData created from the parameters provided in the synapse.properties
getStatisticsCollector
StatisticsCollector getStatisticsCollector()
This method returns the StatisticsCollector responsible for
collecting stats for this synapse instance.
Returns:
Returns the StatisticsCollector
setStatisticsCollector
@Deprecated
void setStatisticsCollector(StatisticsCollector statisticsCollector)
Deprecated. 
To set the StatisticsCollector to the environment
Parameters:
statisticsCollector - - StatisticsCollector to be set
getExecutorService
ExecutorService getExecutorService()
This is used by anyone who needs access to a SynapseThreadPool.
It offers the ability to start work.
Returns:
Returns the ExecutorService
isInitialized
boolean isInitialized()
Has the Synapse Environment properly initialized?
Returns:
true if the environment is ready for processing
setInitialized
void setInitialized(boolean state)
Set the environment as ready for message processing
Parameters:
state - true means ready for processing
getSynapseConfiguration
SynapseConfiguration getSynapseConfiguration()
Retrieves the SynapseConfiguration from the environment
Returns:
configuration of the synapse
getTaskManager
SynapseTaskManager getTaskManager()
Retrieve the SynapseTaskManager from the
environment.
Returns:
SynapseTaskManager of this synapse environment
getServerContextInformation
ServerContextInformation getServerContextInformation()
Get the information about the synapse environment.
Returns:
ServerContextInformation of this synapse environment
getXpathFunctionExtensions
Map<QName,SynapseXpathFunctionContextProvider> getXpathFunctionExtensions()
Get all Xpath Extension objects for Function contexts
Returns:
Map containing xpath extension objects
getXpathVariableExtensions
Map<QName,SynapseXpathVariableResolver> getXpathVariableExtensions()
Get all Xpath Extension objects for Variable contexts
Returns:
Map containing xpath extension objects
Skip navigation links
Overview
Package
Class
Use
Tree
Deprecated
Index
Help
Prev Class
Next Class
Frames
No Frames
All Classes
Summary: 
Nested | 
Field | 
Constr | 
Method
Detail: 
Field | 
Constr | 
Method
Copyright © 2005-2017 Apache Software Foundation. All Rights Reserved.