HPCCFileSprayClient (HPCC Web Services Client API 7.6.62-1 API)

java.lang.Object
- java.util.Observable
- - org.hpccsystems.ws.client.utils.DataSingleton
  - - org.hpccsystems.ws.client.BaseHPCCWsClient
    - - org.hpccsystems.ws.client.HPCCFileSprayClient

```
public class HPCCFileSprayClient
extends BaseHPCCWsClient
```
Use as soap client for HPCC wsFileSpray web service. This includes uploading files to dropzone, listing files in a dropzone, spraying files from dropzone and more. This class can be enhanced to provide further service calls.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class HPCCFileSprayClient.SprayVariableFormat

Nested Classes
Modifier and Type	Class and Description
`static class`	`HPCCFileSprayClient.SprayVariableFormat`

Field Summary
- Fields inherited from class org.hpccsystems.ws.client.BaseHPCCWsClient
  DEAFULTECLWATCHPORT, DEFAULTECLWATCHTLSPORT, fsconn, initErrMessage, stub, targetVersion, verbose

Constructor Summary

Constructors
Modifier Constructor and Description

protected HPCCFileSprayClient(Connection baseConnection)
Instantiates a new HPCC file spray client.

Constructors
Modifier	Constructor and Description
`protected`	`HPCCFileSprayClient(Connection baseConnection)` Instantiates a new HPCC file spray client.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`copyFile(String from, String to, boolean overwrite)` Copy file.
`static DelimitedDataOptions`	`createDelimitedDataOptionsObject(String recordTerminator, String fieldDelimiter, String escapeSequence, String quote)` Convinience static method, crates new delmited data format descriptor.
`DFUWorkunitsActionResponseWrapper`	`deleteDropZoneFiles(String dropzoneName, List<String> fileNames, String netAddress, String path, String os)` Deletes a file from a drop zone
`long`	`downloadFile(FileChannel outputChannel, DropZoneWrapper dropZone, String fileName)` Attempts to download the specified file from a dropzone.
`long`	`downloadFile(File outFile, DropZoneWrapper dropZone, String fileName)` Attempts to download the specified file from a dropzone.
`org.hpccsystems.ws.client.gen.axis2.filespray.v1_17.PhysicalFileStruct[]`	`dzFileSearch(String dzname, String netaddr, String namefilter)` Perform HPCC Drop Zone file search.
`boolean`	`equals(Object aThat)`
`DropZoneFilesResponseWrapper`	`fetchDropZones(DropZoneFilesRequestWrapper szrequest)` Fetch drop zones.
`List<DropZoneWrapper>`	`fetchDropZones(String dropzoneNetAddress)` Fetch drop zones.
`DropZoneFilesResponseWrapper`	`fetchDropZones(String dzname, String netaddress, String os, String path, String subfolder, boolean dironly, boolean watchvisibleonely)` Fetch drop zones.
`List<DropZoneWrapper>`	`fetchLocalDropZones()` Fetch local drop zones.
`static HPCCFileSprayClient`	`get(Connection connection)` Gets the.
`static HPCCFileSprayClient`	`get(String protocol, String targetHost, String targetPort, String user, String pass)` Gets the.
`static HPCCFileSprayClient`	`get(String protocol, String targetHost, String targetPort, String user, String pass, int timeout)` Gets the.
`org.apache.axis2.client.Stub`	`getDefaultStub()` Gets the default stub.
`ProgressResponseWrapper`	`getDfuProgress(String dfuwuid)` Get progress report for given DFU Work Unit.
`GetDFUWorkunitResponseWrapper`	`getDFUWorkunit(String workunitid)` Attempts to fetch information regarding a DFU Workunit.
`GetDFUWorkunitsResponseWrapper`	`getDFUWorkunits(String cluster, Long pagesize)` Attempts to fetch list of DFU Workunits.
`int`	`getFileUploadReadBufferLength()` Gets the file upload read buffer length.
`static String`	`getServiceURI()` Gets the service URI.
`static int`	`getServiceWSDLPort()` Gets the service WSDL port.
`static String`	`getServiceWSDLURL()` Gets the service WSDLURL.
`boolean`	`handleSprayResponse(ProgressResponseWrapper progressResponseWrapper, int maxRetries, int milliesBetweenRetry)` Handle spray response.
`int`	`hashCode()`
`List<PhysicalFileStructWrapper>`	`listFiles(String netAddress, String path, String OS)` Fetch list of files on a given dropzone's machine on the target HPCC System Note: a logical dropzone can contain multiple machines.
`boolean`	`ping()` Ping.
`void`	`setFileUploadReadBufferLength(int length)` Set the buffer length used to read files during upload process.
`void`	`sftpPutFileOnTargetLandingZone(String localFileName, String targetFilename, String machineLoginUserName, String password)` Attempts to upload given file to HPCC Systems on the first dropzone encountered at the target HPCCSystem address.
`void`	`sftpPutFileOnTargetLandingZone(String localFileName, String targetFilename, String machineLoginUserName, String password, Properties connconfig)` Attempts to upload given file to HPCC Systems on the first dropzone encountered at the target HPCCSystem address.
`void`	`sftpPutFileOnTargetLandingZone(String localFileName, String targetDropzoneAddress, String targetFilename, String machineLoginUserName, String password, Properties connconfig)` Attempts to upload given file to HPCC Systems on the first dropzone encountered at the given address.
`ProgressResponseWrapper`	`sprayFixed(DropZoneWrapper targetDropZone, String sourceFileName, int recordSize, String targetFileLabel, String prefix, String destGroup, boolean overwrite, Integer maxConnections, Boolean compress, Boolean replicate, Boolean failIfNoSourceFile, Integer expireDays, String decryptKey, String encryptKey, Boolean nosplit, Boolean recordStructurePresent, Integer transferBufferSize, Boolean wrap)` Spray fixed file from the given target dropzone onto cluster destionation group.
`ProgressResponseWrapper`	`sprayFixed(String dropzoneNetAddress, String sourceFileName, int recordSize, String targetFileLabel, String prefix, String destGroup, boolean overwrite)` Spray fixed file from first dropzone encountered on the given dropzone net address.
`ProgressResponseWrapper`	`sprayFixedLocalDropZone(String sourceFileName, int recordSize, String targetFileLabel, String prefix, String destGroup, boolean overwrite)` Spray fixed file from first local dropzone encountered onto destination cluster group.
`ProgressResponseWrapper`	`sprayLocalXML(String sourceFileName, String targetFileName, String prefix, String destGroup, boolean overwrite)` Spray XML data file from the first local dropzone onto given cluster group.
`ProgressResponseWrapper`	`sprayLocalXML(String sourceFileName, String targetFileName, String prefix, String destGroup, boolean overwrite, HPCCFileSprayClient.SprayVariableFormat format, String rowtag, Integer maxrecsize)` Spray XML data file from the first local dropzone onto given cluster group.
`ProgressResponseWrapper`	`sprayVariable(DelimitedDataOptions options, DropZoneWrapper targetDropZone, String sourceFileName, String targetFileName, String prefix, String destGroup, boolean overwrite)` Spray variable/delimited HPCC file described in the give delimited data options, from given dropzone onto given cluster group.
`ProgressResponseWrapper`	`sprayVariable(DelimitedDataOptions options, DropZoneWrapper targetDropZone, String sourceFileName, String targetFileName, String prefix, String destGroup, boolean overwrite, HPCCFileSprayClient.SprayVariableFormat format, Integer sourceMaxRecordSize, Integer maxConnections, Boolean compress, Boolean replicate, Boolean failIfNoSourceFile, Boolean recordStructurePresent, Integer expireDays)` Spray variable/delimited HPCC file described in the give delimited data options, from given dropzone onto given cluster group.
`ProgressResponseWrapper`	`sprayVariable(String dropzoneNetAddress, DelimitedDataOptions options, String sourceFileName, String targetFileName, String prefix, String destGroup, boolean overwrite)` Spray variable/delimited HPCC file described in the give delimited data options, from the given dropzone address onto given cluster group.
`ProgressResponseWrapper`	`sprayVariable(String dropzoneNetAddress, String sourceFileName, String targetFileName, String prefix, String destGroup, boolean overwrite)` * Spray default CSV variable/delimited HPCC file, from the given dropzone address onto given cluster group.
`ProgressResponseWrapper`	`sprayVariableLocalDropZone(DelimitedDataOptions options, String sourceFileName, String targetFileName, String prefix, String destGroup, boolean overwrite, HPCCFileSprayClient.SprayVariableFormat format)` Spray variable/delimited HPCC file described in the give delimited data options, from local dropzone onto given cluster group.
`ProgressResponseWrapper`	`sprayXML(DropZoneWrapper targetDropZone, String sourceFileName, String targetFileName, String prefix, String destGroup, String rowtag, boolean overwrite, HPCCFileSprayClient.SprayVariableFormat format, Integer maxrecsize, Integer maxConnections, Boolean replicate, Boolean compress, Boolean failIfNoSourceFile, Integer expireDays)` Spray XML data file from the given dropzone onto given cluster group.
`boolean`	`uploadFile(File file, String targetDropzoneAddress)` THIS IS NOT THE PREFERED WAY TO UPLOAD FILES ONTO HPCCSYSTEMS ONLY USE THIS FUNCTION FOR SMALL FILES AND IN THE CASE YOU CANNOT PROVIDE CREDENTIALS TO LOGON TO THE TARGET MACHINE USE sftpPutFileOnTargetLandingZone(...) if possible Attempts to upload given file to HPCC System on the first dropzone encountered at the given address
`boolean`	`uploadFileLocalDropZone(File file)` THIS IS NOT THE PREFERED WAY TO UPLOAD FILES ONTO HPCCSYSTEMS ONLY USE THIS FUNCTION FOR SMALL FILES AND IN THE CASE YOU CANNOT PROVIDE CREDENTIALS TO LOGON TO THE TARGET MACHINE USE sftpPutFileOnTargetLandingZone(...) if possible Attempts to upload given file to HPCC System on the first local dropzone encountered
`boolean`	`uploadLargeFile(File uploadFile, DropZoneWrapper dropZone)` UPLOADS A FILE( UP TO 2GB FILE SIZES) TO THE SPECIFIED LANDING ZONE.

