com.addicticks.net.httpsupload

Class HttpsFileUploaderResult

java.lang.Object

com.addicticks.net.httpsupload.HttpsFileUploaderResult

public class HttpsFileUploaderResult
extends Object

Enclosing class for the result of a file upload operation.

Author:

Addicticks

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HttpsFileUploaderResult(int httpStatusCode, String responseText)

Method Summary

Modifier and Type	Method and Description
int	getHttpStatusCode() Gets the HTTP response status code.
Utils.HttpStatusCode	getHttpStatusCodeEnum() Gets the HTTP response status code as an enum.
String	getResponseText() Gets the response text from an upload request.
String	getResponseTextNoHtml() Gets the response text from an upload request.
boolean	isError() Convenience method.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpsFileUploaderResult

protected HttpsFileUploaderResult(int httpStatusCode,
                                  String responseText)

Method Detail

getHttpStatusCode

public int getHttpStatusCode()

Gets the HTTP response status code. For a successful upload this should be equal to 200.

To get the text that represents the given HTTP status code the method Utils.getHttpStatusCodeText(int) can be used.

Returns:

status code

See Also:

getHttpStatusCodeEnum(), isError()

getHttpStatusCodeEnum

public Utils.HttpStatusCode getHttpStatusCodeEnum()

Gets the HTTP response status code as an enum. Theoretically this can be null if the numerical status code is unknown in the enum.

For a successful upload this should be equal to Utils.HttpStatusCode.HTTP_OK.

Returns:

status code enum

See Also:

getHttpStatusCode()

getResponseText

public String getResponseText()

Gets the response text from an upload request. This is the text (typically some HTML) that the server responds. In the context of file upload it is rarely useful. Instead the HTTP status code should be used to verify if an upload has been successful.

Returns:

server response, may be null if server's response doesn't include text.

getResponseTextNoHtml

public String getResponseTextNoHtml()

Gets the response text from an upload request. Same as getResponseText() but all HTML has been stripped from the text and <br>, <p>, <h1>, <h2> and <h3> has been replaced with newline characters for readability.

Returns:

server response, may be null if server's response doesn't include text.

isError

public boolean isError()

Convenience method. Returns true if getHttpStatusCode() is anything other than Utils.HttpStatusCode.HTTP_OK.

Returns: