net.sf.webdav

Enum WebdavStatus

java.lang.Object

java.lang.Enum<WebdavStatus>

net.sf.webdav.WebdavStatus

All Implemented Interfaces:

Serializable, Comparable<WebdavStatus>

public enum WebdavStatus
extends Enum<WebdavStatus>

Wraps the HttpServletResponse class to abstract the specific protocol used. To support other protocols we would only need to modify this class and the WebDavRetCode classes.

Version:

1.0, 16 Nov 1997

Author:

Marc Eaddy

Enum Constant Summary

Enum Constants

Enum Constant and Description
SC_ACCEPTED Status code (202) indicating that a request was accepted for processing, but was not completed.
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.
SC_BAD_REQUEST Status code (400) indicating the request sent by the client was syntactically incorrect.
SC_CONFLICT Status code (409) indicating that the request could not be completed due to a conflict with the current state of the resource.
SC_CONTINUE Status code (100) indicating the client may continue with its request.
SC_CREATED Status code (201) indicating the request succeeded and created a new resource on the server.
SC_FORBIDDEN Status code (403) indicating the server understood the request but refused to fulfill it.
SC_INSUFFICIENT_SPACE_ON_RESOURCE Status code (419) indicating that the resource does not have sufficient space to record the state of the resource after the execution of this method.
SC_INTERNAL_SERVER_ERROR Status code (500) indicating an error inside the HTTP service which prevented it from fulfilling the request.
SC_LOCKED Status code (423) indicating the destination resource of a method is locked, and either the request did not contain a valid Lock-Info header, or the Lock-Info header identifies a lock held by another principal.
SC_METHOD_FAILURE Status code (420) 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.
SC_METHOD_NOT_ALLOWED Status code (405) indicating the method specified is not allowed for the resource.
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.
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.
SC_MULTI_STATUS Status code (207) indicating that the response requires providing status for multiple independent operations.
SC_NO_CONTENT Status code (204) indicating that the request succeeded but that there was no new information to return.
SC_NOT_FOUND Status code (404) indicating that the requested resource is not available.
SC_NOT_IMPLEMENTED Status code (501) indicating the HTTP service does not support the functionality needed to fulfill the request.
SC_NOT_MODIFIED Status code (304) indicating that a conditional GET operation found that the resource was available and not modified.
SC_OK Status code (200) indicating the request succeeded normally.
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.
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.
SC_SERVICE_UNAVAILABLE Status code (503) indicating that the HTTP service is temporarily overloaded, and unable to handle the request.
SC_UNAUTHORIZED Status code (401) indicating that the request requires HTTP authentication.
SC_UNPROCESSABLE_ENTITY Status code (418) indicating the entity body submitted with the PATCH method was not understood by the resource.
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.

Method Summary

Methods

Modifier and Type	Method and Description
int	code()
static WebdavStatus	get(int status)
static String	getStatusText(int nHttpStatusCode) Returns the HTTP status text for the HTTP or WebDav status code specified by looking it up in the static mapping.
String	message()
static WebdavStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static WebdavStatus[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SC_OK

public static final WebdavStatus SC_OK

Status code (200) indicating the request succeeded normally.

SC_CREATED

public static final WebdavStatus SC_CREATED

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

SC_ACCEPTED

public static final WebdavStatus SC_ACCEPTED

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

SC_NO_CONTENT

public static final WebdavStatus SC_NO_CONTENT

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

SC_MOVED_PERMANENTLY

public static final WebdavStatus 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.

SC_MOVED_TEMPORARILY

public static final WebdavStatus 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.

SC_NOT_MODIFIED

public static final WebdavStatus SC_NOT_MODIFIED

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

SC_BAD_REQUEST

public static final WebdavStatus SC_BAD_REQUEST

Status code (400) indicating the request sent by the client was syntactically incorrect.

SC_UNAUTHORIZED

public static final WebdavStatus SC_UNAUTHORIZED

Status code (401) indicating that the request requires HTTP authentication.

SC_FORBIDDEN

public static final WebdavStatus SC_FORBIDDEN

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

SC_NOT_FOUND

public static final WebdavStatus SC_NOT_FOUND

Status code (404) indicating that the requested resource is not available.

SC_INTERNAL_SERVER_ERROR

public static final WebdavStatus SC_INTERNAL_SERVER_ERROR

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

SC_NOT_IMPLEMENTED

public static final WebdavStatus SC_NOT_IMPLEMENTED

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

SC_BAD_GATEWAY

public static final WebdavStatus 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.

SC_SERVICE_UNAVAILABLE

public static final WebdavStatus SC_SERVICE_UNAVAILABLE

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

SC_CONTINUE

public static final WebdavStatus 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.

SC_METHOD_NOT_ALLOWED

public static final WebdavStatus SC_METHOD_NOT_ALLOWED

Status code (405) indicating the method specified is not allowed for the resource.

SC_CONFLICT

public static final WebdavStatus SC_CONFLICT

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

SC_PRECONDITION_FAILED

public static final WebdavStatus 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.

SC_REQUEST_TOO_LONG

public static final WebdavStatus 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.

SC_UNSUPPORTED_MEDIA_TYPE

public static final WebdavStatus 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.

SC_MULTI_STATUS

public static final WebdavStatus SC_MULTI_STATUS

Status code (207) indicating that the response requires providing status for multiple independent operations.

SC_UNPROCESSABLE_ENTITY

public static final WebdavStatus SC_UNPROCESSABLE_ENTITY

Status code (418) indicating the entity body submitted with the PATCH method was not understood by the resource.

SC_INSUFFICIENT_SPACE_ON_RESOURCE

public static final WebdavStatus SC_INSUFFICIENT_SPACE_ON_RESOURCE

Status code (419) indicating that the resource does not have sufficient space to record the state of the resource after the execution of this method.

SC_METHOD_FAILURE

public static final WebdavStatus SC_METHOD_FAILURE

Status code (420) 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.

SC_LOCKED

public static final WebdavStatus SC_LOCKED

Status code (423) indicating the destination resource of a method is locked, and either the request did not contain a valid Lock-Info header, or the Lock-Info header identifies a lock held by another principal.

Method Detail

values

public static WebdavStatus[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (WebdavStatus c : WebdavStatus.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static WebdavStatus valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getStatusText

public static String getStatusText(int nHttpStatusCode)

Returns the HTTP status text for the HTTP or WebDav status code specified by looking it up in the static mapping. This is a static function.

Parameters:

nHttpStatusCode - [IN] HTTP or WebDAV status code

Returns:

A string with a short descriptive phrase for the HTTP status code (e.g., "OK").

code

public int code()

message

public String message()

get

public static WebdavStatus get(int status)