OSGi™ Service Platform
Release 4

org.osgi.service.cm
Class ConfigurationException

java.lang.Object
  extended byjava.lang.Throwable
      extended byjava.lang.Exception
          extended byorg.osgi.service.cm.ConfigurationException
All Implemented Interfaces:
java.io.Serializable

public class ConfigurationException
extends java.lang.Exception

An Exception class to inform the Configuration Admin service of problems with configuration data.

See Also:
Serialized Form

Constructor Summary
ConfigurationException(java.lang.String property, java.lang.String reason)
          Create a ConfigurationException object.
ConfigurationException(java.lang.String property, java.lang.String reason, java.lang.Throwable cause)
          Create a ConfigurationException object.
 
Method Summary
 java.lang.Throwable getCause()
          Returns the cause of this exception or null if no cause was specified when this exception was created.
 java.lang.String getProperty()
          Return the property name that caused the failure or null.
 java.lang.String getReason()
          Return the reason for this exception.
 java.lang.Throwable initCause(java.lang.Throwable cause)
          The cause of this exception can only be set when constructed.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getLocalizedMessage, getMessage, getStackTrace, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ConfigurationException

public ConfigurationException(java.lang.String property,
                              java.lang.String reason)
Create a ConfigurationException object.

Parameters:
property - name of the property that caused the problem, null if no specific property was the cause
reason - reason for failure

ConfigurationException

public ConfigurationException(java.lang.String property,
                              java.lang.String reason,
                              java.lang.Throwable cause)
Create a ConfigurationException object.

Parameters:
property - name of the property that caused the problem, null if no specific property was the cause
reason - reason for failure
cause - The cause of this exception.
Since:
1.2
Method Detail

getProperty

public java.lang.String getProperty()
Return the property name that caused the failure or null.

Returns:
name of property or null if no specific property caused the problem

getReason

public java.lang.String getReason()
Return the reason for this exception.

Returns:
reason of the failure

getCause

public java.lang.Throwable getCause()
Returns the cause of this exception or null if no cause was specified when this exception was created.

Returns:
The cause of this exception or null if no cause was specified.
Since:
1.2

initCause

public java.lang.Throwable initCause(java.lang.Throwable cause)
The cause of this exception can only be set when constructed.

Parameters:
cause - Cause of the exception.
Returns:
This object.
Throws:
java.lang.IllegalStateException - This method will always throw an IllegalStateException since the cause of this exception can only be set when constructed.
Since:
1.2

OSGi™ Service Platform
Release 4

Copyright © OSGi Alliance (2000, 2006). All Rights Reserved. Licensed under the OSGi Specification License, Version 1.0