com.ithit.webdav.server.http

Interface DavRequest

All Known Implementing Classes:

FilteredDavRequest

public interface DavRequest

Represents http request to the WebDAV server.

Method Summary

Modifier and Type	Method and Description
String	getCharacterEncoding() Returns request encoding.
long	getContentLength() Returns the length, in bytes, of the request body.
String	getContentType() Returns the MIME type of the body of the request, or null.
String	getContextPath() Returns the portion of the request URI that indicates the context of the request.
String	getHeader(String name) Returns http header by name or null if not exists.
Enumeration	getHeaderNames() Returns an enumeration of all the header names this request contains.
InputStream	getInputStream() Retrieves the body of the request as binary data using a InputStream.
String	getMethod() Returns http method of the request.
Object	getOriginalRequest() Returns the original request that was sent by the chosen web container.
String	getQueryString() Returns the query string that is contained in the request URL after the path.
String	getRequestURI() Returns the part of this request's URL from the protocol name up to the query string in the first line of the HTTP request.
String	getScheme() Returns http or https server scheme.
String	getServerName() Returns server name.
String	getServerPath() Returns the part of this request's URL that calls the server.
int	getServerPort() Returns port at which server is running.

Method Detail

getHeader

String getHeader(String name)

Returns http header by name or null if not exists.

Parameters:

name - Name of the header.

Returns:

Value of the header.

getMethod

String getMethod()

Returns http method of the request.

Returns:

Http method.

getRequestURI

String getRequestURI()

Returns the part of this request's URL from the protocol name up to the query string in the first line of the HTTP request.

Returns:

a String containing the part of the URL from the protocol name up to the query string.

getQueryString

String getQueryString()

Returns the query string that is contained in the request URL after the path.

Returns:

a String containing the query string or null if the URL contains no query string. The value is not decoded by the container.

getContextPath

String getContextPath()

Returns the portion of the request URI that indicates the context of the request.

Returns:

a String specifying the portion of the request URI that indicates the context of the request.

getServerPath

String getServerPath()

Returns the part of this request's URL that calls the server.

Returns:

a String containing the name or path of the server being called, as specified in the request URL, decoded, or an empty string if the server used to process the request is matched using the "/*" pattern.

getServerPort

int getServerPort()

Returns port at which server is running.

Returns:

int port.

getScheme

String getScheme()

Returns http or https server scheme.

Returns:

Http or https.

getServerName

String getServerName()

Returns server name.

Returns:

Server name.

getCharacterEncoding

String getCharacterEncoding()

Returns request encoding.

Returns:

Character encoding of the request.

getInputStream

InputStream getInputStream()
                    throws IOException

Retrieves the body of the request as binary data using a InputStream.

Returns:

a InputStream object containing the body of the request.

Throws:

IOException - if an input or output exception occurred.

getContentLength

long getContentLength()

Returns the length, in bytes, of the request body.

Returns:

An long containing the length of the request body or -1 if the length is not known.

getContentType

String getContentType()

Returns the MIME type of the body of the request, or null.

Returns:

a String containing the name of the MIME type of the request, or null if the type is not known.

getHeaderNames

Enumeration getHeaderNames()

Returns an enumeration of all the header names this request contains.

Returns:

An enumeration of all the header names sent with this request.

getOriginalRequest

Object getOriginalRequest()

Returns the original request that was sent by the chosen web container.

Returns:

Object original request.