public class Response extends Message
Modifier and Type | Method and Description |
---|---|
void |
abort()
Ask the connector to abort the related network connection, for example
immediately closing the socket.
|
void |
commit()
Asks the server connector to immediately commit the given response,
making it ready to be sent back to the client.
|
int |
getAge()
Returns the estimated amount of time since a response was generated or
revalidated by the origin server.
|
java.util.Set<Method> |
getAllowedMethods()
Returns the modifiable set of methods allowed on the requested resource.
|
AuthenticationInfo |
getAuthenticationInfo()
Returns information sent by an origin server related to an successful
authentication attempt.
|
java.util.List<ChallengeRequest> |
getChallengeRequests()
Returns the list of authentication requests sent by an origin server to a
client.
|
Series<CookieSetting> |
getCookieSettings()
Returns the modifiable series of cookie settings provided by the server.
|
static Response |
getCurrent()
Returns the response associated to the current thread.
|
java.util.Set<Dimension> |
getDimensions()
Returns the modifiable set of selecting dimensions on which the response
entity may vary.
|
Reference |
getLocationRef()
Returns the location reference.
|
java.util.List<ChallengeRequest> |
getProxyChallengeRequests()
Returns the list of authentication requests sent by an origin server to a
client.
|
Request |
getRequest()
Returns the associated request
|
java.util.Date |
getRetryAfter()
Indicates how long the service is expected to be unavailable to the
requesting client.
|
ServerInfo |
getServerInfo()
Returns the server-specific information.
|
Status |
getStatus()
Returns the status.
|
boolean |
isAutoCommitting()
Indicates if the response should be automatically committed.
|
boolean |
isCommitted()
Indicates if the response has already been committed.
|
boolean |
isConfidential()
Indicates if the message was or will be exchanged confidentially, for
example via a SSL-secured connection.
|
void |
redirectPermanent(Reference targetRef)
Permanently redirects the client to a target URI.
|
void |
redirectPermanent(java.lang.String targetUri)
Permanently redirects the client to a target URI.
|
void |
redirectSeeOther(Reference targetRef)
Redirects the client to a different URI that SHOULD be retrieved using a
GET method on that resource.
|
void |
redirectSeeOther(java.lang.String targetUri)
Redirects the client to a different URI that SHOULD be retrieved using a
GET method on that resource.
|
void |
redirectTemporary(Reference targetRef)
Temporarily redirects the client to a target URI.
|
void |
redirectTemporary(java.lang.String targetUri)
Temporarily redirects the client to a target URI.
|
void |
setAge(int age)
Sets the estimated amount of time since a response was generated or
revalidated by the origin server.
|
void |
setAllowedMethods(java.util.Set<Method> allowedMethods)
Sets the set of methods allowed on the requested resource.
|
void |
setAuthenticationInfo(AuthenticationInfo authenticationInfo)
Sets the authentication information sent by an origin server to a client
after a successful authentication attempt.
Note that when used with HTTP connectors, this property maps to the "Authentication-Info" header. |
void |
setAutoCommitting(boolean autoCommitting)
Indicates if the response should be automatically committed.
|
void |
setChallengeRequest(ChallengeRequest request)
Deprecated.
Add request to
getChallengeRequests() method result
instead or use setChallengeRequests(List) . |
void |
setChallengeRequests(java.util.List<ChallengeRequest> challengeRequests)
Sets the list of authentication requests sent by an origin server to a
client.
|
void |
setCommitted(boolean committed)
Indicates if the response has already been committed.
|
void |
setCookieSettings(Series<CookieSetting> cookieSettings)
Sets the modifiable series of cookie settings provided by the server.
|
static void |
setCurrent(Response response)
Sets the response associated with the current thread.
|
void |
setDimensions(java.util.Set<Dimension> dimensions)
Sets the set of dimensions on which the response entity may vary.
|
void |
setLocationRef(Reference locationRef)
Sets the reference that the client should follow for redirections or
resource creations.
|
void |
setLocationRef(java.lang.String locationUri)
Sets the reference that the client should follow for redirections or
resource creations.
|
void |
setProxyChallengeRequests(java.util.List<ChallengeRequest> proxyChallengeRequests)
Sets the modifiable list of authentication requests sent by a proxy to a
client.
|
void |
setRequest(Request request)
Sets the associated request.
|
void |
setRetryAfter(java.util.Date retryAfter)
Indicates how long the service is expected to be unavailable to the
requesting client.
|
void |
setServerInfo(ServerInfo serverInfo)
Sets the server-specific information.
|
void |
setStatus(Status status)
Sets the status.
|
void |
setStatus(Status status,
java.lang.String message)
Sets the status.
|
void |
setStatus(Status status,
java.lang.Throwable throwable)
Sets the status.
|
void |
setStatus(Status status,
java.lang.Throwable throwable,
java.lang.String message)
Sets the status.
|
java.lang.String |
toString()
Displays a synthesis of the response like an HTTP status line.
|
getAttributes, getCacheDirectives, getDate, getEntity, getEntityAsForm, getEntityAsText, getOnSent, getRecipientsInfo, getWarnings, isEntityAvailable, release, setAttributes, setCacheDirectives, setDate, setEntity, setEntity, setOnSent, setRecipientsInfo, setWarnings
public Response(Request request)
request
- The request associated to this response.public static Response getCurrent()
Handler.getResponse()
.
This variable is stored internally as a thread local variable and updated
each time a call is handled by a Restlet via the
Restlet.handle(org.restlet.Request, org.restlet.Response)
method.public static void setCurrent(Response response)
response
- The thread's response.public void abort()
public void commit()
public int getAge()
public java.util.Set<Method> getAllowedMethods()
public AuthenticationInfo getAuthenticationInfo()
public java.util.List<ChallengeRequest> getChallengeRequests()
public Series<CookieSetting> getCookieSettings()
public java.util.Set<Dimension> getDimensions()
public Reference getLocationRef()
public java.util.List<ChallengeRequest> getProxyChallengeRequests()
public Request getRequest()
public java.util.Date getRetryAfter()
public ServerInfo getServerInfo()
public Status getStatus()
public boolean isAutoCommitting()
commit()
later on, using another thread.public boolean isCommitted()
public boolean isConfidential()
Message
isConfidential
in class Message
public void redirectPermanent(Reference targetRef)
targetRef
- The target URI reference.public void redirectPermanent(java.lang.String targetUri)
Request.getResourceRef()
and Reference.getBaseRef()
.targetUri
- The target URI.public void redirectSeeOther(Reference targetRef)
targetRef
- The target reference.public void redirectSeeOther(java.lang.String targetUri)
Request.getResourceRef()
and Reference.getBaseRef()
.targetUri
- The target URI.public void redirectTemporary(Reference targetRef)
targetRef
- The target reference.public void redirectTemporary(java.lang.String targetUri)
Request.getResourceRef()
and Reference.getBaseRef()
.targetUri
- The target URI.public void setAge(int age)
age
- The response age.public void setAllowedMethods(java.util.Set<Method> allowedMethods)
CopyOnWriteArraySet
for
example.allowedMethods
- The set of methods allowed on the requested resource.public void setAuthenticationInfo(AuthenticationInfo authenticationInfo)
authenticationInfo
- The data returned by the server in response to successful
authentication.public void setAutoCommitting(boolean autoCommitting)
autoCommitting
- True if the response should be automatically committed@Deprecated public void setChallengeRequest(ChallengeRequest request)
getChallengeRequests()
method result
instead or use setChallengeRequests(List)
.request
- The authentication request sent by an origin server to a
client.public void setChallengeRequests(java.util.List<ChallengeRequest> challengeRequests)
challengeRequests
- A list of authentication requests sent by an origin server to
a client.public void setCommitted(boolean committed)
committed
- True if the response has already been committed.public void setCookieSettings(Series<CookieSetting> cookieSettings)
cookieSettings
- A series of cookie settings provided by the server.public void setDimensions(java.util.Set<Dimension> dimensions)
dimensions
- The set of dimensions on which the response entity may vary.public void setLocationRef(Reference locationRef)
locationRef
- The reference to set.public void setLocationRef(java.lang.String locationUri)
Request.getResourceRef()
and
Reference.getBaseRef()
.locationUri
- The URI to set.setLocationRef(Reference)
public void setProxyChallengeRequests(java.util.List<ChallengeRequest> proxyChallengeRequests)
CopyOnWriteArrayList
for example. Note that when used with HTTP
connectors, this property maps to the "Proxy-Authenticate" header. This
method clears the current list and adds all entries in the parameter
list.proxyChallengeRequests
- A list of authentication requests sent by a proxy to a client.public void setRequest(Request request)
request
- The associated requestpublic void setRetryAfter(java.util.Date retryAfter)
retryAfter
- Date after with a retry attempt could occur.public void setServerInfo(ServerInfo serverInfo)
serverInfo
- The server-specific information.public void setStatus(Status status)
status
- The status to set.public void setStatus(Status status, java.lang.String message)
status
- The status to set.message
- The status message.public void setStatus(Status status, java.lang.Throwable throwable)
status
- The status to set.throwable
- The related error or exception.public void setStatus(Status status, java.lang.Throwable throwable, java.lang.String message)
status
- The status to set.throwable
- The related error or exception.message
- The status message.public java.lang.String toString()
toString
in class java.lang.Object
Copyright © 2005-2012. All Rights Reserved.