DHCPOptions (Proxy Vole 1.0.6-RC1 API)

java.lang.Object
- com.github.markusbernhardt.proxy.search.wpad.dhcp.DHCPOptions

```
public class DHCPOptions
extends Object
```
This class represents a linked list of options for a DHCP message. Its purpose is to ease option handling such as add, remove or change.

Author:

Markus Bernhardt, Copyright 2016, Jason Goldschmidt and Simon Frankenberger, Bernd Rosstauscher, Copyright 2009

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`OPTION_BOOT_FILESIZE`
`static int`	`OPTION_COOKIE_SERVERS`
`static int`	`OPTION_DHCP_CLASS_IDENTIFIER`
`static int`	`OPTION_DHCP_CLIENT_IDENTIFIER`
`static int`	`OPTION_DHCP_IP_ADRESS_REQUESTED`
`static int`	`OPTION_DHCP_IP_LEASE_TIME`
`static int`	`OPTION_DHCP_MAXIMUM_MESSAGE_SIZE`
`static int`	`OPTION_DHCP_MESSAGE`
`static int`	`OPTION_DHCP_MESSAGE_TYPE`
`static int`	`OPTION_DHCP_OVERLOAD`
`static int`	`OPTION_DHCP_PARAMETER_REQUEST_LIST`
`static int`	`OPTION_DHCP_REBIND_TIME`
`static int`	`OPTION_DHCP_RENEWAL_TIME`
`static int`	`OPTION_DHCP_SERVER_IDENTIFIER`
`static int`	`OPTION_DNS_SERVERS`
`static int`	`OPTION_DOMAIN_NAME`
`static int`	`OPTION_END`
`static int`	`OPTION_EXTENSIONS_PATH`
`static int`	`OPTION_HOSTNAME`
`static int`	`OPTION_IMPRESS_SERVERS`
`static int`	`OPTION_IP_HOST_DEFAULT_TTL`
`static int`	`OPTION_IP_HOST_FORWARDING_ENABLE`
`static int`	`OPTION_IP_HOST_MAXIMUM_DATAGRAM_REASSEMBLY_SIZE`
`static int`	`OPTION_IP_HOST_MTU_AGEING_TIMEOUT`
`static int`	`OPTION_IP_HOST_MTU_PLATEAU_TABLE`
`static int`	`OPTION_IP_HOST_NON_LOCAL_SOURCE_ROUTING_ENABLE`
`static int`	`OPTION_IP_HOST_POLICY_FILTERS`
`static int`	`OPTION_IP_INTERFACE_ALL_SUBNETS_LOCAL_ENABLE`
`static int`	`OPTION_IP_INTERFACE_BROADCAST_ADDRESS`
`static int`	`OPTION_IP_INTERFACE_MASK_SUPPLIER_ENABLE`
`static int`	`OPTION_IP_INTERFACE_MTU`
`static int`	`OPTION_IP_INTERFACE_PERFORM_MASK_DISCOVERY_ENABLE`
`static int`	`OPTION_IP_INTERFACE_PERFORM_ROUTER_DISCOVERY_ENABLE`
`static int`	`OPTION_IP_INTERFACE_ROUTER_SOLICITATION_ADDRESS`
`static int`	`OPTION_IP_INTERFACE_STATIC_ROUTES`
`static int`	`OPTION_LINK_ARP_CACHE_TIMEOUT`
`static int`	`OPTION_LINK_ETHERNET_ENCAPSULATION_ENABLE`
`static int`	`OPTION_LINK_TRAILER_ENCAPSULATION_ENABLE`
`static int`	`OPTION_LOG_SERVERS`
`static int`	`OPTION_LPR_SERVERS`
`static int`	`OPTION_MERIT_DUMPFILE`
`static int`	`OPTION_NAME_SERVERS`
`static int`	`OPTION_NETMASK`
`static int`	`OPTION_NIS_DOMAIN`
`static int`	`OPTION_NIS_SERVERS`
`static int`	`OPTION_NTP_SERVERS`
`static int`	`OPTION_PAD`
`static int`	`OPTION_PROXY_AUTODISCOVERY`
`static int`	`OPTION_RESSOURCE_LOCATION_SERVERS`
`static int`	`OPTION_ROOT_PATH`
`static int`	`OPTION_ROUTERS`
`static int`	`OPTION_SERVICE_NETBOIS_DATAGRAM_DISTRIBUTION_SERVERS`
`static int`	`OPTION_SERVICE_NETBOIS_NAME_SERVERS`
`static int`	`OPTION_SERVICE_NETBOIS_NODE_TYPE`
`static int`	`OPTION_SERVICE_NETBOIS_SCOPE_TYPE`
`static int`	`OPTION_SERVICE_VENDOR_SPECIFIC_INFORMATIONS`
`static int`	`OPTION_SERVICE_X_DISPLAY_MANAGERS`
`static int`	`OPTION_SERVICE_X_FONT_SERVERS`
`static int`	`OPTION_SWAP_SERVER`
`static int`	`OPTION_TCP_DEFAULT_TTL`
`static int`	`OPTION_TCP_KEEP_ALIVE_GERBAGE_ENABLE`
`static int`	`OPTION_TCP_KEEP_ALIVE_INTERVAL`
`static int`	`OPTION_TIME_OFFSET`
`static int`	`OPTION_TIME_SERVERS`

