wjhk.jupload2.upload.helper

Class HTTPConnectionHelper

java.lang.Object

java.io.OutputStream

wjhk.jupload2.upload.helper.HTTPConnectionHelper

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class HTTPConnectionHelper
extends OutputStream

This class contains utilities to delegate network manipulation. It hides the management for the current upload policy connection parameters.
This class goes through the following states, stored in the private connectionStatus attribute:

STATUS_NOT_INITIALIZED: default status when the instance in created. Only available action: initRequest(URL, String, boolean, boolean)

STATUS_BEFORE_SERVER_CONNECTION: the instance is initialized, and the caller may begin writing the request to this HttpConnectionHelper. All data written to it, will be stored in a ByteArrayEncoderHTTP. The connection switches to this status when the initRequest(URL, String, boolean, boolean) is called.

STATUS_WRITING_REQUEST: The network connection to the server is now opened. The content of the ByteArrayEncoderHTTP has been sent to the server. All subsequent calls to write methods will directly write on the socket to the server. The sendRequest() method changes the connection to this status.

STATUS_READING_RESPONSE: The request to the server has been totally written. No more calls to the write methods are allowed. The readHttpResponse() is responsible to put the HttpConnectionHelper to this status.

STATUS_CONNECTION_CLOSED: The response has been read. All getters can be called, to get information about the server response. The only other method allowed is the initRequest(URL, String, boolean, boolean), to start a new request to the server. Using the same HttpConnectionHelper allows to use the same network connection, when the allowHttpPersistent applet parameter is used.

Author:

etienne_sf

Constructor Summary

Constructors

Constructor and Description
HTTPConnectionHelper(UploadPolicy uploadPolicy) The standard constructor for this class.
HTTPConnectionHelper(URL url, String method, boolean bChunkEnabled, boolean bLastChunk, UploadPolicy uploadPolicy) The standard constructor for this class.

Method Summary

Methods

Modifier and Type	Method and Description
HTTPConnectionHelper	append(byte[] bytes) Append bytes to the current query.
HTTPConnectionHelper	append(byte[] bytes, int off, int len) Append bytes to the current query.
HTTPConnectionHelper	append(ByteArrayEncoder bae) Appends a string to the current HTTP request.
HTTPConnectionHelper	append(int b) Append bytes to the current query.
HTTPConnectionHelper	append(String str) write a string to the current HTTP request.
void	close() This method is the override of OutputStream.close() one.
void	dispose() Releases all reserved resources.
void	flush() Flushes the output stream.
String	getBoundary()
ByteArrayEncoder	getByteArrayEncoder() Return the current ByteArrayEncoder.
PushbackInputStream	getInputStream() get the input stream, where HTTP server response can be read.
String	getMethod() Get the HTTP method (HEAD, POST, GET...)
OutputStream	getOutputStream() get the output stream, where HTTP data can be written.
String	getResponseBody() Get the last response body.
String	getResponseHeaders() Get the headers of the HTTP response.
String	getResponseMsg() Get the last response message.
String	getStatusLabel() Get the label describing the current state of this connection helper.
void	initRequest(URL url, String method, boolean bChunkEnabled, boolean bLastChunk) The standard constructor for this class.
int	readHttpResponse() Read the response of the server.
void	sendRequest() Closes the byteArrayEncoder, create the socket (or not, depending on the current uploadPolicy, and upload history), send the request, and create the InputStream to read the server response.
void	write(byte[] b)
void	write(byte[] b, int off, int len)
void	write(int b)

Methods inherited from class java.lang.Object

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

Constructor Detail

HTTPConnectionHelper

public HTTPConnectionHelper(UploadPolicy uploadPolicy)

The standard constructor for this class.

Parameters:

uploadPolicy - The current upload policy.

HTTPConnectionHelper

public HTTPConnectionHelper(URL url,
                    String method,
                    boolean bChunkEnabled,
                    boolean bLastChunk,
                    UploadPolicy uploadPolicy)
                     throws JUploadIOException

The standard constructor for this class.

Parameters:

url - The target URL

method - The HTTP method (POST, GET, HEAD...)

bChunkEnabled - Indicates if chunkUpload is enabled for this query. Put false, if non chunked request or if it is not relevant.

bLastChunk - Indicates whether this chunk is the last one. Put true, if non chunked request or if it is not relevant.

uploadPolicy - The current upload policy.

Throws:

JUploadIOException

Method Detail

initRequest

public void initRequest(URL url,
               String method,
               boolean bChunkEnabled,
               boolean bLastChunk)
                 throws JUploadIOException

The standard constructor for this class.

Parameters:

url - The target URL

bChunkEnabled - Indicates if chunkUpload is enabled for this query. Put false, if non chunked request or if it is not relevant.

method - The HTTP method (POST, GET, HEAD...)

bLastChunk - Indicates whether this chunk is the last one. Put true, if non chunked request or if it is not relevant.

