unlimited.fc.client.api.fcweb

Class FCWebClient

java.lang.Object

unlimited.fc.client.api.fcweb.FCWebClient

public class FCWebClient
extends java.lang.Object

A client class the defines methods to be used within FCWeb

Author:

Elton Carneiro

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MY_FILE_AREA

Constructor Summary

Constructors

Constructor and Description
FCWebClient() Default Constructor should be used along with setters for host, username and password.
FCWebClient(java.lang.String hostURL, java.lang.String username, java.lang.String password) This is the main constructor used to instantiate the FCWebClient object.

Method Summary

Modifier and Type	Method and Description
protected void	createJob(FCWebOrderForm orderForm)
void	disconnect() This method is used to disconnect once the files are uploaded.
java.util.List	getFCWebOrderForms() This method will establish a connection to the FileCatalyst Workflow instance based on the parameters passed through the constructor or those set through the setter methods and return the list of fields (stored in a Vector) defined in FileCatalyst Web.
java.util.ArrayList<java.lang.String>	getFileAreaFileList() Returns the file list that used for the file area, the file(s) must already exist in the specified File Area
java.lang.String	getFileAreaID() Returns the ID for the File Area, this File Area will be used to submit files that already exisit in the FileArea and will not require a new file upload
java.lang.String	getHostURL() Method used to return the value of the host
java.lang.String	getJobID() Returns the current job's ID
java.lang.String	getPassword() Method used to return the password
java.util.Vector	getSettings() Deprecated.
java.lang.String	getTrackingNumber() get the TrackingNumber after the submitJob() call, other wise this field will be an empty String
TransferHook	getTransfer() This method will return the TransferHook object for the current transfer.
java.lang.String	getUsername() Method used to return the username
static java.lang.String	getVersion() This method returns the version of the FCAPI being used.
void	setFileAreaFileList(java.util.ArrayList<java.lang.String> fileAreaFileList) Sets the File Area File list to the value specified, the file(s) must already exist in the specified File Area, Folders in FileAreas may also be used but must terminate with forward slash "/"
void	setFileAreaID(java.lang.String fileAreaID) Sets the File Area ID to the value that you specify, this File Area will be used to submit files that already exisit in the FileArea and will not require a new file upload
void	setHostURL(java.lang.String hostURL) Method used to set the value of the host
void	setPassword(java.lang.String password) Method used to set the password to be used along with the user when connecting to FileCatalyst Web
void	setUsername(java.lang.String username) Method used to set the username when connecting to FileCatalyst Web
java.lang.String	submitJob() This method will submit and finalize the job.
java.lang.String	submitJob(FCWebOrderForm form) This method will submit and finalize the job.
java.lang.String	submitJob(FCWebOrderForm form, java.util.ArrayList fileAreaList, java.lang.String FileAreaID) This method will submit and finalize the job.
TransferHook	uploadFiles(FCWebOrderForm of, java.io.File localFile) This method when called will create a job in FileCatalyst Workflow, set the field values for the job and upload the selected file to the job folder.
TransferHook	uploadFiles(FCWebOrderForm of, java.io.File localFile, java.nio.file.Path exportLocation) This method when called will create a job in FileCatalyst Workflow, set the field values for the job and upload the selected file to the job folder.
TransferHook	uploadFiles(FCWebOrderForm of, java.util.List<java.nio.file.Path> files) This method when called will create a job in FileCatalyst Workflow, set the field values for the job and upload the selected file to the job folder.
TransferHook	uploadFiles(FCWebOrderForm of, java.util.List<java.nio.file.Path> files, java.nio.file.Path exportLocation) This method when called will create a job in FileCatalyst Workflow, set the field values for the job and upload the selected file to the job folder.
TransferHook	uploadFiles(FCWebOrderForm of, java.util.Vector files) Deprecated.
TransferHook	uploadFiles(FCWebOrderForm of, java.util.Vector files, java.nio.file.Path exportLocation) Deprecated.
TransferHook	uploadFiles(java.util.Vector formFields, java.io.File filePath) Deprecated.
TransferHook	uploadFiles(java.util.Vector formFields, java.util.Vector files) Deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

MY_FILE_AREA

public static java.lang.String MY_FILE_AREA

Constructor Detail

FCWebClient

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

This is the main constructor used to instantiate the FCWebClient object. You can also use the default constructor and set the host, username and password through their setters.

FCWebClient

public FCWebClient()

Default Constructor should be used along with setters for host, username and password.

Method Detail

getVersion

public static java.lang.String getVersion()

This method returns the version of the FCAPI being used.

Returns:

getHostURL

public java.lang.String getHostURL()

Method used to return the value of the host

Returns:

String representation of the FileCatalyst Web URL

setHostURL

public void setHostURL(java.lang.String hostURL)

Method used to set the value of the host

Parameters:

hostURL - String to the URL of FileCatalyst Web instance

getPassword

public java.lang.String getPassword()

Method used to return the password

Returns:

String password of the user used to connect to FileCatalyst Web

setPassword

