org.apache.synapse.endpoints.utils
Class EndpointDefinition

java.lang.Object
  org.apache.synapse.endpoints.utils.EndpointDefinition

public class EndpointDefinition
extends Object

Endpoint definition contains the information about an web services endpoint. It is used by leaf level endpoints to keep these information (e.g. AddressEndpoint and WSDLEndpoint). An EndpointDefinition object is used by only one endpoint and they cannot be looked up in the registry.

Constructor Summary

EndpointDefinition()

Method Summary

String	getAddress() This should return the absolute EPR address referenced by the named endpoint.
String	getAddressingVersion() Get the addressing namespace version
String	getCharSetEncoding() Get the charset encoding for messages sent to the endpoint.
String	getFormat()
int	getStatisticsState() To check whether statistics should have collected or not
long	getSuspendOnFailDuration() Get the suspend on fail duration.
int	getTimeoutAction()
long	getTimeoutDuration()
int	getTraceState()
String	getWsRMPolicyKey() Get the WS-RM configuration policys' 'key' to be used
String	getWsSecPolicyKey() Return the Rampart Security configuration policys' 'key' to be used (See Rampart)
boolean	isAddressingOn() Is WS-A turned on on this endpoint?
boolean	isForceGET()
boolean	isForcePOX()
boolean	isForceSOAP11()
boolean	isForceSOAP12()
boolean	isReliableMessagingOn() Is RM turned on on this endpoint?
boolean	isSecurityOn() Is WS-Security turned on on this endpoint?
boolean	isUseMTOM()
boolean	isUseSeparateListener()
boolean	isUseSwa()
void	setAddress(String address) Set an absolute URL as the address for this named endpoint
void	setAddressingOn(boolean addressingOn) Request that WS-A be turned on/off on this endpoint
void	setAddressingVersion(String addressingVersion) Set the addressing namespace version
void	setCharSetEncoding(String charSetEncoding) Set the charset encoding for messages sent to the endpoint.
void	setForceGET(boolean forceGET)
void	setForcePOX(boolean forcePOX)
void	setForceSOAP11(boolean forceSOAP11)
void	setForceSOAP12(boolean forceSOAP12)
void	setFormat(String format)
void	setReliableMessagingOn(boolean reliableMessagingOn) Request that RM be turned on/off on this endpoint
void	setSecurityOn(boolean securityOn) Request that WS-Sec be turned on/off on this endpoint
void	setStatisticsState(int statisticsState) To set the statistics enable variable value
void	setSuspendOnFailDuration(long suspendOnFailDuration) Set the suspend on fail duration.
void	setTimeoutAction(int timeoutAction)
void	setTimeoutDuration(long timeoutDuration) Set the timeout duration.
void	setTraceState(int traceState)
void	setUseMTOM(boolean useMTOM)
void	setUseSeparateListener(boolean b)
void	setUseSwa(boolean useSwa)
void	setWsRMPolicyKey(String wsRMPolicyKey) Set the WS-RM configuration policys' 'key' to be used
void	setWsSecPolicyKey(String wsSecPolicyKey) Set the Rampart Security configuration policys' 'key' to be used (See Rampart)

Methods inherited from class java.lang.Object

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

Constructor Detail

EndpointDefinition

public EndpointDefinition()

Method Detail

getAddress

public String getAddress()

This should return the absolute EPR address referenced by the named endpoint. This may be possibly computed.

Returns:

an absolute address to be used to reference the named endpoint

setAddress

public void setAddress(String address)

Set an absolute URL as the address for this named endpoint

Parameters:

address - the absolute address to be used

isReliableMessagingOn

public boolean isReliableMessagingOn()

Is RM turned on on this endpoint?

Returns:

true if on

setReliableMessagingOn

public void setReliableMessagingOn(boolean reliableMessagingOn)

Request that RM be turned on/off on this endpoint

Parameters:

reliableMessagingOn -

isAddressingOn

public boolean isAddressingOn()

Is WS-A turned on on this endpoint?

