Package org.hpccsystems.ws.client

Class HPCCWsFileIOClient

java.lang.Object

java.util.Observable

org.hpccsystems.ws.client.utils.DataSingleton

org.hpccsystems.ws.client.BaseHPCCWsClient

org.hpccsystems.ws.client.HPCCWsFileIOClient

public class HPCCWsFileIOClient
extends BaseHPCCWsClient

Facilitates File I/O actions on target HPCC instance. Actions supported include creating a new file, and appending data to a file in the given HPCC System.

Field Summary

Fields

Modifier and Type	Field	Description
static String	FILEIOWSDLURI	Constant FILEIOWSDLURI="/WsFileIO"

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

DEAFULTECLWATCHPORT, DEFAULTECLWATCHTLSPORT, initErrMessage, stub, targetESPInterfaceVer, targetHPCCBuildVersion, targetsContainerizedHPCC, verbose, wsconn

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HPCCWsFileIOClient(Connection baseConnection)	Instantiates a new HPCC ws file IO client.

Method Summary

Modifier and Type	Method	Description
boolean	createHPCCFile(String fileName, String targetLandingZone, boolean overwritefile)	Creates the HPCC file.
static HPCCWsFileIOClient	get(String protocol, String targetHost, String targetPort, String user, String pass)	Gets the.
static HPCCWsFileIOClient	get(String protocol, String targetHost, String targetPort, String user, String pass, int timeout)	Gets the.
static HPCCWsFileIOClient	get(Connection connection)	Gets the.
org.apache.axis2.client.Stub	getDefaultStub()	Gets the default stub.
String	getServiceURI()	Gets the service URI.
static int	getServiceWSDLPort()	Gets the service WSDL port.
static String	getServiceWSDLURL()	Gets the service WSDLURL.
boolean	ping()	Ping.
String	readFileData(String dropzone, String fileName, long datasize, long offset)	Read file data.
boolean	writeHPCCFileData(byte[] data, String fileName, String targetLandingZone, boolean append, long offset, int uploadchunksize)	Write HPCC file data.

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

compatibilityCheck, compatibilityCheck, equals, fastRefresh, fullRefresh, getConnectionURL, getInitError, getServiceVersion, getServiceVersion, getServiceWSDLPort, getServiceWSDLURL, getStubConnectionTO, getTargetESPInterfaceVersion, getTargetHPCCBuildVersion, getVerbose, handleECLExceptions, handleECLExceptions, handleEspExceptions, handleEspExceptions, handleEspSoapFaults, handleEspSoapFaults, hashCode, hasInitError, initBaseWsClient, isComplete, isTargetHPCCContainerized, loadESPRuntimeInterfaceVer, setActiveConnectionInfo, setClientAuth, setStubConnectionTO, setStubOptions, setUpBuildVersionParser, setUpContainerizedParser, setUpversionParser, 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

Field Detail

FILEIOWSDLURI

public static final String FILEIOWSDLURI

Constant FILEIOWSDLURI="/WsFileIO"

See Also:

Constant Field Values

Constructor Detail

HPCCWsFileIOClient

protected HPCCWsFileIOClient(Connection baseConnection)

Instantiates a new HPCC ws file IO client.

Parameters:

baseConnection - the base connection

Method Detail

getServiceURI

public String getServiceURI()

Gets the service URI.

Specified by:

getServiceURI in class BaseHPCCWsClient

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

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 HPCCWsFileIOClient get(Connection connection)

Gets the.

Parameters:

connection - the connection

Returns:

the HPCC ws file IO client

get

public static HPCCWsFileIOClient 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 ws file IO client

get

public static HPCCWsFileIOClient 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 ws file IO client

ping

public boolean ping()
             throws Exception

Ping.

Returns:

true, if successful

Throws:

Exception - the exception

createHPCCFile

public boolean createHPCCFile(String fileName,
                              String targetLandingZone,
                              boolean overwritefile)
                       throws Exception,
                              ArrayOfEspExceptionWrapper

Creates the HPCC file.

Parameters:

fileName - - The target HPCC file name

targetLandingZone - - The "netaddress" of the target landing, can be localhost, should be fetched from landingzones in filesprayclient

overwritefile - - If the file exists, should it be overwritten?

Returns:

true, if successful

Throws:

Exception - - Caller should handle exception in case of errors

ArrayOfEspExceptionWrapper - the array of esp exception wrapper

writeHPCCFileData

public boolean writeHPCCFileData(byte[] data,
                                 String fileName,
                                 String targetLandingZone,
                                 boolean append,
                                 long offset,
                                 int uploadchunksize)
                          throws Exception,
                                 ArrayOfEspExceptionWrapper

Write HPCC file data.

Parameters:

data - - The data to write

fileName - - The target HPCC file to write to

targetLandingZone - - The "netaddress" of the target landing, can be localhost, should be fetched from landingzones in filesprayclient

append - - Should this data be appended?

offset - - At what offset should this be written - Specify 0 if necessary

uploadchunksize - - Chunksize to upload the data

Returns:

true, if successful

Throws:

Exception - the exception

ArrayOfEspExceptionWrapper - the array of esp exception wrapper

readFileData

public String readFileData(String dropzone,
                           String fileName,
                           long datasize,
                           long offset)
                    throws Exception,
                           ArrayOfEspExceptionWrapper

Read file data.

Parameters:

dropzone - the dropzone

fileName - the file name

datasize - the datasize

offset - the offset

Returns:

the string

Throws:

Exception - the exception

ArrayOfEspExceptionWrapper - the array of esp exception wrapper