public void setPassword(java.lang.String password)

Method used to set the password to be used along with the user when connecting to FileCatalyst Web

Parameters:

password - of the user connecting to FileCatalyst Web

getUsername

public java.lang.String getUsername()

Method used to return the username

Returns:

the username of the user connecting to FileCatalyst Web.

setUsername

public void setUsername(java.lang.String username)

Method used to set the username when connecting to FileCatalyst Web

Parameters:

username - of the user connecting to FileCatalyst Web

getTransfer

public TransferHook getTransfer()

This method will return the TransferHook object for the current transfer. The TransferHook object can be used to get information on the transfer. Refer to the FileCatalyst Direct API for more information.

Returns:

TransferHook object for the transfer.

getSettings

@Deprecated
public java.util.Vector getSettings()
                                          throws java.lang.Exception

Deprecated.

Deprecated as of v2.0. Use getFCWebOrderForms This method will establish a connection to the FileCatalyst Workflow instance based on the parameters passed through the constructor or those set through the setter methods and return the list of fields (stored in a Vector) defined in FileCatalyst Web. The Vector contains FCWebField objects. The application is required set the description of the appropriate field then pass the vector to the uploadAndSubmitJob function. Deprecated and disabled. removed as of version 3.7

Throws:

java.lang.Exception

getFCWebOrderForms

public java.util.List getFCWebOrderForms()
                                  throws java.lang.Exception

This method will establish a connection to the FileCatalyst Workflow instance based on the parameters passed through the constructor or those set through the setter methods and return the list of fields (stored in a Vector) defined in FileCatalyst Web. The Vector contains FCWebField objects. The application is required set the description of the appropriate field then pass the vector to the uploadAndSubmitJob function.

Returns:

List of orderforms

Throws:

java.lang.Exception

uploadFiles

@Deprecated
public TransferHook uploadFiles(java.util.Vector formFields,
                                             java.io.File filePath)
                                      throws java.lang.Exception

Deprecated.

This method when called will create a job in FileCatalyst Workflow, set the field values for the job and upload the selected file to the job folder. Deprecated and disabled.

Parameters:

formFields - Vector of FCWebFields that contain the parameters for the job

filePath - File object of the file or folder to be uploaded.

Returns:

TransferHook object of the transfer.

Throws:

java.lang.Exception - Removed as of version 3.7

uploadFiles

public TransferHook uploadFiles(FCWebOrderForm of,
                                java.io.File localFile,
                                java.nio.file.Path exportLocation)
                         throws java.lang.Exception

This method when called will create a job in FileCatalyst Workflow, set the field values for the job and upload the selected file to the job folder.

Parameters:

formFields - Vector of FCWebFields that contain the parameters for the job

filePath - File object of the file or folder to be uploaded.

exportLocation - where you want to export the client configurations... will be ignored if null;

Returns:

TransferHook object of the transfer.

Throws:

java.lang.Exception

uploadFiles

public TransferHook uploadFiles(FCWebOrderForm of,
                                java.io.File localFile)
                         throws java.lang.Exception

This method when called will create a job in FileCatalyst Workflow, set the field values for the job and upload the selected file to the job folder.

Parameters:

formFields - Vector of FCWebFields that contain the parameters for the job

filePath - File object of the file or folder to be uploaded.

Returns:

TransferHook object of the transfer.

Throws:

java.lang.Exception

uploadFiles

@Deprecated
public TransferHook uploadFiles(java.util.Vector formFields,
                                             java.util.Vector files)
                                      throws java.lang.Exception

Deprecated.

This method when called will create a job in FileCatalyst Workflow, set the field values for the job and upload the selected file to the job folder. Deprecated and disabled.

Parameters:

formFields - Vector of FCWebFields that contain the parameters for the job

files - Vector of File objects that are to be uploaded. Can be folders or files.

Returns:

TransferHook object of the transfer.

Throws:

java.lang.Exception - removed as of version 3.7

uploadFiles

@Deprecated
public TransferHook uploadFiles(FCWebOrderForm of,
                                             java.util.Vector files,
                                             java.nio.file.Path exportLocation)
                                      throws java.lang.Exception

Deprecated.

This method when called will create a job in FileCatalyst Workflow, set the field values for the job and upload the selected file to the job folder. Deprecated

Parameters:

formFields - Vector of FCWebFields that contain the parameters for the job

files - Vector of File objects that are to be uploaded. Can be folders or files.

exportLocation - where you want to export the client configurations... will be ignored if null;

Returns:

TransferHook object of the transfer.

Throws:

java.lang.Exception

uploadFiles

@Deprecated
public TransferHook uploadFiles(FCWebOrderForm of,
                                             java.util.Vector files)
                                      throws java.lang.Exception

Deprecated.

This method when called will create a job in FileCatalyst Workflow, set the field values for the job and upload the selected file to the job folder. Deprecated

Parameters:

formFields - Vector of FCWebFields that contain the parameters for the job

files - Vector of File objects that are to be uploaded. Can be folders or files.

Returns:

TransferHook object of the transfer.

Throws:

java.lang.Exception

uploadFiles

public TransferHook uploadFiles(FCWebOrderForm of,
                                java.util.List<java.nio.file.Path> files)
                         throws java.lang.Exception,
                                java.io.IOException,
                                unlimited.core.util.common.exception.FCException

This method when called will create a job in FileCatalyst Workflow, set the field values for the job and upload the selected file to the job folder.

Parameters:

formFields - Vector of FCWebFields that contain the parameters for the job

files - List of java.nio.file.Path objects that are to be uploaded. Can be folders or files.

Returns:

TransferHook object of the transfer.

Throws:

java.lang.Exception

java.io.IOException

unlimited.core.util.common.exception.FCException

uploadFiles

public TransferHook uploadFiles(FCWebOrderForm of,
                                java.util.List<java.nio.file.Path> files,
                                java.nio.file.Path exportLocation)
                         throws java.lang.Exception,
                                java.io.IOException,
                                unlimited.core.util.common.exception.FCException

This method when called will create a job in FileCatalyst Workflow, set the field values for the job and upload the selected file to the job folder.

Parameters:

formFields - Vector of FCWebFields that contain the parameters for the job

files - List of java.nio.file.Path objects that are to be uploaded. Can be folders or files.

exportLocation - where you want to export the client configurations... will be ignored if null;

Returns:

TransferHook object of the transfer.

Throws:

java.lang.Exception

java.io.IOException

unlimited.core.util.common.exception.FCException

getJobID

public java.lang.String getJobID()
                          throws java.lang.Exception

Returns the current job's ID

Returns:

String representing the ID

Throws:

java.lang.Exception - Thrown if job == null

submitJob

public java.lang.String submitJob(FCWebOrderForm form,
                                  java.util.ArrayList fileAreaList,
                                  java.lang.String FileAreaID)
                           throws java.lang.Exception

This method will submit and finalize the job. Files maybe added from file areas. Once the job is finalized successfully, email notifications will be sent out by FileCatalystWeb. If there is an error in the transfer or the transfer is cancelled, no emails will be sent out. to get the TrackingNumber call getTrackingNumber() after the submitJob() call Append a slash to a folder located in a file area

Returns:

String representation of the Job ID

Throws:

java.lang.Exception - an exception will be thrown is there is an error in the transfer or if the transfer was cancelled.

submitJob

public java.lang.String submitJob(FCWebOrderForm form)
                           throws java.lang.Exception

This method will submit and finalize the job. No file transfer is required. Once the job is finalized successfully, email notifications will be sent out by FileCatalystWeb. If there is an error in the transfer or the transfer is cancelled, no emails will be sent out. to get the TrackingNumber call getTrackingNumber() after the submitJob() call

Returns:

String representation of the Job ID

Throws:

java.lang.Exception - an exception will be thrown is there is an error in the transfer or if the transfer was cancelled.

submitJob

public java.lang.String submitJob()
                           throws java.lang.Exception

This method will submit and finalize the job. Once the job is finalized successfully, email notifications will be sent out by FileCatalystWeb. If there is an error in the transfer or the transfer is cancelled, no emails will be sent out. to get the TrackingNumber call getTrackingNumber() after the submitJob() call

Returns:

String representation of the Job ID

Throws:

java.lang.Exception - an exception will be thrown is there is an error in the transfer or if the transfer was cancelled.

createJob

protected void createJob(FCWebOrderForm orderForm)
                  throws java.lang.Exception

Throws:

java.lang.Exception

disconnect

public void disconnect()
                throws unlimited.core.util.common.exception.FCException,
                       java.io.IOException

This method is used to disconnect once the files are uploaded.

Throws:

unlimited.core.util.common.exception.FCException

java.io.IOException

getTrackingNumber

public java.lang.String getTrackingNumber()

get the TrackingNumber after the submitJob() call, other wise this field will be an empty String

Returns:

the trackingNumber AFTER the job is submitted, for non Distribution jobs this will return an empty String

getFileAreaFileList

public java.util.ArrayList<java.lang.String> getFileAreaFileList()

Returns the file list that used for the file area, the file(s) must already exist in the specified File Area

Returns:

the fileAreaFileList

setFileAreaFileList

public void setFileAreaFileList(java.util.ArrayList<java.lang.String> fileAreaFileList)

Sets the File Area File list to the value specified, the file(s) must already exist in the specified File Area, Folders in FileAreas may also be used but must terminate with forward slash "/"

Parameters:

fileAreaFileList - the fileAreaFileList to set

getFileAreaID

public java.lang.String getFileAreaID()

Returns the ID for the File Area, this File Area will be used to submit files that already exisit in the FileArea and will not require a new file upload

Returns:

the fileAreaID

setFileAreaID

public void setFileAreaID(java.lang.String fileAreaID)

Sets the File Area ID to the value that you specify, this File Area will be used to submit files that already exisit in the FileArea and will not require a new file upload

Parameters:

fileAreaID - the fileAreaID to set