Methods inherited from class org.hpccsystems.ws.client.BaseHPCCWsClient
fastRefresh, fullRefresh, getConnectionURL, getInitError, getServiceVersion, getServiceVersion, getServiceWSDLPort, getServiceWSDLURL, getStubConnectionTO, getVerbose, handleECLExceptions, handleECLExceptions, handleEspExceptions, handleEspExceptions, handleEspSoapFaults, handleEspSoapFaults, hasInitError, isComplete, setClientAuth, setStubConnectionTO, setStubOptions, setVerbose, verifyStub

Methods inherited from class org.hpccsystems.ws.client.utils.DataSingleton
monitor

Methods inherited from class java.util.Observable
addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- HPCCFileSprayClient
```
protected HPCCFileSprayClient(Connection baseConnection)
```
  Instantiates a new HPCC file spray client.
  
  Parameters:
  
  baseConnection - the base connection

Method Detail

getServiceURI
```
public static String getServiceURI()
```
Gets the service URI.

Returns:

the service URI

getServiceWSDLURL
```
public static String getServiceWSDLURL()
```
Gets the service WSDLURL.

Returns:

the service WSDLURL

getServiceWSDLPort
```
public static int getServiceWSDLPort()
```
Gets the service WSDL port.

Returns:

the service WSDL port

