COM.FutureTense.Util
Class FormPoster

java.lang.Object
  COM.FutureTense.Util.FormPoster

public class FormPoster

extends java.lang.Object

This class allows for the construction and posting of multipart mime encoded messages much as would be sent from a web browser posting the results of an HTML form

Field Summary

static java.lang.String	Connect CONNECT action
static java.lang.String	Delete DELETE action
static int	ERRORBADRESPONSE Error server response did not contain handshake code
static int	ERRORFILEIO File I/O error
static int	ERRORGENERAL General error
static int	ERRORILLEGALDATAFORACTION File data used with Get Method error
static int	ERRORNETDISCONNECT Error network disconnected
static int	ERRORNOCONSERVER Error can't connect to server
static int	ERRORNOTAUTHENTICATED Server certificate does not match what is expected
static int	ERRORNOURLPARAM Error bad URL input params
static int	ERROROUTOFMEMORY Error - out of memory reading a server response
static int	ERRORSUCCESS Error success
static int	ERRORTIMEOUT Error network timeout forced
static java.lang.String	Get GET action
static java.lang.String	Head HEAD action
static java.lang.String	HTTP_ACCEPT_CHARSET
static java.lang.String	HTTP_ACCEPT_LANGUAGE
static java.lang.String	HTTP_ACCEPT_MIME_TYPES
static java.lang.String	HTTP_CONNECTION
static java.lang.String	HTTP_CONTENT_LENGTH
static java.lang.String	HTTP_CONTENT_TYPE
static java.lang.String	HTTP_CONTENT_TYPE_CHARSET
static java.lang.String	HTTP_EXPIRES
static java.lang.String	HTTP_LAST_MODIFIED
static java.lang.String	HTTP_POST_FORMMULTIPART
static java.lang.String	HTTP_POST_FORMURLENCODED
static java.lang.String	HTTP_REFERER
static java.lang.String	HTTP_SET_COOKIE
static java.lang.String	HTTP_USER_AGENT
static int	HTTPRESPONSENOPAGEFOUND
static int	HTTPRESPONSENOSERVICE
static int	HTTPRESPONSENOTOK HTTP Errors...
static int	HTTPRESPONSEOK HTTP Success
static int	HTTPRESPONSETIMEOUT
static int	HTTPVERSION10 HTTP 1.0 flag
static int	HTTPVERSION11 HTTP 1.1 flag
static java.lang.String	Options PUT action
static java.lang.String	PATH_INFO
static java.lang.String	Post POST action
static java.lang.String	Put PUT action
static java.lang.String	REMOTE_ADDR
static java.lang.String	REMOTE_HOST
static java.lang.String	Trace TRACE action

Constructor Summary

FormPoster()
Construct a new object for post

Method Summary

