Package org.hpccsystems.ws.client

Class HPCCWsDFUXRefClient

java.lang.Object

java.util.Observable

org.hpccsystems.ws.client.utils.DataSingleton

org.hpccsystems.ws.client.BaseHPCCWsClient

org.hpccsystems.ws.client.HPCCWsDFUXRefClient

public class HPCCWsDFUXRefClient
extends BaseHPCCWsClient

Facilitates XRef Logical File System actions on target HPCC instance. Actions include building XRef, listing lost/orphaned/unused files, and more. NOTE: Many WsDFUXRef methods are not supported on Containerized HPCC deployments. The following methods are not supported in containerized HPCC: DFUXRefList: list all XRefNodes. Each Thor cluster or Roxie cluster in environment xml is an XRefNode. SuperFiles is an XRefNode. DFUXRefBuild: add an XRefNode to a job queue where XRef information will be generated for the XRefNode. DFUXRefLostFiles: list lost files in an XRefNode. DFUXRefFoundFiles: list found files in an XRefNode. DFUXRefOrphanFiles: list orphan files in an XRefNode. DFUXRefMessages: report messages ** in an XRefNode. DFUXRefDirectories: report directories in an XRefNode. DFUXRefArrayAction: take an action (attach, delete, etc.) on given XRef files. DFUXRefBuildCancel: dequeue all the jobs. DFUXRefCleanDirectories: remove empty directories in ** an XRefNode DFUXRefUnusedFiles: list unused files in a roxie XRefNode.

Field Summary

Fields

Modifier and Type	Field	Description
static String	WSDFUXREFURI	Constant WSDFUXREFURI="/WsDFUXRef"

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	HPCCWsDFUXRefClient(Connection baseConnection)	Instantiates a new HPCC WSDFUXREF client.

Method Summary

Modifier and Type	Method	Description
String	action(String cluster, String action, String type, org.hpccsystems.ws.client.gen.axis2.wsdfuxref.latest.EspStringArray xrefFilesArray)	Should provide either action or type
String	build(String cluster)	build.
String	buildCancel()	buildCancel.
void	cleanDirectories(String cluster)	cleanDirectories.
ArrayOfXRefDirectoryWrapper	directories(String cluster)	directories.
ArrayOfXRefFileWrapper	foundFiles(String cluster)	foundFiles.
static HPCCWsDFUXRefClient	get(String protocol, String targetHost, String targetPort, String user, String pass)	Gets the.
static HPCCWsDFUXRefClient	get(String protocol, String targetHost, String targetPort, String user, String pass, int timeout)	Gets the.
static HPCCWsDFUXRefClient	get(Connection connection)	Gets the.
org.apache.axis2.client.Stub	getDefaultStub()	Gets the default stub.
static double	getMinVerSupported()	getMinVerSupported.
String	getServiceURI()	Gets the service URI.
static int	getServiceWSDLPort()	Gets the service WSDL port.
static String	getServiceWSDLURL()	Gets the service WSDLURL.
protected void	initWsDFUXRefClientStub(Connection conn)	Initializes the service's underlying stub Should only be used by constructors.
boolean	isRuntimeVersionSupported()	isRuntimeVersionSupported.
ArrayOfXRefNodeWrapper	list()	list.
ArrayOfXRefFileWrapper	lostFiles(String cluster)	lostFiles.
ArrayOfXRefMessageWrapper	messages(String cluster)	messages.
ArrayOfXRefFileWrapper	orphanedFiles(String cluster)	orphanedFiles.
boolean	ping()	Ping.
org.hpccsystems.ws.client.wrappers.gen.wsdfuxref.DFUXRefUnusedFilesResponseWrapper	unusedFiles(String processCluster, Boolean getFileDetails, Boolean checkPackageMaps)	unusedFiles.

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

WSDFUXREFURI

public static final String WSDFUXREFURI

Constant WSDFUXREFURI="/WsDFUXRef"

See Also:

Constant Field Values

Constructor Detail

HPCCWsDFUXRefClient