Constructor Summary

Constructors
Constructor and Description

DHCPOptions()

Constructors
Constructor and Description
`DHCPOptions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`contains(byte entryCode)` Returns true if option code is set in list; false otherwise
`byte[]`	`externalize()` Converts a linked options list to a byte array
`byte[]`	`getOption(byte entryCode)` Fetches value of option by its option code
`void`	`internalize(byte[] optionsArray)` Converts an options byte array to a linked list
`boolean`	`isEmpty()` Determines if list is empty
`void`	`printList()` Prints the options linked list: For testing only.
`void`	`removeOption(byte entryCode)` Removes option with specified bytecode
`void`	`setOption(byte entryCode, byte[] value)` Changes an existing option to new value

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

- Field Detail
  - OPTION_PAD
```
public static final int OPTION_PAD
```
    See Also:
    
    Constant Field Values
  - OPTION_NETMASK
```
public static final int OPTION_NETMASK
```
    See Also:
    
    Constant Field Values
  - OPTION_TIME_OFFSET
```
public static final int OPTION_TIME_OFFSET
```
    See Also:
    
    Constant Field Values
  - OPTION_ROUTERS
```
public static final int OPTION_ROUTERS
```
    See Also:
    
    Constant Field Values
  - OPTION_TIME_SERVERS
```
public static final int OPTION_TIME_SERVERS
```
    See Also:
    
    Constant Field Values
  - OPTION_NAME_SERVERS
```
public static final int OPTION_NAME_SERVERS
```
    See Also:
    
    Constant Field Values
  - OPTION_DNS_SERVERS
```
public static final int OPTION_DNS_SERVERS
```
    See Also:
    
    Constant Field Values
  - OPTION_LOG_SERVERS
```
public static final int OPTION_LOG_SERVERS
```
    See Also:
    
    Constant Field Values
  - OPTION_COOKIE_SERVERS
```
public static final int OPTION_COOKIE_SERVERS
```
    See Also:
    
    Constant Field Values
  - OPTION_LPR_SERVERS
```
public static final int OPTION_LPR_SERVERS
```
    See Also:
    
    Constant Field Values
  - OPTION_IMPRESS_SERVERS
```
public static final int OPTION_IMPRESS_SERVERS
```
    See Also:
    
    Constant Field Values
  - OPTION_RESSOURCE_LOCATION_SERVERS
```
public static final int OPTION_RESSOURCE_LOCATION_SERVERS
```
    See Also:
    
    Constant Field Values
  - OPTION_HOSTNAME
```
public static final int OPTION_HOSTNAME
```
    See Also:
    
    Constant Field Values
  - OPTION_BOOT_FILESIZE
```
public static final int OPTION_BOOT_FILESIZE
```
    See Also:
    
    Constant Field Values
  - OPTION_MERIT_DUMPFILE
```
public static final int OPTION_MERIT_DUMPFILE
```
    See Also:
    
    Constant Field Values
  - OPTION_DOMAIN_NAME
```
public static final int OPTION_DOMAIN_NAME
```
    See Also:
    
    Constant Field Values
  - OPTION_SWAP_SERVER
```
public static final int OPTION_SWAP_SERVER
```
    See Also:
    
    Constant Field Values
  - OPTION_ROOT_PATH
```
public static final int OPTION_ROOT_PATH
```
    See Also:
    
    Constant Field Values
  - OPTION_EXTENSIONS_PATH
```
public static final int OPTION_EXTENSIONS_PATH
```
    See Also:
    
    Constant Field Values
  - OPTION_END
```
public static final int OPTION_END
```
    See Also:
    
    Constant Field Values
  - OPTION_IP_HOST_FORWARDING_ENABLE
```
public static final int OPTION_IP_HOST_FORWARDING_ENABLE
```
    See Also:
    
    Constant Field Values
  - OPTION_IP_HOST_NON_LOCAL_SOURCE_ROUTING_ENABLE
```
public static final int OPTION_IP_HOST_NON_LOCAL_SOURCE_ROUTING_ENABLE
```
    See Also:
    
    Constant Field Values
  - OPTION_IP_HOST_POLICY_FILTERS
```
public static final int OPTION_IP_HOST_POLICY_FILTERS
```
    See Also:
    
    Constant Field Values
  - OPTION_IP_HOST_MAXIMUM_DATAGRAM_REASSEMBLY_SIZE
```
public static final int OPTION_IP_HOST_MAXIMUM_DATAGRAM_REASSEMBLY_SIZE
```
    See Also:
    
    Constant Field Values
  - OPTION_IP_HOST_DEFAULT_TTL
```
public static final int OPTION_IP_HOST_DEFAULT_TTL
```
    See Also:
    
    Constant Field Values
  - OPTION_IP_HOST_MTU_AGEING_TIMEOUT
```
public static final int OPTION_IP_HOST_MTU_AGEING_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - OPTION_IP_HOST_MTU_PLATEAU_TABLE
```
public static final int OPTION_IP_HOST_MTU_PLATEAU_TABLE
```
    See Also:
    
    Constant Field Values
  - OPTION_IP_INTERFACE_MTU
