Package org.apache.cxf.throttling

Class ThrottleResponse

java.lang.Object

org.apache.cxf.throttling.ThrottleResponse

Direct Known Subclasses:

SimpleThrottlingManager

public class ThrottleResponse
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected long	delay
protected String	errorMessage
protected int	responseCode
protected Map<String,String>	responseHeaders

Constructor Summary

Constructors

Constructor	Description
ThrottleResponse()
ThrottleResponse(int responceCode)
ThrottleResponse(int responceCode, long delay)

Method Summary

Modifier and Type	Method	Description
ThrottleResponse	addResponseHeader(String header, String value)	Add headers to the response.
long	getDelay()	Delay processing for specified milliseconds.
String	getErrorMessage()
int	getResponseCode()
Map<String,String>	getResponseHeaders()
ThrottleResponse	setDelay(long d)
ThrottleResponse	setResponseCode(int rc)
ThrottleResponse	setResponseCode(int rc, String msg)

Methods inherited from class java.lang.Object

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

Field Detail

delay

protected long delay

responseHeaders

protected Map<String,String> responseHeaders

responseCode

protected int responseCode

errorMessage

protected String errorMessage

Constructor Detail

ThrottleResponse

public ThrottleResponse()

ThrottleResponse

public ThrottleResponse(int responceCode)

ThrottleResponse

public ThrottleResponse(int responceCode,
                        long delay)

Method Detail

getResponseHeaders

public Map<String,String> getResponseHeaders()

addResponseHeader

public ThrottleResponse addResponseHeader(String header,
                                          String value)

Add headers to the response. Typically, this would be things like X-RateLimit-Limit headers

Returns:

getResponseCode

public int getResponseCode()

getErrorMessage

public String getErrorMessage()

setResponseCode

public ThrottleResponse setResponseCode(int rc)

setResponseCode

public ThrottleResponse setResponseCode(int rc,
                                        String msg)

getDelay

public long getDelay()

Delay processing for specified milliseconds. Should be "small" to prevent the client from timing out unless the client request is aborted with the HTTP error code.

Returns:

setDelay

public ThrottleResponse setDelay(long d)