getDefaultStub
```
public org.apache.axis2.client.Stub getDefaultStub()
                                            throws org.apache.axis2.AxisFault
```
Description copied from class: BaseHPCCWsClient

Gets the default stub.

Specified by:

getDefaultStub in class BaseHPCCWsClient

Returns:

the default stub

Throws:

org.apache.axis2.AxisFault - the axis fault

get
```
public static HPCCFileSprayClient get(Connection connection)
```
Gets the.

Parameters:

connection - the connection

Returns:

the HPCC file spray client

get

public static HPCCFileSprayClient get(String protocol,
                                      String targetHost,
                                      String targetPort,
                                      String user,
                                      String pass)

Gets the.

Parameters:: protocol - the protocol; targetHost - the target host; targetPort - the target port; user - the user; pass - the pass
Returns:: the HPCC file spray client

get

public static HPCCFileSprayClient get(String protocol,
                                      String targetHost,
                                      String targetPort,
                                      String user,
                                      String pass,
                                      int timeout)

Gets the.

Parameters:: protocol - the protocol; targetHost - the target host; targetPort - the target port; user - the user; pass - the pass; timeout - the timeout
Returns:: the HPCC file spray client

ping
```
public boolean ping()
             throws Exception
```
Ping.

Returns:

true, if successful

Throws:

Exception - the exception

getFileUploadReadBufferLength
```
public int getFileUploadReadBufferLength()
```
Gets the file upload read buffer length.

Returns:

the upload file buffer length

setFileUploadReadBufferLength
```
public void setFileUploadReadBufferLength(int length)
```
Set the buffer length used to read files during upload process.

Parameters:

length - the new file upload read buffer length

handleSprayResponse

public boolean handleSprayResponse(ProgressResponseWrapper progressResponseWrapper,
                                   int maxRetries,
                                   int milliesBetweenRetry)
                            throws Exception,
                                   ArrayOfEspExceptionWrapper

Handle spray response.

Parameters:: progressResponseWrapper - the progress response wrapper; maxRetries - the max retries; milliesBetweenRetry - the millies between retry
Returns:: true, if successful
Throws:: Exception - the exception; ArrayOfEspExceptionWrapper - the array of esp exception wrapper

