|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.restlet.data.Message
org.restlet.data.Response
public class Response
Generic response sent by server connectors. It is then received by client connectors. Responses are uniform across all types of connectors, protocols and components.
Request
,
Uniform
Constructor Summary | |
---|---|
Response(Request request)
Constructor. |
Method Summary | |
---|---|
java.util.Set<Method> |
getAllowedMethods()
Returns the modifiable set of methods allowed on the requested resource. |
ChallengeRequest |
getChallengeRequest()
Deprecated. Use the getChallengeRequests() method instead. |
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 reference that the client should follow for redirections or resource creations. |
Reference |
getRedirectRef()
Deprecated. Use getLocationRef() instead. |
Request |
getRequest()
Returns the associated request |
ServerInfo |
getServerInfo()
Returns the server-specific information. |
Status |
getStatus()
Returns the status. |
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 |
setAllowedMethods(java.util.Set<Method> allowedMethods)
Sets the set of methods allowed on the requested resource. |
void |
setChallengeRequest(ChallengeRequest request)
Sets the authentication request sent by an origin server to a client. |
void |
setChallengeRequests(java.util.List<ChallengeRequest> requests)
Sets the list of authentication requests sent by an origin server to a client. |
void |
setCookieSettings(Series<CookieSetting> cookieSettings)
Sets the 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 |
setRedirectRef(Reference locationRef)
Deprecated. Use the setLocationRef() method instead. |
void |
setRedirectRef(java.lang.String locationUri)
Deprecated. Use the setLocationRef() method instead. |
void |
setRequest(Request request)
Sets the associated request. |
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. |
Methods inherited from class org.restlet.data.Message |
---|
getAttributes, getEntity, getEntityAsDom, getEntityAsForm, getEntityAsObject, getEntityAsSax, isEntityAvailable, release, setAttributes, setEntity, setEntity, setEntity |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Response(Request request)
request
- The request associated to this response.Method Detail |
---|
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.data.Request, org.restlet.data.Response)
method.
public static void setCurrent(Response response)
response
- The thread's response.public java.util.Set<Method> getAllowedMethods()
@Deprecated public ChallengeRequest getChallengeRequest()
getChallengeRequests()
method instead.
public java.util.List<ChallengeRequest> getChallengeRequests()
public Series<CookieSetting> getCookieSettings()
public java.util.Set<Dimension> getDimensions()
public Reference getLocationRef()
@Deprecated public Reference getRedirectRef()
public Request getRequest()
public ServerInfo getServerInfo()
public Status getStatus()
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 setAllowedMethods(java.util.Set<Method> allowedMethods)
CopyOnWriteArraySet
for
example.
allowedMethods
- The set of methods allowed on the requested resource.public void setChallengeRequest(ChallengeRequest request)
request
- The authentication request sent by an origin server to a
client.public void setChallengeRequests(java.util.List<ChallengeRequest> requests)
CopyOnWriteArrayList
for example.
requests
- The list of authentication requests sent by an origin server
to a client.public void setCookieSettings(Series<CookieSetting> cookieSettings)
cookieSettings
- The cookie settings provided by the server.public void setDimensions(java.util.Set<Dimension> dimensions)
CopyOnWriteArraySet
for
example.
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.@Deprecated public void setRedirectRef(Reference locationRef)
locationRef
- The reference to set.@Deprecated public void setRedirectRef(java.lang.String locationUri)
locationUri
- The URI to set.public void setRequest(Request request)
request
- The associated requestpublic 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.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |