org.ws4d.java.communication.protocol.http

Class HTTPResponseUtil

java.lang.Object

org.ws4d.java.communication.protocol.http.HTTPResponseUtil

public class HTTPResponseUtil
extends java.lang.Object

Utility class for the easier creation of HTTP response messages.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getHTTPStatusString(int statusCode)
static HTTPResponseHeader	getResponseHeader(boolean secure) Creates HTTP 204 "No Content" Header.
static HTTPResponseHeader	getResponseHeader(int status, boolean secure) Returns the default HTTP response header for the given status code.
static HTTPResponseHeader	handleResponse(java.io.InputStream in, boolean secure)
static void	sendBadRequest(java.io.OutputStream out, boolean secure, java.lang.String note) Sends an HTTP bad request.
static void	sendCountinueResponse(java.io.OutputStream out, boolean secure, java.lang.String message) Sends default HTTP 100 Continue response.
static void	sendDefaultDocument(java.io.OutputStream out, boolean secure) Sends the default document.
static void	sendDefaultErrorDocument(java.io.OutputStream out, boolean secure, java.lang.String request) Sends the default Error document.
static void	sendHTTPVersionNotSupported(java.io.OutputStream out, boolean secure, java.lang.String note) Sends an HTTP version not supported.
static void	sendInternalServerError(java.io.OutputStream out, boolean secure, java.lang.String note) Sends an HTTP bad request.
static void	sendNoContentResponse(java.io.OutputStream out, boolean secure, java.lang.String message) Sends default HTTP 204 No Content response.
static void	sendNotFoundResponse(java.io.OutputStream out, boolean secure, HTMLDocument document) Sends default HTTP 404 Not Found response.
static void	sendNotFoundResponse(java.io.OutputStream out, boolean secure, java.lang.String message) Sends default HTTP 404 Not Found response.
static void	sendOKResponse(java.io.OutputStream out, boolean secure, HTMLDocument document) Sends default HTTP 200 OK response.
static void	sendOKResponse(java.io.OutputStream out, boolean secure, java.lang.String message) Sends default HTTP 200 OK response.
static void	sendRedirect(java.io.OutputStream out, URI request, java.lang.String note) Sends a HTTP redirect.
static boolean	sendResource(java.io.OutputStream out, boolean secure, java.lang.String res, ContentType type, boolean chunked, boolean trailer) Sends the resource.
static void	sendResponse(java.io.OutputStream out, boolean secure, int status, HTMLDocument message) Sends a byte array with correct HTTP response.
static void	sendResponse(java.io.OutputStream out, boolean secure, int status, java.lang.String message) Sends a byte array with correct HTTP response.
static void	sendResponse(java.io.OutputStream out, byte[] message, HTTPResponseHeader header) Sends a byte array with correct HTTP response.
static void	sendUnsupportedMediaType(java.io.OutputStream out, boolean secure, java.lang.String note) Sends an HTTP unsupported media type
static java.io.OutputStream	writeResponse(java.io.OutputStream out, boolean secure, int code, ContentType type, boolean chunked, boolean trailer) Writes an HTTP response header to the stream with given media type (e.g.

Methods inherited from class java.lang.Object

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

Method Detail

sendCountinueResponse

public static void sendCountinueResponse(java.io.OutputStream out,
                                         boolean secure,
                                         java.lang.String message)

Sends default HTTP 100 Continue response.

Parameters:

out - stream to work with.

message - message body.

sendOKResponse

public static void sendOKResponse(java.io.OutputStream out,
                                  boolean secure,
                                  java.lang.String message)

Sends default HTTP 200 OK response.

Parameters:

out - stream to work with.

message - message body.

sendOKResponse

public static void sendOKResponse(java.io.OutputStream out,
                                  boolean secure,
                                  HTMLDocument document)

Sends default HTTP 200 OK response.

Parameters:

out - stream to work with.

document - message document.

sendNoContentResponse

public static void sendNoContentResponse(java.io.OutputStream out,
                                         boolean secure,
                                         java.lang.String message)

Sends default HTTP 204 No Content response.

Parameters:

out - stream to work with.

message - message body.

sendNotFoundResponse

public static void sendNotFoundResponse(java.io.OutputStream out,
                                        boolean secure,
                                        HTMLDocument document)

Sends default HTTP 404 Not Found response.

Parameters:

out - stream to work with.

document - message document.

sendNotFoundResponse

public static void sendNotFoundResponse(java.io.OutputStream out,
                                        boolean secure,
                                        java.lang.String message)

Sends default HTTP 404 Not Found response.

Parameters:

out - stream to work with.

message - message body.

sendResponse

public static void sendResponse(java.io.OutputStream out,
                                boolean secure,
                                int status,
                                java.lang.String message)

Sends a byte array with correct HTTP response.

Parameters:

out - stream to work with.

status - HTTP status code for the response.

message - message body.

sendResponse

public static void sendResponse(java.io.OutputStream out,
                                boolean secure,
                                int status,
                                HTMLDocument message)

Sends a byte array with correct HTTP response.

Parameters:

out - stream to work with.

status - HTTP status code for the response.

message - message body.

sendResponse

public static void sendResponse(java.io.OutputStream out,
                                byte[] message,
                                HTTPResponseHeader header)

Sends a byte array with correct HTTP response.

Parameters:

out - stream to work with.

message - message body.

header - the HTTP response header. Please set the correct content length etc.

sendBadRequest

public static void sendBadRequest(java.io.OutputStream out,
                                  boolean secure,
                                  java.lang.String note)

Sends an HTTP bad request.

Parameters:

out - stream to work with.

note - the error note.

sendInternalServerError

public static void sendInternalServerError(java.io.OutputStream out,
                                           boolean secure,
                                           java.lang.String note)

Sends an HTTP bad request.

Parameters:

out - stream to work with.

note - the error note.

sendHTTPVersionNotSupported

public static void sendHTTPVersionNotSupported(java.io.OutputStream out,
                                               boolean secure,
                                               java.lang.String note)

Sends an HTTP version not supported.

Parameters:

out - stream to work with.

note - the error note.

sendUnsupportedMediaType

public static void sendUnsupportedMediaType(java.io.OutputStream out,
                                            boolean secure,
                                            java.lang.String note)

Sends an HTTP unsupported media type

Parameters:

out - stream to work with.

note - the error note.

sendRedirect

public static void sendRedirect(java.io.OutputStream out,
                                URI request,
                                java.lang.String note)

Sends a HTTP redirect.

Parameters:

out - stream to work with.

request - the request which was done.

note - the error note.

sendDefaultErrorDocument

public static void sendDefaultErrorDocument(java.io.OutputStream out,
                                            boolean secure,
                                            java.lang.String request)

Sends the default Error document.

Parameters:

out - stream to work with.

request - the request which was done.

sendDefaultDocument

public static void sendDefaultDocument(java.io.OutputStream out,
                                       boolean secure)

Sends the default document.

Parameters:

out - stream to work with.

getResponseHeader

public static HTTPResponseHeader getResponseHeader(boolean secure)

Creates HTTP 204 "No Content" Header.

Returns:

the HTTP response header.

getResponseHeader

public static HTTPResponseHeader getResponseHeader(int status,
                                                   boolean secure)

Returns the default HTTP response header for the given status code.

Parameters:

status - the status code.

Returns:

the HTTP response header.

getHTTPStatusString

public static java.lang.String getHTTPStatusString(int statusCode)

handleResponse

public static HTTPResponseHeader handleResponse(java.io.InputStream in,
                                                boolean secure)
                                         throws java.io.IOException,
                                                ProtocolException

Throws:

java.io.IOException

ProtocolException

writeResponse

public static java.io.OutputStream writeResponse(java.io.OutputStream out,
                                                 boolean secure,
                                                 int code,
                                                 ContentType type,
                                                 boolean chunked,
                                                 boolean trailer)
                                          throws java.io.IOException

Writes an HTTP response header to the stream with given media type (e.g. application/soap+xml). Can be set to chunked mode if the length of followed communication cannot be determined. The returned OutputStream MUST be used it should be ensured that the chunks are written correctly.

Parameters:

out - the output stream to write the HTTP request to.

code - the HTTP response code.

type - the internet media type.

chunked - true if a special chunked output stream should be returned, false otherwise.

trailer - true if the chunk trailer should be appended at the end, false otherwise.

Returns:

ChunkedOutputStream if chunked is true, the normal output stream otherwise.

Throws:

java.io.IOException

sendResource

public static boolean sendResource(java.io.OutputStream out,
                                   boolean secure,
                                   java.lang.String res,
                                   ContentType type,
                                   boolean chunked,
                                   boolean trailer)

Sends the resource.

Parameters:

out - stream to work with.

res - resource to send.

type - MIME type for this resource.

chunked - if false the whole resource is loaded into memory before it is sent. if true the resource is sent as chunked response, with out much memory usage.

trailer - true if you want to send the OPTIONAL chunk trailer, false otherwise.

Returns:

true if the resource could be loaded and could be sent, false otherwise.