Package org.hpccsystems.ws.client

Class HPCCWsPackageProcessClient

java.lang.Object

java.util.Observable

org.hpccsystems.ws.client.utils.DataSingleton

org.hpccsystems.ws.client.BaseHPCCWsClient

org.hpccsystems.ws.client.HPCCWsPackageProcessClient

public class HPCCWsPackageProcessClient
extends BaseHPCCWsClient

Use as soap client for HPCC wsPackageProcess web service. This includes creating a new file, and appending data to a file in the given SHPCC System.

Field Summary

Fields

Modifier and Type	Field	Description
static String	PACKAGEPROCESSURI	Constant PACKAGEPROCESSURI="/WsPackageProcess"

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	HPCCWsPackageProcessClient(String protocol, String targetHost, String targetPort, String user, String pass)	Instantiates a new HPCC ws package process client.
protected	HPCCWsPackageProcessClient(String protocol, String targetHost, String targetPort, String user, String pass, int timeout)	Instantiates a new HPCC ws package process client.
protected	HPCCWsPackageProcessClient(Connection baseConnection)	Instantiates a new HPCC ws package process client.

Method Summary

Modifier and Type	Method	Description
org.hpccsystems.ws.client.wrappers.gen.wspackageprocess.BasePackageStatusWrapper	activatePackage(boolean globalScope, String packageMapName, String process, String target)	Activate package.
org.hpccsystems.ws.client.gen.axis2.wspackageprocess.latest.AddPackageResponse	addPackage(String packageMapID, String packageMapContent, String targetCluster, Boolean active, Boolean allowforeignfiles, Boolean appendcluster, String daliip, Boolean globalscope, Boolean overwrite, Boolean preloadallpackages, String process, Boolean replacepackagemap, String sourceprocess, Boolean updateclonefrom, Boolean updatesuperfiles)	addPackage.
org.hpccsystems.ws.client.gen.axis2.wspackageprocess.latest.AddPackageResponse	addPackage(String packageMapID, String packageMapContent, String targetCluster, String daliip)	addPackage.
org.hpccsystems.ws.client.gen.axis2.wspackageprocess.latest.AddPackageResponse	addPackage(String packageMapID, String packageMapContent, String targetCluster, String daliip, Boolean overwrite)	addPackage.
org.hpccsystems.ws.client.gen.axis2.wspackageprocess.latest.AddPackageResponse	addPackage(String packageMapID, String packageMapContent, String targetCluster, String daliip, Boolean overwrite, Boolean active)	addPackage.
org.hpccsystems.ws.client.gen.axis2.wspackageprocess.latest.AddPackageResponse	addPackage(org.hpccsystems.ws.client.wrappers.gen.wspackageprocess.AddPackageRequestWrapper reqwrapper)	addPackage.
org.hpccsystems.ws.client.gen.axis2.wspackageprocess.latest.DeletePackageResponse	deletePackage(String packageMapID, String targetcluster)	Request to delete package map, defaults to ALL process
org.hpccsystems.ws.client.gen.axis2.wspackageprocess.latest.DeletePackageResponse	deletePackage(String packageMapID, String targetcluster, String process)	Request to delete package map
org.hpccsystems.ws.client.gen.axis2.wspackageprocess.latest.DeletePackageResponse	deletePackage(String packageMapID, String targetcluster, String process, Boolean globalscope)	Request to delete package map
org.hpccsystems.ws.client.gen.axis2.wspackageprocess.latest.DeletePackageResponse	deletePackage(org.hpccsystems.ws.client.wrappers.gen.wspackageprocess.DeletePackageRequestWrapper reqwrapper)	deletePackage.
static HPCCWsPackageProcessClient	get(Connection connection)	Gets the.
org.apache.axis2.client.Stub	getDefaultStub()	Gets the default stub.
org.hpccsystems.ws.client.wrappers.gen.wspackageprocess.BasePackageStatusWrapper	getPackage(String process, String target)	Gets the package.
String	getPackageMapById(String packageMapName)	Gets the package map by id.
String	getServiceURI()	Gets the service URI.
static int	getServiceWSDLPort()	Gets the service WSDL port.
static String	getServiceWSDLURL()	Gets the service WSDLURL.
List<org.hpccsystems.ws.client.wrappers.gen.wspackageprocess.PackageListMapDataWrapper>	listPackages(String process, String target, String processFilter)	List packages.
boolean	ping()	Ping.
org.hpccsystems.ws.client.wrappers.gen.wspackageprocess.BasePackageStatusWrapper	removePartFromPackageMap(boolean globalScope, String partName, String target, String packageMap)	Remove a part from a package map.

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

PACKAGEPROCESSURI

public static final String PACKAGEPROCESSURI

Constant PACKAGEPROCESSURI="/WsPackageProcess"

See Also:

Constant Field Values

Constructor Detail

HPCCWsPackageProcessClient

protected HPCCWsPackageProcessClient(Connection baseConnection)

Instantiates a new HPCC ws package process client.

Parameters:

baseConnection - the base connection

HPCCWsPackageProcessClient

protected HPCCWsPackageProcessClient(String protocol,
                                     String targetHost,
                                     String targetPort,
                                     String user,
                                     String pass)

Instantiates a new HPCC ws package process client.

Parameters:

protocol - the protocol

targetHost - the target host

targetPort - the target port

user - the user

pass - the pass

HPCCWsPackageProcessClient

protected HPCCWsPackageProcessClient(String protocol,
                                     String targetHost,
                                     String targetPort,
                                     String user,
                                     String pass,
                                     int timeout)

Instantiates a new HPCC ws package process client.

Parameters:

protocol - the protocol

targetHost - the target host

targetPort - the target port

user - the user

pass - the pass

timeout - the timeout

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

get

public static HPCCWsPackageProcessClient get(Connection connection)

Gets the.

Parameters:

connection - the connection

Returns:

the HPCC ws package process client

ping

public boolean ping()
             throws Exception

Ping.

Returns:

true, if successful

Throws:

Exception - the exception

addPackage

public org.hpccsystems.ws.client.gen.axis2.wspackageprocess.latest.AddPackageResponse addPackage(String packageMapID,
                                                                                                 String packageMapContent,
                                                                                                 String targetCluster,
                                                                                                 String daliip)
                                                                                          throws Exception

addPackage.

Parameters:

packageMapID - - The name of the new packagemap

packageMapContent - - The packagemap content

targetCluster - - The packagemap cluster name

daliip - - The target Dali IP All other request values are defaulted

Returns:

a AddPackageResponse object.

Throws:

Exception - a Exception object.

addPackage

public org.hpccsystems.ws.client.gen.axis2.wspackageprocess.latest.AddPackageResponse addPackage(String packageMapID,
                                                                                                 String packageMapContent,
                                                                                                 String targetCluster,
                                                                                                 String daliip,
                                                                                                 Boolean overwrite)
                                                                                          throws Exception

addPackage.

Parameters:

packageMapID - - The name of the new packagemap

packageMapContent - - The packagemap content

targetCluster - - The packagemap cluster name

daliip - - The target Dali IP

overwrite - - Option to overwrite package map is pre-existing All other request values are defaulted

Returns:

a AddPackageResponse object.

Throws:

Exception - a Exception object.

addPackage

public org.hpccsystems.ws.client.gen.axis2.wspackageprocess.latest.AddPackageResponse addPackage(String packageMapID,
                                                                                                 String packageMapContent,
                                                                                                 String targetCluster,
                                                                                                 String daliip,
                                                                                                 Boolean overwrite,
                                                                                                 Boolean active)
                                                                                          throws Exception

addPackage.

Parameters:

packageMapID - - The name of the new packagemap

packageMapContent - - The packagemap content

targetCluster - - The packagemap cluster name

daliip - - The target Dali IP

overwrite - - Option to overwrite package map is pre-existing

active - a Boolean object.

Returns:

a AddPackageResponse object.

Throws:

Exception - a Exception object.

addPackage

public org.hpccsystems.ws.client.gen.axis2.wspackageprocess.latest.AddPackageResponse addPackage(String packageMapID,
                                                                                                 String packageMapContent,
                                                                                                 String targetCluster,
                                                                                                 Boolean active,
                                                                                                 Boolean allowforeignfiles,
                                                                                                 Boolean appendcluster,
                                                                                                 String daliip,
                                                                                                 Boolean globalscope,
                                                                                                 Boolean overwrite,
                                                                                                 Boolean preloadallpackages,
                                                                                                 String process,
                                                                                                 Boolean replacepackagemap,
                                                                                                 String sourceprocess,
                                                                                                 Boolean updateclonefrom,
                                                                                                 Boolean updatesuperfiles)
                                                                                          throws Exception

addPackage.

Parameters:

packageMapID - - The name of the new packagemap

packageMapContent - - The packagemap content

targetCluster - - The packagemap cluster name

active - - Option to set new package map as active

allowforeignfiles - - Option to allow foreing files

appendcluster - - Option to append cluster

daliip - - The target Dali IP

globalscope - - Global scope option

overwrite - - Option to overwrite package map is pre-existing

preloadallpackages - - Option to pre-load all packages

process - - Target process

replacepackagemap - - Option to replace packagemap

sourceprocess - - The source process

updateclonefrom - - Option to update clone from

updatesuperfiles - - Option to update superfiles

Returns:

a AddPackageResponse object.

Throws:

Exception - a Exception object.

addPackage

public org.hpccsystems.ws.client.gen.axis2.wspackageprocess.latest.AddPackageResponse addPackage(org.hpccsystems.ws.client.wrappers.gen.wspackageprocess.AddPackageRequestWrapper reqwrapper)
                                                                                          throws Exception

addPackage.

Parameters:

reqwrapper - - Add package request options object (AddPackageRequestWrapper) Caller is responsible for setting all options appropriately This call might override server side defaults

Returns:

- Add package response object Caller is responsible for interpreting response codes/status. Function will report Java Exception if service reports any exceptions

Throws:

