Package org.hpccsystems.ws.client.extended

Class HPCCWsAttributesClient

java.lang.Object

java.util.Observable

org.hpccsystems.ws.client.utils.DataSingleton

org.hpccsystems.ws.client.BaseHPCCWsClient

org.hpccsystems.ws.client.extended.HPCCWsAttributesClient

public class HPCCWsAttributesClient
extends BaseHPCCWsClient

HPCCWsAttributesClient class.

Field Summary

Fields

Modifier and Type	Field	Description
static String	WSATTRIBUTESWSDLURI	Constant WSATTRIBUTESWSDLURI="/WsAttributes"

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	HPCCWsAttributesClient(Connection baseConnection)	Instantiates a new HPCC ws attributes client.

Method Summary

Modifier and Type	Method	Description
boolean	attributeExists(String modulename, String attributename, String type)	Check whether an attribute exists.
org.hpccsystems.ws.client.gen.axis2.wsattributes.latest.ECLAttribute	checkinAttribute(String modulename, String attributename, String checkindesc)	Check in an attribute in an HPCC Repository.
org.hpccsystems.ws.client.gen.axis2.wsattributes.latest.ECLAttribute	checkoutAttribute(String modulename, String attributename)	Check out an attribute in a legacy repository.
org.hpccsystems.ws.client.gen.axis2.wsattributes.latest.ECLAttribute	createAttribute(String modulename, String attributename, String type, String text, Boolean checkin, String checkindesc)	Create an attribute in an HPCC Legacy Repository.
ECLAttributeWrapper	createOrUpdateAttribute(ECLAttributeWrapper item, boolean checkoutin, String checkindesc)	Create/Update an attribute in a legacy repository.
List<ECLAttributeWrapper>	createOrUpdateAttributes(List<ECLAttributeWrapper> in, boolean checkoutin, String checkindesc)	Creates the or update attributes.
List<ECLAttributeWrapper>	deleteAttribute(String modulename, String attributename)	delete an attribute from the remote repository.
void	deleteModule(String modulename)	Delete a module from the remote repository.
List<ECLAttributeWrapper>	findItems(String modulename, String attributename, String type, String username, String anytext, String changedSince)	Search for and retrieve the attribute metadata for attributes from a repository.
static HPCCWsAttributesClient	get(String protocol, String targetHost, String targetPort, String user, String pass)	Gets the.
static HPCCWsAttributesClient	get(String protocol, String targetHost, String targetPort, String user, String pass, int timeout)	Gets the.
static HPCCWsAttributesClient	get(Connection connection)	Gets the.
GetAttributesResponseWrapper	getAttributes(String label, String modulename, org.hpccsystems.ws.client.gen.axis2.wsattributes.latest.EspStringArray typelist)	Gets the attributes.
GetAttributesResponseWrapper	getAttributes(GetAttributesWrapper request)	Gets the attributes.
String	getAttributeText(String modulename, String attributename, String type)	Get the text of an attribute from a repo.
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.
org.hpccsystems.ws.client.gen.axis2.wsattributes.latest.ECLAttribute	renameAttribute(String modulename, String attributename, String newmodulename, String newattributename)	Rename an attribute in a legacy repo.
org.hpccsystems.ws.client.gen.axis2.wsattributes.latest.ECLAttribute	updateAttribute(String modulename, String attributename, String type, String text, Boolean checkoutin, String checkindesc)	Update an attribute in a legacy repository.

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

WSATTRIBUTESWSDLURI

public static final String WSATTRIBUTESWSDLURI

Constant WSATTRIBUTESWSDLURI="/WsAttributes"

See Also:

Constant Field Values

Constructor Detail

HPCCWsAttributesClient

protected HPCCWsAttributesClient(Connection baseConnection)

Instantiates a new HPCC ws attributes 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

get

public static HPCCWsAttributesClient get(Connection connection)

Gets the.

Parameters:

connection - the connection

Returns:

the HPCC ws attributes client

get

public static HPCCWsAttributesClient 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 attributes client

get

public static HPCCWsAttributesClient 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 attributes client

attributeExists

public boolean attributeExists(String modulename,
                               String attributename,
                               String type)
                        throws Exception,
                               ArrayOfEspExceptionWrapper

Check whether an attribute exists.

Parameters:

modulename - - ECL Module name containing the attribute to check

attributename - - Attribute to check

type - the type

Returns:

true if the attribute exists, false if it does not

Throws:

Exception - the exception

ArrayOfEspExceptionWrapper - the array of esp exception wrapper

findItems

public List<ECLAttributeWrapper> findItems(String modulename,
                                           String attributename,
                                           String type,
                                           String username,
                                           String anytext,
                                           String changedSince)
                                    throws Exception,
                                           ArrayOfEspExceptionWrapper

Search for and retrieve the attribute metadata for attributes from a repository.

Parameters:

modulename - - modulename of attributes to find. Entire name will be matched.

attributename - - attributename of attributes to find. Entire name will be matched.

type - the type

username - - owner of attributes to find. Entire name will be matched

anytext - - text string to find. It is implicitly surrounded by wildcards. will match any module name containing the pattern, attribute name containing the pattern, or attribute containing ecl that contains the pattern

changedSince - - only return attributes changes since this time

Returns:

a list of ECLAttributeInfo

Throws:

Exception - the exception

ArrayOfEspExceptionWrapper - the array of esp exception wrapper

getAttributeText

public String getAttributeText(String modulename,
                               String attributename,
                               String type)
                        throws Exception,
                               ArrayOfEspExceptionWrapper

Get the text of an attribute from a repo.

Parameters:

modulename - - module name of the attribute

attributename - - attribute name of the attribute

type - the type

Returns:

text contained by the attribute

Throws:

Exception - the exception

ArrayOfEspExceptionWrapper - the array of esp exception wrapper

renameAttribute

public org.hpccsystems.ws.client.gen.axis2.wsattributes.latest.ECLAttribute renameAttribute(String modulename,
                                                                                            String attributename,
                                                                                            String newmodulename,
                                                                                            String newattributename)
                                                                                     throws Exception,
                                                                                            ArrayOfEspExceptionWrapper

Rename an attribute in a legacy repo.

Parameters:

modulename - -existing module name that will be renamed

attributename - - existing attributename that will be renamed

newmodulename - - new module name to rename module to

newattributename - - new attribute name to rename attribute to

Returns:

ECL attribute of the renamed attribute

Throws:

Exception - the exception

ArrayOfEspExceptionWrapper - the array of esp exception wrapper

createOrUpdateAttributes

public List<ECLAttributeWrapper> createOrUpdateAttributes(List<ECLAttributeWrapper> in,
                                                          boolean checkoutin,
                                                          String checkindesc)
                                                   throws Exception,
                                                          ArrayOfEspExceptionWrapper

Creates the or update attributes.

Parameters:

in - - a list of ECLAttributeInfo objects to create or update

checkoutin - - if true, check out before updating and check in afterwards

checkindesc - - if checkoutin is true, this is the checkin message

Returns:

- a list of updated eclattributeinfo objects

Throws:

Exception - the exception

ArrayOfEspExceptionWrapper - the array of esp exception wrapper

createOrUpdateAttribute

public ECLAttributeWrapper createOrUpdateAttribute(ECLAttributeWrapper item,
                                                   boolean checkoutin,
                                                   String checkindesc)
                                            throws Exception,
                                                   ArrayOfEspExceptionWrapper

Create/Update an attribute in a legacy repository.

Parameters:

item - the item

checkoutin - - whether to check the attribute out/in before doing this

checkindesc - - if checkoutin=true, the description to append to the checkin

Returns:

updated ECLAttributeItem for created/updated item

Throws:

Exception - the exception

ArrayOfEspExceptionWrapper - the array of esp exception wrapper

updateAttribute