boolean	addFile(java.lang.String sParamName, java.lang.String sValue, java.lang.String sFileName) Add a file (upload file path spec) to data for multipart post, as in INPUT TYPE=FILE
boolean	addFile(java.lang.String sParamName, java.lang.String sValue, java.lang.String sFileName, java.lang.String sMIMEType) Add a file (upload file path spec) to data for multipart post, as in INPUT TYPE=FILE Allow specifing of mime type string.
boolean	addFileData(java.lang.String sParamName, java.lang.String sFileName, byte[] byData) Add file (upload) data via a byte array for multipart post, as in INPUT TYPE=FILE
boolean	addFileData(java.lang.String sParamName, java.lang.String sFileName, byte[] byData, java.lang.String sMIMEType) Add file (upload) data via a byte array for multipart post, as in INPUT TYPE=FILE
boolean	addFileData(java.lang.String sParamName, java.lang.String sFileName, java.io.InputStream is) Add file (upload) data via a InputStream object for multipart post, as in INPUT TYPE=FILE
boolean	addFileData(java.lang.String sParamName, java.lang.String sFileName, java.io.InputStream is, java.lang.String sMIMEType) Add file (upload) data via a InputStream object for multipart post, as in INPUT TYPE=FILE
boolean	addTextValue(java.lang.String sParamName, java.lang.String sValue) Adds a name/value pair to the MIME message we're assembling.
boolean	addURL(java.lang.String sParamName, java.lang.String sURL) Add a url ("http://" or "https://") to data for multipart post, as in INPUT TYPE=FILE
byte[]	cleanRawResponse() Fetch the raw bytes from the output stream and remove the HTTP header.
byte[]	cleanRawResponse(boolean bRemoveStatus) Fetch the raw bytes from the output stream and remove the HTTP header.
java.lang.String	cleanResponse() Fetch the string from the output stream and remove the HTTP header.
java.lang.String	cleanResponse(boolean bRemoveStatus) Fetch the string from the output stream and remove the HTTP header.
void	dumpMsg(java.lang.String msg) Send a String message to stdout or a log file if one was selected via setLog.
FTValList	findAllCookies() Find the cookies in the post response
static FTValList	findAllCookies(java.lang.String sData) Find all cookie values in the HTTP response
static COM.FutureTense.Util.CookieWrapper[]	getCookieArray(java.lang.String sData) Find all cookie values in the HTTP response
FTValList	getCookies() Return FTValList containing all cookie names/values
int	getHTTPStatusCode() Fetch the HTTP status from the response
java.lang.String	getHTTPStatusText() Fetch the HTTP status text from the response
int	getLastError() Retrieve the last error code set
java.lang.String	getLastErrorStr() Retrieve any coded message from the status code object
java.lang.String	getLastErrorText() Retrieve the text represenation of the error returned by getLastError()
java.lang.String	getOutputFileSpec() Fetch the file spec where the post output has been written
byte[]	getRawResponse() Fetch the raw bytes from the output stream
java.lang.String	getResponse() Returns String response from the server after we post() our request.
java.lang.String	getResponseEncoding() Method to get the character encoding of the response if known
javax.servlet.http.Cookie[]	getServletCookies() Get HTTPServlet cookies
void	login(boolean login, COM.FutureTense.Util.ftStatusCode status, java.lang.String user, java.lang.String pass) Login or logout Set the url first in the FormPoster otherwise it will attempt to default to a NAS 2.1 style URL
boolean	post() Send this record via an HTTP POST.
void	registerMIMENotifier(COM.FutureTense.Interfaces.IMIMENotifier mn) Register an object that supports the IMIMENotifier interface so that it will be called with MIME header information.
void	reset() Reset to reuse for a new post
void	setAction(java.lang.String sAction) Sets the action for this request.
void	setAutenticationParameters(java.lang.String sEntity, java.lang.String sIssuer) Set the certificate parameters to be used to authenticate the server.
void	setBodyData(byte[] data) Pass a prebuilt MIME body for posting
void	setBodyStream(java.lang.Object is, int length) Pass a prebuilt MIME body for posting
void	setCharacterEncoding(java.lang.String sEncoding) Set the character encoding for the string data contained in the MIME request message body Ignored when the transmission method is Get
void	setCookies(javax.servlet.http.Cookie[] c) Use these cookies in the future
void	setCookies(java.util.Map cookiesMap) Use these cookies in the future
void	setDump(boolean dumpOutput) Control status logging info; default is false
boolean	setEncodeURL(java.lang.String sURL) Set the URL to post to.
void	setHeaderInformation(FTValList vlHeaderInfo) Use the header information supplied
void	setHTTPVersion(int nVersion) Set the HTTP protocol version to use.
void	setLog(COM.FutureTense.Util.LogFile logFile) Supply a logging object if desired for special log types; not required, output will stream to default location based on invocation environment
void	setLog(java.lang.String logdir) Provide a standard ascii file dump location for logging in absense of LogFile object
void	setOutputDirectory(java.lang.String sDir) Set the directory where the post results output file should be written.
void	setOutputStream(java.io.OutputStream os) Set an output stream to be used for capturing the response.
void	setPort(int nPort) Set the port to be used to connect to the remote http server
void	setProxy(java.lang.String sHost) Set the proxy host if needed to post thru a fire wall
void	setProxyPort(int nPort) Specify a proxy server port if needed to push data thru a firewall
void	setSecureProtocol(boolean bSecure) Communicate in secure (https) mode.
void	setTimeout(int milliseconds) Set a network socket connection timeout, in milliseconds.
boolean	setURL(java.lang.String sURL) Set the URL to post to.

