se.entra.phantom.server.http

Class HttpReply

java.lang.Object

se.entra.phantom.server.http.HttpReply

public class HttpReply
extends Object

Handles HTTP Status Code and Reason Phrase. See RFC 2616 HTTP/1.1 June, 1999 for more information.

The Status-Code element is a 3-digit integer result code of the attempt to understand and satisfy the request.

These codes are fully defined in section 10. The Reason-Phrase is intended to give a short textual description of the Status-Code.

The Status-Code is intended for use by automata and the Reason-Phrase is intended for the human user. The client is not required to examine or display the Reason-Phrase.

The first digit of the Status-Code defines the class of response. The last two digits do not have any categorization role. There are 5 values for the first digit:

 1xx: Informational - Request received, continuing process
 2xx: Success - The action was successfully received, understood, and accepted
 3xx: Redirection - Further action must be taken in order to complete the request
 4xx: Client Error - The request contains bad syntax or cannot be fulfilled
 5xx: Server Error - The server failed to fulfill an apparently valid request
 

Field Summary

Fields

Modifier and Type	Field and Description
static int	EC_Accepted
static int	EC_Bad_Gateway
static int	EC_Bad_Request
static int	EC_Conflict
static int	EC_Created
static int	EC_Expectation_Failed
static int	EC_Forbidden
static int	EC_Found
static int	EC_Gateway_Time_out
static int	EC_Gone
static int	EC_HTTP_Version_not_supported
static int	EC_Internal_Server_Error
static int	EC_Length_Required
static int	EC_Method_Not_Allowed
static int	EC_Moved_Permanently
static int	EC_Multiple_Choices
static int	EC_No_Content
static int	EC_Non_Authoritative_Information
static int	EC_Not_Acceptable
static int	EC_Not_Found
static int	EC_Not_Implemented
static int	EC_Not_Modified
static int	EC_Partial_Content
static int	EC_Payment_Required
static int	EC_Precondition_Failed
static int	EC_Proxy_Authentication_Required
static int	EC_Request_Entity_Too_Large
static int	EC_Request_Time_out
static int	EC_Request_URI_Too_Large
static int	EC_Requested_range_not_satisfiable
static int	EC_Reset_Content
static int	EC_See_Other
static int	EC_Service_Unavailable
static int	EC_Temporary_Redirect
static int	EC_Unauthorized
static int	EC_Unsupported_Media_Type
static int	EC_Use_Proxy
static String	HR_100
static String	HR_101
static String	HR_200
static String	HR_201
static String	HR_202
static String	HR_203
static String	HR_204
static String	HR_205
static String	HR_206
static String	HR_300
static String	HR_301
static String	HR_302
static String	HR_303
static String	HR_304
static String	HR_305
static String	HR_307
static String	HR_400
static String	HR_401
static String	HR_402
static String	HR_403
static String	HR_404
static String	HR_405
static String	HR_406
static String	HR_407
static String	HR_408
static String	HR_409
static String	HR_410
static String	HR_411
static String	HR_412
static String	HR_413
static String	HR_414
static String	HR_415
static String	HR_416
static String	HR_417
static String	HR_500
static String	HR_501
static String	HR_502
static String	HR_503
static String	HR_504
static String	HR_505
int	webServerHeaderReadTimeout The timeout in milliseconds for web server header read in milliseconds, zero for indefinite wait.
int	webServerKeepAliveTimeout The timeout in milliseconds for web server request for keep-alive connections, zero for indefinite wait.

Constructor Summary

Constructors

Constructor and Description
HttpReply(HttpWebServer webServer) The constructor tries to load a default error document called default.html in the error directory.

Method Summary

Modifier and Type	Method and Description
byte[]	createErrorReply(HttpSession session, int errCode) Creates an error reply for a session.
byte[]	createErrorReply(HttpSession session, int errCode, String errExtra) Creates an error reply for a session.
byte[]	createErrorReply(HttpSession session, int errCode, String[] fields) Creates an error reply for a session.
byte[]	createErrorReply(HttpSession session, int errCode, String errExtra, String[] fields) Creates an error reply for a session.
byte[]	createFoundRedirection(HttpSession session, String uri) Creates the found redirection error reply.
byte[]	createMethodNotAllowedError(HttpSession session) Creates the method not allowed reply.
byte[]	createNormalReply(HttpSession session, byte[] data) Creates an normal reply for a session.
byte[]	createNormalReply(HttpSession session, int dataLength) Deprecated.
byte[]	createNormalReply(HttpSession session, long dataLength) Creates an normal reply for a session.
byte[]	createNormalReply(HttpSession session, String data) Creates an normal reply for a session.
byte[]	createOnlyPostMethodAllowedError(HttpSession session) Creates the method not allowed reply.
HtmlResource	getErrorDocument(int errCode) Gets the error document for an error code.
String	getErrorText(int errCode) Gets the error text for an error code.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

