Package org.hpccsystems.ws.client

Class HPCCWsWorkUnitsClient

  • public class HPCCWsWorkUnitsClient
extends BaseHPCCWsClient
    Facilitates ECL WorkUnit related actions. Supported actions include fetching Workunit info, submiting ECL query, fetching workunit status, publishing workunit, deleting, aborting and more.

    • Field Detail

      • WSWORKUNITSWSDLURI

        public static final String WSWORKUNITSWSDLURI
        Constant WSWORKUNITSWSDLURI="/WsWorkunits"
        See Also:
        Constant Field Values

      • defaultWaitTime

        public static final int defaultWaitTime
        Constant defaultWaitTime=10000
        See Also:
        Constant Field Values

      • defaultResultLimit

        public static final int defaultResultLimit
        Constant defaultResultLimit=100
        See Also:
        Constant Field Values

      • defaultMaxWaitTime

        public static final int defaultMaxWaitTime
        Constant defaultMaxWaitTime=1000 * 60 * 5
        See Also:
        Constant Field Values

    • Constructor Detail

      • HPCCWsWorkUnitsClient

        protected HPCCWsWorkUnitsClient​(Connection baseConnection)
        Instantiates a new HPCC ws work units client.
        Parameters:
        baseConnection - the base connection

    • Method Detail

      • 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 HPCCWsWorkUnitsClient get​(Connection connection)
        Gets the.
        Parameters:
        connection - the connection
        Returns:
        the HPCC ws work units client

      • get

        public static HPCCWsWorkUnitsClient 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 work units client

      • get

        public static HPCCWsWorkUnitsClient 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 work units client

      • initWsWorkUnitsClientStub

        public void initWsWorkUnitsClientStub​(Connection conn)
        Initializes the service's underlying soap proxy. Should only be used by constructors
        Parameters:
        conn - the conn

      • fastWURefresh

        public void fastWURefresh​(WorkunitWrapper wu)
                   throws Exception,
                          ArrayOfEspExceptionWrapper
        Performs limited refresh of local WU instance based on that WU's state on target HPCC cluster if state of WU has not changed, Graphs, Results,ResultsView, ResultSchemas, SourceFiles, ApplicationValues are not updated. However if local WU instance's state is found to differ from the server's version, a full refresh is performed.
        Parameters:
        wu - the wu
        Throws:
        Exception - the exception
        ArrayOfEspExceptionWrapper - the array of esp exception wrapper

      • fullWURefresh

        protected void fullWURefresh​(WorkunitWrapper wu)
                      throws Exception
        Performs full refresh of local WU instance based on that WU's state on target HPCC cluster. Full refresh includes Graphs, Results,ResultsView, ResultSchemas, SourceFiles, ApplicationValues.
        Parameters:
        wu - the wu
        Throws:
        Exception - the exception

      • fullWURefresh

        public void fullWURefresh​(WorkunitWrapper wu,
                          boolean includeGraphs,
                          boolean includeResults,
                          boolean includeSourceFiles,
                          boolean includeApplicationValues)
                   throws Exception
        Full WU refresh.
        Parameters:
        wu - the wu
        includeGraphs - the include graphs
        includeResults - the include results
        includeSourceFiles - the include source files
        includeApplicationValues - the include application values
        Throws:
        Exception - the exception

      • isWorkunitCompiled

        public boolean isWorkunitCompiled​(String wuid)
                           throws Exception,
                                  ArrayOfEspExceptionWrapper
        Reports if the WU in question is in the compiled state. Makes a call to the target Web Service to extract information about the WU
        Parameters:
        wuid - the wuid
        Returns:
        true if state is compiled
        Throws:
        Exception - the exception
        ArrayOfEspExceptionWrapper - the array of esp exception wrapper

      • isWorkunitCompiled

        public boolean isWorkunitCompiled​(WorkunitWrapper thewui)
        Reports if the WU in question is in the compiled state. Does not make call to the target Web Service, extracts information from the WU object
        Parameters:
        thewui - the thewui
        Returns:
        true if state is compiled

      • isWorkunitFailed

        public boolean isWorkunitFailed​(WorkunitWrapper thewui)
        Reports if the WU in question is in the failed state. Does not make call to the target Web Service, extracts information from the WU object
        Parameters:
        thewui - the thewui
        Returns:
        true if state is failed

      • isWorkunitFailed

        public boolean isWorkunitFailed​(String state)
        Reports if the string state represents the failed state.
        Parameters:
        state - the state
        Returns:
        true if state is failed

      • isWorkunitComplete

        public boolean isWorkunitComplete​(String wuid)
                           throws Exception,
                                  ArrayOfEspExceptionWrapper
        Replies true if given wuid is in complete state. This method makes call to WS, it is preferable to use WU object version
        Parameters:
        wuid - the wuid
        Returns:
        true, if is workunit complete
        Throws:
        Exception - the exception
        ArrayOfEspExceptionWrapper - the array of esp exception wrapper

      • isWorkunitComplete

        public static boolean isWorkunitComplete​(WorkunitWrapper thewui)
        Replies true if given wuid is in complete state. This method does not make a call to WS, and it is preferable over the version that calls WS.
        Parameters:
        thewui - the thewui
        Returns:
        true if wu is in one of the complete states

      • isWorkunitComplete

        public static boolean isWorkunitComplete​(WUState state,
                                         WUActionCode origAction)
        reports if a workunit is complete based on wustate, and original action if available.
        Parameters:
        state - the state
        origAction - the orig action
        Returns:
        true if wu is in completed state

      • isWorkunitComplete

        public static boolean isWorkunitComplete​(WUState state)
        reports if WuState is in the completed set.
        Parameters:
        state - the state
        Returns:
        true if state is in completed set

      • getStateID

        public static WUState getStateID​(WorkunitWrapper wu)
        Gets the state ID.
        Parameters:
        wu - the workunit
        Returns:
        the state of the workunit

      • getStateID

        public static WUState getStateID​(Integer id)
        Converts integer representation of WU state, to WUState enumeration.
        Parameters:
        id - the id
        Returns:
        WU state enumeration

      • publishWUFromEcl

        public org.hpccsystems.ws.client.gen.axis2.wsworkunits.latest.WUPublishWorkunitResponse publishWUFromEcl​(WorkunitWrapper wu)
                                                                                                  throws Exception,
                                                                                                         ArrayOfEspExceptionWrapper
        Deprecated.
        use publishWUFromEclWrapped
        Attempts to create, compile and publish a query based on ecl provided via a workunitinfo object.
        Parameters:
        wu - - Workunitinfo object containing all pertinent information for WU request
        Returns:
        the WU publish workunit response
        Throws:
        Exception - the exception
        ArrayOfEspExceptionWrapper - the array of esp exception wrapper

      • publishWUFromEclWrapped

        public org.hpccsystems.ws.client.wrappers.gen.wsworkunits.WUPublishWorkunitResponseWrapper publishWUFromEclWrapped​(WorkunitWrapper wu)
                                                                                                            throws Exception,
                                                                                                                   ArrayOfEspExceptionWrapper
        Attempts to create, compile and publish a query based on ecl provided via a workunitinfo object.
        Parameters:
        wu - - Workunitinfo object containing all pertinent information for WU request
        Returns:
        the WU publish workunit response
        Throws:
        Exception - the exception
        ArrayOfEspExceptionWrapper - the array of esp exception wrapper

      • publishWU

        public org.hpccsystems.ws.client.gen.axis2.wsworkunits.latest.WUPublishWorkunitResponse publishWU​(WorkunitWrapper wu)
                                                                                           throws Exception,
                                                                                                  ArrayOfEspExceptionWrapper
        Deprecated.
        use publishWUWrapped
        Attempts to publish a query based on a given Workunit.
        Parameters:
        wu - the wu
        Returns:
        the WU publish workunit response
        Throws:
        Exception - the exception
        ArrayOfEspExceptionWrapper - the array of esp exception wrapper

      • publishWU

        public void publishWU​(String wuid)
               throws Exception
        Publish WU.
        Parameters:
        wuid - the wuid
        Throws:
        Exception - the exception

      • getWUInfo

        public WorkunitWrapper getWUInfo​(String wuid,
                                 boolean unarchive)
                          throws Exception,
                                 ArrayOfEspExceptionWrapper
        Get information about a given WorkUnit, caller can request to unarchive the WU if necessary to fetch WU info.
        Parameters:
        wuid - - ID of target workunit
        unarchive - - unarchive archived workunit
        Returns:
        - ECLWorkunit object with information pertaining to the WU
        Throws:
        Exception - - Caller must handle exceptions
        ArrayOfEspExceptionWrapper - the array of esp exception wrapper

      • getWUInfo

        @Deprecated
