com.cisco.provisioning.cpe.extensions
Class FeatureNotEnabledException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by java.lang.RuntimeException
              extended by com.cisco.provisioning.cpe.BaseRuntimeException
                  extended by com.cisco.provisioning.cpe.extensions.FeatureNotEnabledException
All Implemented Interfaces:
Serializable

public class FeatureNotEnabledException
extends com.cisco.provisioning.cpe.BaseRuntimeException

This exception is thrown when an attempt is made to use features that were added in BPR 2.5, when such features are not enabled.

BPR 2.5 supports an incremental upgrade from previous versions, to avoid requiring all BPR servers be upgraded to 2.5 at once. This requires the RDU to generate device configurations that are compatible with BPR 2.0.3 servers until all servers in a provisioning group have been upgraded to 2.5.

BPR 2.5 adds several new features to DHCP configuration commands, including additional special value codes, binary values, and enumeration codes instead of strings for CNR attribute names. These new features must not be used if the device configuration will be sent to a BPR 2.03 server.

BPR keeps track of the servers in a provisioning group and will not enable 2.5 features on a ConfigContext for a device, unless all servers in the provisioning group have been upgraded. The default RDU device generation extensions are careful to not use BPR 2.5 features, if they have not been enabled. Should an extension attempt to add a DHCP command that requires BPR 2.5 features to a DHCPConfig for a ConfigContext that does not have 2.5 features enabled, this exception will be thrown.

See Also:
ConfigContext, DHCPConfig, DHCPSpecialValue, Serialized Form

Field Summary
static long serialVersionUID
           
 
Constructor Summary
FeatureNotEnabledException()
          Constructor for an exception with no text message or nested exception.
FeatureNotEnabledException(Exception nestedException)
          Constructor for an exception that contains a nested exception.
FeatureNotEnabledException(Exception nestedException, String message)
          Constructor with a message and a nested exception.
FeatureNotEnabledException(Exception nestedException, String message, boolean hideNestedException)
          Deprecated. Please use FeatureNotEnabledException(Exception, String) instead.
FeatureNotEnabledException(String message)
          Constructor with a message
 
Method Summary
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

serialVersionUID

public static final long serialVersionUID
See Also:
Constant Field Values
Constructor Detail

FeatureNotEnabledException

public FeatureNotEnabledException()
Constructor for an exception with no text message or nested exception.


FeatureNotEnabledException

public FeatureNotEnabledException(Exception nestedException)
Constructor for an exception that contains a nested exception.

The message for this exception will be the result of toString() of the nestedException (as long as its not null).

Parameters:
nestedException - The exception this exception is explaining in more detail.

FeatureNotEnabledException

public FeatureNotEnabledException(String message)
Constructor with a message

Parameters:
message - the message string to associate with this exception

FeatureNotEnabledException

public FeatureNotEnabledException(Exception nestedException,
                                  String message)
Constructor with a message and a nested exception.

Parameters:
nestedException - The exception this exception is explaining in more detail.
message - The display message for the explanation message.

FeatureNotEnabledException

@Deprecated
public FeatureNotEnabledException(Exception nestedException,
                                             String message,
                                             boolean hideNestedException)
Deprecated. Please use FeatureNotEnabledException(Exception, String) instead.

Constructor for an exception that contains a text messsage and a nested exception.

Parameters:
nestedException - the exception this exception is explaining in more detail
message - the message to associate with this exception.
hideNestedException - this field is ignored.