createDelimitedDataOptionsObject

public static DelimitedDataOptions createDelimitedDataOptionsObject(String recordTerminator,
                                                                    String fieldDelimiter,
                                                                    String escapeSequence,
                                                                    String quote)

Convinience static method, crates new delmited data format descriptor. Parameters not provided are csv defaulted

Parameters:: recordTerminator - the record terminator; fieldDelimiter - the field delimiter; escapeSequence - the escape sequence; quote - the quote
Returns:: the delimited data options

fetchLocalDropZones

public List<DropZoneWrapper> fetchLocalDropZones()
                                          throws Exception,
                                                 ArrayOfEspExceptionWrapper

Fetch local drop zones.

Returns:: List of all local drop zones on target HPCC system
Throws:: Exception - the exception; ArrayOfEspExceptionWrapper - the array of esp exception wrapper

fetchDropZones

public List<DropZoneWrapper> fetchDropZones(String dropzoneNetAddress)
                                     throws Exception,
                                            ArrayOfEspExceptionWrapper

Fetch drop zones.

Parameters:: dropzoneNetAddress - the dropzone net address
Returns:: list of all dropzones on dropzoneNetAddress
Throws:: Exception - the exception; ArrayOfEspExceptionWrapper - the array of esp exception wrapper

copyFile

public String copyFile(String from,
                       String to,
                       boolean overwrite)
                throws Exception,
                       ArrayOfEspExceptionWrapper

Copy file.

Parameters:: from - the from; to - the to; overwrite - the overwrite
Returns:: the string
Throws:: Exception - the exception; ArrayOfEspExceptionWrapper - the array of esp exception wrapper

fetchDropZones

public DropZoneFilesResponseWrapper fetchDropZones(String dzname,
                                                   String netaddress,
                                                   String os,
                                                   String path,
                                                   String subfolder,
                                                   boolean dironly,
                                                   boolean watchvisibleonely)
                                            throws Exception,
                                                   ArrayOfEspExceptionWrapper

Fetch drop zones.

Parameters:: dzname - the dzname; netaddress - the netaddress; os - the os; path - the path; subfolder - the subfolder; dironly - the dironly; watchvisibleonely - the watchvisibleonely
Returns:: the drop zone files response wrapper
Throws:: Exception - the exception; ArrayOfEspExceptionWrapper - the array of esp exception wrapper

fetchDropZones

public DropZoneFilesResponseWrapper fetchDropZones(DropZoneFilesRequestWrapper szrequest)
                                            throws Exception,
                                                   ArrayOfEspExceptionWrapper

Fetch drop zones.

Parameters:: szrequest - the szrequest
Returns:: the drop zone files response wrapper
Throws:: Exception - the exception; ArrayOfEspExceptionWrapper - the array of esp exception wrapper

dzFileSearch

public org.hpccsystems.ws.client.gen.axis2.filespray.v1_17.PhysicalFileStruct[] dzFileSearch(String dzname,
                                                                                             String netaddr,
                                                                                             String namefilter)
                                                                                      throws Exception,
                                                                                             ArrayOfEspExceptionWrapper

Perform HPCC Drop Zone file search.

Parameters:: dzname - - Required, the name of the Drop Zone to query; netaddr - - Required, the netaddress of the Drop Zone node to query; namefilter - - Required, the wildcard based name-filter to query
Returns:: the physical file struct[]
Throws:: Exception - the exception; ArrayOfEspExceptionWrapper - the array of esp exception wrapper

listFiles

public List<PhysicalFileStructWrapper> listFiles(String netAddress,
                                                 String path,
                                                 String OS)
                                          throws Exception,
                                                 ArrayOfEspExceptionWrapper

Fetch list of files on a given dropzone's machine on the target HPCC System Note: a logical dropzone can contain multiple machines.

Parameters:: netAddress - - Address of specific dropzone instance; path - - The dropzone zone path on the local filesystem; OS - - Optional, OS code
Returns:: - Array of file descriptors
Throws:: Exception - the exception; ArrayOfEspExceptionWrapper - the array of esp exception wrapper

sprayVariable

public ProgressResponseWrapper sprayVariable(String dropzoneNetAddress,
                                             String sourceFileName,
                                             String targetFileName,
                                             String prefix,
                                             String destGroup,
                                             boolean overwrite)
                                      throws Exception,
                                             ArrayOfEspExceptionWrapper

* Spray default CSV variable/delimited HPCC file, from the given dropzone address onto given cluster group.

Parameters:: dropzoneNetAddress - the dropzone net address; sourceFileName - the source file name; targetFileName - the target file name; prefix - the prefix; destGroup - the dest group; overwrite - the overwrite
Returns:: - Progress response at time of request
Throws:: Exception - the exception; ArrayOfEspExceptionWrapper - the array of esp exception wrapper

sprayVariable

public ProgressResponseWrapper sprayVariable(String dropzoneNetAddress,
                                             DelimitedDataOptions options,
                                             String sourceFileName,
                                             String targetFileName,
                                             String prefix,
                                             String destGroup,
                                             boolean overwrite)
                                      throws Exception,
                                             ArrayOfEspExceptionWrapper

Spray variable/delimited HPCC file described in the give delimited data options, from the given dropzone address onto given cluster group.

Parameters:: dropzoneNetAddress - the dropzone net address; options - the options; sourceFileName - the source file name; targetFileName - the target file name; prefix - the prefix; destGroup - the dest group; overwrite - the overwrite
Returns:: - Progress response at time of request
Throws:: Exception - the exception; ArrayOfEspExceptionWrapper - the array of esp exception wrapper

sprayVariableLocalDropZone

public ProgressResponseWrapper sprayVariableLocalDropZone(DelimitedDataOptions options,
                                                          String sourceFileName,
                                                          String targetFileName,
                                                          String prefix,
                                                          String destGroup,
                                                          boolean overwrite,
                                                          HPCCFileSprayClient.SprayVariableFormat format)
                                                   throws Exception,
                                                          ArrayOfEspExceptionWrapper

Spray variable/delimited HPCC file described in the give delimited data options, from local dropzone onto given cluster group.

Parameters:: options - the options; sourceFileName - the source file name; targetFileName - the target file name; prefix - the prefix; destGroup - the dest group; overwrite - the overwrite; format - - SprayVariableFormat object describing the file format
Returns:: - Progress response at time of request
Throws:: Exception - the exception; ArrayOfEspExceptionWrapper - the array of esp exception wrapper

sprayVariable

public ProgressResponseWrapper sprayVariable(DelimitedDataOptions options,
                                             DropZoneWrapper targetDropZone,
                                             String sourceFileName,
                                             String targetFileName,
                                             String prefix,
                                             String destGroup,
                                             boolean overwrite)
                                      throws Exception,
                                             ArrayOfEspExceptionWrapper

Spray variable/delimited HPCC file described in the give delimited data options, from given dropzone onto given cluster group.

Parameters:: options - the options; targetDropZone - the target drop zone; sourceFileName - the source file name; targetFileName - the target file name; prefix - the prefix; destGroup - the dest group; overwrite - the overwrite
Returns:: - Progress response at time of request
Throws:: Exception - the exception; ArrayOfEspExceptionWrapper - the array of esp exception wrapper

sprayVariable

public ProgressResponseWrapper sprayVariable(DelimitedDataOptions options,
                                             DropZoneWrapper targetDropZone,
                                             String sourceFileName,
                                             String targetFileName,
                                             String prefix,
                                             String destGroup,
                                             boolean overwrite,
                                             HPCCFileSprayClient.SprayVariableFormat format,
                                             Integer sourceMaxRecordSize,
                                             Integer maxConnections,
                                             Boolean compress,
                                             Boolean replicate,
                                             Boolean failIfNoSourceFile,
                                             Boolean recordStructurePresent,
                                             Integer expireDays)
                                      throws Exception,
                                             ArrayOfEspExceptionWrapper

Spray variable/delimited HPCC file described in the give delimited data options, from given dropzone onto given cluster group.

Parameters:: options - the options; targetDropZone - the target drop zone; sourceFileName - the source file name; targetFileName - the target file name; prefix - the prefix; destGroup - the dest group; overwrite - the overwrite; format - - SprayVariableFormat object describing the file format; sourceMaxRecordSize - the source max record size; maxConnections - the max connections; compress - the compress; replicate - the replicate; failIfNoSourceFile - the fail if no source file; recordStructurePresent - the record structure present; expireDays - the expire days
Returns:: - Progress response at time of request
Throws:: Exception - the exception; ArrayOfEspExceptionWrapper - the array of esp exception wrapper

sprayLocalXML

public ProgressResponseWrapper sprayLocalXML(String sourceFileName,
                                             String targetFileName,
                                             String prefix,
                                             String destGroup,
                                             boolean overwrite)
                                      throws Exception,
                                             ArrayOfEspExceptionWrapper

Spray XML data file from the first local dropzone onto given cluster group. defaults to first local dropzone, row tag to "tag", source format to "ASCII" default max record size

Parameters:: sourceFileName - the source file name; targetFileName - the target file name; prefix - the prefix; destGroup - the dest group; overwrite - the overwrite
Returns:: ProgressResponse
Throws:: Exception - the exception; ArrayOfEspExceptionWrapper - the array of esp exception wrapper

sprayLocalXML

public ProgressResponseWrapper sprayLocalXML(String sourceFileName,
                                             String targetFileName,
                                             String prefix,
                                             String destGroup,
                                             boolean overwrite,
                                             HPCCFileSprayClient.SprayVariableFormat format,
                                             String rowtag,
                                             Integer maxrecsize)
                                      throws Exception,
                                             ArrayOfEspExceptionWrapper

Spray XML data file from the first local dropzone onto given cluster group.

Parameters:: sourceFileName - the source file name; targetFileName - the target file name; prefix - the prefix; destGroup - the dest group; overwrite - the overwrite; format - the format; rowtag - the rowtag; maxrecsize - the maxrecsize
Returns:: ProgressResponse
Throws:: Exception - the exception; ArrayOfEspExceptionWrapper - the array of esp exception wrapper

sprayXML

public ProgressResponseWrapper sprayXML(DropZoneWrapper targetDropZone,
                                        String sourceFileName,
                                        String targetFileName,
                                        String prefix,
                                        String destGroup,
                                        String rowtag,
                                        boolean overwrite,
                                        HPCCFileSprayClient.SprayVariableFormat format,
                                        Integer maxrecsize,
                                        Integer maxConnections,
                                        Boolean replicate,
                                        Boolean compress,
                                        Boolean failIfNoSourceFile,
                                        Integer expireDays)
                                 throws Exception,
                                        ArrayOfEspExceptionWrapper

Spray XML data file from the given dropzone onto given cluster group.

Parameters:: targetDropZone - the target drop zone; sourceFileName - the source file name; targetFileName - the target file name; prefix - the prefix; destGroup - the dest group; rowtag - the rowtag; overwrite - the overwrite; format - the format; maxrecsize - the maxrecsize; maxConnections - the max connections; replicate - the replicate; compress - the compress; failIfNoSourceFile - the fail if no source file; expireDays - the expire days
Returns:: ProgressResponse
Throws:: Exception - the exception; ArrayOfEspExceptionWrapper - the array of esp exception wrapper

sprayFixed

public ProgressResponseWrapper sprayFixed(String dropzoneNetAddress,
                                          String sourceFileName,
                                          int recordSize,
                                          String targetFileLabel,
                                          String prefix,
                                          String destGroup,
                                          boolean overwrite)
                                   throws Exception,
                                          ArrayOfEspExceptionWrapper

Spray fixed file from first dropzone encountered on the given dropzone net address.

Parameters:: dropzoneNetAddress - the dropzone net address; sourceFileName - the source file name; recordSize - the record size; targetFileLabel - the target file label; prefix - the prefix; destGroup - the dest group; overwrite - the overwrite
Returns:: - Progress response at time of request
Throws:: Exception - the exception; ArrayOfEspExceptionWrapper - the array of esp exception wrapper

sprayFixedLocalDropZone

public ProgressResponseWrapper sprayFixedLocalDropZone(String sourceFileName,
                                                       int recordSize,
                                                       String targetFileLabel,
                                                       String prefix,
                                                       String destGroup,
                                                       boolean overwrite)
                                                throws Exception,
                                                       ArrayOfEspExceptionWrapper

Spray fixed file from first local dropzone encountered onto destination cluster group.

Parameters:: sourceFileName - the source file name; recordSize - the record size; targetFileLabel - the target file label; prefix - the prefix; destGroup - the dest group; overwrite - the overwrite
Returns:: - Progress response at time of request
Throws:: Exception - the exception; ArrayOfEspExceptionWrapper - the array of esp exception wrapper

sprayFixed

public ProgressResponseWrapper sprayFixed(DropZoneWrapper targetDropZone,
                                          String sourceFileName,
                                          int recordSize,
                                          String targetFileLabel,
                                          String prefix,
                                          String destGroup,
                                          boolean overwrite,
                                          Integer maxConnections,
                                          Boolean compress,
                                          Boolean replicate,
                                          Boolean failIfNoSourceFile,
                                          Integer expireDays,
                                          String decryptKey,
                                          String encryptKey,
                                          Boolean nosplit,
                                          Boolean recordStructurePresent,
                                          Integer transferBufferSize,
                                          Boolean wrap)
                                   throws Exception,
                                          ArrayOfEspExceptionWrapper

Spray fixed file from the given target dropzone onto cluster destionation group.

Parameters:: targetDropZone - the target drop zone; sourceFileName - the source file name; recordSize - the record size; targetFileLabel - the target file label; prefix - the prefix; destGroup - the dest group; overwrite - the overwrite; maxConnections - the max connections; compress - the compress; replicate - the replicate; failIfNoSourceFile - the fail if no source file; expireDays - the expire days; decryptKey - the decrypt key; encryptKey - the encrypt key; nosplit - the nosplit; recordStructurePresent - the record structure present; transferBufferSize - the transfer buffer size; wrap - the wrap
Returns:: - Progress response at time of request
Throws:: Exception - the exception; ArrayOfEspExceptionWrapper - the array of esp exception wrapper

getDfuProgress

public ProgressResponseWrapper getDfuProgress(String dfuwuid)
                                       throws Exception,
                                              ArrayOfEspExceptionWrapper

Get progress report for given DFU Work Unit.

Parameters:: dfuwuid - - The DFU Work unit number
Returns:: - The Progress report at time of request
Throws:: Exception - the exception; ArrayOfEspExceptionWrapper - the array of esp exception wrapper

uploadFile
```
public boolean uploadFile(File file,
                          String targetDropzoneAddress)
                   throws Exception,
                          ArrayOfEspExceptionWrapper
```
THIS IS NOT THE PREFERED WAY TO UPLOAD FILES ONTO HPCCSYSTEMS ONLY USE THIS FUNCTION FOR SMALL FILES AND IN THE CASE YOU CANNOT PROVIDE CREDENTIALS TO LOGON TO THE TARGET MACHINE USE sftpPutFileOnTargetLandingZone(...) if possible Attempts to upload given file to HPCC System on the first dropzone encountered at the given address

Parameters:

file - - The File to upload

targetDropzoneAddress - - The target dropzone address

Returns:

- Boolean, success

Throws:

Exception - the exception

ArrayOfEspExceptionWrapper - the array of esp exception wrapper

uploadFileLocalDropZone
```
public boolean uploadFileLocalDropZone(File file)
                                throws Exception,
                                       ArrayOfEspExceptionWrapper
```
THIS IS NOT THE PREFERED WAY TO UPLOAD FILES ONTO HPCCSYSTEMS ONLY USE THIS FUNCTION FOR SMALL FILES AND IN THE CASE YOU CANNOT PROVIDE CREDENTIALS TO LOGON TO THE TARGET MACHINE USE sftpPutFileOnTargetLandingZone(...) if possible Attempts to upload given file to HPCC System on the first local dropzone encountered

Parameters:

file - - The File to upload

Returns:

- Boolean, success

Throws:

Exception - the exception

ArrayOfEspExceptionWrapper - the array of esp exception wrapper

uploadLargeFile
```
public boolean uploadLargeFile(File uploadFile,
                               DropZoneWrapper dropZone)
```
UPLOADS A FILE( UP TO 2GB FILE SIZES) TO THE SPECIFIED LANDING ZONE.

Parameters:

uploadFile - - The File to upload

dropZone - - The target dropzone

Returns:

- Boolean, success

downloadFile
```
public long downloadFile(File outFile,
                         DropZoneWrapper dropZone,
                         String fileName)
```
Attempts to download the specified file from a dropzone.

Parameters:

outFile - - The File to write to

dropZone - - The target HPCC file dropzone

fileName - - The file to download

Returns:

- long, bytes transferred, -1 on error

downloadFile
```
public long downloadFile(FileChannel outputChannel,
                         DropZoneWrapper dropZone,
                         String fileName)
```
Attempts to download the specified file from a dropzone.

Parameters:

outputChannel - - The FileChannel to write to

dropZone - - The target HPCC file dropzone

fileName - - The file to download

Returns:

- long, bytes transferred, -1 on error

sftpPutFileOnTargetLandingZone

public void sftpPutFileOnTargetLandingZone(String localFileName,
                                           String targetFilename,
                                           String machineLoginUserName,
                                           String password)
                                    throws Exception,
                                           ArrayOfEspExceptionWrapper

Attempts to upload given file to HPCC Systems on the first dropzone encountered at the target HPCCSystem address.

Parameters:: localFileName - - The File to upload; targetFilename - (optional) - The desired name for the uploaded file; machineLoginUserName - - The user account name to log on to the target machine; password - - The user account password to log on to the target machine
Throws:: Exception - the exception; ArrayOfEspExceptionWrapper - the array of esp exception wrapper

sftpPutFileOnTargetLandingZone

public void sftpPutFileOnTargetLandingZone(String localFileName,
                                           String targetFilename,
                                           String machineLoginUserName,
                                           String password,
                                           Properties connconfig)
                                    throws Exception,
                                           ArrayOfEspExceptionWrapper

