org.sape.carbon.core.config
Class InvalidConfigurationException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--java.lang.RuntimeException
                    |
                    +--org.sape.carbon.core.exception.BaseRuntimeException
                          |
                          +--org.sape.carbon.core.config.ConfigurationRuntimeException
                                |
                                +--org.sape.carbon.core.config.InvalidConfigurationException

All Implemented Interfaces:

Exceptionable, Serializable

public class InvalidConfigurationException

extends ConfigurationRuntimeException

This exception is utilized to relate that a supplied configuration is invalid or could not be found. This exception should be utilized for individual properties that are invalid or for properties that in relation to eachother are invalid.

Copyright 2001 Sapient

Since:

carbon 1.0

Version:

$Revision: 1.15 $($Author: dvoet $ / $Date: 2003/05/05 21:21:16 $)

Author:

Greg Hinkle, December 2001

See Also:

Serialized Form

Field Summary

Fields inherited from class org.sape.carbon.core.exception.BaseRuntimeException

delegatedException

Fields inherited from class java.lang.RuntimeException

Fields inherited from class java.lang.Throwable

Constructor Summary

InvalidConfigurationException(Class sourceClass, String documentName, String propertyName)
Constructs this exception with the supplied source, document and property

InvalidConfigurationException(Class sourceClass, String documentName, String propertyName, String message)
Constructs an invalid configuration exception

InvalidConfigurationException(Class sourceClass, String documentName, String propertyName, String message, Throwable cause)
Constructs an invalid configuration exception

InvalidConfigurationException(Class sourceClass, String documentName, String propertyName, Throwable cause)
Constructs an invalid configuration exception

InvalidConfigurationException(String message)
Deprecated. Utilize one of the more specific constructors

InvalidConfigurationException(String message, Throwable cause)
Deprecated. Utilize one of the more specific constructors

Method Summary

SeverityEnum

getSeverity() Retrieves the severity of this exception.

Methods inherited from class org.sape.carbon.core.exception.BaseRuntimeException

getCause, getExceptionSource, getMessage, toString

Methods inherited from class java.lang.Throwable

fillInStackTrace, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

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

Constructor Detail

InvalidConfigurationException

public InvalidConfigurationException(Class sourceClass,
                                     String documentName,
                                     String propertyName)

Constructs this exception with the supplied source, document and property

Parameters:

sourceClass - the source class where the property retrieval failed

documentName - the name of the configuration document which was supposed to have a valid configuration property

propertyName - the name of the property that was invalid

InvalidConfigurationException

public InvalidConfigurationException(Class sourceClass,
                                     String documentName,
                                     String propertyName,
                                     String message)

Constructs an invalid configuration exception

Parameters:

sourceClass - the source class of the exception

documentName - the name of the document that contained the configuration

propertyName - the name of the property that contained invalid data

message - a message describing why this configuration is not valid

InvalidConfigurationException

public InvalidConfigurationException(Class sourceClass,
                                     String documentName,
                                     String propertyName,
                                     Throwable cause)

Constructs an invalid configuration exception

Parameters:

sourceClass - the source class of the exception

documentName - the name of the document that contained the configuration

propertyName - the name of the property that contained the value

cause - the exception that caused this configuration to be invalid

InvalidConfigurationException

public InvalidConfigurationException(Class sourceClass,
                                     String documentName,
                                     String propertyName,
                                     String message,
                                     Throwable cause)

Constructs an invalid configuration exception

Parameters:

sourceClass - the source class of the exception

documentName - the name of the document that contained the configuration

propertyName - the name of the property that contained the value

message - a message describing why this configuration is not valid

cause - the exception that caused this configuration to be invalid

InvalidConfigurationException

public InvalidConfigurationException(String message)

Deprecated. Utilize one of the more specific constructors

Parameters:

message - string information relating to this exception

InvalidConfigurationException

public InvalidConfigurationException(String message,
                                     Throwable cause)

Deprecated. Utilize one of the more specific constructors

Parameters:

message - string information relating to this exception

cause - a throwable that can be considered the cause of the current exception (used in levelizing exceptions)

Method Detail

getSeverity

public SeverityEnum getSeverity()

Retrieves the severity of this exception. It should be noted that invalid configurations are a technical failure and not an exposed business service and therefore have a relatively low severity of info. If this exception causes a buisnes failure higher up the stack, that exception should have a more severe exception severity.

Specified by:

getSeverity in interface Exceptionable

Overrides:

getSeverity in class ConfigurationRuntimeException

Returns:

this exception's severity

See Also:

BaseRuntimeException.getSeverity()