HR_100

public static final String HR_100

See Also:

Constant Field Values

HR_101

public static final String HR_101

See Also:

Constant Field Values

HR_200

public static final String HR_200

See Also:

Constant Field Values

HR_201

public static final String HR_201

See Also:

Constant Field Values

HR_202

public static final String HR_202

See Also:

Constant Field Values

HR_203

public static final String HR_203

See Also:

Constant Field Values

HR_204

public static final String HR_204

See Also:

Constant Field Values

HR_205

public static final String HR_205

See Also:

Constant Field Values

HR_206

public static final String HR_206

See Also:

Constant Field Values

HR_300

public static final String HR_300

See Also:

Constant Field Values

HR_301

public static final String HR_301

See Also:

Constant Field Values

HR_302

public static final String HR_302

See Also:

Constant Field Values

HR_303

public static final String HR_303

See Also:

Constant Field Values

HR_304

public static final String HR_304

See Also:

Constant Field Values

HR_305

public static final String HR_305

See Also:

Constant Field Values

HR_307

public static final String HR_307

See Also:

Constant Field Values

HR_400

public static final String HR_400

See Also:

Constant Field Values

HR_401

public static final String HR_401

See Also:

Constant Field Values

HR_402

public static final String HR_402

See Also:

Constant Field Values

HR_403

public static final String HR_403

See Also:

Constant Field Values

HR_404

public static final String HR_404

See Also:

Constant Field Values

HR_405

public static final String HR_405

See Also:

Constant Field Values

HR_406

public static final String HR_406

See Also:

Constant Field Values

HR_407

public static final String HR_407

See Also:

Constant Field Values

HR_408

public static final String HR_408

See Also:

Constant Field Values

HR_409

public static final String HR_409

See Also:

Constant Field Values

HR_410

public static final String HR_410

See Also:

Constant Field Values

HR_411

public static final String HR_411

See Also:

Constant Field Values

HR_412

public static final String HR_412

See Also:

Constant Field Values

HR_413

public static final String HR_413

See Also:

Constant Field Values

HR_414

public static final String HR_414

See Also:

Constant Field Values

HR_415

public static final String HR_415

See Also:

Constant Field Values

HR_416

public static final String HR_416

See Also:

Constant Field Values

HR_417

public static final String HR_417

See Also:

Constant Field Values

HR_500

public static final String HR_500

See Also:

Constant Field Values

HR_501

public static final String HR_501

See Also:

Constant Field Values

HR_502

public static final String HR_502

See Also:

Constant Field Values

HR_503

public static final String HR_503

See Also:

Constant Field Values

HR_504

public static final String HR_504

See Also:

Constant Field Values

HR_505

public static final String HR_505

See Also:

Constant Field Values

EC_Created

public static final int EC_Created

See Also:

Constant Field Values

EC_Accepted

public static final int EC_Accepted

See Also:

Constant Field Values

EC_Non_Authoritative_Information

public static final int EC_Non_Authoritative_Information

See Also:

Constant Field Values

EC_No_Content

public static final int EC_No_Content

See Also:

Constant Field Values

EC_Reset_Content

public static final int EC_Reset_Content

See Also:

Constant Field Values

EC_Partial_Content

public static final int EC_Partial_Content

See Also:

Constant Field Values

EC_Multiple_Choices

public static final int EC_Multiple_Choices

See Also:

Constant Field Values

EC_Moved_Permanently

public static final int EC_Moved_Permanently

See Also:

Constant Field Values

EC_Found

public static final int EC_Found

See Also:

Constant Field Values

EC_See_Other

public static final int EC_See_Other

See Also:

Constant Field Values

EC_Not_Modified

public static final int EC_Not_Modified

See Also:

Constant Field Values

EC_Use_Proxy

public static final int EC_Use_Proxy

See Also:

Constant Field Values

EC_Temporary_Redirect

public static final int EC_Temporary_Redirect

See Also:

Constant Field Values

EC_Bad_Request

public static final int EC_Bad_Request

See Also:

Constant Field Values

EC_Unauthorized

public static final int EC_Unauthorized

See Also:

Constant Field Values

EC_Payment_Required

public static final int EC_Payment_Required

See Also:

Constant Field Values

EC_Forbidden

public static final int EC_Forbidden

See Also:

Constant Field Values

EC_Not_Found

public static final int EC_Not_Found

See Also:

Constant Field Values

EC_Method_Not_Allowed

public static final int EC_Method_Not_Allowed

See Also:

Constant Field Values

EC_Not_Acceptable

public static final int EC_Not_Acceptable

See Also:

Constant Field Values

EC_Proxy_Authentication_Required

public static final int EC_Proxy_Authentication_Required

See Also:

Constant Field Values

EC_Request_Time_out

public static final int EC_Request_Time_out

See Also:

Constant Field Values

EC_Conflict

public static final int EC_Conflict

See Also:

Constant Field Values

EC_Gone

public static final int EC_Gone

See Also:

Constant Field Values

EC_Length_Required

public static final int EC_Length_Required

See Also:

Constant Field Values

EC_Precondition_Failed

public static final int EC_Precondition_Failed

See Also:

Constant Field Values

EC_Request_Entity_Too_Large

public static final int EC_Request_Entity_Too_Large

See Also:

Constant Field Values

EC_Request_URI_Too_Large

public static final int EC_Request_URI_Too_Large

See Also:

Constant Field Values

EC_Unsupported_Media_Type

public static final int EC_Unsupported_Media_Type

See Also:

Constant Field Values

EC_Requested_range_not_satisfiable

public static final int EC_Requested_range_not_satisfiable

See Also:

Constant Field Values

EC_Expectation_Failed

public static final int EC_Expectation_Failed

See Also:

Constant Field Values

EC_Internal_Server_Error

public static final int EC_Internal_Server_Error

See Also:

Constant Field Values

EC_Not_Implemented

public static final int EC_Not_Implemented

See Also:

Constant Field Values

EC_Bad_Gateway

public static final int EC_Bad_Gateway

See Also:

Constant Field Values

EC_Service_Unavailable

public static final int EC_Service_Unavailable

See Also:

Constant Field Values

EC_Gateway_Time_out

public static final int EC_Gateway_Time_out

See Also:

Constant Field Values

EC_HTTP_Version_not_supported

public static final int EC_HTTP_Version_not_supported

See Also:

Constant Field Values

webServerHeaderReadTimeout

public final int webServerHeaderReadTimeout

The timeout in milliseconds for web server header read in milliseconds, zero for indefinite wait.

The default timeout used in NetPhantom is indefinite.

webServerKeepAliveTimeout

public final int webServerKeepAliveTimeout

The timeout in milliseconds for web server request for keep-alive connections, zero for indefinite wait.

The default keep-alive timeout used in NetPhantom is 20 seconds.

Constructor Detail

HttpReply

public HttpReply(HttpWebServer webServer)
          throws IOException

The constructor tries to load a default error document called default.html in the error directory. It then tries to load all the other documents, such as error404.html, etc. If not found, the default document will be used instead.

Throws:

IOException - if the HTML documents cannot be loaded.

Method Detail

getErrorText

public String getErrorText(int errCode)

Gets the error text for an error code.

getErrorDocument

public HtmlResource getErrorDocument(int errCode)

Gets the error document for an error code.

Returns:

null if error code is zero or 200 (OK).

createMethodNotAllowedError

public byte[] createMethodNotAllowedError(HttpSession session)

Creates the method not allowed reply.

createOnlyPostMethodAllowedError

public byte[] createOnlyPostMethodAllowedError(HttpSession session)

Creates the method not allowed reply.

createErrorReply

public byte[] createErrorReply(HttpSession session,
                               int errCode)

Creates an error reply for a session.

createErrorReply

public byte[] createErrorReply(HttpSession session,
                               int errCode,
                               String errExtra)

Creates an error reply for a session.

createErrorReply

public byte[] createErrorReply(HttpSession session,
                               int errCode,
                               String[] fields)

Creates an error reply for a session.

createErrorReply

public byte[] createErrorReply(HttpSession session,
                               int errCode,
                               String errExtra,
                               String[] fields)

Creates an error reply for a session.

createFoundRedirection

public byte[] createFoundRedirection(HttpSession session,
                                     String uri)

Creates the found redirection error reply.

createNormalReply

@Deprecated
public byte[] createNormalReply(HttpSession session,
                                             int dataLength)

Deprecated.

Creates an normal reply for a session.

createNormalReply

public byte[] createNormalReply(HttpSession session,
                                long dataLength)

Creates an normal reply for a session.

createNormalReply

public byte[] createNormalReply(HttpSession session,
                                String data)

Creates an normal reply for a session.

createNormalReply

public byte[] createNormalReply(HttpSession session,
                                byte[] data)

Creates an normal reply for a session.