Attempts to upload given file to HPCC Systems on the first dropzone encountered at the target HPCCSystem address.

Parameters:: localFileName - - The File to upload; targetFilename - (optional) - The desired name for the uploaded file; machineLoginUserName - - The user account name to log on to the target machine; password - - The user account password to log on to the target machine; connconfig - (optional) - Connection config options
Throws:: Exception - the exception; ArrayOfEspExceptionWrapper - the array of esp exception wrapper

sftpPutFileOnTargetLandingZone

public void sftpPutFileOnTargetLandingZone(String localFileName,
                                           String targetDropzoneAddress,
                                           String targetFilename,
                                           String machineLoginUserName,
                                           String password,
                                           Properties connconfig)
                                    throws Exception,
                                           ArrayOfEspExceptionWrapper

Attempts to upload given file to HPCC Systems on the first dropzone encountered at the given address.

Parameters:: localFileName - - The File to upload; targetDropzoneAddress - - The target landing zone ip address; targetFilename - (optional) - The desired name for the uploaded file; machineLoginUserName - - The user account name to log on to the target machine; password - - The user account password to log on to the target machine; connconfig - (optional) - Connection config options
Throws:: Exception - the exception; ArrayOfEspExceptionWrapper - the array of esp exception wrapper

getDFUWorkunit

public GetDFUWorkunitResponseWrapper getDFUWorkunit(String workunitid)
                                             throws Exception,
                                                    ArrayOfEspExceptionWrapper

Attempts to fetch information regarding a DFU Workunit.

Parameters:: workunitid - the workunitid
Returns:: the DFU workunit
Throws:: Exception - the exception; ArrayOfEspExceptionWrapper - the array of esp exception wrapper

getDFUWorkunits

public GetDFUWorkunitsResponseWrapper getDFUWorkunits(String cluster,
                                                      Long pagesize)
                                               throws Exception,
                                                      ArrayOfEspExceptionWrapper

Attempts to fetch list of DFU Workunits.

Parameters:: cluster - the cluster; pagesize - the pagesize
Returns:: the DFU workunits
Throws:: Exception - the exception; ArrayOfEspExceptionWrapper - the array of esp exception wrapper

deleteDropZoneFiles

public DFUWorkunitsActionResponseWrapper deleteDropZoneFiles(String dropzoneName,
                                                             List<String> fileNames,
                                                             String netAddress,
                                                             String path,
                                                             String os)
                                                      throws Exception

Deletes a file from a drop zone

Parameters:: dropzoneName - - The name of the dropzone to delete from; fileNames - - A List of names to delete from the drop zone; netAddress - - The net address of the dropzone; path - - The full path to the dropzone on the filesystem ie /var/lib/HPCCSystems/mydropzone; {string} - [os] - The os
Returns:
Throws:: RemoteException; org.hpccsystems.ws.client.gen.axis2.filespray.v1_17.EspSoapFault; Exception

equals
```
public boolean equals(Object aThat)
```
Overrides:

equals in class BaseHPCCWsClient

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class BaseHPCCWsClient

Class HPCCFileSprayClient

Nested Class Summary

Field Summary

Fields inherited from class org.hpccsystems.ws.client.BaseHPCCWsClient

Constructor Summary

Method Summary

Methods inherited from class org.hpccsystems.ws.client.BaseHPCCWsClient

Methods inherited from class org.hpccsystems.ws.client.utils.DataSingleton

Methods inherited from class java.util.Observable

Methods inherited from class java.lang.Object

Constructor Detail

HPCCFileSprayClient

Method Detail

getServiceURI

getServiceWSDLURL

getServiceWSDLPort

getDefaultStub

get

get

get

ping

getFileUploadReadBufferLength

setFileUploadReadBufferLength

handleSprayResponse

createDelimitedDataOptionsObject

fetchLocalDropZones

fetchDropZones

copyFile

fetchDropZones

fetchDropZones

dzFileSearch

listFiles

sprayVariable

sprayVariable

sprayVariableLocalDropZone

sprayVariable

sprayVariable

sprayLocalXML

sprayLocalXML

sprayXML

sprayFixed

sprayFixedLocalDropZone

sprayFixed

getDfuProgress

uploadFile

uploadFileLocalDropZone

uploadLargeFile

downloadFile

downloadFile

sftpPutFileOnTargetLandingZone

sftpPutFileOnTargetLandingZone

sftpPutFileOnTargetLandingZone

getDFUWorkunit

getDFUWorkunits

deleteDropZoneFiles

equals

hashCode