NetHelper (Plugins 9.1.00-SNAPSHOT API)

java.lang.Object
- com.bmc.arsys.plugins.snmp.helper.NetHelper

public final class NetHelper
extends Object

Field Summary

Fields
Modifier and Type	Field and Description
`static Pattern`	`EMAIL_ADDRESS` This pattern matches valid E-mail addresses
`static Pattern`	`FQDN_HOST_NAME` Checks domain names.
`static Pattern`	`IP_ADDRESS` This pattern may be used to find a valid ip address in a string.
`static Pattern`	`LAX_FQDN_HOST_NAME` Checks domain names.
`static int`	`MAXIMUM_PORT` Field MAXIMUM_PORT (65535)
`static int`	`MAXIMUM_RESTRICTED_PORT` Field MAXIMUM_RESTRICTED_PORT (1023)
`static int`	`MINIMUM_PORT` Field MINIMUM_PORT (0)
`static Pattern`	`URL` Looks for standard, simple URL's not contained by any real delimiters.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`canBindPort(int port)` This method will indicate whether or not a server socket can be created on the provided port or not, if not, most likely another process already has it bound and is listening on it.
`static boolean`	`canGetIPForHostName(String hostName)` Determines if you can get an IP for a host name
`static String`	`getBestFQDNMatch(String hostName)` Determines a FQDN for the specified host name.
`static String`	`getLocalHostIP()` Gets the local host IP
`static String`	`getPrettyHostName(String hostName)` Gets a pretty version of a host name that cleans up capitalization
`static boolean`	`isActiveHostName(String hostName)` Determines if a host name is acceptable.
`static boolean`	`isActiveIP(String ipAddress)` Determines if an IP is acceptable.
`static boolean`	`isIPv6LiteralAddress(String src)` Determines if IPV6 literal address
`static boolean`	`isLocalHostName(String hostName)` Determines if a host name is a reference to the local machine
`static boolean`	`isPortBound(String host, int port)` This method will indicate whether or not a port is bound at the specified host
`static boolean`	`isPortOpen(String host, int port)` This method will indicate whether or not a port is open at the specified host
`static boolean`	`isRestrictedPort(String port)`
`static boolean`	`isValidEmail(String email)` Determines if an E-mail is acceptable
`static boolean`	`isValidFQDNHostName(String hostName)` Determines if a host name is acceptable.
`static boolean`	`isValidIP(String ipAddress)` Determines if an IP is acceptable.
`static boolean`	`isValidIP(String ipAddress, boolean allowIPV6)` Determines if an IP is acceptable.
`static boolean`	`isValidLaxFQDNHostName(String hostName)` This check is almost the same as isValidFQDNHostName except certain characters that are allowed inside a domain (such as underscores) are allowed even though those are invalid by the exact network definition of a valid FQDN that would work outside a domain.
`static boolean`	`isValidURL(String url)` Determines if a URL is acceptable.
`static boolean`	`isValidURL(String url, boolean allowIPV6)` Determines if a URL is acceptable.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

URL
```
public static final Pattern URL
```
Looks for standard, simple URL's not contained by any real delimiters. Requires the protocol to be present. Does not meet RFC 2396 specifications! Sample Matches: http://www.domain.com|http://domain.com Sample Non-Matches: www.domain.com|htp://www.domain.com

FQDN_HOST_NAME
```
public static final Pattern FQDN_HOST_NAME
```
Checks domain names. This validates domains based on latest specifications (RFCs 952 and 1123 dealing with hostnames and RFC 1035 dealing with domain name system requirements) except that it only includes realistic fully-qualified domains: 1. requires at least one subdomain 2. allows shortest top-level domains like "ca". Other validation rules: 1. Labels/parts should be seperated by period. 2. Each label/part has maximum of 63 characters. 3. First and last character of label must be alphanumeric, other characters alphanumeric or hyphen. 4. Does not check maxlength of domain which incidentally is 253 characters of text (255 binary representation). Sample Matches: regexlib.com|this.is.a.museum|3com.com Sample Non-Matches: notadomain-.com|helloworld.c|.oops.org