Returns:

true if on

setAddressingOn

public void setAddressingOn(boolean addressingOn)

Request that WS-A be turned on/off on this endpoint

Parameters:

addressingOn -

getAddressingVersion

public String getAddressingVersion()

Get the addressing namespace version

Returns:

the adressing version

setAddressingVersion

public void setAddressingVersion(String addressingVersion)

Set the addressing namespace version

Parameters:

addressingVersion -

isSecurityOn

public boolean isSecurityOn()

Is WS-Security turned on on this endpoint?

Returns:

true if on

setSecurityOn

public void setSecurityOn(boolean securityOn)

Request that WS-Sec be turned on/off on this endpoint

Parameters:

securityOn -

getWsSecPolicyKey

public String getWsSecPolicyKey()

Return the Rampart Security configuration policys' 'key' to be used (See Rampart)

Returns:

the ORampart Security configuration policys' 'key' to be used (See Rampart)

setWsSecPolicyKey

public void setWsSecPolicyKey(String wsSecPolicyKey)

Set the Rampart Security configuration policys' 'key' to be used (See Rampart)

Parameters:

wsSecPolicyKey - the Rampart Security configuration policys' 'key' to be used

getWsRMPolicyKey

public String getWsRMPolicyKey()

Get the WS-RM configuration policys' 'key' to be used

Returns:

the WS-RM configuration policys' 'key' to be used

setWsRMPolicyKey

public void setWsRMPolicyKey(String wsRMPolicyKey)

Set the WS-RM configuration policys' 'key' to be used

Parameters:

wsRMPolicyKey - the WS-RM configuration policys' 'key' to be used

setUseSeparateListener

public void setUseSeparateListener(boolean b)

isUseSeparateListener

public boolean isUseSeparateListener()

setForcePOX

public void setForcePOX(boolean forcePOX)

isForcePOX

public boolean isForcePOX()

isForceGET

public boolean isForceGET()

setForceGET

public void setForceGET(boolean forceGET)

setForceSOAP11

public void setForceSOAP11(boolean forceSOAP11)

isForceSOAP11

public boolean isForceSOAP11()

setForceSOAP12

public void setForceSOAP12(boolean forceSOAP12)

isForceSOAP12

public boolean isForceSOAP12()

isUseMTOM

public boolean isUseMTOM()

setUseMTOM

public void setUseMTOM(boolean useMTOM)

isUseSwa

public boolean isUseSwa()

setUseSwa

public void setUseSwa(boolean useSwa)

getTimeoutDuration

public long getTimeoutDuration()

setTimeoutDuration

public void setTimeoutDuration(long timeoutDuration)

Set the timeout duration.

Parameters:

timeoutDuration - a duration in milliseconds

getTimeoutAction

public int getTimeoutAction()

setTimeoutAction

public void setTimeoutAction(int timeoutAction)

getFormat

public String getFormat()

setFormat

public void setFormat(String format)

getCharSetEncoding

public String getCharSetEncoding()

Get the charset encoding for messages sent to the endpoint.

Returns:

charSetEncoding

setCharSetEncoding

public void setCharSetEncoding(String charSetEncoding)

Set the charset encoding for messages sent to the endpoint.

Parameters:

charSetEncoding - the charset encoding or null

getSuspendOnFailDuration

public long getSuspendOnFailDuration()

Get the suspend on fail duration.

Returns:

suspendOnFailDuration

setSuspendOnFailDuration

public void setSuspendOnFailDuration(long suspendOnFailDuration)

Set the suspend on fail duration.

Parameters:

suspendOnFailDuration - a duration in milliseconds

getStatisticsState

public int getStatisticsState()

To check whether statistics should have collected or not

Returns:

Returns the int value that indicate statistics is enabled or not.

setStatisticsState

public void setStatisticsState(int statisticsState)

To set the statistics enable variable value

Parameters:

statisticsState - Indicates whether statictics is enable or not

getTraceState

public int getTraceState()

setTraceState

public void setTraceState(int traceState)