|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.restlet.Message
org.restlet.Response
org.restlet.util.WrapperResponse
public class WrapperResponse
Request wrapper. Useful for application developer who need to enrich the request with application related properties and behavior.
Constructor Summary | |
---|---|
WrapperResponse(Response wrappedResponse)
Constructor. |
Method Summary | |
---|---|
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. |
Set<Method> |
getAllowedMethods()
Returns the set of methods allowed on the requested resource. |
ConcurrentMap<String,Object> |
getAttributes()
Returns a modifiable attributes map that can be used by developers to save information relative to the message. |
AuthenticationInfo |
getAuthenticationInfo()
Returns information sent by an origin server related to an successful authentication attempt. |
List<ChallengeRequest> |
getChallengeRequests()
Returns the list of authentication requests sent by an origin server to a client. |
Series<CookieSetting> |
getCookieSettings()
Returns the cookie settings provided by the server. |
Set<Dimension> |
getDimensions()
Returns the set of selecting dimensions on which the response entity may vary. |
Representation |
getEntity()
Returns the entity representation. |
Reference |
getLocationRef()
Returns the reference that the client should follow for redirections or resource creations. |
List<ChallengeRequest> |
getProxyChallengeRequests()
Returns the list of authentication requests sent by a proxy to a client. |
Request |
getRequest()
Returns the associated request |
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. |
protected Response |
getWrappedResponse()
Returns the wrapped response. |
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 call came over a confidential channel such as an SSL-secured connection. |
boolean |
isEntityAvailable()
Indicates if a content is available and can be sent. |
void |
redirectPermanent(Reference targetRef)
Permanently redirects the client to a target URI. |
void |
redirectPermanent(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(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(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(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 |
setChallengeRequests(List<ChallengeRequest> requests)
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. |
void |
setDimensions(Set<Dimension> dimensions)
Sets the set of dimensions on which the response entity may vary. |
void |
setEntity(Representation entity)
Sets the entity representation. |
void |
setEntity(String value,
MediaType mediaType)
Sets a textual entity. |
void |
setLocationRef(Reference locationRef)
Sets the reference that the client should follow for redirections or resource creations. |
void |
setLocationRef(String locationUri)
Sets the reference that the client should follow for redirections or resource creations. |
void |
setProxyChallengeRequests(List<ChallengeRequest> requests)
Sets the list of authentication requests sent by a proxy to a client. |
void |
setRequest(Request request)
Sets the associated request. |
void |
setRequest(WrapperRequest request)
Sets the associated request. |
void |
setRetryAfter(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,
String message)
Sets the status. |
void |
setStatus(Status status,
Throwable throwable)
Sets the status. |
void |
setStatus(Status status,
Throwable throwable,
String message)
Sets the status. |
String |
toString()
Displays a synthesis of the response like an HTTP status line. |
Methods inherited from class org.restlet.Response |
---|
getCurrent, isFinal, isProvisional, setCurrent |
Methods inherited from class org.restlet.Message |
---|
getCacheDirectives, getDate, getEntityAsText, getOnError, getOnSent, getRecipientsInfo, getWarnings, release, setAttributes, setCacheDirectives, setDate, setOnError, setOnSent, setRecipientsInfo, setWarnings |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public WrapperResponse(Response wrappedResponse)
wrappedResponse
- The wrapped response.Method Detail |
---|
public void abort()
Response
abort
in class Response
public void commit()
Response
commit
in class Response
public int getAge()
Response
getAge
in class Response
public Set<Method> getAllowedMethods()
getAllowedMethods
in class Response
public ConcurrentMap<String,Object> getAttributes()
Attribute name | Class name | Description |
---|---|---|
org.restlet.http.headers | org.restlet.data.Form | Server HTTP connectors must provide all request headers and client HTTP connectors must provide all response headers, exactly as they were received. In addition, developers can also use this attribute to specify non-standard headers that should be added to the request or to the response. |
getAttributes
in class Message
public AuthenticationInfo getAuthenticationInfo()
Response
getAuthenticationInfo
in class Response
public List<ChallengeRequest> getChallengeRequests()
getChallengeRequests
in class Response
public Series<CookieSetting> getCookieSettings()
getCookieSettings
in class Response
public Set<Dimension> getDimensions()
getDimensions
in class Response
public Representation getEntity()
getEntity
in class Message
public Reference getLocationRef()
getLocationRef
in class Response
public List<ChallengeRequest> getProxyChallengeRequests()
getProxyChallengeRequests
in class Response
public Request getRequest()
getRequest
in class Response
public Date getRetryAfter()
Response
getRetryAfter
in class Response
public ServerInfo getServerInfo()
getServerInfo
in class Response
public Status getStatus()
getStatus
in class Response
protected Response getWrappedResponse()
public boolean isAutoCommitting()
Response
Response.commit()
later on, using another thread.
isAutoCommitting
in class Response
public boolean isCommitted()
Response
isCommitted
in class Response
public boolean isConfidential()
isConfidential
in class Response
public boolean isEntityAvailable()
isEntityAvailable
in class Message
public void redirectPermanent(Reference targetRef)
redirectPermanent
in class Response
targetRef
- The target URI reference.public void redirectPermanent(String targetUri)
redirectPermanent
in class Response
targetUri
- The target URI.public void redirectSeeOther(Reference targetRef)
redirectSeeOther
in class Response
targetRef
- The target reference.public void redirectSeeOther(String targetUri)
redirectSeeOther
in class Response
targetUri
- The target URI.public void redirectTemporary(Reference targetRef)
redirectTemporary
in class Response
targetRef
- The target reference.public void redirectTemporary(String targetUri)
redirectTemporary
in class Response
targetUri
- The target URI.public void setAge(int age)
Response
setAge
in class Response
age
- The response age.public void setAllowedMethods(Set<Method> allowedMethods)
Response
CopyOnWriteArraySet
for
example.
setAllowedMethods
in class Response
allowedMethods
- The set of methods allowed on the requested resource.public void setAuthenticationInfo(AuthenticationInfo authenticationInfo)
Response
setAuthenticationInfo
in class Response
authenticationInfo
- The data returned by the server in response to successful
authentication.public void setAutoCommitting(boolean autoCommitting)
Response
setAutoCommitting
in class Response
autoCommitting
- True if the response should be automatically committedpublic void setChallengeRequests(List<ChallengeRequest> requests)
setChallengeRequests
in class Response
requests
- The list of authentication requests sent by an origin server
to a client.public void setCommitted(boolean committed)
Response
setCommitted
in class Response
committed
- True if the response has already been committed.public void setCookieSettings(Series<CookieSetting> cookieSettings)
Response
setCookieSettings
in class Response
cookieSettings
- A series of cookie settings provided by the server.public void setDimensions(Set<Dimension> dimensions)
Response
setDimensions
in class Response
dimensions
- The set of dimensions on which the response entity may vary.public void setEntity(Representation entity)
setEntity
in class Message
entity
- The entity representation.public void setEntity(String value, MediaType mediaType)
setEntity
in class Message
value
- The represented string.mediaType
- The representation's media type.public void setLocationRef(Reference locationRef)
setLocationRef
in class Response
locationRef
- The reference to set.public void setLocationRef(String locationUri)
setLocationRef
in class Response
locationUri
- The URI to set.Response.setLocationRef(Reference)
public void setProxyChallengeRequests(List<ChallengeRequest> requests)
setProxyChallengeRequests
in class Response
requests
- The list of authentication requests sent by a proxy to a
client.public void setRequest(Request request)
setRequest
in class Response
request
- The associated requestpublic void setRequest(WrapperRequest request)
request
- The associated requestpublic void setRetryAfter(Date retryAfter)
Response
setRetryAfter
in class Response
retryAfter
- Date after with a retry attempt could occur.public void setServerInfo(ServerInfo serverInfo)
Response
setServerInfo
in class Response
serverInfo
- The server-specific information.public void setStatus(Status status)
setStatus
in class Response
status
- The status to set.public void setStatus(Status status, String message)
setStatus
in class Response
status
- The status to set.message
- The status message.public void setStatus(Status status, Throwable throwable)
Response
setStatus
in class Response
status
- The status to set.throwable
- The related error or exception.public void setStatus(Status status, Throwable throwable, String message)
Response
setStatus
in class Response
status
- The status to set.throwable
- The related error or exception.message
- The status message.public String toString()
Response
toString
in class Response
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |