unlimited.fc.client.api.fcweb

Class FCWebConnection

java.lang.Object

unlimited.fc.client.api.fcweb.FCWebConnection

All Implemented Interfaces:

java.lang.AutoCloseable

Direct Known Subclasses:

TwoWayFCWebConnection

public class FCWebConnection
extends java.lang.Object
implements java.lang.AutoCloseable

Title: FileCatalyst

Description:

Copyright: Copyright (c) 2008

Company: Unlimi-Tech Software Inc.

Version:

1.0

Author:

Chris Bailey

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DOWNLOAD_DIRECTION
protected java.util.logging.Logger	logger
static java.lang.String	TOTAL_FILEAREA_DATA_TRANSFER_STRING
static java.lang.String	TRANSFER_AGENT
static java.lang.String	TWOWAYCONNECTION
static java.lang.String	UPLOAD_DIRECTION

Constructor Summary

Constructors

Constructor and Description
FCWebConnection(java.lang.String hostURL, java.lang.String username, java.lang.String password) Creates a FCWebConnection object that can be validated, and allows the creation and finaliztion of jobs.
FCWebConnection(java.lang.String hostURL, java.lang.String userName, java.lang.String password, boolean isUpload, java.lang.String userAgent, java.lang.String fcWebJobId, java.lang.String trackingNumber, java.lang.String authToken, java.lang.String sessionId)

Method Summary

Modifier and Type	Method and Description
boolean	cancelJob(java.util.List fileListLocal, java.util.List fileListRemote, java.lang.String jobid)
void	checkSizeAndRegexForTaUpload(java.util.List<java.lang.String> files)
void	close()
FCWebJob	createJob(FCWebOrderForm of)
FCWebJob	createJob(FCWebOrderForm of, boolean getFTPSettingsOnly, boolean isFileAreaDownload)
FCWebJob	createJob(java.util.Vector fields) Deprecated.
FCWebJob	downloadJob(java.lang.String jobID, boolean authenticate)
boolean	finalizeJob(java.util.List fileListLocal, java.util.List fileListRemote, boolean isComplete, java.lang.String jobid)
boolean	finalizeJob(java.util.List fileListLocal, java.util.List fileListRemote, boolean isComplete, java.lang.String jobid, java.util.List FileAreaFileList, java.lang.String FileAreaID)
boolean	finalizeJob(java.util.List fileListLocal, java.util.List fileListRemote, java.lang.String result, java.lang.String transferMode)
java.lang.String	getCookieValue(java.lang.String surl, java.lang.String cookieName)
java.util.Vector	getFields()
protected java.lang.String	geTheURLToPostFTPLogs()
java.lang.String	getHostURL()
FCWebSettings	getHotFolderJobSettings()
java.util.List<java.lang.String>	getJobsForDownload()
protected int	getModeFromString(java.lang.String mode)
java.util.List<FCWebOrderForm>	getOrderForms()
java.lang.String	getPassword()
protected java.lang.String	getPlatformInformationToAddToLogs()
FCWebSettings	getSettings()
protected org.w3c.dom.Document	getSettingsDocument(java.lang.String fcwebURLThatReturnsTheSettings, java.lang.Boolean fetchFTPSettings)
java.lang.String	getTaDownloadAuthToken()
java.lang.String	getTaFCWebJobId()
unlimited.core.util.common.StringLogHandler	getTaFcWebLogHandler()
java.lang.String	getTaFCWebSessionId()
FCWebSettings	getTAJobSettings()
protected org.w3c.dom.Node	getTheFTPNodeFromDomDocument(org.w3c.dom.Document document)
java.lang.String	getTrackingNumber()
static java.lang.String	getTransferStatsString(long bytesTransferred)
java.lang.String	getUserAgent()
java.lang.String	getUsername()
boolean	isInitialDirectoryLocked()
boolean	isSecondVersion() this gets updated after you call validateConnection.
boolean	isSecure()
boolean	isShouldWorkWithMobile()
boolean	isTATransferDirectionUpload()
boolean	isTwoWayConnection()
boolean	needsFileListSecurityCheck()
protected org.w3c.dom.Document	parseResponse(java.lang.String xmlStr)
boolean	performPOST(java.lang.String surl, java.lang.String data)
protected void	postDataToTheURLConnection(java.net.URLConnection uc, java.lang.String postData)
boolean	postTAFTPLogs()
boolean	postTAFTPLogsAsynchrounously(java.lang.String threadName, java.lang.String fcwebJobId)
protected void	readAndAssignFTPSettingsFromDOMDocument(org.w3c.dom.Document document, FCWebSettings settings)
protected java.lang.StringBuffer	readDataFromURLConnection(java.net.URLConnection uc)
void	setHostURL(java.lang.String hostURL)
void	setLogs(java.util.logging.Logger logger)
void	setPassword(java.lang.String password)
void	setSecure(boolean isSecure)
void	setShouldJobBeMarked(boolean shouldJobbeFinalized)
void	setShouldWorkWithMobile(boolean shouldWorkWithMobile)
void	setTaDownloadAuthToken(java.lang.String taDownloadAuthToken)
void	setTaFCWebJobId(java.lang.String taFCWebJobId)
void	setTATransferDirectionUpload(boolean isTransferDirectionUpload)
void	setTrackingNumber(java.lang.String trackingNumber)
void	setTwoWayConnection(boolean isTwoWayConnection)
void	setUserAgent(java.lang.String userAgent)
void	setUsername(java.lang.String username)
boolean	shouldJobBeMarked()
void	validateConnectionAndGetSettings(java.lang.Boolean fetchFTPSettings)

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected java.util.logging.Logger logger

