Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.net

Class IpAddress

java.lang.Object

com.aoindustries.aoserv.client.AoservObject<Integer,IpAddress>

com.aoindustries.aoserv.client.CachedObject<Integer,IpAddress>

com.aoindustries.aoserv.client.CachedObjectIntegerKey<IpAddress>

com.aoindustries.aoserv.client.net.IpAddress

All Implemented Interfaces:

Streamable, StreamReadable, StreamWritable, Row, AoservReadable, AoservStreamable, AoservWritable, SingleTableObject<Integer,IpAddress>

public final class IpAddress
extends CachedObjectIntegerKey<IpAddress>

Each IpAddress represents a unique IPv4 address. Two of the IP addresses exist on every server, WILDCARD_IP and LOOPBACK_IP. Every other IP address is assigned to a specific Server. IP addresses may be assigned to a specific Package and may have a monthly rate associated with them.

Author:

AO Industries, Inc.

See Also:

• Host
• Package
• Bind
• PrivateServer

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COLUMN_DEVICE_name
static final String	COLUMN_IP_ADDRESS_name
static final String	LOOPBACK_IP
static final String	WILDCARD_IP

Fields inherited from class com.aoindustries.aoserv.client.CachedObjectIntegerKey

pkey

Fields inherited from class com.aoindustries.aoserv.client.CachedObject

table

Fields inherited from class com.aoindustries.aoserv.client.AoservObject

USE_ARRAY_OF_DOMAIN, USE_SQL_DATA, USE_SQL_DATA_WRITE

Constructor Summary

Constructors

Constructor	Description
IpAddress()	Deprecated. Only required for implementation, do not use directly.

Method Summary

Modifier and Type	Method	Description
protected Object	getColumnImpl(int i)
UnmodifiableTimestamp	getCreated()	Determines when this IpAddress was created.
Device	getDevice()
int	getDevice_id()
InetAddress	getExternalInetAddress()	Gets the external IP address, if different than ip_address.
DomainName	getHostname()
int	getId()
InetAddress	getInetAddress()
static Integer	getIntForIpAddress(String ipAddress)
static String	getIpAddressForInt(int i)
IpAddressMonitoring	getMonitoring()
List<Bind>	getNetBinds()
String	getNetMask()
Package	getPackage()
int	getPackage_id()
Table.TableId	getTableId()
void	init(ResultSet result)	Initializes this object from the raw database contents.
boolean	isAlias()
boolean	isAvailable()
boolean	isDhcp()
boolean	isOverflow()
boolean	isUsed()
boolean	isWildcard()	Deprecated. Replace with getInetAddress().isUnspecified()
void	moveTo(Host server)
void	read(StreamableInput in, AoservProtocol.Version protocolVersion)
void	setDhcpAddress(InetAddress ipAddress)
void	setHostname(DomainName hostname)	Sets the hostname for this IpAddress.
void	setPackage(Package pk)	Sets the Package.
void	write(StreamableOutput out, AoservProtocol.Version protocolVersion)

Methods inherited from class com.aoindustries.aoserv.client.CachedObjectIntegerKey

equals, getKey, getPkey, hashCode, toStringImpl

Methods inherited from class com.aoindustries.aoserv.client.CachedObject

getTable, setTable

Methods inherited from class com.aoindustries.aoserv.client.AoservObject

compare, compare, compare, compare, compareIgnoreCaseConsistentWithEquals, compareTo, compareTo, compareTo, getAccountingCode, getColumn, getColumns, getColumns, getDomainLabel, getDomainLabels, getDomainName, getDto, getEmail, getGecos, getGroupId, getHashedKey, getHashedPassword, getHostname, getInetAddress, getLinuxId, getLinuxUserName, getMacAddress, getMysqlDatabaseName, getMysqlServerName, getMysqlUserName, getPort, getPostgresDatabaseName, getPostgresServerName, getPostgresUserId, getTableSchema, getTimeMillis, getTimeMillis, getUnixPath, getUserId, read, toString, write

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

COLUMN_IP_ADDRESS_name

public static final String COLUMN_IP_ADDRESS_name