Methods inherited from class java.lang.Object

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

Field Detail

ERRORSUCCESS

public static final int ERRORSUCCESS

Error success

See Also:

Constant Field Values

ERRORNOCONSERVER

public static final int ERRORNOCONSERVER

Error can't connect to server

See Also:

Constant Field Values

ERRORNETDISCONNECT

public static final int ERRORNETDISCONNECT

Error network disconnected

See Also:

Constant Field Values

ERRORNOURLPARAM

public static final int ERRORNOURLPARAM

Error bad URL input params

See Also:

Constant Field Values

ERRORTIMEOUT

public static final int ERRORTIMEOUT

Error network timeout forced

See Also:

Constant Field Values

ERRORBADRESPONSE

public static final int ERRORBADRESPONSE

Error server response did not contain handshake code

See Also:

Constant Field Values

ERRORNOTAUTHENTICATED

public static final int ERRORNOTAUTHENTICATED

Server certificate does not match what is expected

See Also:

Constant Field Values

ERROROUTOFMEMORY

public static final int ERROROUTOFMEMORY

Error - out of memory reading a server response

See Also:

Constant Field Values

ERRORGENERAL

public static final int ERRORGENERAL

General error

See Also:

Constant Field Values

ERRORFILEIO

public static final int ERRORFILEIO

File I/O error

See Also:

Constant Field Values

ERRORILLEGALDATAFORACTION

public static final int ERRORILLEGALDATAFORACTION

File data used with Get Method error

See Also:

Constant Field Values

HTTPVERSION10

public static final int HTTPVERSION10

HTTP 1.0 flag

See Also:

Constant Field Values

HTTPVERSION11

public static final int HTTPVERSION11

HTTP 1.1 flag

See Also:

Constant Field Values

Post

public static final java.lang.String Post

POST action

See Also:

Constant Field Values

Get

public static final java.lang.String Get

GET action

See Also:

Constant Field Values

Connect

public static final java.lang.String Connect

CONNECT action

See Also:

Constant Field Values

Delete

public static final java.lang.String Delete

DELETE action

See Also:

Constant Field Values

Head

public static final java.lang.String Head

HEAD action

See Also:

Constant Field Values

Options

public static final java.lang.String Options

PUT action

See Also:

Constant Field Values

Put

public static final java.lang.String Put

PUT action

See Also:

Constant Field Values

Trace

public static final java.lang.String Trace

TRACE action

See Also:

Constant Field Values

HTTPRESPONSEOK

public static final int HTTPRESPONSEOK

HTTP Success

See Also:

Constant Field Values

HTTPRESPONSENOTOK

public static final int HTTPRESPONSENOTOK

HTTP Errors... and up

See Also:

Constant Field Values

HTTPRESPONSENOPAGEFOUND

public static final int HTTPRESPONSENOPAGEFOUND

See Also:

Constant Field Values

HTTPRESPONSETIMEOUT

public static final int HTTPRESPONSETIMEOUT

See Also:

Constant Field Values

HTTPRESPONSENOSERVICE

public static final int HTTPRESPONSENOSERVICE

See Also:

Constant Field Values

HTTP_ACCEPT_LANGUAGE

public static final java.lang.String HTTP_ACCEPT_LANGUAGE

See Also:

Constant Field Values

HTTP_REFERER

public static final java.lang.String HTTP_REFERER

See Also:

Constant Field Values

REMOTE_HOST

public static final java.lang.String REMOTE_HOST

See Also:

Constant Field Values

REMOTE_ADDR

public static final java.lang.String REMOTE_ADDR

See Also:

Constant Field Values

HTTP_CONNECTION

public static final java.lang.String HTTP_CONNECTION

See Also:

Constant Field Values

PATH_INFO

public static final java.lang.String PATH_INFO

See Also:

Constant Field Values

HTTP_USER_AGENT

public static final java.lang.String HTTP_USER_AGENT

See Also:

Constant Field Values

HTTP_ACCEPT_MIME_TYPES