protected HPCCWsDFUXRefClient(Connection baseConnection)

Instantiates a new HPCC WSDFUXREF client.

Parameters:

baseConnection - the base connection

Method Detail

getMinVerSupported

public static double getMinVerSupported()

getMinVerSupported.

Returns:

a double.

isRuntimeVersionSupported

public boolean isRuntimeVersionSupported()

isRuntimeVersionSupported.

Returns:

a boolean.

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

Gets the.

Parameters:

connection - the connection

Returns:

the HPCC WSDFUXREF client

get

public static HPCCWsDFUXRefClient 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 WSDFUXREF client

get

public static HPCCWsDFUXRefClient 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 WSDFUXREF client

initWsDFUXRefClientStub

protected void initWsDFUXRefClientStub(Connection conn)

Initializes the service's underlying stub Should only be used by constructors.

Parameters:

conn - -- All connection settings included

unusedFiles

public org.hpccsystems.ws.client.wrappers.gen.wsdfuxref.DFUXRefUnusedFilesResponseWrapper unusedFiles(String processCluster,
                                                                                                      Boolean getFileDetails,
                                                                                                      Boolean checkPackageMaps)
                                                                                               throws Exception

unusedFiles.

Parameters:

processCluster - a String object.

getFileDetails - a Boolean object.

checkPackageMaps - a Boolean object.

Returns:

a DFUXRefUnusedFilesResponseWrapper object.

Throws:

Exception - a Exception object.

orphanedFiles

public ArrayOfXRefFileWrapper orphanedFiles(String cluster)
                                     throws Exception

orphanedFiles.

Parameters:

cluster - a String object.

Returns:

a ArrayOfXRefFileWrapper object.

Throws:

Exception - a Exception object.

lostFiles

public ArrayOfXRefFileWrapper lostFiles(String cluster)
                                 throws Exception

lostFiles.

Parameters:

cluster - a String object.

Returns:

a ArrayOfXRefFileWrapper object.

Throws:

Exception - a Exception object.

directories

public ArrayOfXRefDirectoryWrapper directories(String cluster)
                                        throws Exception

directories.

Parameters:

cluster - a String object.

Returns:

a ArrayOfXRefDirectoryWrapper object.

Throws:

Exception - if any.

action

public String action(String cluster,
                     String action,
                     String type,
                     org.hpccsystems.ws.client.gen.axis2.wsdfuxref.latest.EspStringArray xrefFilesArray)
              throws Exception

Should provide either action or type

Parameters:

cluster - a String object.

action - "Attach", "Delete", "DeleteLogical"

type - "Found", "Lost", "Orphan"

xrefFilesArray - a EspStringArray object.

Returns:

a String object.

Throws:

Exception - a Exception object.

cleanDirectories

public void cleanDirectories(String cluster)
                      throws Exception

cleanDirectories.

Parameters:

cluster - a String object.

Throws:

Exception - a Exception object.

buildCancel

public String buildCancel()
                   throws Exception

buildCancel.

Returns:

a String object.

Throws:

Exception - a Exception object.

build

public String build(String cluster)
             throws Exception

build.

Parameters:

cluster - a String object.

Returns:

a String object.

Throws:

Exception - a Exception object.

foundFiles

public ArrayOfXRefFileWrapper foundFiles(String cluster)
                                  throws Exception

foundFiles.

Parameters:

cluster - a String object.

Returns:

a ArrayOfXRefFileWrapper object.

Throws:

Exception - a Exception object.

messages

public ArrayOfXRefMessageWrapper messages(String cluster)
                                   throws Exception

messages.

Parameters:

cluster - a String object.

Returns:

a ArrayOfXRefMessageWrapper object.

Throws:

Exception - a Exception object.

list

public ArrayOfXRefNodeWrapper list()
                            throws Exception

list.

Returns:

a ArrayOfXRefNodeWrapper object.

Throws:

Exception - a Exception object.

ping

public boolean ping()
             throws Exception

Ping.

Returns:

true, if successful

Throws:

Exception - a Exception object. the exception