LAX_FQDN_HOST_NAME
```
public static final Pattern LAX_FQDN_HOST_NAME
```
Checks domain names. This validates domains based on latest specifications (RFCs 952 and 1123 dealing with hostnames and RFC 1035 dealing with domain name system requirements) except that it only includes realistic fully-qualified domains: 1. requires at least one subdomain 2. allows shortest top-level domains like "ca". Other validation rules: 1. Labels/parts should be seperated by period. 2. Each label/part has maximum of 63 characters. 3. First and last character of label must be alphanumeric, other characters alphanumeric or hyphen. 4. Does not check maxlength of domain which incidentally is 253 characters of text (255 binary representation). Sample Matches: regexlib.com|this.is.a.museum|3com.com Sample Non-Matches: notadomain-.com|helloworld.c|.oops.org

IP_ADDRESS

public static final Pattern IP_ADDRESS

This pattern may be used to find a valid ip address in a string. When a Matcher is created from this pattern, the following results may be seen:

String	`matcher.matches()`	`matcher.find()`	`matcher.group( 0 )`
ip address	false	false
209.247.228.221	true	true	209.247.228.221
247.228.221	false	false
www.utexas.edu (128.83.40.145)	false	true	128.83.40.145
064.157.107.097.045	false	true	064.157.107.097
256.4.2.43	false	false
-4.3.2.1	false	true	4.3.2.1

EMAIL_ADDRESS
```
public static final Pattern EMAIL_ADDRESS
```
This pattern matches valid E-mail addresses

MINIMUM_PORT
```
public static final int MINIMUM_PORT
```
Field MINIMUM_PORT (0)

See Also:

Constant Field Values

MAXIMUM_PORT
```
public static final int MAXIMUM_PORT
```
Field MAXIMUM_PORT (65535)

See Also:

Constant Field Values

MAXIMUM_RESTRICTED_PORT
```
public static final int MAXIMUM_RESTRICTED_PORT
```
Field MAXIMUM_RESTRICTED_PORT (1023)

See Also:

Constant Field Values

Method Detail
- isValidURL
```
public static boolean isValidURL(String url)
```
  Determines if a URL is acceptable. Note this does not check to make sure the actual URL exists, just that the String is a valid URL pattern. Note to make sure legacy functionality does not change, this only matches IPV4 addresses and hosts. To also match IPV6 addresses, you need to use the form of this method which also takes a boolean parameter.
  
  Parameters:
  
  url - URL to examine
  
  Returns:
  
  true if the URL is a valid URL String, false otherwise
- isValidURL
```
public static boolean isValidURL(String url,
                                 boolean allowIPV6)
```
  Determines if a URL is acceptable. Note this does not check to make sure the actual URL exists, just that the String is a valid URL pattern.
  
  Parameters:
  
  url - URL to examine
  
  allowIPV6 - whether to allow IPV6
  
  Returns:
  
  true if the URL is a valid URL String, false otherwise
- getPrettyHostName
```
public static String getPrettyHostName(String hostName)
```
  Gets a pretty version of a host name that cleans up capitalization
  
  Parameters:
  
  hostName - original host name
  
  Returns:
  
  pretty host name
- getLocalHostIP
```
public static String getLocalHostIP()
```
  Gets the local host IP
  
  Returns:
  
  local host IP
- isLocalHostName
```
public static boolean isLocalHostName(String hostName)
```
  Determines if a host name is a reference to the local machine
  
  Parameters:
  
  hostName - host name
  
  Returns:
  
  true if the name is the local host, false otherwise
- isValidFQDNHostName
```
public static boolean isValidFQDNHostName(String hostName)
```
  Determines if a host name is acceptable. Note this does not check to make sure the actual host exists, just that the String is a valid host name pattern.
  
  Parameters:
  
  hostName - host name to examine
  
  Returns:
  
  true if the host name is a valid fully-qualified domain name (FQDN), false otherwise
- isValidLaxFQDNHostName
```
public static boolean isValidLaxFQDNHostName(String hostName)
```
  This check is almost the same as isValidFQDNHostName except certain characters that are allowed inside a domain (such as underscores) are allowed even though those are invalid by the exact network definition of a valid FQDN that would work outside a domain.
  
  Parameters:
  
  hostName - host name to examine
  
  Returns:
  
  true if the host name is a valid fully-qualified domain name (FQDN), false otherwise
  
  See Also:
  
  isValidFQDNHostName( String )