DOWNLOAD_DIRECTION

public static final java.lang.String DOWNLOAD_DIRECTION

See Also:

Constant Field Values

UPLOAD_DIRECTION

public static final java.lang.String UPLOAD_DIRECTION

See Also:

Constant Field Values

TWOWAYCONNECTION

public static final java.lang.String TWOWAYCONNECTION

See Also:

Constant Field Values

TRANSFER_AGENT

public static final java.lang.String TRANSFER_AGENT

See Also:

Constant Field Values

TOTAL_FILEAREA_DATA_TRANSFER_STRING

public static final java.lang.String TOTAL_FILEAREA_DATA_TRANSFER_STRING

See Also:

Constant Field Values

Constructor Detail

FCWebConnection

public FCWebConnection(java.lang.String hostURL,
                       java.lang.String username,
                       java.lang.String password)

Creates a FCWebConnection object that can be validated, and allows the creation and finaliztion of jobs.

Parameters:

hostURL - String

username - String

password - String

FCWebConnection

public FCWebConnection(java.lang.String hostURL,
                       java.lang.String userName,
                       java.lang.String password,
                       boolean isUpload,
                       java.lang.String userAgent,
                       java.lang.String fcWebJobId,
                       java.lang.String trackingNumber,
                       java.lang.String authToken,
                       java.lang.String sessionId)

Method Detail

getTaFCWebSessionId

public java.lang.String getTaFCWebSessionId()

getUserAgent

public java.lang.String getUserAgent()

setUserAgent

public void setUserAgent(java.lang.String userAgent)

isSecondVersion

public boolean isSecondVersion()

this gets updated after you call validateConnection. It looks at the version being returned back from the server

Returns:

true if version="2.0"

isShouldWorkWithMobile

public boolean isShouldWorkWithMobile()

setShouldWorkWithMobile

public void setShouldWorkWithMobile(boolean shouldWorkWithMobile)

getTaFCWebJobId

public java.lang.String getTaFCWebJobId()

setTaFCWebJobId

public void setTaFCWebJobId(java.lang.String taFCWebJobId)

isTATransferDirectionUpload

public boolean isTATransferDirectionUpload()

setTATransferDirectionUpload

public void setTATransferDirectionUpload(boolean isTransferDirectionUpload)

shouldJobBeMarked

public boolean shouldJobBeMarked()

setShouldJobBeMarked

public void setShouldJobBeMarked(boolean shouldJobbeFinalized)

getUsername

public java.lang.String getUsername()

setUsername

public void setUsername(java.lang.String username)

getPassword

public java.lang.String getPassword()

setPassword

public void setPassword(java.lang.String password)

getHostURL

public java.lang.String getHostURL()

setHostURL

public void setHostURL(java.lang.String hostURL)

getTrackingNumber

public java.lang.String getTrackingNumber()

setTrackingNumber

public void setTrackingNumber(java.lang.String trackingNumber)

getTaDownloadAuthToken

public java.lang.String getTaDownloadAuthToken()

setTaDownloadAuthToken

public void setTaDownloadAuthToken(java.lang.String taDownloadAuthToken)

getTaFcWebLogHandler

public unlimited.core.util.common.StringLogHandler getTaFcWebLogHandler()

isSecure

public boolean isSecure()

needsFileListSecurityCheck

public boolean needsFileListSecurityCheck()

setSecure

public void setSecure(boolean isSecure)

geTheURLToPostFTPLogs

protected java.lang.String geTheURLToPostFTPLogs()
                                          throws java.lang.Exception

Throws:

java.lang.Exception

getSettingsDocument

protected org.w3c.dom.Document getSettingsDocument(java.lang.String fcwebURLThatReturnsTheSettings,
                                                   java.lang.Boolean fetchFTPSettings)
                                            throws java.lang.Exception

Throws:

java.lang.Exception

parseResponse

protected org.w3c.dom.Document parseResponse(java.lang.String xmlStr)

