org.eclipse.webdav
Interface IResponse

All Known Implementing Classes:
Response, Response

public interface IResponse

Represents a response from a WebDAV server.

A response contains an open input stream, which is obtained by getInputStream().

The client (i.e., the party that invoked the Server method) is responsible for indicating that they're done with the response object by calling its close() method; this discards any remaining unread bytes, closes the stream, and frees up any associated OS resources.

Failing to close the response may lead to spurious bytes being left on the response socket and causing unspecified behavior on subsequent request/response interactions.

The recommended basic usage pattern is as follows:

 Response r = server.mkcol(source, context);
 try {
   if (r.getStatus() == Response.SC_OK) {
     ... // handle standard response
   } else {
     ... // handle non-standard response
   }
 } finally {
     r.close();
 }
 
Certain kinds of responses (e.g., certain status codes, responses to certain methods) contain a WebDAV-specified XML element in the response body. The presence (or expected presence) of an XML element body is indicated by hasDocumentBody returning true, in which case the client should access this element with readDocumentBody(); in other cases, hasDocumentBody returnsfalse, and the client should access the stream of raw bytes with getInputStream().

Note: This class/interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.


Field Summary
static int SC_ACCEPTED
          Status code (202) indicating that a request was accepted for processing, but was not completed.
static int SC_BAD_GATEWAY
          Status code (502) indicating that the HTTP server received an invalid response from a server it consulted when acting as a proxy or gateway.
static int SC_BAD_REQUEST
          Status code (400) indicating the request sent by the client was syntactically incorrect.
static int SC_CONFLICT
          Status code (409) indicating that the request could not be completed due to a conflict with the current state of the resource.
static int SC_CONTINUE
          Status code (100) indicating the client may continue with its request.
static int SC_CREATED
          Status code (201) indicating the request succeeded and created a new resource on the server.
static int SC_CROSS_SERVER_BINDING_FORBIDDEN
          Status code (507) indicating the server is unable to create the requested binding because it would bind a segment in a collection on one server to a resource on a different server.
static int SC_FAILED_DEPENDENCY
          Status code (424) indicating the method was not executed on a particular resource within its scope because some part of the method's execution failed causing the entire method to be aborted.
static int SC_FORBIDDEN
          Status code (403) indicating the server understood the request but refused to fulfill it.
static int SC_GATEWAY_TIMEOUT
          Status code (504) indicating the server did not receive a timely response from the upstream server while acting as a gateway or proxy.
static int SC_GONE
          Status code (410) indicating the server did not receive a timely response from the upstream server while acting as a gateway or proxy.
static int SC_HTTP_VERSION_NOT_SUPPORTED
          Status code (505) indicating the server does not support or refuses to support the HTTP protocol version that was used in the request message.
static int SC_INSUFFICIENT_SPACE_ON_RESOURCE
          Status code (425) indicating that the resource does not have sufficient space to record the state of the resource after the execution of the method.
static int SC_INTERNAL_SERVER_ERROR
          Status code (500) indicating an error inside the HTTP service which prevented it from fulfilling the request.
static int SC_LENGTH_REQUIRED
          Status code (411) indicating the request cannot be handled without a defined Content-Length.
static int SC_LOCKED
          Status code (423) indicating the source or destination resource of a method is locked.
static int SC_LOOP_DETECTED
          Status code (506) indicating the server terminated an operation because it encountered an infinite loop while processing a request with "Depth: infinity".
static int SC_METHOD_NOT_ALLOWED
          Status code (405) indicating the method specified is not allowed for the resource.
static int SC_MOVED_PERMANENTLY
          Status code (301) indicating that the resource has permanently moved to a new location, and that future references should use a new URI with their requests.
static int SC_MOVED_TEMPORARILY
          Status code (302) indicating that the resource has temporarily moved to another location, but that future references should still use the original URI to access the resource.
static int SC_MULTI_STATUS
          Status code (207) indicating that the response provides status for multiple independent operations.
static int SC_MULTIPLE_CHOICES
          Status code (300) indicating that the requested resource corresponds to any one of a set of representations, each with its own specific location
static int SC_NO_CONTENT
          Status code (204) indicating that the request succeeded but that there was no new information to return.
static int SC_NON_AUTHORITATIVE_INFORMATION
          Status code (203) indicating that the meta information presented by the client did not originate from the server.
static int SC_NOT_ACCEPTABLE
          Status code (406) indicating the resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headerssent in the request.
static int SC_NOT_FOUND
          Status code (404) indicating that the requested resource is not available.
static int SC_NOT_IMPLEMENTED
          Status code (501) indicating the HTTP service does not support the functionality needed to fulfill the request.
