Package com.compuware.api.topaz.hosts
Interface IHost
-
- All Known Subinterfaces:
IZOSHost
public interface IHost
Generic interface for a host.- Since:
- 1.0.0
- Version:
- 2.0.0
- 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 String
getDescription()
Returns the description of this host as specified in its definition.String
getIPAddress()
Returns the IPv4 IP address of this host.String
getName()
Returns the name of this host as specified in its definition.HostType
getType()
Returns the type of this host.boolean
isReachable()
Returns whether this host can be reached to establish a connection.
-
-
-
Method Detail
-
getDescription
String getDescription()
Returns the description of this host as specified in its definition.If no description was defined for this host, this method will return an empty
String
.- Returns:
- the description or an empty
String
- Since:
- 1.0.0
-
getIPAddress
String getIPAddress()
Returns the IPv4 IP address of this host.- Returns:
- the IPv4 IP address
- Since:
- 1.0.0
-
getName
String getName()
Returns the name of this host as specified in its definition.If the host's name cannot be determined using reverse name lookup, this method will return the IPv4 IP address.
- Returns:
- the host's name or IPv4 IP address
- Since:
- 1.0.0
-
getType
HostType getType()
Returns the type of this host.- Returns:
- the host type
- Since:
- 1.0.0
-
isReachable
boolean isReachable()
Returns whether this host can be reached to establish a connection.- Returns:
true
if the host can be reached,false
otherwise- Throws:
HostNotDefinedException
- if this host is no longer defined- Since:
- 1.0.0
-
-