org.apache.directory.server.dhcp.messages

Class DhcpMessage

java.lang.Object

org.apache.directory.server.dhcp.messages.DhcpMessage

public class DhcpMessage
extends java.lang.Object

A DHCP (RFC 2131) message. Field descriptions contain the oroginal RFC field names in brackets.

Field Summary

Fields

Modifier and Type	Field and Description
private java.net.InetAddress	assignedClientAddress [yiaddr] 'your' (client) IP address.
private java.lang.String	bootFileName [file] Boot file name, null terminated string; "generic" name or null in DHCPDISCOVER, fully qualified directory-path name in DHCPOFFER.
private java.net.InetAddress	currentClientAddress [ciaddr] Current client IP address; only filled in if client is in BOUND, RENEW or REBINDING state and can respond to ARP requests.
static int	FLAG_BROADCAST Flag value: request broadcast answer.
private short	flags [flags] Flags.
private HardwareAddress	hardwareAddress
private short	hopCount [hops] Client sets to zero, optionally used by relay agents when booting via a relay agent.
private MessageType	messageType The DHCP message type option.
private java.net.InetAddress	nextServerAddress [siaddr] IP address of next server to use in bootstrap; returned in DHCPOFFER, DHCPACK by server.
private byte	op [op] Message op code.
static byte	OP_BOOTREPLY Operation constant: boot reply (server to client).
static byte	OP_BOOTREQUEST Operation constant: boot request (client to server).
private OptionsField	options [options] Optional parameters field.
private java.net.InetAddress	relayAgentAddress [giaddr] Relay agent IP address, used in booting via a relay agent.
private int	seconds [secs] Filled in by client, seconds elapsed since client began address acquisition or renewal process.
private java.lang.String	serverHostname [sname] Optional server host name, null terminated string.
private int	transactionId [xid] Transaction ID, a random number chosen by the client, used by the client and server to associate messages and responses between a client and a server.

Constructor Summary

Constructors

Constructor and Description
DhcpMessage() Create a default dhcp message.
DhcpMessage(MessageType messageType, byte op, HardwareAddress hardwareAddress, short hops, int transactionId, int seconds, short flags, java.net.InetAddress currentClientAddress, java.net.InetAddress assignedClientAddress, java.net.InetAddress nextServerAddress, java.net.InetAddress relayAgentAddress, java.lang.String serverHostname, java.lang.String bootFileName, OptionsField options) Create a DHCP message based on the supplied values.

Method Summary

Modifier and Type	Method and Description
java.net.InetAddress	getAssignedClientAddress()
java.lang.String	getBootFileName()
java.net.InetAddress	getCurrentClientAddress()
short	getFlags()
HardwareAddress	getHardwareAddress()
short	getHopCount()
MessageType	getMessageType()
java.net.InetAddress	getNextServerAddress()
byte	getOp()
OptionsField	getOptions()
java.net.InetAddress	getRelayAgentAddress()
int	getSeconds()
java.lang.String	getServerHostname()
int	getTransactionId()
void	setAssignedClientAddress(java.net.InetAddress assignedClientAddress)
void	setBootFileName(java.lang.String bootFileName)
void	setCurrentClientAddress(java.net.InetAddress currentClientAddress)
void	setFlags(short flags)
void	setHardwareAddress(HardwareAddress hardwareAddress)
void	setHopCount(short hopCount)
void	setMessageType(MessageType messageType)
void	setNextServerAddress(java.net.InetAddress nextServerAddress)
void	setOp(byte op)
void	setOptions(OptionsField options)
void	setRelayAgentAddress(java.net.InetAddress relayAgentAddress)
void	setSeconds(int seconds)
void	setServerHostname(java.lang.String serverHostname)
void	setTransactionId(int transactionId)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

FLAG_BROADCAST

public static final int FLAG_BROADCAST

Flag value: request broadcast answer.

See Also:

Constant Field Values

assignedClientAddress

private java.net.InetAddress assignedClientAddress

[yiaddr] 'your' (client) IP address.

bootFileName

private java.lang.String bootFileName

[file] Boot file name, null terminated string; "generic" name or null in DHCPDISCOVER, fully qualified directory-path name in DHCPOFFER.

currentClientAddress

private java.net.InetAddress currentClientAddress

[ciaddr] Current client IP address; only filled in if client is in BOUND, RENEW or REBINDING state and can respond to ARP requests.

flags

private short flags

[flags] Flags. (LSB is broadcast flag)

hopCount

private short hopCount

[hops] Client sets to zero, optionally used by relay agents when booting via a relay agent.

op

private byte op

[op] Message op code. 1 = BOOTREQUEST, 2 = BOOTREPLY, ...

OP_BOOTREQUEST

public static final byte OP_BOOTREQUEST

Operation constant: boot request (client to server).

See Also:

op, Constant Field Values

OP_BOOTREPLY

public static final byte OP_BOOTREPLY

Operation constant: boot reply (server to client).

See Also:

op, Constant Field Values

nextServerAddress

private java.net.InetAddress nextServerAddress

[siaddr] IP address of next server to use in bootstrap; returned in DHCPOFFER, DHCPACK by server.

options

private OptionsField options

[options] Optional parameters field. See the options documents for a list of defined options.

relayAgentAddress

private java.net.InetAddress relayAgentAddress

[giaddr] Relay agent IP address, used in booting via a relay agent.

seconds

private int seconds

[secs] Filled in by client, seconds elapsed since client began address acquisition or renewal process.

serverHostname

private java.lang.String serverHostname

[sname] Optional server host name, null terminated string.

transactionId

private int transactionId

[xid] Transaction ID, a random number chosen by the client, used by the client and server to associate messages and responses between a client and a server.

messageType

private MessageType messageType

The DHCP message type option.

hardwareAddress

private HardwareAddress hardwareAddress

Constructor Detail

DhcpMessage

public DhcpMessage()

Create a default dhcp message.

DhcpMessage

public DhcpMessage(MessageType messageType,
                   byte op,
                   HardwareAddress hardwareAddress,
                   short hops,
                   int transactionId,
                   int seconds,
                   short flags,
                   java.net.InetAddress currentClientAddress,
                   java.net.InetAddress assignedClientAddress,
                   java.net.InetAddress nextServerAddress,
                   java.net.InetAddress relayAgentAddress,
                   java.lang.String serverHostname,
                   java.lang.String bootFileName,
                   OptionsField options)

Create a DHCP message based on the supplied values.

Parameters:

messageType -

op -

hardwareAddress -

hops -

transactionId -

seconds -

flags -

currentClientAddress -

assignedClientAddress -

nextServerAddress -

relayAgentAddress -

serverHostname -

bootFileName -

options -

Method Detail

getAssignedClientAddress

public java.net.InetAddress getAssignedClientAddress()

getBootFileName

public java.lang.String getBootFileName()

getCurrentClientAddress

public java.net.InetAddress getCurrentClientAddress()

getFlags

public short getFlags()

getHopCount

public short getHopCount()

getMessageType

public MessageType getMessageType()

getNextServerAddress

public java.net.InetAddress getNextServerAddress()

getOptions

public OptionsField getOptions()

getRelayAgentAddress

public java.net.InetAddress getRelayAgentAddress()

getSeconds

public int getSeconds()

getServerHostname

public java.lang.String getServerHostname()

getTransactionId

public int getTransactionId()

setAssignedClientAddress

public void setAssignedClientAddress(java.net.InetAddress assignedClientAddress)

setBootFileName

public void setBootFileName(java.lang.String bootFileName)

setCurrentClientAddress

public void setCurrentClientAddress(java.net.InetAddress currentClientAddress)

setFlags

public void setFlags(short flags)

setHopCount

public void setHopCount(short hopCount)

setMessageType

public void setMessageType(MessageType messageType)

setNextServerAddress

public void setNextServerAddress(java.net.InetAddress nextServerAddress)

setOptions

public void setOptions(OptionsField options)

setRelayAgentAddress

public void setRelayAgentAddress(java.net.InetAddress relayAgentAddress)

setSeconds

public void setSeconds(int seconds)

setServerHostname

public void setServerHostname(java.lang.String serverHostname)

setTransactionId

public void setTransactionId(int transactionId)

getOp

public byte getOp()

setOp

public void setOp(byte op)

getHardwareAddress

public HardwareAddress getHardwareAddress()

setHardwareAddress

public void setHardwareAddress(HardwareAddress hardwareAddress)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object