See Also:

• Constant Field Values

COLUMN_DEVICE_name

public static final String COLUMN_DEVICE_name

See Also:

• Constant Field Values

LOOPBACK_IP

public static final String LOOPBACK_IP

See Also:

• Constant Field Values

WILDCARD_IP

public static final String WILDCARD_IP

See Also:

• Constant Field Values

Constructor Details

IpAddress

@Deprecated
public IpAddress()

Deprecated.

Only required for implementation, do not use directly.

See Also:

• init(java.sql.ResultSet)
• read(com.aoapps.hodgepodge.io.stream.StreamableInput, com.aoindustries.aoserv.client.schema.AoservProtocol.Version)

Method Details

getIntForIpAddress

public static Integer getIntForIpAddress(String ipAddress)
                                  throws IllegalArgumentException

Throws:

IllegalArgumentException

getIpAddressForInt

public static String getIpAddressForInt(int i)

getColumnImpl

protected Object getColumnImpl(int i)

Specified by:

getColumnImpl in class AoservObject<Integer,IpAddress>

getId

public int getId()

getInetAddress

public InetAddress getInetAddress()

getDevice_id

public int getDevice_id()

getDevice

public Device getDevice()
                 throws SQLException,
IOException

Throws:

SQLException

IOException

isAlias

public boolean isAlias()

getHostname

public DomainName getHostname()

getPackage_id

public int getPackage_id()

getPackage

public Package getPackage()
                   throws IOException,
SQLException

Throws:

IOException

SQLException

getCreated

public UnmodifiableTimestamp getCreated()

Determines when this IpAddress was created. The created time is reset when the address is allocated to a different Package, which allows the automated accounting to start the billing on the correct day of the month.

getNetBinds

public List<Bind> getNetBinds()
                       throws IOException,
SQLException

Throws:

IOException

SQLException

isAvailable

public boolean isAvailable()

isOverflow

public boolean isOverflow()

isDhcp

public boolean isDhcp()

getExternalInetAddress

public InetAddress getExternalInetAddress()

Gets the external IP address, if different than ip_address.

getNetMask

public String getNetMask()

getTableId

public Table.TableId getTableId()

Specified by:

getTableId in class AoservObject<Integer,IpAddress>

init

public void init(ResultSet result)
          throws SQLException

Description copied from class: AoservObject

Initializes this object from the raw database contents.

Specified by:

init in class AoservObject<Integer,IpAddress>

Parameters:

result - the ResultSet containing the row to copy into this object

Throws:

SQLException

read

public void read(StreamableInput in,
 AoservProtocol.Version protocolVersion)
          throws IOException

Specified by:

read in interface AoservReadable

Specified by:

read in interface AoservStreamable

Specified by:

read in class AoservObject<Integer,IpAddress>

Throws:

IOException

write

public void write(StreamableOutput out,
 AoservProtocol.Version protocolVersion)
           throws IOException

Specified by:

write in interface AoservStreamable

Specified by:

write in interface AoservWritable

Specified by:

write in class AoservObject<Integer,IpAddress>

Throws:

IOException

isUsed

public boolean isUsed()
               throws IOException,
SQLException

Throws:

IOException

SQLException

isWildcard

@Deprecated
public boolean isWildcard()

Deprecated.

Replace with getInetAddress().isUnspecified()

moveTo

public void moveTo(Host server)
            throws IOException,
SQLException

Throws:

IOException

SQLException

setHostname

public void setHostname(DomainName hostname)
                 throws IOException,
SQLException

Sets the hostname for this IpAddress.

Throws:

IOException

SQLException

setPackage

public void setPackage(Package pk)
                throws IOException,
SQLException

Sets the Package. The package may only be set if the IP Address is not used by other resources.

Throws:

IOException

SQLException

setDhcpAddress

public void setDhcpAddress(InetAddress ipAddress)
                    throws IOException,
SQLException

Throws:

IOException

SQLException

getMonitoring

public IpAddressMonitoring getMonitoring()
                                  throws IOException,
SQLException

Throws:

IOException

SQLException