static int SC_NOT_MODIFIED
          Status code (304) indicating that a conditional GET operation found that the resource was available and not modified.
static int SC_OK
          Status code (200) indicating the request succeeded normally.
static int SC_PARTIAL_CONTENT
          Status code (206) indicating that the server has fulfilled the partial GET request for the resource.
static int SC_PAYMENT_REQUIRED
          Status code (402) reserved for future use.
static int SC_PRECONDITION_FAILED
          Status code (412) indicating the precondition given in one or more of the request-header fields evaluated to false when it was tested on the server.
static int SC_PROCESSING
          Status code (102) indicating the server is still processing the request.
static int SC_PROXY_AUTHENTICATION_REQUIRED
          Status code (407) indicating the client MUST first authenticate itself with the proxy.
static int SC_REQUEST_TIMEOUT
          Status code (408) indicating the client did not produce a request within the time that the server was prepared to wait.
static int SC_REQUEST_TOO_LONG
          Status code (413) indicating the server is refusing to process a request because the request entity is larger than the server is willing or able to process.
static int SC_REQUEST_URI_TOO_LONG
          Status code (414) indicating the server is refusing to service the request because the Request-URI is longer than the server is willing to interpret.
static int SC_RESET_CONTENT
          Status code (205) indicating that the agent SHOULD reset the document view which caused the request to be sent.
static int SC_SEE_OTHER
          Status code (303) indicating that the response to the request can be found under a different URI.
static int SC_SERVICE_UNAVAILABLE
          Status code (503) indicating that the HTTP service is temporarily overloaded, and unable to handle the request.
static int SC_SWITCHING_PROTOCOLS
          Status code (101) indicating the server is switching protocols according to Upgrade header.
static int SC_UNAUTHORIZED
          Status code (401) indicating that the request requires HTTP authentication.
static int SC_UNPROCESSABLE_ENTITY
          Status code (422) indicating the server understands the content type of the request entity, but was unable to process the contained instructions.
static int SC_UNSUPPORTED_MEDIA_TYPE
          Status code (415) indicating the server is refusing to service the request because the entity of the request is in a format not supported by the requested resource for the requested method.
static int SC_USE_PROXY
          Status code (305) indicating that the requested resource MUST be accessed through the proxy given by the Location field.
 
Method Summary
 void close()
          Closes this response.
 IContext getContext()
          Returns this response's header fields.
 Document getDocumentBody()
          Gets the contents of the response body as a DOM Document.
 InputStream getInputStream()
          Returns an open input stream for reading the the body of this response.
 int getStatusCode()
          Returns the HTTP response status code.
 String getStatusMessage()
          Returns the response status message.
 boolean hasDocumentBody()
          Returns whether this response has an XML element as a body; this is the element that would be read if readDocumentBody() was called.
 

Field Detail

SC_CONTINUE

static final int SC_CONTINUE
Status code (100) indicating the client may continue with its request. This interim response is used to inform the client that the initial part of the request has been received and has not yet been rejected by the server.

See Also:
Constant Field Values

SC_SWITCHING_PROTOCOLS

static final int SC_SWITCHING_PROTOCOLS
Status code (101) indicating the server is switching protocols according to Upgrade header.

See Also:
Constant Field Values

SC_PROCESSING

static final int SC_PROCESSING
Status code (102) indicating the server is still processing the request.

See Also:
Constant Field Values

SC_OK

static final int SC_OK
Status code (200) indicating the request succeeded normally.

See Also:
Constant Field Values

SC_CREATED

static final int SC_CREATED
Status code (201) indicating the request succeeded and created a new resource on the server.

See Also:
Constant Field Values

SC_ACCEPTED

static final int SC_ACCEPTED
Status code (202) indicating that a request was accepted for processing, but was not completed.

See Also:
Constant Field Values

SC_NON_AUTHORITATIVE_INFORMATION

static final int SC_NON_AUTHORITATIVE_INFORMATION
Status code (203) indicating that the meta information presented by the client did not originate from the server.

See Also:
Constant Field Values

SC_NO_CONTENT

static final int SC_NO_CONTENT
Status code (204) indicating that the request succeeded but that there was no new information to return.

See Also:
Constant Field Values

SC_RESET_CONTENT

static final int SC_RESET_CONTENT
Status code (205) indicating that the agent SHOULD reset the document view which caused the request to be sent.

See Also:
Constant Field Values

SC_PARTIAL_CONTENT

static final int SC_PARTIAL_CONTENT
Status code (206) indicating that the server has fulfilled the partial GET request for the resource.

