org.apache.synapse.endpoints
Class EndpointContext

java.lang.Object
  org.apache.synapse.endpoints.EndpointContext

public class EndpointContext
extends Object

Keeps the states of the endpoint.This hides where those states are kept .For a cluster environment,all states are kept in the axis2 configuration context in order to replicate those states so that other synapse instance in the same cluster can see those changes . This class can be evolved to keep any run time states related to the endpoint .For a non-clustered environment, all data are kept locally.

This class provide the abstraction need to separate the dynamic data from the static data and improve the high cohesion and provides capability to replicate only required state at a given time. This improves the performance when replicate data.

Constructor Summary

EndpointContext()

Method Summary

ConfigurationContext	getConfigurationContext() Get the configuration context instance .
long	getRecoverOn() Time to recover a failed endpoint.
protected void	handleException(String msg) Helper methods for handle errors.
protected void	handleException(String msg, Exception e) Helper methods for handle errors.
boolean	isActive() Checks if the endpoint is active (failed or not)
void	setActive(boolean active) Sets if endpoint active or not.
void	setConfigurationContext(ConfigurationContext configCtx) Sets the ConfigurationContext instance .
void	setContextID(String contextID) Sets the identifier for this endpoint context , so that , this can be identified uniquely across the cluster.
void	setRecoverOn(long recoverOn) Sets time to recover a failed endpoint.

Methods inherited from class java.lang.Object

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

Constructor Detail

EndpointContext

public EndpointContext()

Method Detail

isActive

public boolean isActive()

Checks if the endpoint is active (failed or not)

Returns:

Returns true if the endpoint is active , otherwise , false will be returned

setActive

public void setActive(boolean active)

Sets if endpoint active or not.

Parameters:

active - True for make endpoint active , false for make it inactive

getRecoverOn

public long getRecoverOn()

Time to recover a failed endpoint.

Returns:

Returns time to recover a failed endpoint.

setRecoverOn

public void setRecoverOn(long recoverOn)

Sets time to recover a failed endpoint.

Parameters:

recoverOn - The value for recover time

getConfigurationContext

public ConfigurationContext getConfigurationContext()

Get the configuration context instance . This is only available for cluster env.

Returns:

Returns the ConfigurationContext instance

setConfigurationContext

public void setConfigurationContext(ConfigurationContext configCtx)

Sets the ConfigurationContext instance . This is only used for cluster env. By setting this , indicates that this is a cluster env.

Parameters:

configCtx - The ConfigurationContext instance

setContextID

public void setContextID(String contextID)

Sets the identifier for this endpoint context , so that , this can be identified uniquely across the cluster. The id will be the name of the endpoint

Parameters:

contextID - The Id for this endpoint context

handleException

protected void handleException(String msg)

Helper methods for handle errors.

Parameters:

msg - The error message

handleException

protected void handleException(String msg,
                               Exception e)

Helper methods for handle errors.

Parameters:

msg - The error message

e - The exception