public org.hpccsystems.ws.client.gen.axis2.wsattributes.latest.ECLAttribute updateAttribute(String modulename,
                                                                                            String attributename,
                                                                                            String type,
                                                                                            String text,
                                                                                            Boolean checkoutin,
                                                                                            String checkindesc)
                                                                                     throws Exception,
                                                                                            ArrayOfEspExceptionWrapper

Update an attribute in a legacy repository.

Parameters:

modulename - - module name to update

attributename - - attribute name to update

type - the type

text - - text to update the attribute to

checkoutin - - whether to check the attribute out/in before doing this

checkindesc - - if checkoutin=true, the description to append to the checkin

Returns:

the ECL attribute

Throws:

Exception - the exception

ArrayOfEspExceptionWrapper - the array of esp exception wrapper

checkinAttribute

public org.hpccsystems.ws.client.gen.axis2.wsattributes.latest.ECLAttribute checkinAttribute(String modulename,
                                                                                             String attributename,
                                                                                             String checkindesc)
                                                                                      throws Exception,
                                                                                             ArrayOfEspExceptionWrapper

Check in an attribute in an HPCC Repository.

Parameters:

modulename - - module name to check in

attributename - - attribute name to check in

checkindesc - - check in comment

Returns:

ECLAttribute of checked in attribute

Throws:

Exception - the exception

ArrayOfEspExceptionWrapper - the array of esp exception wrapper

checkoutAttribute

public org.hpccsystems.ws.client.gen.axis2.wsattributes.latest.ECLAttribute checkoutAttribute(String modulename,
                                                                                              String attributename)
                                                                                       throws Exception,
                                                                                              ArrayOfEspExceptionWrapper

Check out an attribute in a legacy repository.

Parameters:

modulename - - module to check out

attributename - - attribute to check out

Returns:

ECLAttribute of checked out attribute

Throws:

Exception - the exception

ArrayOfEspExceptionWrapper - the array of esp exception wrapper

createAttribute

public org.hpccsystems.ws.client.gen.axis2.wsattributes.latest.ECLAttribute createAttribute(String modulename,
                                                                                            String attributename,
                                                                                            String type,
                                                                                            String text,
                                                                                            Boolean checkin,
                                                                                            String checkindesc)
                                                                                     throws Exception,
                                                                                            ArrayOfEspExceptionWrapper

Create an attribute in an HPCC Legacy Repository.

Parameters:

modulename - - module name to create

attributename - - attribute name to create

type - the type

text - the text

checkin - - if true, check this attribute in after creating it

checkindesc - - checkin comment. Required if checkin=true

Returns:

the ECL Attribute of the created object

Throws:

Exception - the exception

ArrayOfEspExceptionWrapper - the array of esp exception wrapper

deleteModule

public void deleteModule(String modulename)
                  throws Exception,
                         ArrayOfEspExceptionWrapper

Delete a module from the remote repository.

Parameters:

modulename - - name of module to delete

Throws:

Exception - the exception

ArrayOfEspExceptionWrapper - the array of esp exception wrapper

deleteAttribute

public List<ECLAttributeWrapper> deleteAttribute(String modulename,
                                                 String attributename)
                                          throws Exception,
                                                 ArrayOfEspExceptionWrapper

delete an attribute from the remote repository.

Parameters:

modulename - - name of module for attribute to delete

attributename - - name of attribute to delete

Returns:

the list

Throws:

Exception - the exception

ArrayOfEspExceptionWrapper - the array of esp exception wrapper

getAttributes

public GetAttributesResponseWrapper getAttributes(String label,
                                                  String modulename,
                                                  org.hpccsystems.ws.client.gen.axis2.wsattributes.latest.EspStringArray typelist)
                                           throws Exception

Gets the attributes.

Parameters:

label - the label

modulename - the modulename

typelist - the typelist

Returns:

the attributes

Throws:

Exception - the exception

getAttributes

public GetAttributesResponseWrapper getAttributes(GetAttributesWrapper request)
                                           throws Exception

Gets the attributes.

Parameters:

request - the request

Returns:

the attributes

Throws:

Exception - the exception

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