OSGi™ Service Platform
Release 4 Version 4.2

org.osgi.framework
Class ServiceException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by java.lang.RuntimeException
              extended by org.osgi.framework.ServiceException
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
ServiceUnavailableException

public class ServiceException
extends java.lang.RuntimeException

A service exception used to indicate that a service problem occurred.

A ServiceException object is created by the Framework or service implementation to denote an exception condition in the service. A type code is used to identify the exception type for future extendability. Service implementations may also create subclasses of ServiceException. When subclassing, the subclass should set the type to SUBCLASSED to indicate that ServiceException has been subclassed.

This exception conforms to the general purpose exception chaining mechanism.

Since:
1.5
See Also:
Serialized Form

Field Summary
static int FACTORY_ERROR
          The service factory produced an invalid service object.
static int FACTORY_EXCEPTION
          The service factory threw an exception.
static int REMOTE
          An error occurred invoking a remote service.
static int SUBCLASSED
          The exception is a subclass of ServiceException.
static int UNREGISTERED
          The service has been unregistered.
static int UNSPECIFIED
          No exception type is unspecified.
 
Constructor Summary
ServiceException(java.lang.String msg)
          Creates a ServiceException with the specified message.
ServiceException(java.lang.String msg, int type)
          Creates a ServiceException with the specified message and type.
ServiceException(java.lang.String msg, int type, java.lang.Throwable cause)
          Creates a ServiceException with the specified message, type and exception cause.
ServiceException(java.lang.String msg, java.lang.Throwable cause)
          Creates a ServiceException with the specified message and exception cause.
 
Method Summary
 int getType()
          Returns the type for this exception or UNSPECIFIED if the type was unspecified or unknown.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

UNSPECIFIED

public static final int UNSPECIFIED
No exception type is unspecified.

See Also:
Constant Field Values

UNREGISTERED

public static final int UNREGISTERED
The service has been unregistered.

See Also:
Constant Field Values

FACTORY_ERROR

public static final int FACTORY_ERROR
The service factory produced an invalid service object.

See Also:
Constant Field Values

FACTORY_EXCEPTION

public static final int FACTORY_EXCEPTION
The service factory threw an exception.

See Also:
Constant Field Values

SUBCLASSED

public static final int SUBCLASSED
The exception is a subclass of ServiceException. The subclass should be examined for the type of the exception.

See Also:
Constant Field Values

REMOTE

public static final int REMOTE
An error occurred invoking a remote service.

See Also:
Constant Field Values
Constructor Detail

ServiceException

public ServiceException(java.lang.String msg,
                        java.lang.Throwable cause)
Creates a ServiceException with the specified message and exception cause.

Parameters:
msg - The associated message.
cause - The cause of this exception.

ServiceException

public ServiceException(java.lang.String msg)
Creates a ServiceException with the specified message.

Parameters:
msg - The message.

ServiceException

public ServiceException(java.lang.String msg,
                        int type,
                        java.lang.Throwable cause)
Creates a ServiceException with the specified message, type and exception cause.

Parameters:
msg - The associated message.
type - The type for this exception.
cause - The cause of this exception.

ServiceException

public ServiceException(java.lang.String msg,
                        int type)
Creates a ServiceException with the specified message and type.

Parameters:
msg - The message.
type - The type for this exception.
Method Detail

getType

public int getType()
Returns the type for this exception or UNSPECIFIED if the type was unspecified or unknown.

Returns:
The type of this exception.

OSGi™ Service Platform
Release 4 Version 4.2

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