Interface IHostManager


  • public interface IHostManager
    Manager for retrieving hosts defined in the Topaz Workbench client.
    Since:
    1.0.0
    Version:
    2.0.0
    See Also:
    HostManager.getInstance()
    Restriction:
    This interface is not intended to be extended by clients.
    Restriction:
    This interface is not intended to be implemented by clients.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      com.compuware.api.topaz.hosts.zos.IZOSHost findZOSHost​(String host, int port)
      Returns the z/OS host that is defined in the Topaz Workbench client with the specified host and port.
      List<com.compuware.api.topaz.hosts.zos.IZOSHost> getZOSHosts()
      Returns all z/OS hosts defined in the Topaz Workbench client.
    • Method Detail

      • findZOSHost

        com.compuware.api.topaz.hosts.zos.IZOSHost findZOSHost​(String host,
                                                               int port)
        Returns the z/OS host that is defined in the Topaz Workbench client with the specified host and port.

        Regarding parameter validation for this method:

        A host is considered invalid if:

        • A DNS name is specified that cannot be resolved to an IP address.
        • An IPv4 IP address is specified but does not have exactly 4 period-delimited integer qualifiers between 0 and 255.

        A port is considered invalid if:

        • It is outside the integer range of 0-65535.
        Parameters:
        host - the name or IPv4 IP address of the host
        port - the port
        Returns:
        the host or null if the host can not be found
        Throws:
        IllegalArgumentException - if host is null or invalid, or if port is invalid
        Since:
        1.0.0
      • getZOSHosts

        List<com.compuware.api.topaz.hosts.zos.IZOSHost> getZOSHosts()
        Returns all z/OS hosts defined in the Topaz Workbench client.

        An empty list will be returned if no z/OS hosts are defined in the Topaz Workbench client.

        Returns:
        the list of z/OS hosts
        Since:
        1.0.0