Package org.apache.synapse.endpoints

Class ClassEndpoint

java.lang.Object

org.apache.synapse.FaultHandler

org.apache.synapse.endpoints.AbstractEndpoint

org.apache.synapse.endpoints.ClassEndpoint

All Implemented Interfaces:

Endpoint, ManagedLifecycle, Nameable, PropertyInclude, SynapseArtifact

public class ClassEndpoint
extends AbstractEndpoint

Class which defines custom user defined endpoints. Custom Endpoint implementations must extend the AbstractEndpoint class. eg: XYZ*

Field Summary

Fields inherited from class org.apache.synapse.endpoints.AbstractEndpoint

anonymous, artifactContainerName, CHILDREN_JSON_ATT, errorHandler, fileName, initialized, isClusteringEnabled, log, NAME_JSON_ATT, trace, TYPE_JSON_ATT

Constructor Summary

Constructors

Constructor	Description
ClassEndpoint()

Method Summary

Modifier and Type	Method	Description
protected void	createJsonRepresentation()
Endpoint	getClassEndpoint()
Map<String,String>	getParameters()
void	init(SynapseEnvironment synapseEnvironment)	Override the AbstractEndpoint.init() to load a custom synapse environment.
void	send(MessageContext synCtx)	Sends the message context according to an endpoint specific behavior.
void	sendMessage(MessageContext synMessageContext)	Override the AbstractEndpoint.send() to have a custom message send out logic.
void	setClassEndpoint(Endpoint classEndpoint)
void	setParameters(String name, String value)

Methods inherited from class org.apache.synapse.endpoints.AbstractEndpoint

addProperties, addProperty, destroy, evaluateProperties, executeEpTypeSpecificFunctions, getArtifactContainerName, getChildren, getCommentsList, getContext, getDefinition, getDescription, getEndpointChildrenAsJson, getErrorHandler, getFileName, getIsEdited, getJsonRepresentation, getMetricsMBean, getName, getParentEndpoint, getProperties, getProperty, getReportingName, getValue, handleException, handleException, handleException, informFailure, isAnonymous, isInitialized, isLeafEndpoint, isRetry, isSuspendFault, isTimeout, isTraceOn, isTraceOrDebugOn, logOnChildEndpointFail, logSetter, onChildEndpointFail, onFault, onSuccess, prepareForEndpointStatistics, readyToSend, removeProperty, setAdvancedProperties, setAnonymous, setArtifactContainerName, setChildren, setCommentsList, setComponentStatisticsId, setContentAware, setDefinition, setDescription, setEnableMBeanStats, setErrorHandler, setErrorOnMessage, setFileName, setForceBuildMC, setIsEdited, setName, setParentEndpoint, setValue, toString, traceOrDebug

Methods inherited from class org.apache.synapse.FaultHandler

executeExtendedSynapseHandlerOnFault, getStackTrace, handleFault, handleFault

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassEndpoint

public ClassEndpoint()

Method Detail

getParameters

public Map<String,String> getParameters()

setParameters

public void setParameters(String name,
                          String value)

setClassEndpoint

public void setClassEndpoint(Endpoint classEndpoint)

getClassEndpoint

public Endpoint getClassEndpoint()

send

public void send(MessageContext synCtx)

Description copied from interface: Endpoint

Sends the message context according to an endpoint specific behavior.

Specified by:

send in interface Endpoint

Overrides:

send in class AbstractEndpoint

Parameters:

synCtx - MessageContext to be sent.

createJsonRepresentation

protected void createJsonRepresentation()

Specified by:

createJsonRepresentation in class AbstractEndpoint

init

public void init(SynapseEnvironment synapseEnvironment)

Override the AbstractEndpoint.init() to load a custom synapse environment.

Specified by:

init in interface ManagedLifecycle

Overrides:

init in class AbstractEndpoint

Parameters:

synapseEnvironment - SynapseEnvironment to be used for initialization

sendMessage

public void sendMessage(MessageContext synMessageContext)

Override the AbstractEndpoint.send() to have a custom message send out logic.