```
public static final int OPTION_IP_INTERFACE_MTU
```
    See Also:
    
    Constant Field Values
  - OPTION_IP_INTERFACE_ALL_SUBNETS_LOCAL_ENABLE
```
public static final int OPTION_IP_INTERFACE_ALL_SUBNETS_LOCAL_ENABLE
```
    See Also:
    
    Constant Field Values
  - OPTION_IP_INTERFACE_BROADCAST_ADDRESS
```
public static final int OPTION_IP_INTERFACE_BROADCAST_ADDRESS
```
    See Also:
    
    Constant Field Values
  - OPTION_IP_INTERFACE_PERFORM_MASK_DISCOVERY_ENABLE
```
public static final int OPTION_IP_INTERFACE_PERFORM_MASK_DISCOVERY_ENABLE
```
    See Also:
    
    Constant Field Values
  - OPTION_IP_INTERFACE_MASK_SUPPLIER_ENABLE
```
public static final int OPTION_IP_INTERFACE_MASK_SUPPLIER_ENABLE
```
    See Also:
    
    Constant Field Values
  - OPTION_IP_INTERFACE_PERFORM_ROUTER_DISCOVERY_ENABLE
```
public static final int OPTION_IP_INTERFACE_PERFORM_ROUTER_DISCOVERY_ENABLE
```
    See Also:
    
    Constant Field Values
  - OPTION_IP_INTERFACE_ROUTER_SOLICITATION_ADDRESS
```
public static final int OPTION_IP_INTERFACE_ROUTER_SOLICITATION_ADDRESS
```
    See Also:
    
    Constant Field Values
  - OPTION_IP_INTERFACE_STATIC_ROUTES
```
public static final int OPTION_IP_INTERFACE_STATIC_ROUTES
```
    See Also:
    
    Constant Field Values
  - OPTION_LINK_TRAILER_ENCAPSULATION_ENABLE
```
public static final int OPTION_LINK_TRAILER_ENCAPSULATION_ENABLE
```
    See Also:
    
    Constant Field Values
  - OPTION_LINK_ARP_CACHE_TIMEOUT