public static final java.lang.String HTTP_ACCEPT_MIME_TYPES

See Also:

Constant Field Values

HTTP_ACCEPT_CHARSET

public static final java.lang.String HTTP_ACCEPT_CHARSET

See Also:

Constant Field Values

HTTP_SET_COOKIE

public static final java.lang.String HTTP_SET_COOKIE

See Also:

Constant Field Values

HTTP_CONTENT_TYPE_CHARSET

public static final java.lang.String HTTP_CONTENT_TYPE_CHARSET

See Also:

Constant Field Values

HTTP_CONTENT_TYPE

public static final java.lang.String HTTP_CONTENT_TYPE

See Also:

Constant Field Values

HTTP_CONTENT_LENGTH

public static final java.lang.String HTTP_CONTENT_LENGTH

See Also:

Constant Field Values

HTTP_EXPIRES

public static final java.lang.String HTTP_EXPIRES

See Also:

Constant Field Values

HTTP_LAST_MODIFIED

public static final java.lang.String HTTP_LAST_MODIFIED

See Also:

Constant Field Values

HTTP_POST_FORMMULTIPART

public static final java.lang.String HTTP_POST_FORMMULTIPART

See Also:

Constant Field Values

HTTP_POST_FORMURLENCODED

public static final java.lang.String HTTP_POST_FORMURLENCODED

See Also:

Constant Field Values

Constructor Detail

FormPoster

public FormPoster()

Construct a new object for post

Method Detail

getServletCookies

public javax.servlet.http.Cookie[] getServletCookies()

Get HTTPServlet cookies

getCookies

public FTValList getCookies()

Return FTValList containing all cookie names/values

Returns:

FTValList - FTValList containing cookie names/values

setCookies

public void setCookies(javax.servlet.http.Cookie[] c)

Use these cookies in the future

Parameters:

c - cookie array, null to clear

setCookies

public void setCookies(java.util.Map cookiesMap)

Use these cookies in the future

Parameters:

cookiesMap - - Map containing cookie name/value pairs

setHeaderInformation

public void setHeaderInformation(FTValList vlHeaderInfo)

Use the header information supplied

Parameters:

vlHeaderInfo - - vallist containing header information

setBodyData

public void setBodyData(byte[] data)

Pass a prebuilt MIME body for posting

Parameters:

data -

setBodyStream

public void setBodyStream(java.lang.Object is,
                          int length)

Pass a prebuilt MIME body for posting

Parameters:

is - mime body

length - length of body

reset

public void reset()

Reset to reuse for a new post

login

public void login(boolean login,
                  COM.FutureTense.Util.ftStatusCode status,
                  java.lang.String user,
                  java.lang.String pass)

Login or logout Set the url first in the FormPoster otherwise it will attempt to default to a NAS 2.1 style URL

Parameters:

login - - TRUE login otherwise logout

status - - optional if specified return status will be set

user - - username to use to log in

pass - - password to use to log in

setDump

public void setDump(boolean dumpOutput)

Control status logging info; default is false

Parameters:

dumpOutput - whether to dump output msgs

setOutputDirectory

public void setOutputDirectory(java.lang.String sDir)

Set the directory where the post results output file should be written. Mutually exclusive with setOutputStream.

Parameters:

sDir - - directory path. If null, no output file written

setOutputStream

public void setOutputStream(java.io.OutputStream os)

Set an output stream to be used for capturing the response. Mutually exclusive with setOutputDirectory.

Parameters:

os - output stream (not closed)

setCharacterEncoding

public void setCharacterEncoding(java.lang.String sEncoding)

Set the character encoding for the string data contained in the MIME request message body Ignored when the transmission method is Get

Parameters:

sEncoding - character encoding

getOutputFileSpec

public java.lang.String getOutputFileSpec()

Fetch the file spec where the post output has been written

Returns:

String

getResponse

public java.lang.String getResponse()

Returns String response from the server after we post() our request.

Returns:

String response

getRawResponse

public byte[] getRawResponse()

Fetch the raw bytes from the output stream

Returns:

byte[] response

getResponseEncoding

public final java.lang.String getResponseEncoding()

Method to get the character encoding of the response if known

Returns:

character encoding or null if not text or unknown

Since:

6.0

cleanRawResponse

public byte[] cleanRawResponse(boolean bRemoveStatus)

Fetch the raw bytes from the output stream and remove the HTTP header. Optionally remove the trailing status code.

Parameters:

bRemoveStatus - boolean flag

Returns:

byte[] response

cleanRawResponse

public byte[] cleanRawResponse()

Fetch the raw bytes from the output stream and remove the HTTP header.

Returns:

byte[] response

getLastError

public int getLastError()

Retrieve the last error code set

Returns:

int error code

getLastErrorText

public java.lang.String getLastErrorText()

Retrieve the text represenation of the error returned by getLastError()

Returns:

String

getLastErrorStr

public java.lang.String getLastErrorStr()

Retrieve any coded message from the status code object

Returns:

String

getHTTPStatusCode

public int getHTTPStatusCode()

Fetch the HTTP status from the response

Returns:

int

getHTTPStatusText

public java.lang.String getHTTPStatusText()

Fetch the HTTP status text from the response

Returns:

String

setLog

public void setLog(COM.FutureTense.Util.LogFile logFile)

Supply a logging object if desired for special log types; not required, output will stream to default location based on invocation environment

Parameters:

logFile - an object which can construct a logging output

setLog

public void setLog(java.lang.String logdir)

Provide a standard ascii file dump location for logging in absense of LogFile object

Parameters:

logdir - path to log directory and 'wwwresponse.log' will be appended to create a logfile

setAction

public void setAction(java.lang.String sAction)
               throws java.lang.Exception

Sets the action for this request. Either FormPoster.Get or FormPoster.Post

Parameters:

sAction - action

Throws:

java.lang.Exception - if invalid action

addURL

public boolean addURL(java.lang.String sParamName,
                      java.lang.String sURL)

Add a url ("http://" or "https://") to data for multipart post, as in INPUT TYPE=FILE

Parameters:

sParamName - - the parameter name

sURL - - URL to fetch

Returns:

boolean

addFileData

public boolean addFileData(java.lang.String sParamName,
                           java.lang.String sFileName,
                           byte[] byData)

Add file (upload) data via a byte array for multipart post, as in INPUT TYPE=FILE

Parameters:

sParamName - - the parameter name

sFileName - - desired name of the file on the target (ie foo.txt)

byData - byte array containing file data

Returns:

boolean

addFileData

public boolean addFileData(java.lang.String sParamName,
                           java.lang.String sFileName,
                           byte[] byData,
                           java.lang.String sMIMEType)

Add file (upload) data via a byte array for multipart post, as in INPUT TYPE=FILE

Parameters:

sParamName - - the parameter name

sFileName - - desired name of the file on the target (ie foo.txt)

byData - byte array containing file data

sMIMEType - MIME type of the data

Returns:

boolean

addFileData

public boolean addFileData(java.lang.String sParamName,
                           java.lang.String sFileName,
                           java.io.InputStream is,
                           java.lang.String sMIMEType)

Add file (upload) data via a InputStream object for multipart post, as in INPUT TYPE=FILE

Parameters:

sParamName - - the parameter name

sFileName - - desired name of the file on the target (ie foo.txt)

is - - the object from where the file data will be read

sMIMEType - MIME type of the data

Returns:

boolean

addFileData

public boolean addFileData(java.lang.String sParamName,
                           java.lang.String sFileName,
                           java.io.InputStream is)

Add file (upload) data via a InputStream object for multipart post, as in INPUT TYPE=FILE

Parameters:

sParamName - - the parameter name

sFileName - - desired name of the file on the target (ie foo.txt)

is - - the object from where the file data will be read

Returns:

boolean

addFile

public boolean addFile(java.lang.String sParamName,
                       java.lang.String sValue,
                       java.lang.String sFileName)

Add a file (upload file path spec) to data for multipart post, as in INPUT TYPE=FILE

Parameters:

sParamName - - the parameter name

sValue - - value of the parameter (usually the file name)

sFileName - - name of the file to add

Returns:

boolean

addFile

public boolean addFile(java.lang.String sParamName,
                       java.lang.String sValue,
                       java.lang.String sFileName,
                       java.lang.String sMIMEType)

Add a file (upload file path spec) to data for multipart post, as in INPUT TYPE=FILE Allow specifing of mime type string.

Parameters:

sParamName - - the parameter name

sValue - - value of the parameter (usually the file name)

sFileName - - name of the file to add

sMIMEType - - MIME type string

Returns:

boolean

addTextValue

public boolean addTextValue(java.lang.String sParamName,
                            java.lang.String sValue)

Adds a name/value pair to the MIME message we're assembling.

Parameters:

sParamName - - name of the parameter

sValue - - value string of the parameter

Returns:

boolean status

setEncodeURL

public boolean setEncodeURL(java.lang.String sURL)

Set the URL to post to.

Returns:

true if URL is legal, false otherwise. (URL exceptions are captured and just return false)

setURL

public boolean setURL(java.lang.String sURL)

Set the URL to post to.

Returns:

true if URL is legal, false otherwise. (URL exceptions are captured and just return false)

setProxy

public void setProxy(java.lang.String sHost)

Set the proxy host if needed to post thru a fire wall

Parameters:

sHost - host

setProxyPort

public void setProxyPort(int nPort)

Specify a proxy server port if needed to push data thru a firewall

Parameters:

nPort - port

setTimeout

public void setTimeout(int milliseconds)

Set a network socket connection timeout, in milliseconds. Specify 0 for no timeout.

Parameters:

milliseconds - timeout in milliseconds

setSecureProtocol

public void setSecureProtocol(boolean bSecure)

Communicate in secure (https) mode.

Parameters:

bSecure - If set after URL is set, will override the default which was determined from the URL protocol

setPort

public void setPort(int nPort)

Set the port to be used to connect to the remote http server

Parameters:

nPort - port. If set after URL is set, will override the default which was determined from the URL protocol

setHTTPVersion

public void setHTTPVersion(int nVersion)
                    throws java.lang.Exception

Set the HTTP protocol version to use.

Parameters:

nVersion - protocol. Input should be one of:

FormPoster.HTTPVERSION10 or FormPoster.HTTPVERSION11

Throws:

java.lang.Exception - if invalid http version

post

public boolean post()

Send this record via an HTTP POST.

Returns:

boolean

dumpMsg

public void dumpMsg(java.lang.String msg)

Send a String message to stdout or a log file if one was selected via setLog.

Parameters:

msg - - the message to display

findAllCookies

public FTValList findAllCookies()

Find the cookies in the post response

getCookieArray

public static COM.FutureTense.Util.CookieWrapper[] getCookieArray(java.lang.String sData)

Find all cookie values in the HTTP response

Parameters:

sData - data - HTTP response string

Returns:

Cookie[] - array of cookie objects

findAllCookies

public static FTValList findAllCookies(java.lang.String sData)

Find all cookie values in the HTTP response

Parameters:

sData - data - HTTP response string

Returns:

FTValList - FTValList object containing all cookie names and values

cleanResponse

public java.lang.String cleanResponse(boolean bRemoveStatus)

Fetch the string from the output stream and remove the HTTP header. Optionally remove the trailing status code.

Parameters:

bRemoveStatus - - TRUE remove status, FALSE otherwise

Returns:

String response

cleanResponse

public java.lang.String cleanResponse()

Fetch the string from the output stream and remove the HTTP header.

Returns:

String response

setAutenticationParameters

public void setAutenticationParameters(java.lang.String sEntity,
                                       java.lang.String sIssuer)

Set the certificate parameters to be used to authenticate the server. Will NOT be used if the protocol is not required to be secured.

Parameters:

sEntity - String expected name of the entity

sIssuer - String expected certificate issuer name (ie verisign)

registerMIMENotifier

public void registerMIMENotifier(COM.FutureTense.Interfaces.IMIMENotifier mn)

Register an object that supports the IMIMENotifier interface so that it will be called with MIME header information. This method is only applicable when the post output is written to a disk or output stream.

Parameters:

mn - IMIMENotifer object which supports IMIMENotifier