org.mobicents.javax.servlet

Class RequestThrottledEvent

java.lang.Object

org.mobicents.javax.servlet.ContainerEvent

org.mobicents.javax.servlet.CongestionControlEvent

org.mobicents.javax.servlet.RequestThrottledEvent

public class RequestThrottledEvent
extends CongestionControlEvent

When a request that comes in is not passed up to the application because of congestion control. The event gives details on what triggered the throttling. The service logic may introduce a SipServletResponse that should be sent back to the originator of the request in the ServletContext as attribute. The attribute name should be "org.mobicents.servlet.sip.THROTTLED_RESPONSE". If null, then the container will generate the response automatically.

Nested Class Summary

Nested classes/interfaces inherited from class org.mobicents.javax.servlet.CongestionControlEvent

CongestionControlEvent.Reason

Constructor Summary

Constructors

Constructor and Description
RequestThrottledEvent(SipServletRequest request, CongestionControlEvent.Reason reason, String message)

Method Summary

Methods

Modifier and Type	Method and Description
SipServletRequest	getRequest()
SipServletResponse	getResponse()
void	setResponse(SipServletResponse response)

Methods inherited from class org.mobicents.javax.servlet.CongestionControlEvent

getMessage, getReason

Methods inherited from class org.mobicents.javax.servlet.ContainerEvent

getEventType

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestThrottledEvent

public RequestThrottledEvent(SipServletRequest request,
                     CongestionControlEvent.Reason reason,
                     String message)

Method Detail

getResponse

public SipServletResponse getResponse()

setResponse

public void setResponse(SipServletResponse response)

getRequest

public SipServletRequest getRequest()

Returns:

the request that wasn't passed up to the application because of congestion control