```
public static final int OPTION_LINK_ARP_CACHE_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - OPTION_LINK_ETHERNET_ENCAPSULATION_ENABLE
```
public static final int OPTION_LINK_ETHERNET_ENCAPSULATION_ENABLE
```
    See Also:
    
    Constant Field Values
  - OPTION_TCP_DEFAULT_TTL
```
public static final int OPTION_TCP_DEFAULT_TTL
```
    See Also:
    
    Constant Field Values
  - OPTION_TCP_KEEP_ALIVE_INTERVAL
```
public static final int OPTION_TCP_KEEP_ALIVE_INTERVAL
```
    See Also:
    
    Constant Field Values
  - OPTION_TCP_KEEP_ALIVE_GERBAGE_ENABLE
```
public static final int OPTION_TCP_KEEP_ALIVE_GERBAGE_ENABLE
```
    See Also:
    
    Constant Field Values
  - OPTION_NIS_DOMAIN
```
public static final int OPTION_NIS_DOMAIN
```
    See Also:
    
    Constant Field Values
  - OPTION_NIS_SERVERS
```
public static final int OPTION_NIS_SERVERS
```
    See Also:
    
    Constant Field Values
  - OPTION_NTP_SERVERS
```
public static final int OPTION_NTP_SERVERS
```
    See Also:
    
    Constant Field Values
  - OPTION_SERVICE_VENDOR_SPECIFIC_INFORMATIONS
```
public static final int OPTION_SERVICE_VENDOR_SPECIFIC_INFORMATIONS
```
    See Also:
    
    Constant Field Values
  - OPTION_SERVICE_NETBOIS_NAME_SERVERS
```
public static final int OPTION_SERVICE_NETBOIS_NAME_SERVERS
```
    See Also:
    
    Constant Field Values
  - OPTION_SERVICE_NETBOIS_DATAGRAM_DISTRIBUTION_SERVERS
```
public static final int OPTION_SERVICE_NETBOIS_DATAGRAM_DISTRIBUTION_SERVERS
```
    See Also:
    
    Constant Field Values
  - OPTION_SERVICE_NETBOIS_NODE_TYPE
```
public static final int OPTION_SERVICE_NETBOIS_NODE_TYPE
```
    See Also:
    
    Constant Field Values
  - OPTION_SERVICE_NETBOIS_SCOPE_TYPE
```
public static final int OPTION_SERVICE_NETBOIS_SCOPE_TYPE
```
    See Also:
    
    Constant Field Values
  - OPTION_SERVICE_X_FONT_SERVERS
```
public static final int OPTION_SERVICE_X_FONT_SERVERS
```
    See Also:
    
    Constant Field Values
  - OPTION_SERVICE_X_DISPLAY_MANAGERS
```
public static final int OPTION_SERVICE_X_DISPLAY_MANAGERS
```
    See Also:
    
    Constant Field Values
  - OPTION_DHCP_IP_ADRESS_REQUESTED
```
public static final int OPTION_DHCP_IP_ADRESS_REQUESTED
```
    See Also:
    
    Constant Field Values
  - OPTION_DHCP_IP_LEASE_TIME
```
public static final int OPTION_DHCP_IP_LEASE_TIME
```
    See Also:
    
    Constant Field Values
  - OPTION_DHCP_OVERLOAD
```
public static final int OPTION_DHCP_OVERLOAD
```
    See Also:
    
    Constant Field Values
  - OPTION_DHCP_MESSAGE_TYPE
```
public static final int OPTION_DHCP_MESSAGE_TYPE
```
    See Also:
    
    Constant Field Values
  - OPTION_DHCP_SERVER_IDENTIFIER
```
public static final int OPTION_DHCP_SERVER_IDENTIFIER
```
    See Also:
    
    Constant Field Values
  - OPTION_DHCP_PARAMETER_REQUEST_LIST
```
public static final int OPTION_DHCP_PARAMETER_REQUEST_LIST
```
    See Also:
    
    Constant Field Values
  - OPTION_DHCP_MESSAGE
```
public static final int OPTION_DHCP_MESSAGE
```
    See Also:
    
    Constant Field Values
  - OPTION_DHCP_MAXIMUM_MESSAGE_SIZE
```
public static final int OPTION_DHCP_MAXIMUM_MESSAGE_SIZE
```
    See Also:
    
    Constant Field Values
  - OPTION_DHCP_RENEWAL_TIME
```
public static final int OPTION_DHCP_RENEWAL_TIME
```
    See Also:
    
    Constant Field Values
  - OPTION_DHCP_REBIND_TIME
```
public static final int OPTION_DHCP_REBIND_TIME
```
    See Also:
    
    Constant Field Values
  - OPTION_DHCP_CLASS_IDENTIFIER
```
public static final int OPTION_DHCP_CLASS_IDENTIFIER
```
    See Also:
    
    Constant Field Values
  - OPTION_DHCP_CLIENT_IDENTIFIER
```
public static final int OPTION_DHCP_CLIENT_IDENTIFIER
```
    See Also:
    
    Constant Field Values
  - OPTION_PROXY_AUTODISCOVERY
```
public static final int OPTION_PROXY_AUTODISCOVERY
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DHCPOptions
```
public DHCPOptions()
```
- Method Detail
  - removeOption
```
public void removeOption(byte entryCode)
```
    Removes option with specified bytecode
    
    Parameters:
    
    entryCode - The code of option to be removed
  - contains
```
public boolean contains(byte entryCode)
```
    Returns true if option code is set in list; false otherwise
    
    Parameters:
    
    entryCode - The node's option code
    
    Returns:
    
    true if option is set, otherwise false
  - isEmpty
```
public boolean isEmpty()
```
    Determines if list is empty
    
    Returns:
    
    true if there are no options set, otherwise false
  - getOption
```
public byte[] getOption(byte entryCode)
```
    Fetches value of option by its option code
    
    Parameters:
    
    entryCode - The node's option code
    
    Returns:
    
    byte array containing the value of option entryCode. null is returned if option is not set.
  - setOption
```
public void setOption(byte entryCode,
                      byte[] value)
```
    Changes an existing option to new value
    
    Parameters:
    
    entryCode - The node's option code
    
    value - Content of node option
  - internalize
```
public void internalize(byte[] optionsArray)
```
    Converts an options byte array to a linked list
    
    Parameters:
    
    optionsArray - The byte array representation of the options list
  - externalize
```
public byte[] externalize()
```
    Converts a linked options list to a byte array
    
    Returns:
    
    array representation of optionsTable
  - printList
```
public void printList()
```
    Prints the options linked list: For testing only.

Class DHCPOptions

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

OPTION_PAD

OPTION_NETMASK

OPTION_TIME_OFFSET

OPTION_ROUTERS

OPTION_TIME_SERVERS

OPTION_NAME_SERVERS

OPTION_DNS_SERVERS

OPTION_LOG_SERVERS

OPTION_COOKIE_SERVERS

OPTION_LPR_SERVERS

OPTION_IMPRESS_SERVERS

OPTION_RESSOURCE_LOCATION_SERVERS

OPTION_HOSTNAME

OPTION_BOOT_FILESIZE

OPTION_MERIT_DUMPFILE

OPTION_DOMAIN_NAME

OPTION_SWAP_SERVER

OPTION_ROOT_PATH

OPTION_EXTENSIONS_PATH

OPTION_END

OPTION_IP_HOST_FORWARDING_ENABLE

OPTION_IP_HOST_NON_LOCAL_SOURCE_ROUTING_ENABLE

OPTION_IP_HOST_POLICY_FILTERS

OPTION_IP_HOST_MAXIMUM_DATAGRAM_REASSEMBLY_SIZE

OPTION_IP_HOST_DEFAULT_TTL

OPTION_IP_HOST_MTU_AGEING_TIMEOUT

OPTION_IP_HOST_MTU_PLATEAU_TABLE

OPTION_IP_INTERFACE_MTU

OPTION_IP_INTERFACE_ALL_SUBNETS_LOCAL_ENABLE

OPTION_IP_INTERFACE_BROADCAST_ADDRESS

OPTION_IP_INTERFACE_PERFORM_MASK_DISCOVERY_ENABLE

OPTION_IP_INTERFACE_MASK_SUPPLIER_ENABLE

OPTION_IP_INTERFACE_PERFORM_ROUTER_DISCOVERY_ENABLE

OPTION_IP_INTERFACE_ROUTER_SOLICITATION_ADDRESS

OPTION_IP_INTERFACE_STATIC_ROUTES

OPTION_LINK_TRAILER_ENCAPSULATION_ENABLE

OPTION_LINK_ARP_CACHE_TIMEOUT

OPTION_LINK_ETHERNET_ENCAPSULATION_ENABLE

OPTION_TCP_DEFAULT_TTL

OPTION_TCP_KEEP_ALIVE_INTERVAL

OPTION_TCP_KEEP_ALIVE_GERBAGE_ENABLE

OPTION_NIS_DOMAIN

OPTION_NIS_SERVERS

OPTION_NTP_SERVERS

OPTION_SERVICE_VENDOR_SPECIFIC_INFORMATIONS

OPTION_SERVICE_NETBOIS_NAME_SERVERS

OPTION_SERVICE_NETBOIS_DATAGRAM_DISTRIBUTION_SERVERS

OPTION_SERVICE_NETBOIS_NODE_TYPE

OPTION_SERVICE_NETBOIS_SCOPE_TYPE

OPTION_SERVICE_X_FONT_SERVERS

OPTION_SERVICE_X_DISPLAY_MANAGERS

OPTION_DHCP_IP_ADRESS_REQUESTED

OPTION_DHCP_IP_LEASE_TIME

OPTION_DHCP_OVERLOAD

OPTION_DHCP_MESSAGE_TYPE

OPTION_DHCP_SERVER_IDENTIFIER

OPTION_DHCP_PARAMETER_REQUEST_LIST

OPTION_DHCP_MESSAGE

OPTION_DHCP_MAXIMUM_MESSAGE_SIZE

OPTION_DHCP_RENEWAL_TIME

OPTION_DHCP_REBIND_TIME

OPTION_DHCP_CLASS_IDENTIFIER

OPTION_DHCP_CLIENT_IDENTIFIER

OPTION_PROXY_AUTODISCOVERY

Constructor Detail

DHCPOptions

Method Detail

removeOption

contains

isEmpty

getOption

setOption

internalize

externalize