com.cisco.provisioning.cpe.extensions.configuration
Enum DHCPOper

java.lang.Object
  java.lang.Enum<DHCPOper>
      com.cisco.provisioning.cpe.extensions.configuration.DHCPOper

All Implemented Interfaces:

Serializable, Comparable<DHCPOper>

public enum DHCPOper
extends Enum<DHCPOper>

Enumerated type for specifying DHCPConfig command operations.

Enum Constant Summary

DROP_IF_MAX_IA_ADDRESSES_EXCEEDED
DHCPConfig command operation: drop packet is maximum IA Addresses exceeded Requires the provisioning group to be enabled for ProvGroupCapabilitiesKeys.DHCP_CONFIGURATION_V3 or greater.

PUT_APPEND
DHCPConfig command operation: put append.

PUT_APPEND_ADDITIONAL
DHCPConfig command operation: put append additional.

PUT_APPEND_SUBOPTION
DHCPConfig command operation: put append suboption.

PUT_AUGMENT
DHCPConfig command operation: put augment.

PUT_OPTION
DHCPConfig command operation: put option.

PUT_REPLACE
DHCPConfig command operation: put replace.

REMOVE
DHCPConfig command operation: remove.

REMOVE_OPTION
DHCPConfig command operation: remove option.

RESERVED_0
Reserved for future use.

RESERVED_5
Reserved for future use.

UPDATE_IP_ADDRESS
DHCPConfig command operation: update IP address.

UPDATE_IPV6_ADDRESS
DHCPConfig command operation: update IPv6 address.

VALIDATE
DHCPConfig command operation: validate.

VALIDATE_CONTINUE
DHCPConfig command operation: validate continue.

VALIDATE_IS_V4
DHCPConfig command operation: validate extension is being called for a DHCPv4 packet.

VALIDATE_IS_V6
DHCPConfig command operation: validate extension is being called for a DHCPv6 packet.

VALIDATE_NO_MATCH
DHCPConfig command operation: validate no match.

VALIDATE_NO_MATCH_CONTINUE
DHCPConfig command operation: validate no match continue.

VALIDATE_OPTION
DHCPConfig command operation: validate option.

VALIDATE_OPTION_CONTINUE
DHCPConfig command operation: validate option continue.

VALIDATE_PREFIX
DHCPConfig command operation: validate prefix.

VALIDATE_PREFIX_CONTINUE
DHCPConfig command operation: validate prefix continue.

Method Summary

