Package org.hpccsystems.ws.client

Class HPCCWsTopologyClient

  • public class HPCCWsTopologyClient
extends BaseHPCCWsClient
    Facilitates accessing HPCC Systems instance topology information. This client can be used for fetching topology information regarding the target HPCCSystem of special interest are the cluster groups, and the target clusters within those groups. NOTE: Many WsTopology methods are not supported on Containerized HPCC deployments. The following methods are not supported in containerized HPCC: TpServiceQuery: support the System Servers page on ECLWatch. TpClusterQuery: support the Cluster Processes page on ECLWatch. TpMachineQuery: support the Cluster Details page on ECLWatch Cluster Processes page. TpTargetClusterQuery: support the Target Clusters page on ECLWatch. (based on Software/Topology/Cluster in environment xml) TpListTargetClusters: report the names and types of the Target Clusters (based on Software/Topology/Cluster in environment xml) TpClusterInfo: report thor queues and ecl workunits in the queues. (based on /Status/Servers) TpThorStatus: report thor server information and ecl workunits in the queues. (based on /Status/Servers – thorname not in for cloud) TpMachineInfo: report computer information from Hardware/Computer in environment xml. TpSwapNode: swap nodes TpGetComponentFile: support the configuration pages and log pages on ECLWatch Operation pages. SystemLog: download component ** log file from ECLWatch Operation pages. TpLogFile and TpLogFileDisplay: return a part or whole content of a log file. TpXMLFile: report thor data in /Status/Servers/Server (thorname not in for cloud).

    • Field Detail

      • WSTOPOLOGYWSDLURI

        public static final String WSTOPOLOGYWSDLURI
        Constant WSTOPOLOGYWSDLURI="/WsTopology"
        See Also:
        Constant Field Values

    • Constructor Detail

      • HPCCWsTopologyClient

        protected HPCCWsTopologyClient​(Connection baseConnection)
        Instantiates a new HPCC ws topology 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 HPCCWsTopologyClient get​(Connection connection)
        Gets the.
        Parameters:
        connection - the connection
        Returns:
        the HPCC ws topology client

      • get

        public static HPCCWsTopologyClient 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 topology client

      • get

        public static HPCCWsTopologyClient 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 topology client

      • getTopologyGroups

        public List<org.hpccsystems.ws.client.wrappers.gen.wstopology.TpGroupWrapper> getTopologyGroups​(String kind)
                                                                                         throws HpccContainerizedUnsupportedException,
                                                                                                Exception
        Fetch HPCC Topology Groups (data storage planes in containerized mode)
        Parameters:
        kind - - Storage plane kind filter. Ignored in Containerized mode 'Plane'. Baremetal options: 'hthor', 'Thor', or 'Roxie'.
        Returns:
        list of wrapped groups object
        Throws:
        HpccContainerizedUnsupportedException - if kind not provided while targeting baremetal HPCC environment
        Exception - if error encountered

      • getValidTargetGroups

        public List<org.hpccsystems.ws.client.wrappers.gen.wstopology.TpTargetClusterWrapper> getValidTargetGroups()
                                                                                                    throws Exception,
                                                                                                           ArrayOfEspExceptionWrapper
        Get full descriptions of all valid cluster groups on the target HPCC System.
        Returns:
        the valid target groups
        Throws:
        Exception - the exception
        ArrayOfEspExceptionWrapper - the array of esp exception wrapper

      • getValidClusterNames

        public String[] getValidClusterNames​(String clusterGroupType)
                              throws Exception
        Gets the valid cluster names.
        Parameters:
        clusterGroupType - the cluster group type
        Returns:
        the valid cluster names
        Throws:
        Exception - the exception

      • getValidTargetClusterNames

        public String[] getValidTargetClusterNames​(String clusterGroupType)
                                    throws Exception,
                                           ArrayOfEspExceptionWrapper
        Get the names of all available target clusters from a given cluster group (hthor, thor, roxie, Hole, etc).
        Parameters:
        clusterGroupType - -- RoxieCluster, HoleCluster
        Returns:
        the valid target cluster names
        Throws:
        Exception - the exception
        ArrayOfEspExceptionWrapper - the array of esp exception wrapper

      • getValidTargetClusterNamesArray

        public String[] getValidTargetClusterNamesArray()
                                         throws Exception,
                                                ArrayOfEspExceptionWrapper
        Get the names of all available target clusters (mythor, myroxie, etc.) from all cluster groups (hthor, thor, roxie, etc)
        Returns:
        the valid target cluster names array
        Throws:
        Exception - the exception
        ArrayOfEspExceptionWrapper - the array of esp exception wrapper

      • 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