- canGetIPForHostName
```
public static boolean canGetIPForHostName(String hostName)
```
  Determines if you can get an IP for a host name
  
  Parameters:
  
  hostName - host name to examine
  
  Returns:
  
  true if an IP can be determined, false otherwise
- isActiveHostName
```
public static boolean isActiveHostName(String hostName)
```
  Determines if a host name is acceptable. Note this does check to make sure the actual host exists, not that the String is a valid host name pattern.
  
  Parameters:
  
  hostName - host name to examine
  
  Returns:
  
  true if the host name is an active host, false otherwise
- isValidIP
```
public static boolean isValidIP(String ipAddress)
```
  Determines if an IP is acceptable. Note this does not check to make sure the actual host exists, just that the String is a valid IP pattern. Note to make sure legacy functionality does not change, this only matches IPV4 addresses. To also match IPV6 addresses, you need to use the form of this method which also takes a boolean parameter.
  
  Parameters:
  
  ipAddress - IP address to examine
  
  Returns:
  
  true if the IP is a valid IP String, false otherwise
- isValidIP
```
public static boolean isValidIP(String ipAddress,
                                boolean allowIPV6)
```
  Determines if an IP is acceptable. Note this does not check to make sure the actual host exists, just that the String is a valid IP pattern.
  
  Parameters:
  
  ipAddress - IP address to examine
  
  allowIPV6 - whether to allow IPV6
  
  Returns:
  
  true if the IP is a valid IP String, false otherwise
- isActiveIP
```
public static boolean isActiveIP(String ipAddress)
```
  Determines if an IP is acceptable. Note this checks to make sure the actual host exists, not that the String is a valid IP pattern.
  
  Parameters:
  
  ipAddress - IP address to examine
  
  Returns:
  
  true if the IP is an active IP, false otherwise
- isRestrictedPort
```
public static boolean isRestrictedPort(String port)
```
- isPortOpen
```
public static boolean isPortOpen(String host,
                                 int port)
```
  This method will indicate whether or not a port is open at the specified host
  
  Parameters:
  
  host - host name to check
  
  port - port to check
  
  Returns:
  
  true if the specified port at the specified host is open, false otherwise
- canBindPort
```
public static boolean canBindPort(int port)
```
  This method will indicate whether or not a server socket can be created on the provided port or not, if not, most likely another process already has it bound and is listening on it.
  
  Parameters:
  
  port - port to check
  
  Returns:
  
  true if a server socket was able to be attached to the provided port, false otherwise
- isPortBound
```
public static boolean isPortBound(String host,
                                  int port)
```
  This method will indicate whether or not a port is bound at the specified host
  
  Parameters:
  
  host - host name to check
  
  port - port to check
  
  Returns:
  
  true if the specified port at the specified host is bound to another process, false otherwise
- isValidEmail
```
public static boolean isValidEmail(String email)
```
  Determines if an E-mail is acceptable
  
  Parameters:
  
  email - E-mail to examine
  
  Returns:
  
  true if the E-mail is a valid E-mail, false otherwise
- getBestFQDNMatch
```
public static String getBestFQDNMatch(String hostName)
```
  Determines a FQDN for the specified host name.
  
  Parameters:
  
  hostName - host name to convert to FQDN
  
  Returns:
  
  FQDN if one is found, otherwise the original input host name.
- isIPv6LiteralAddress
```
public static boolean isIPv6LiteralAddress(String src)
```
  Determines if IPV6 literal address
  
  Parameters:
  
  src - String representing an IPv6 address in textual format
  
  Returns:
  
  boolean indicating whether IPv6 literal address

Class NetHelper

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

URL

FQDN_HOST_NAME

LAX_FQDN_HOST_NAME

IP_ADDRESS

EMAIL_ADDRESS

MINIMUM_PORT

MAXIMUM_PORT

MAXIMUM_RESTRICTED_PORT

Method Detail

isValidURL

isValidURL

getPrettyHostName

getLocalHostIP

isLocalHostName

isValidFQDNHostName

isValidLaxFQDNHostName

canGetIPForHostName

isActiveHostName

isValidIP

isValidIP

isActiveIP

isRestrictedPort

isPortOpen

canBindPort

isPortBound

isValidEmail

getBestFQDNMatch

isIPv6LiteralAddress