boolean	isAvailable(Capabilities capabilities) Returns true if this DHCPOper is available in the given provisioning group.
boolean	isCNROptionArgumentArrayRequired() Returns true if this operation requires the use of a CNROptionArgumentArray.
boolean	isSpecialValueSupported() Returns true if this operation supports DHCPSpecialValue values.
boolean	isValueRequired() Returns true if this operation requires a value.
static DHCPOper	valueOf(String name) Returns the enum constant of this type with the specified name.
static DHCPOper[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

RESERVED_0

public static final DHCPOper RESERVED_0

Reserved for future use.

PUT_REPLACE

public static final DHCPOper PUT_REPLACE

DHCPConfig command operation: put replace.

Requires the provisioning group to be enabled for ProvGroupCapabilitiesKeys.DHCP_CONFIGURATION_V1 or greater.

PUT_APPEND

public static final DHCPOper PUT_APPEND

DHCPConfig command operation: put append.

Requires the provisioning group to be enabled for ProvGroupCapabilitiesKeys.DHCP_CONFIGURATION_V1 or greater.

PUT_AUGMENT

public static final DHCPOper PUT_AUGMENT

DHCPConfig command operation: put augment.

Requires the provisioning group to be enabled for ProvGroupCapabilitiesKeys.DHCP_CONFIGURATION_V1 or greater.

REMOVE

public static final DHCPOper REMOVE

DHCPConfig command operation: remove.

Requires the provisioning group to be enabled for ProvGroupCapabilitiesKeys.DHCP_CONFIGURATION_V1 or greater.

RESERVED_5

public static final DHCPOper RESERVED_5

Reserved for future use.

VALIDATE

public static final DHCPOper VALIDATE

DHCPConfig command operation: validate.

Requires the provisioning group to be enabled for ProvGroupCapabilitiesKeys.DHCP_CONFIGURATION_V1 or greater.

UPDATE_IP_ADDRESS

public static final DHCPOper UPDATE_IP_ADDRESS

DHCPConfig command operation: update IP address.

Requires the provisioning group to be enabled for ProvGroupCapabilitiesKeys.DHCP_CONFIGURATION_V1 or greater.

PUT_APPEND_ADDITIONAL

public static final DHCPOper PUT_APPEND_ADDITIONAL

DHCPConfig command operation: put append additional.

Requires the provisioning group to be enabled for ProvGroupCapabilitiesKeys.DHCP_CONFIGURATION_V1 or greater.

PUT_APPEND_SUBOPTION

public static final DHCPOper PUT_APPEND_SUBOPTION

DHCPConfig command operation: put append suboption.

Requires the provisioning group to be enabled for ProvGroupCapabilitiesKeys.DHCP_CONFIGURATION_V1 or greater.

VALIDATE_CONTINUE

public static final DHCPOper VALIDATE_CONTINUE

DHCPConfig command operation: validate continue.

Requires the provisioning group to be enabled for ProvGroupCapabilitiesKeys.DHCP_CONFIGURATION_V1 or greater.

VALIDATE_PREFIX

public static final DHCPOper VALIDATE_PREFIX

DHCPConfig command operation: validate prefix.

Requires the provisioning group to be enabled for ProvGroupCapabilitiesKeys.DHCP_CONFIGURATION_V2 or greater.

VALIDATE_PREFIX_CONTINUE

public static final DHCPOper VALIDATE_PREFIX_CONTINUE

DHCPConfig command operation: validate prefix continue.

Requires the provisioning group to be enabled for ProvGroupCapabilitiesKeys.DHCP_CONFIGURATION_V2 or greater.

VALIDATE_NO_MATCH

public static final DHCPOper VALIDATE_NO_MATCH

DHCPConfig command operation: validate no match.

Requires the provisioning group to be enabled for ProvGroupCapabilitiesKeys.DHCP_CONFIGURATION_V2 or greater.

VALIDATE_NO_MATCH_CONTINUE

public static final DHCPOper VALIDATE_NO_MATCH_CONTINUE

DHCPConfig command operation: validate no match continue.

Requires the provisioning group to be enabled for ProvGroupCapabilitiesKeys.DHCP_CONFIGURATION_V2 or greater.

PUT_OPTION

public static final DHCPOper PUT_OPTION

DHCPConfig command operation: put option.

Requires the provisioning group to be enabled for ProvGroupCapabilitiesKeys.DHCP_CONFIGURATION_V3 or greater.

REMOVE_OPTION

public static final DHCPOper REMOVE_OPTION

DHCPConfig command operation: remove option.

Requires the provisioning group to be enabled for ProvGroupCapabilitiesKeys.DHCP_CONFIGURATION_V3 or greater.

VALIDATE_OPTION

public static final DHCPOper VALIDATE_OPTION

DHCPConfig command operation: validate option.

Requires the provisioning group to be enabled for ProvGroupCapabilitiesKeys.DHCP_CONFIGURATION_V3 or greater.

VALIDATE_OPTION_CONTINUE

public static final DHCPOper VALIDATE_OPTION_CONTINUE

DHCPConfig command operation: validate option continue.

Requires the provisioning group to be enabled for ProvGroupCapabilitiesKeys.DHCP_CONFIGURATION_V3 or greater.

VALIDATE_IS_V4

public static final DHCPOper VALIDATE_IS_V4

DHCPConfig command operation: validate extension is being called for a DHCPv4 packet.

Requires the provisioning group to be enabled for ProvGroupCapabilitiesKeys.DHCP_CONFIGURATION_V3 or greater.

VALIDATE_IS_V6

public static final DHCPOper VALIDATE_IS_V6

DHCPConfig command operation: validate extension is being called for a DHCPv6 packet.

Requires the provisioning group to be enabled for ProvGroupCapabilitiesKeys.DHCP_CONFIGURATION_V3 or greater.

UPDATE_IPV6_ADDRESS

public static final DHCPOper UPDATE_IPV6_ADDRESS

DHCPConfig command operation: update IPv6 address.

Requires the provisioning group to be enabled for ProvGroupCapabilitiesKeys.DHCP_CONFIGURATION_V3 or greater.

DROP_IF_MAX_IA_ADDRESSES_EXCEEDED

public static final DHCPOper DROP_IF_MAX_IA_ADDRESSES_EXCEEDED

DHCPConfig command operation: drop packet is maximum IA Addresses exceeded

Requires the provisioning group to be enabled for ProvGroupCapabilitiesKeys.DHCP_CONFIGURATION_V3 or greater.

Method Detail

values

public static DHCPOper[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DHCPOper c : DHCPOper.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DHCPOper valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

isSpecialValueSupported

public boolean isSpecialValueSupported()

Returns true if this operation supports DHCPSpecialValue values.

Returns:

true If this operation supports DHCPSpecialValue values.

isValueRequired

public boolean isValueRequired()

Returns true if this operation requires a value.

Returns:

boolean True if operation requires a value.

isCNROptionArgumentArrayRequired

public boolean isCNROptionArgumentArrayRequired()

Returns true if this operation requires the use of a CNROptionArgumentArray. Otherwise returns false.

Returns:

true if this operation requires the use of a CNROptionArgumentArray. Otherwise returns false.

See Also:

CNROptionArgumentArray

isAvailable

public boolean isAvailable(Capabilities capabilities)

Returns true if this DHCPOper is available in the given provisioning group. Otherwise returns false.

Parameters:

capabilities - the available capabilities.

Returns:

true if this DHCPOper is available in the given provisioning group. Otherwise returns false.