org.virtualbox_6_1
Class IDHCPConfig

java.lang.Object
  extended by org.virtualbox_6_1.IUnknown
      extended by org.virtualbox_6_1.IDHCPConfig
Direct Known Subclasses:
IDHCPGlobalConfig, IDHCPGroupConfig, IDHCPIndividualConfig

public class IDHCPConfig
extends IUnknown

The DHCP server has several configuration levels: global, group and individual MAC. This interface implements the settings common to each level. Interface ID: {00F4A8DC-0002-4B81-0077-1DCB004571BA}


Field Summary
 
Fields inherited from class org.virtualbox_6_1.IUnknown
obj, objMgr, port
 
Constructor Summary
IDHCPConfig(java.lang.String wrapped, org.virtualbox_6_1.ObjectRefManager objMgr, org.virtualbox_6_1.jaxws.VboxPortType port)
           
 
Method Summary
 java.util.List<java.lang.String> getAllOptions(Holder<java.util.List<DHCPOption>> options, Holder<java.util.List<DHCPOptionEncoding>> encodings)
          Gets all DHCP options and their values
 java.lang.Long getDefaultLeaseTime()
          The default lease time in seconds, ignored if zero.
 java.util.List<DHCPOption> getForcedOptions()
          List of DHCP options which should be forced upon the clients in this config scope when they are available, whether the clients asks for them or not.
 java.lang.Long getMaxLeaseTime()
          The maximum lease time in seconds, ignored if zero.
 java.lang.Long getMinLeaseTime()
          The minimum lease time in seconds, ignored if zero.
 java.lang.String getOption(DHCPOption option, Holder<DHCPOptionEncoding> encoding)
          Gets the value of a single DHCP option.
 DHCPConfigScope getScope()
          Indicates the kind of config this is (mostly for IDHCPIndividualConfig).
 java.util.List<DHCPOption> getSuppressedOptions()
          List of DHCP options which should not be sent to the clients in this config scope.
static IDHCPConfig queryInterface(IUnknown obj)
           
 void remove()
          Remove this group or individual configuration.
 void removeAllOptions()
          Removes all the options.
 void removeOption(DHCPOption option)
          Removes the given DHCP option.
 void setDefaultLeaseTime(java.lang.Long value)
          The default lease time in seconds, ignored if zero.
 void setForcedOptions(java.util.List<DHCPOption> value)
          List of DHCP options which should be forced upon the clients in this config scope when they are available, whether the clients asks for them or not.
 void setMaxLeaseTime(java.lang.Long value)
          The maximum lease time in seconds, ignored if zero.
 void setMinLeaseTime(java.lang.Long value)
          The minimum lease time in seconds, ignored if zero.
 void setOption(DHCPOption option, DHCPOptionEncoding encoding, java.lang.String value)
          Sets a DHCP option.
 void setSuppressedOptions(java.util.List<DHCPOption> value)
          List of DHCP options which should not be sent to the clients in this config scope.
 
Methods inherited from class org.virtualbox_6_1.IUnknown
getObjMgr, getRemoteWSPort, getWrapped, releaseRemote
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IDHCPConfig

public IDHCPConfig(java.lang.String wrapped,
                   org.virtualbox_6_1.ObjectRefManager objMgr,
                   org.virtualbox_6_1.jaxws.VboxPortType port)
Method Detail

getScope

public DHCPConfigScope getScope()
Indicates the kind of config this is (mostly for IDHCPIndividualConfig).

Returns:
org.virtualbox_6_1.DHCPConfigScope

getMinLeaseTime

public java.lang.Long getMinLeaseTime()
The minimum lease time in seconds, ignored if zero.

Returns:
Long

setMinLeaseTime

public void setMinLeaseTime(java.lang.Long value)
The minimum lease time in seconds, ignored if zero.

Parameters:
value - Long

getDefaultLeaseTime

public java.lang.Long getDefaultLeaseTime()
The default lease time in seconds, ignored if zero.

Returns:
Long

setDefaultLeaseTime

public void setDefaultLeaseTime(java.lang.Long value)
The default lease time in seconds, ignored if zero.

Parameters:
value - Long

getMaxLeaseTime

public java.lang.Long getMaxLeaseTime()
The maximum lease time in seconds, ignored if zero.

Returns:
Long

setMaxLeaseTime

public void setMaxLeaseTime(java.lang.Long value)
The maximum lease time in seconds, ignored if zero.

Parameters:
value - Long

getForcedOptions

public java.util.List<DHCPOption> getForcedOptions()
List of DHCP options which should be forced upon the clients in this config scope when they are available, whether the clients asks for them or not.

Returns:
List<org.virtualbox_6_1.DHCPOption>

setForcedOptions

public void setForcedOptions(java.util.List<DHCPOption> value)
List of DHCP options which should be forced upon the clients in this config scope when they are available, whether the clients asks for them or not.

Parameters:
value - List<org.virtualbox_6_1.DHCPOption>

getSuppressedOptions

public java.util.List<DHCPOption> getSuppressedOptions()
List of DHCP options which should not be sent to the clients in this config scope. This is intended for cases where one client or a group of clients shouldn't see one or more (typically global) options.

Returns:
List<org.virtualbox_6_1.DHCPOption>

setSuppressedOptions

public void setSuppressedOptions(java.util.List<DHCPOption> value)
List of DHCP options which should not be sent to the clients in this config scope. This is intended for cases where one client or a group of clients shouldn't see one or more (typically global) options.

Parameters:
value - List<org.virtualbox_6_1.DHCPOption>

queryInterface

public static IDHCPConfig queryInterface(IUnknown obj)

setOption

public void setOption(DHCPOption option,
                      DHCPOptionEncoding encoding,
                      java.lang.String value)
Sets a DHCP option.

Parameters:
option - The DHCP option.
encoding - The value encoding.
value - The DHCP option value. The exact format depends on the DHCP option value and encoding, see seeDHCPOptionfor theDHCPOptionEncoding.Normalformat.

removeOption

public void removeOption(DHCPOption option)
Removes the given DHCP option.


removeAllOptions

public void removeAllOptions()
Removes all the options. One exception here is the DhcpOpt_SubnetMask option in the global scope that is linked to theIDHCPServer.getNetworkMask()attribute and therefore cannot be removed.


getOption

public java.lang.String getOption(DHCPOption option,
                                  Holder<DHCPOptionEncoding> encoding)
Gets the value of a single DHCP option.

Parameters:
option - The DHCP option being sought.
encoding - The value encoding.
Returns:
The value of the requested DHCP option. The exact format depends on the DHCP option value and the encoding, seeDHCPOptionfor theDHCPOptionEncoding.Normalformat.

getAllOptions

public java.util.List<java.lang.String> getAllOptions(Holder<java.util.List<DHCPOption>> options,
                                                      Holder<java.util.List<DHCPOptionEncoding>> encodings)
Gets all DHCP options and their values

Parameters:
options - Array containing the DHCP option numbers.
encodings - Array of value encodings that runs parallel to options.
Returns:
Array of values that runs parallel to options and encodings. The format depends on both of those.

remove

public void remove()
Remove this group or individual configuration. Will of course not work on global configurations.