See Also:
Constant Field Values

SC_MULTI_STATUS

static final int SC_MULTI_STATUS
Status code (207) indicating that the response provides status for multiple independent operations.

See Also:
Constant Field Values

SC_MULTIPLE_CHOICES

static final int SC_MULTIPLE_CHOICES
Status code (300) indicating that the requested resource corresponds to any one of a set of representations, each with its own specific location

See Also:
Constant Field Values

SC_MOVED_PERMANENTLY

static final int SC_MOVED_PERMANENTLY
Status code (301) indicating that the resource has permanently moved to a new location, and that future references should use a new URI with their requests.

See Also:
Constant Field Values

SC_MOVED_TEMPORARILY

static final int SC_MOVED_TEMPORARILY
Status code (302) indicating that the resource has temporarily moved to another location, but that future references should still use the original URI to access the resource.

See Also:
Constant Field Values

SC_SEE_OTHER

static final int SC_SEE_OTHER
Status code (303) indicating that the response to the request can be found under a different URI.

See Also:
Constant Field Values

SC_NOT_MODIFIED

static final int SC_NOT_MODIFIED
Status code (304) indicating that a conditional GET operation found that the resource was available and not modified.

See Also:
Constant Field Values

SC_USE_PROXY

static final int SC_USE_PROXY
Status code (305) indicating that the requested resource MUST be accessed through the proxy given by the Location field.

See Also:
Constant Field Values

SC_BAD_REQUEST

static final int SC_BAD_REQUEST
Status code (400) indicating the request sent by the client was syntactically incorrect.

See Also:
Constant Field Values

SC_UNAUTHORIZED

static final int SC_UNAUTHORIZED
Status code (401) indicating that the request requires HTTP authentication.

See Also:
Constant Field Values

SC_PAYMENT_REQUIRED

static final int SC_PAYMENT_REQUIRED
Status code (402) reserved for future use.

See Also:
Constant Field Values

SC_FORBIDDEN

static final int SC_FORBIDDEN
Status code (403) indicating the server understood the request but refused to fulfill it.

See Also:
Constant Field Values

SC_NOT_FOUND

static final int SC_NOT_FOUND
Status code (404) indicating that the requested resource is not available.

See Also:
Constant Field Values

SC_METHOD_NOT_ALLOWED

static final int SC_METHOD_NOT_ALLOWED
Status code (405) indicating the method specified is not allowed for the resource.

See Also:
Constant Field Values

SC_NOT_ACCEPTABLE

static final int SC_NOT_ACCEPTABLE
Status code (406) indicating the resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headerssent in the request.

See Also:
Constant Field Values

SC_PROXY_AUTHENTICATION_REQUIRED

static final int SC_PROXY_AUTHENTICATION_REQUIRED
Status code (407) indicating the client MUST first authenticate itself with the proxy.

See Also:
Constant Field Values

SC_REQUEST_TIMEOUT

static final int SC_REQUEST_TIMEOUT
Status code (408) indicating the client did not produce a request within the time that the server was prepared to wait.

See Also:
Constant Field Values

SC_CONFLICT

static final int SC_CONFLICT
Status code (409) indicating that the request could not be completed due to a conflict with the current state of the resource.

See Also:
Constant Field Values

SC_GONE

static final int SC_GONE
Status code (410) indicating the server did not receive a timely response from the upstream server while acting as a gateway or proxy.

See Also:
Constant Field Values

SC_LENGTH_REQUIRED

static final int SC_LENGTH_REQUIRED
Status code (411) indicating the request cannot be handled without a defined Content-Length.

See Also:
Constant Field Values

SC_PRECONDITION_FAILED

static final int SC_PRECONDITION_FAILED
Status code (412) indicating the precondition given in one or more of the request-header fields evaluated to false when it was tested on the server.

See Also:
Constant Field Values

SC_REQUEST_TOO_LONG

static final int SC_REQUEST_TOO_LONG
Status code (413) indicating the server is refusing to process a request because the request entity is larger than the server is willing or able to process.

See Also:
Constant Field Values

SC_REQUEST_URI_TOO_LONG

static final int SC_REQUEST_URI_TOO_LONG
Status code (414) indicating the server is refusing to service the request because the Request-URI is longer than the server is willing to interpret.

See Also:
Constant Field Values

SC_UNSUPPORTED_MEDIA_TYPE

static final int SC_UNSUPPORTED_MEDIA_TYPE
Status code (415) indicating the server is refusing to service the request because the entity of the request is in a format not supported by the requested resource for the requested method.

See Also:
Constant Field Values

SC_UNPROCESSABLE_ENTITY

static final int SC_UNPROCESSABLE_ENTITY
Status code (422) indicating the server understands the content type of the request entity, but was unable to process the contained instructions.

See Also:
Constant Field Values

SC_LOCKED

static final int SC_LOCKED
Status code (423) indicating the source or destination resource of a method is locked.

See Also:
Constant Field Values

SC_FAILED_DEPENDENCY

static final int SC_FAILED_DEPENDENCY
Status code (424) indicating the method was not executed on a particular resource within its scope because some part of the method's execution failed causing the entire method to be aborted.

See Also:
Constant Field Values

SC_INSUFFICIENT_SPACE_ON_RESOURCE

static final int SC_INSUFFICIENT_SPACE_ON_RESOURCE
Status code (425) indicating that the resource does not have sufficient space to record the state of the resource after the execution of the method.

See Also:
Constant Field Values

SC_INTERNAL_SERVER_ERROR

static final int SC_INTERNAL_SERVER_ERROR
Status code (500) indicating an error inside the HTTP service which prevented it from fulfilling the request.

See Also:
Constant Field Values

SC_NOT_IMPLEMENTED

static final int SC_NOT_IMPLEMENTED
Status code (501) indicating the HTTP service does not support the functionality needed to fulfill the request.

See Also:
Constant Field Values

SC_BAD_GATEWAY

static final int SC_BAD_GATEWAY
Status code (502) indicating that the HTTP server received an invalid response from a server it consulted when acting as a proxy or gateway.

See Also:
Constant Field Values

SC_SERVICE_UNAVAILABLE

static final int SC_SERVICE_UNAVAILABLE
Status code (503) indicating that the HTTP service is temporarily overloaded, and unable to handle the request.

See Also:
Constant Field Values

SC_GATEWAY_TIMEOUT

static final int SC_GATEWAY_TIMEOUT
Status code (504) indicating the server did not receive a timely response from the upstream server while acting as a gateway or proxy.

See Also:
Constant Field Values

SC_HTTP_VERSION_NOT_SUPPORTED

static final int SC_HTTP_VERSION_NOT_SUPPORTED
Status code (505) indicating the server does not support or refuses to support the HTTP protocol version that was used in the request message.

See Also:
Constant Field Values

SC_LOOP_DETECTED

static final int SC_LOOP_DETECTED
Status code (506) indicating the server terminated an operation because it encountered an infinite loop while processing a request with "Depth: infinity".

See Also:
Constant Field Values

SC_CROSS_SERVER_BINDING_FORBIDDEN

static final int SC_CROSS_SERVER_BINDING_FORBIDDEN
Status code (507) indicating the server is unable to create the requested binding because it would bind a segment in a collection on one server to a resource on a different server.

See Also:
Constant Field Values
Method Detail

close

void close()
           throws IOException
Closes this response. Any unread bytes that make up the body of this response are discarded; any underlying OS resources associated with this response are freed.

This method should be invoked on every response returned from the server without exception.

Throws:
IOException - if there was a problem closing this response

getContext

IContext getContext()
Returns this response's header fields.

Returns:
the Context containing the header key, value pairs.

getDocumentBody

Document getDocumentBody()
                         throws IOException
Gets the contents of the response body as a DOM Document.

This response MUST have an XML body (i.e., hasDocumentBody() must return true).

Once the body has been read as an InputStream it cannot be subsequently read as a Document (the bytes have been consumed).

If a problem occurs parsing the document body an IOException is thrown.

Returns:
DOM document obtained from the XML body.
Throws:
IOException - if there was a problem receiving the response or interpreting it as XML.

getInputStream

InputStream getInputStream()
Returns an open input stream for reading the the body of this response.

This response must not have an XML body (i.e., hasElementBody() must return false ).

The client may close the stream early, however, the resulting stream will be closed if necessary when the client closes this response.

Returns:
the bytes of the response as an InputStream.

getStatusCode

int getStatusCode()
Returns the HTTP response status code.

As a convenience, the status code should be one of the SC_* constants defined in this class.

Returns:
the response status code.

getStatusMessage

String getStatusMessage()
Returns the response status message.

The status message is the HTTP string that follows the status code on the first line of the response.

Returns:
the status message verbatim.

hasDocumentBody

boolean hasDocumentBody()
Returns whether this response has an XML element as a body; this is the element that would be read if readDocumentBody() was called.

This method can be called numerous times, and can be called after the body has been read either as an InputStream or a Document -- all with no bad effect.

Returns:
true if this message has a document body and false otherwise.


Copyright © 2001-2014 JBoss by Red Hat. All Rights Reserved.