org.apache.synapse.commons.throttle.core

Class CallerContext

java.lang.Object

org.apache.synapse.commons.throttle.core.CallerContext

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

DomainBaseCallerContext, IPBaseCallerContext, RoleBaseCallerContext

public abstract class CallerContext
extends Object
implements Serializable, Cloneable

Contains all runtime data for a particular remote caller. provides the default rate based access controller algorithm implementation. This is not thread-safe

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CallerContext(String ID)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canAccess(ThrottleContext throttleContext, CallerConfiguration configuration, long currentTime) Check whether that caller can access or not ,based on current state and pre-defined policy
void	cleanUpCallers(CallerConfiguration configuration, ThrottleContext throttleContext, long currentTime) Clean up the callers - remove all callers that have expired their time window
CallerContext	clone()
int	getGlobalCounter()
String	getID()
int	getLocalCounter()
long	getNextTimeWindow() Returns the next time window
abstract int	getType() Gets type of throttle that this caller belong ex : ip/domain
UUID	getUuid()
void	incrementGlobalCounter(int incrementBy)
void	resetLocalCounter()
void	setGlobalCounter(int counter)

Methods inherited from class java.lang.Object

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

Constructor Detail

CallerContext

public CallerContext(String ID)

Method Detail

clone

public CallerContext clone()
                    throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

getUuid

public UUID getUuid()

getID

public String getID()

Returns:

Returns Id of caller

cleanUpCallers

public void cleanUpCallers(CallerConfiguration configuration,
                  ThrottleContext throttleContext,
                  long currentTime)

Clean up the callers - remove all callers that have expired their time window

Parameters:

configuration - -The Configuration for this caller

throttleContext - -The Throttle that caller having pass

currentTime - -The system current time

canAccess

public boolean canAccess(ThrottleContext throttleContext,
                CallerConfiguration configuration,
                long currentTime)
                  throws ThrottleException

Check whether that caller can access or not ,based on current state and pre-defined policy

Parameters:

throttleContext - -The Context for this caller - runtime state

configuration - -The Configuration for this caller - data from policy

currentTime - -The current system time

Returns:

boolean -The boolean value which say access will allow or not

Throws:

ThrottleException - throws for invalid throttle configuration

getNextTimeWindow

public long getNextTimeWindow()

Returns the next time window

Returns:

long value of next time window

incrementGlobalCounter

public void incrementGlobalCounter(int incrementBy)

getGlobalCounter

public int getGlobalCounter()

setGlobalCounter

public void setGlobalCounter(int counter)

getLocalCounter

public int getLocalCounter()

resetLocalCounter

public void resetLocalCounter()

getType

public abstract int getType()

Gets type of throttle that this caller belong ex : ip/domain

Returns:

Returns the type of the throttle