Exception - a Exception object.

deletePackage

public org.hpccsystems.ws.client.gen.axis2.wspackageprocess.latest.DeletePackageResponse deletePackage(String packageMapID,
                                                                                                       String targetcluster)
                                                                                                throws Exception

Request to delete package map, defaults to ALL process

Parameters:

packageMapID - - The packagemap to delete

targetcluster - - The packagemap cluster

Returns:

a DeletePackageResponse object.

Throws:

Exception - a Exception object.

deletePackage

public org.hpccsystems.ws.client.gen.axis2.wspackageprocess.latest.DeletePackageResponse deletePackage(String packageMapID,
                                                                                                       String targetcluster,
                                                                                                       String process)
                                                                                                throws Exception

Request to delete package map

Parameters:

packageMapID - - The packagemap to delete

targetcluster - - The packagemap cluster

process - - The process

Returns:

a DeletePackageResponse object.

Throws:

Exception - a Exception object.

deletePackage

public org.hpccsystems.ws.client.gen.axis2.wspackageprocess.latest.DeletePackageResponse deletePackage(String packageMapID,
                                                                                                       String targetcluster,
                                                                                                       String process,
                                                                                                       Boolean globalscope)
                                                                                                throws Exception

Request to delete package map

Parameters:

packageMapID - - The packagemap to delete

targetcluster - - The packagemap cluster

process - - The process

globalscope - - Is the target packagemap global scoped

Returns:

a DeletePackageResponse object.

Throws:

Exception - a Exception object.

deletePackage

public org.hpccsystems.ws.client.gen.axis2.wspackageprocess.latest.DeletePackageResponse deletePackage(org.hpccsystems.ws.client.wrappers.gen.wspackageprocess.DeletePackageRequestWrapper reqwrapper)
                                                                                                throws Exception

deletePackage.

Parameters:

reqwrapper - - Delete package request options object (DeletePackageRequestWrapper) Caller is responsible for setting all options appropriately This call might override server side defaults

Returns:

- Delete package response object Caller is responsible for interpreting response codes/status.

Throws:

Exception - a Exception object.

getPackageMapById

public String getPackageMapById(String packageMapName)
                         throws Exception,
                                ArrayOfEspExceptionWrapper

Gets the package map by id.

Parameters:

packageMapName - the package map name

Returns:

String - packagemap content

Throws:

Exception - a Exception object. - Caller should handle exception in case of errors

ArrayOfEspExceptionWrapper - a ArrayOfEspExceptionWrapper object. the array of esp exception wrapper

activatePackage

public org.hpccsystems.ws.client.wrappers.gen.wspackageprocess.BasePackageStatusWrapper activatePackage(boolean globalScope,
                                                                                                        String packageMapName,
                                                                                                        String process,
                                                                                                        String target)
                                                                                                 throws Exception,
                                                                                                        ArrayOfEspExceptionWrapper

Activate package.

Parameters:

globalScope - the global scope

packageMapName - the package map name

process - the process

target - the target

Returns:

BasePackageStatus - Caller should interrogate status object for success

Throws:

Exception - a Exception object. - Caller should handle exception in case of errors

ArrayOfEspExceptionWrapper - a ArrayOfEspExceptionWrapper object. the array of esp exception wrapper

getPackage

public org.hpccsystems.ws.client.wrappers.gen.wspackageprocess.BasePackageStatusWrapper getPackage(String process,
                                                                                                   String target)
                                                                                            throws Exception,
                                                                                                   ArrayOfEspExceptionWrapper

Gets the package.

Parameters:

process - the process

target - the target

Returns:

BasePackageStatus - Caller should interrogate status object for success

Throws:

Exception - a Exception object. - Caller should handle exception in case of errors

ArrayOfEspExceptionWrapper - a ArrayOfEspExceptionWrapper object. the array of esp exception wrapper

removePartFromPackageMap

public org.hpccsystems.ws.client.wrappers.gen.wspackageprocess.BasePackageStatusWrapper removePartFromPackageMap(boolean globalScope,
                                                                                                                 String partName,
                                                                                                                 String target,
                                                                                                                 String packageMap)
                                                                                                          throws Exception

Remove a part from a package map.

Parameters:

globalScope - Global or non global scoped.

partName - The part name to remove.

target - The target.

packageMap - The package map id.

Returns:

BasePackageStatus - Caller should interrogate status object for success

Throws:

Exception - a Exception object. - Caller should handle exception in case of errors

listPackages

public List<org.hpccsystems.ws.client.wrappers.gen.wspackageprocess.PackageListMapDataWrapper> listPackages(String process,
                                                                                                            String target,
                                                                                                            String processFilter)
                                                                                                     throws Exception,
                                                                                                            ArrayOfEspExceptionWrapper

List packages.

Parameters:

process - the process

target - the target

processFilter - the process filter

Returns:

List of PackageListMapDataWrappers

Throws:

Exception - a Exception object. the exception

ArrayOfEspExceptionWrapper - a ArrayOfEspExceptionWrapper object. the array of esp exception wrapper

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