public WorkunitWrapper getWUInfo​(String wuid,
                                 boolean includeResults,
                                 boolean includeGraphs,
                                 boolean includeSourceFiles,
                                 boolean includeApplicationValues,
                                 Boolean includeDebugValues,
                                 Boolean includeExceptions,
                                 Boolean includeVariables,
                                 Boolean includeXmlSchemas,
                                 Boolean includeTimers)
                          throws Exception,
                                 ArrayOfEspExceptionWrapper
        Deprecated.
        Get information about a given WorkUnit, Workunit must not be archived. Caller can choose which WU information portion to fetch Deprecated; use getWUInfo(WSInfoRequestWrapper,unarchive)
        Parameters:
        wuid - the wuid
        includeResults - the include results
        includeGraphs - the include graphs
        includeSourceFiles - the include source files
        includeApplicationValues - the include application values
        includeDebugValues - the include debug values
        includeExceptions - the include exceptions
        includeVariables - the include variables
        includeXmlSchemas - the include xml schemas
        includeTimers - the include timers
        Returns:
        the WU info
        Throws:
        Exception - the exception
        ArrayOfEspExceptionWrapper - the array of esp exception wrapper

      • getWUInfo

        @Deprecated
public WorkunitWrapper getWUInfo​(String wuid,
                                 boolean includeResults,
                                 boolean includeGraphs,
                                 boolean includeSourceFiles,
                                 boolean includeApplicationValues,
                                 Boolean includeDebugValues,
                                 Boolean includeExceptions,
                                 Boolean includeVariables,
                                 Boolean includeXmlSchemas,
                                 Boolean includeTimers,
                                 boolean unarchive)
                          throws Exception,
                                 ArrayOfEspExceptionWrapper
        Deprecated.
        Get information about a given WorkUnit, caller can request to unarchive Caller can choose which WU information portion to fetch. Deprecated; use getWUInfo(WSInfoRequestWrapper,unarchive)
        Parameters:
        wuid - the wuid
        includeResults - the include results
        includeGraphs - the include graphs
        includeSourceFiles - the include source files
        includeApplicationValues - the include application values
        includeDebugValues - the include debug values
        includeExceptions - the include exceptions
        includeVariables - the include variables
        includeXmlSchemas - the include xml schemas
        includeTimers - the include timers
        unarchive - the unarchive
        Returns:
        the WU info
        Throws:
        Exception - the exception
        ArrayOfEspExceptionWrapper - the array of esp exception wrapper

      • testWUQuery

        public boolean testWUQuery()
                    throws Exception
        This method queries WU information using a bogus WUID. Used as a mechanism for testing connectivity with HPCC ESP. Temporarily increases timeout value to 3 seconds;
        Returns:
        - True if able to reply is received within timout value of 3 secs, false otherwise
        Throws:
        Exception - - Caller must handle exceptions

      • workUnitUQuery

        public List<WorkunitWrapper> workUnitUQuery​(String wuid,
                                            String jobname,
                                            String cluster,
                                            Boolean archived,
                                            WUQueryWrapper.SortBy sortby,
                                            WUState state,
                                            Date endDate,
                                            Date startDate,
                                            Long pageStartFrom,
                                            Long pageSize,
                                            String owner,
                                            List<ApplicationValueWrapper> applicationValues)
                                     throws Exception,
                                            ArrayOfEspExceptionWrapper
        As of Platform version 6.0.0. Now maps to new prototype, excluding the pageSize and startPageFrom parameters. Executes a WUQuery, based on parameters provided. If a custom WUQuery is desired, the caller can make a direct call to WUQuery based on the soapproxy for this client. If using applicationValues objects for filtering, a user must pair the Application with either an attribute name, or attribute value.
        Parameters:
        wuid - the wuid
        jobname - the jobname
        cluster - the cluster
        archived - the archived
        sortby - the sortby
        state - the state
        endDate - the end date
        startDate - the start date
        pageStartFrom - the page start from
        pageSize - the page size
        owner - the owner
        applicationValues - the application values
        Returns:
        the list
        Throws:
        Exception - the exception
        ArrayOfEspExceptionWrapper - the array of esp exception wrapper

      • doesWUContainErrors

        public boolean doesWUContainErrors​(String wuid)
                            throws Exception,
                                   ArrayOfEspExceptionWrapper
        This method queries information about a given WU and answers if the WU has reported errors.
        Parameters:
        wuid - - The ID of the target workunit
        Returns:
        - true if errors present
        Throws:
        Exception - - Caller must handle exceptions
        ArrayOfEspExceptionWrapper - the array of esp exception wrapper

      • getWorkunits

        public List<WorkunitWrapper> getWorkunits​(String jobName,
                                          String owner,
                                          String ecl,
                                          Boolean archived,
                                          String wuid,
                                          String cluster,
                                          WUState state)
                                   throws Exception,
                                          ArrayOfEspExceptionWrapper
        Gets the workunits.
        Parameters:
        jobName - the pattern to find in the jobname (wildcard * matches multiple jobnames)
        owner - - hpcc owner of the job
        ecl - - text in the ecl
        archived - - if true, search archived workunits. If false or null, search unarchived workunits.
        wuid - - wuid to search for
        cluster - - cluster to search workunits for
        state - - WUState of workunits to find
        Returns:
        an List <WorkunitInfo> of matching workunits
        Throws:
        Exception - the exception
        ArrayOfEspExceptionWrapper - the array of esp exception wrapper

      • submitWU

        public void submitWU​(WUSubmitWrapper wusubmitwrapper)
              throws Exception
        Use this version if targeting HPCC 8+ Provides caller full control over request options via WUSubmitWrapper
        Parameters:
        wusubmitwrapper - a WUSubmitWrapper object.
        Throws:
        Exception - a Exception object.

      • fetchResultsFromLogicalName

        public String fetchResultsFromLogicalName​(String logicalName,
                                          int sequence,
                                          String cluster,
                                          boolean suppressXMLShema,
                                          long resultOffset,
                                          int resultCount)
                                   throws Exception,
                                          ArrayOfEspExceptionWrapper
        Fetches results associated with a given Logical name.
        Parameters:
        logicalName - the logical name
        sequence - - Zero based index result sequence (Each result set may contain multiple results)
        cluster - - The target cluster
        suppressXMLShema - - Results are accompanied by a schema, do you want to suppress it?
        resultOffset - - Request results starting at record offset
        resultCount - - Total result record count
        Returns:
        - Results in xml string
        Throws:
        Exception - the exception
        ArrayOfEspExceptionWrapper - the array of esp exception wrapper

      • fetchResults

        public String fetchResults​(String wuid,
                           int sequence,
                           String cluster,
                           boolean suppressXMLShema,
                           long resultOffset,
                           int resultCount)
                    throws Exception,
                           ArrayOfEspExceptionWrapper
        Fetches results associated with a given WUID. If the given WUID has been archived, results might not be available using this function Use fetchResultsFromLogicalName instead
        Parameters:
        wuid - - The target WUID to fetch results from
        sequence - - Zero based index result sequence (Each result set may contain multiple results)
        cluster - - The target cluster
        suppressXMLShema - - Results are accompanied by a schema, do you want to suppress it?
        resultOffset - - Request results starting at record offset
        resultCount - - Total result record count re
        Returns:
        - Results in xml string
        Throws:
        Exception - the exception
        ArrayOfEspExceptionWrapper - the array of esp exception wrapper

      • fetchRawResults

        public org.hpccsystems.ws.client.gen.axis2.wsworkunits.latest.WUResultResponse fetchRawResults​(String wuidorlogicalname,
                                                                                               boolean useWuid,
                                                                                               int sequence,
                                                                                               String cluster,
                                                                                               boolean suppressXMLShema,
                                                                                               long resultOffset,
                                                                                               int resultCount)
                                                                                        throws Exception
        Fetches results associated with a given WUID or logical file name. If the given WUID has been archived, results might not be available -use fetchResultsFromLogicalName instead
        Parameters:
        wuidorlogicalname - the wuidorlogicalname
        useWuid - the use wuid
        sequence - the sequence
        cluster - the cluster
        suppressXMLShema - the suppress XML shema
        resultOffset - the result offset
        resultCount - the result count
        Returns:
        the WU result response
        Throws:
        Exception - the exception

      • looksLikeAWuid

        public static boolean looksLikeAWuid​(String wuid)
        Looks like A wuid.
        Parameters:
        wuid - does this string follow the known WU format
        Returns:
        true if it wuid appears to be a workunit, false otherwise logic borrowed from platform code: workunit.cpp bool looksLikeAWuid(const char * wuid) { if (!wuid) return false; if (wuid[0] != 'W') return false; if (!isdigit(wuid[1]) || !isdigit(wuid[2]) || !isdigit(wuid[3]) || !isdigit(wuid[4])) return false; if (!isdigit(wuid[5]) || !isdigit(wuid[6]) || !isdigit(wuid[7]) || !isdigit(wuid[8])) return false; return (wuid[9]=='-'); }

      • fetchRawResults

        public org.hpccsystems.ws.client.gen.axis2.wsworkunits.latest.WUResultResponse fetchRawResults​(org.hpccsystems.ws.client.gen.axis2.wsworkunits.latest.WUResult parameters)
                                                                                        throws Exception
        Fetches results associated with a given WUID or logical file name. All parameters and options must be pre-set in the "parameters" input param
        Parameters:
        parameters - the parameters
        Returns:
        the WU result response
        Throws:
        Exception - the exception

      • syntaxCheckECL

        public ArrayOfECLExceptionWrapper syntaxCheckECL​(String ecl,
                                                 String cluster,
                                                 Integer timeout)
                                          throws Exception
        Submit the given ECL code for syntax check upon the given target cluster.
        Parameters:
        ecl - - The ECL to syntax check
        cluster - - The HPCC target cluster on which to syntax check
        timeout - - Maximum time for this check
        Returns:
        the array of ECL exception wrapper
        Throws:
        Exception - the exception

      • getQueriesDetail

        public org.hpccsystems.ws.client.gen.axis2.wsworkunits.latest.WUQuerySetDetailsResponse getQueriesDetail​(String querySetName,
                                                                                                         String clusterName,
                                                                                                         String filter)
                                                                                                  throws Exception
        Fetch details about the given query.
        Parameters:
        querySetName - the query set name
        clusterName - the cluster name
        filter - the filter
        Returns:
        the queries detail
        Throws:
        Exception - the exception

      • abortWU

        public void abortWU​(String wuid)
             throws Exception
        Request that a given workunit is aborted.
        Parameters:
        wuid - the wuid
        Throws:
        Exception - the exception

      • resubmitWU

        public void resubmitWU​(String wuid,
                       boolean restart,
                       boolean clone)
                throws Exception
        Request that a given workunit is re-submitted. Caller can choose to clone the wu, and to restart the WU's workflow.
        Parameters:
        wuid - the wuid
        restart - the restart
        clone - the clone
        Throws:
        Exception - the exception

      • getQuerySets

        public org.hpccsystems.ws.client.gen.axis2.wsworkunits.latest.QuerySet[] getQuerySets()
                                                                               throws Exception
        Fetch set of available QuerySets.
        Returns:
        the query sets
        Throws:
        Exception - the exception

      • getWorkunitResult

        public org.hpccsystems.ws.client.gen.axis2.wsworkunits.latest.WUResultResponse getWorkunitResult​(org.hpccsystems.ws.client.gen.axis2.wsworkunits.latest.WUResult wur)
                                                                                          throws Exception,
                                                                                                 ArrayOfEspExceptionWrapper
        Return a workunit result.
        Parameters:
        wur - the wur
        Returns:
        WUResultResponse
        Throws:
        Exception - the exception
        ArrayOfEspExceptionWrapper - the array of esp exception wrapper

      • getWorkunitResult

        public org.hpccsystems.ws.client.gen.axis2.wsworkunits.latest.WUResultResponse getWorkunitResult​(org.hpccsystems.ws.client.gen.axis2.wsworkunits.latest.WUResult wur,
                                                                                                 boolean unarchive)
                                                                                          throws Exception,
                                                                                                 ArrayOfEspExceptionWrapper
        Return a workunit result.
        Parameters:
        wur - the wur
        unarchive - the unarchive
        Returns:
        WUResultResponse
        Throws:
        Exception - the exception
        ArrayOfEspExceptionWrapper - the array of esp exception wrapper

      • createWorkunit

        public WorkunitWrapper createWorkunit()
                               throws Exception
        Create a new workunit. Does not update/run/submit
        Returns:
        new WorkunitInfo containing created wuid
        Throws:
        Exception - the exception

      • protectWorkunit

        public WorkunitWrapper protectWorkunit​(String wuid)
                                throws Exception
        Protect a workunit
        Parameters:
        wuid - - wuid to protect
        Returns:
        WorkunitInfo with updated status
        Throws:
        Exception - the exception

      • getWorkunitFile

        public WULogFileWrapper getWorkunitFile​(String wuid,
                                        String filename,
                                        WUFileType filetype,
                                        String description,
                                        String ipaddr,
                                        boolean entirefile)
                                 throws Exception
        Get Workunit file.
        Parameters:
        wuid - the wuid
        filename - the filename
        filetype - the filetype
        description - the description
        ipaddr - the ipaddr
        entirefile - the entirefile
        Returns:
        the workunit file
        Throws:
        Exception - the exception

      • runWorkunit

        public WorkunitWrapper runWorkunit​(String wuid,
                                   HashMap<String,​String> namedvalues,
                                   HashMap<String,​String> appvalues,
                                   Integer timeout,
                                   Boolean cloneWorkunit,
                                   String appsource)
                            throws Exception
        Request to run a given workunit. Caller can set various WU options.
        Parameters:
        wuid - - wuid to call WURun for
        namedvalues - - override stored variables with this set of stored variables
        appvalues - - override application values with this set of app values
        timeout - - if provided, timeout before returning
        cloneWorkunit - - if true, clone workunit before rerunning
        appsource - - application source for app values
        Returns:
        WorkunitInfo with wuid of run, run status and result
        Throws:
        Exception - the exception

      • searchQueries

        public List<QueryResultWrapper> searchQueries​(QuerySetFilterType filtertype,
                                              String filtervalue,
                                              String querySetName,
                                              String clustername)
                                       throws Exception
        Fetch list of querysets.
        Parameters:
        filtertype - the filtertype
        filtervalue - the filtervalue
        querySetName - the query set name
        clustername - the clustername
        Returns:
        the list
        Throws:
        Exception - the exception

      • listQueries

        public List<QueryResultWrapper> listQueries​(String queryid,
                                            String queryname,
                                            String clustername,
                                            String querysetname,
                                            Integer pageSize,
                                            Integer pageStartFrom,
                                            Boolean activated,
                                            String filename,
                                            Boolean descending)
                                     throws Exception
        Call WUListQueries service
        Parameters:
        queryid - - unique ID of the query
        queryname - - name/alias of the query
        clustername - - name of the cluster the query is on
        querysetname - - name of the queryset the cluster is part of
        pageSize - - number of results to return (if null, 100 results are returned)
        pageStartFrom - - which result to start returning on (if null, results start with 1)
        activated - - whether to return activated queries
        filename - - return queries using this filename
        descending - the descending
        Returns:
        List of QueryResults populated from QuerySetQuery list
        Throws:
        Exception - the exception

      • getQueryFiles

        public List<QueryFileWrapper> getQueryFiles​(String queryname,
                                            String cluster)
                                     throws Exception
        Gets the query files.
        Parameters:
        queryname - - query to retrieve files for
        cluster - - the cluster to search for said query
        Returns:
        - List <QueryFileWrapper> of matching queries
        Throws:
        Exception - the exception

      • activateQuery

        public QueryResultWrapper activateQuery​(String queryId,
                                        String cluster)
                                 throws Exception
        Activate query.
        Parameters:
        queryId - - unique id of query to activate
        cluster - - cluster to activate upon
        Returns:
        the query result wrapper
        Throws:
        Exception - the exception

      • deleteQueries

        public List<QueryResultWrapper> deleteQueries​(Set<String> querynames,
                                              String cluster)
                                       throws Exception
        Delete queries.
        Parameters:
        querynames - - queries to delete
        cluster - - cluster to delete from
        Returns:
        - List <QueryResult> result of actions
        Throws:
        Exception - the exception

      • ping

        public boolean ping()
             throws Exception
        Ping.
        Returns:
        true, if successful
        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