readDataFromURLConnection

protected java.lang.StringBuffer readDataFromURLConnection(java.net.URLConnection uc)
                                                    throws java.io.IOException

Throws:

java.io.IOException

postDataToTheURLConnection

protected void postDataToTheURLConnection(java.net.URLConnection uc,
                                          java.lang.String postData)
                                   throws java.io.IOException

Throws:

java.io.IOException

createJob

@Deprecated
public FCWebJob createJob(java.util.Vector fields)
                                throws java.lang.Exception

Deprecated.

Throws:

java.lang.Exception

createJob

public FCWebJob createJob(FCWebOrderForm of)
                   throws java.lang.Exception

Throws:

java.lang.Exception

createJob

public FCWebJob createJob(FCWebOrderForm of,
                          boolean getFTPSettingsOnly,
                          boolean isFileAreaDownload)
                   throws java.lang.Exception

Throws:

java.lang.Exception

getJobsForDownload

public java.util.List<java.lang.String> getJobsForDownload()
                                                    throws java.lang.Exception

Throws:

java.lang.Exception

downloadJob

public FCWebJob downloadJob(java.lang.String jobID,
                            boolean authenticate)
                     throws java.lang.Exception

Throws:

java.lang.Exception

cancelJob

public boolean cancelJob(java.util.List fileListLocal,
                         java.util.List fileListRemote,
                         java.lang.String jobid)
                  throws java.lang.Exception

Throws:

java.lang.Exception

finalizeJob

public boolean finalizeJob(java.util.List fileListLocal,
                           java.util.List fileListRemote,
                           java.lang.String result,
                           java.lang.String transferMode)
                    throws java.lang.Exception

Throws:

java.lang.Exception

finalizeJob

public boolean finalizeJob(java.util.List fileListLocal,
                           java.util.List fileListRemote,
                           boolean isComplete,
                           java.lang.String jobid)
                    throws java.lang.Exception

Throws:

java.lang.Exception

finalizeJob

public boolean finalizeJob(java.util.List fileListLocal,
                           java.util.List fileListRemote,
                           boolean isComplete,
                           java.lang.String jobid,
                           java.util.List FileAreaFileList,
                           java.lang.String FileAreaID)
                    throws java.lang.Exception

Throws:

java.lang.Exception

validateConnectionAndGetSettings

public void validateConnectionAndGetSettings(java.lang.Boolean fetchFTPSettings)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

checkSizeAndRegexForTaUpload

public void checkSizeAndRegexForTaUpload(java.util.List<java.lang.String> files)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

isTwoWayConnection

public boolean isTwoWayConnection()

setTwoWayConnection

public void setTwoWayConnection(boolean isTwoWayConnection)

getSettings

public FCWebSettings getSettings()
                          throws java.lang.Exception

Throws:

java.lang.Exception

getTAJobSettings

public FCWebSettings getTAJobSettings()

getHotFolderJobSettings

public FCWebSettings getHotFolderJobSettings()

isInitialDirectoryLocked

public boolean isInitialDirectoryLocked()

readAndAssignFTPSettingsFromDOMDocument

protected void readAndAssignFTPSettingsFromDOMDocument(org.w3c.dom.Document document,
                                                       FCWebSettings settings)
                                                throws java.lang.Exception

Throws:

java.lang.Exception

getTheFTPNodeFromDomDocument

protected org.w3c.dom.Node getTheFTPNodeFromDomDocument(org.w3c.dom.Document document)
                                                 throws java.lang.Exception

Throws:

java.lang.Exception

getModeFromString

protected int getModeFromString(java.lang.String mode)

getOrderForms

public java.util.List<FCWebOrderForm> getOrderForms()
                                             throws java.lang.Exception

Throws:

java.lang.Exception

getFields

public java.util.Vector getFields()
                           throws java.lang.Exception

Throws:

java.lang.Exception

getCookieValue

public java.lang.String getCookieValue(java.lang.String surl,
                                       java.lang.String cookieName)
                                throws java.lang.Exception

Throws:

java.lang.Exception

postTAFTPLogs

public boolean postTAFTPLogs()
                      throws java.lang.Exception

Throws:

java.lang.Exception

postTAFTPLogsAsynchrounously

public boolean postTAFTPLogsAsynchrounously(java.lang.String threadName,
                                            java.lang.String fcwebJobId)

getPlatformInformationToAddToLogs

protected java.lang.String getPlatformInformationToAddToLogs()

performPOST

public boolean performPOST(java.lang.String surl,
                           java.lang.String data)
                    throws java.lang.Exception

Throws:

java.lang.Exception

setLogs

public void setLogs(java.util.logging.Logger logger)

close

public void close()
           throws java.lang.Exception

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.Exception

getTransferStatsString

public static java.lang.String getTransferStatsString(long bytesTransferred)