Package org.apache.synapse.inbound

Class InboundEndpoint

java.lang.Object

org.apache.synapse.inbound.InboundEndpoint

All Implemented Interfaces:

AspectConfigurable, ManagedLifecycle

public class InboundEndpoint
extends Object
implements AspectConfigurable, ManagedLifecycle

Entity which is responsible for exposing ESB message flow as an endpoint which can be invoked by Clients. InboundEndpoint is an artifact type which can be created/modified dynamically.

Field Summary

Fields

Modifier and Type	Field	Description
protected static org.apache.commons.logging.Log	log

Constructor Summary

Constructors

Constructor	Description
InboundEndpoint()

Method Summary

Modifier and Type	Method	Description
void	addHandler(org.apache.synapse.commons.handlers.MessagingHandler handler)
void	addParameter(String name, String value)
void	addParameter(String name, String value, String key)
void	configure(AspectConfiguration aspectConfiguration)	Configure aspects according to the given configuration
void	destroy()	Remove inbound endpoints.
void	destroy(boolean removeTask)	Remove inbound endpoints.
String	getArtifactContainerName()
AspectConfiguration	getAspectConfiguration()	Get the aspects configuration
String	getClassImpl()
String	getFileName()
List<org.apache.synapse.commons.handlers.MessagingHandler>	getHandlers()
String	getInjectingSeq()
boolean	getIsEdited()
String	getName()
String	getOnErrorSeq()
String	getParameter(String name)
String	getParameterKey(String name)
Map<String,String>	getParametersMap()
String	getProtocol()
void	init(SynapseEnvironment se)	This method should implement the initialization of the implemented parts of the configuration.
boolean	isSuspend()
void	setArtifactContainerName(String name)
void	setClassImpl(String classImpl)
void	setComponentStatisticsId(ArtifactHolder holder)
void	setFileName(String fileName)
void	setInjectingSeq(String injectingSeq)
void	setIsEdited(boolean isEdited)
void	setName(String name)
void	setOnErrorSeq(String onErrorSeq)
void	setProtocol(String protocol)
void	setSuspend(boolean isSuspend)

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static final org.apache.commons.logging.Log log

Constructor Detail

InboundEndpoint

public InboundEndpoint()

Method Detail

init

public void init(SynapseEnvironment se)

Description copied from interface: ManagedLifecycle

This method should implement the initialization of the implemented parts of the configuration.

Specified by:

init in interface ManagedLifecycle

Parameters:

se - SynapseEnvironment to be used for initialization

destroy

public void destroy(boolean removeTask)

Remove inbound endpoints.

This was introduced as a fix for product-ei#1206.

Parameters:

removeTask - Whether to remove scheduled task or not.

destroy

public void destroy()

Remove inbound endpoints.

Specified by:

destroy in interface ManagedLifecycle

getName

public String getName()

setName

public void setName(String name)

getProtocol

public String getProtocol()

setProtocol

public void setProtocol(String protocol)

isSuspend

public boolean isSuspend()

setSuspend

public void setSuspend(boolean isSuspend)

getInjectingSeq

public String getInjectingSeq()

setInjectingSeq

public void setInjectingSeq(String injectingSeq)

getOnErrorSeq

public String getOnErrorSeq()

setOnErrorSeq

public void setOnErrorSeq(String onErrorSeq)

getFileName

public String getFileName()

setFileName

public void setFileName(String fileName)

getParametersMap

public Map<String,String> getParametersMap()

addParameter

public void addParameter(String name,
                         String value)

addParameter

public void addParameter(String name,
                         String value,
                         String key)

getParameter

public String getParameter(String name)

getParameterKey

public String getParameterKey(String name)

getClassImpl

public String getClassImpl()

setClassImpl

public void setClassImpl(String classImpl)

setArtifactContainerName

public void setArtifactContainerName(String name)

getArtifactContainerName

public String getArtifactContainerName()

getIsEdited

public boolean getIsEdited()

setIsEdited

public void setIsEdited(boolean isEdited)

configure

public void configure(AspectConfiguration aspectConfiguration)

Description copied from interface: AspectConfigurable

Configure aspects according to the given configuration

Specified by:

configure in interface AspectConfigurable

Parameters:

aspectConfiguration - AspectConfiguration instance

getAspectConfiguration

public AspectConfiguration getAspectConfiguration()

Description copied from interface: AspectConfigurable

Get the aspects configuration

Specified by:

getAspectConfiguration in interface AspectConfigurable

Returns:

AspectConfiguration instance

setComponentStatisticsId

public void setComponentStatisticsId(ArtifactHolder holder)

getHandlers

public List<org.apache.synapse.commons.handlers.MessagingHandler> getHandlers()

addHandler

public void addHandler(org.apache.synapse.commons.handlers.MessagingHandler handler)