Throws:

JUploadIOException

getByteArrayEncoder

public ByteArrayEncoder getByteArrayEncoder()
                                     throws JUploadIOException

Return the current ByteArrayEncoder. If it was not created, it is initialized.

Returns:

The current ByteArrayEncoder, null if called before the first initialization.

Throws:

JUploadIOException

See Also:

initRequest(URL, String, boolean, boolean)

getBoundary

public String getBoundary()

Returns:

Returns the boundary for this HTTP request.

sendRequest

public void sendRequest()
                 throws JUploadIOException

Closes the byteArrayEncoder, create the socket (or not, depending on the current uploadPolicy, and upload history), send the request, and create the InputStream to read the server response.

Throws:

JUploadIOException

dispose

public void dispose()
             throws JUploadIOException

Releases all reserved resources.

Throws:

JUploadIOException

getOutputStream

public OutputStream getOutputStream()

get the output stream, where HTTP data can be written.

Returns:

The current output stream to the server, where things can be written, event after the socket is open, if the byteArrayEncoder did not contain the full request.

getInputStream

public PushbackInputStream getInputStream()

get the input stream, where HTTP server response can be read.

Returns:

The current input stream of the socket.

getMethod

public String getMethod()

Get the HTTP method (HEAD, POST, GET...)

Returns:

The HTTP method

getResponseBody

public String getResponseBody()

Get the last response body.

Returns:

The full response body, that is: the HTTP body of the server response.

getResponseHeaders

public String getResponseHeaders()

Get the headers of the HTTP response.

Returns:

The HTTP headers.

getResponseMsg

public String getResponseMsg()

Get the last response message.

Returns:

the response message, like "200 OK"

getStatusLabel

public String getStatusLabel()

Get the label describing the current state of this connection helper.

Returns:

A text describing briefly the current connection status.

append

public HTTPConnectionHelper append(int b)
                            throws JUploadIOException

Append bytes to the current query. The bytes will be written to the current ByteArrayEncoder if the the connection to the server is not open, or directly to the server if the connection is opened.

Parameters:

b - The byte to send to the server.

Returns:

Returns the current HttpConnectionHelper, to allow coding like StringBuffers: a.append(b).append(c);

Throws:

JUploadIOException

append

public HTTPConnectionHelper append(byte[] bytes)
                            throws JUploadIOException

Append bytes to the current query. The bytes will be written to the current ByteArrayEncoder if the the connection to the server is not open, or directly to the server if the connection is opened.

Parameters:

bytes - The bytes to send to the server.

Returns:

Returns the current HttpConnectionHelper, to allow coding like StringBuffers: a.append(b).append(c);

Throws:

JUploadIOException

append

public HTTPConnectionHelper append(byte[] bytes,
                          int off,
                          int len)
                            throws JUploadIOException

Append bytes to the current query. The bytes will be written to the current ByteArrayEncoder if the the connection to the server is not open, or directly to the server if the connection is opened.

Parameters:

bytes - The bytes to send to the server.

off - The first byte to send

len - Number of bytes to send.

Returns:

Returns the current HttpConnectionHelper, to allow coding like StringBuffers: a.append(b).append(c);

Throws:

JUploadIOException

append

public HTTPConnectionHelper append(String str)
                            throws JUploadIOException

write a string to the current HTTP request.

Parameters:

str - The string to write

Returns:

The current HTTPConnectionHelper

Throws:

JUploadIOException - If any problem occurs during the writing operation.

See Also:

append(byte[])

append

public HTTPConnectionHelper append(ByteArrayEncoder bae)
                            throws JUploadIOException

Appends a string to the current HTTP request.

Parameters:

bae - The ByteArrayEncoder to write. It is expected to be correctly encoded. That is: it is up to the caller to check that its encoding is the same as the current HTTP request encoding.

Returns:

The current HTTPConnectionHelper

Throws:

JUploadIOException - If any problem occurs during the writing operation.

See Also:

append(byte[])

readHttpResponse

public int readHttpResponse()
                     throws JUploadException

Read the response of the server. This method delegates the work to the HTTPInputStreamReader. handles the chunk HTTP response.

Returns:

The HTTP status. Should be 200, when everything is right.

Throws:

JUploadException

write

public void write(int b)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

write

public void write(byte[] b,
         int off,
         int len)
           throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

write

public void write(byte[] b)
           throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

close

public void close()
           throws IOException

This method is the override of OutputStream.close() one. It may not been called. You must use the sendRequest() or readHttpResponse() methods instead.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream

Throws:

IOException

See Also:

OutputStream.close()

flush

public void flush()
           throws IOException

Flushes the output stream. Useful only when the HTTPConnectionHelper is writing to the socket toward the server, that is when the status is: STATUS_WRITING_REQUEST.

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

See Also:

OutputStream.flush()