info.aduna.gee.spectacle.webserver
Class ChannelException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          info.aduna.gee.spectacle.webserver.ChannelException

All Implemented Interfaces:

Serializable

public class ChannelException
extends Exception

A ChannelException gets thrown when an problem occurs somewhere in a Channel.

See Also:

Serialized Form

Field Summary

static String	COVER_NOT_SET Message indicating that the Channel needs to call setCover before attempting to perform the action.
static String	INTERNAL_ERROR Message indicating that an otherwise unspecified internal error occurred
static String	NOT_AUTHORIZED Message indicating that the Channel cannot login with the specified credentials, because either the password is incorrect, or the server does not accept Channel connections.
static String	NOT_LOGGED_IN Message indicating that the Channel needs to be logged in to perform the action
static String	UNKNOWN_CHANNEL Message indicating that the Channel cannot login with the specified credentials, because the channel name is not found on the server.

Constructor Summary

ChannelException(int returnCode, String message)
Construct a new ChannelException

ChannelException(int returnCode, String message, Exception wrapped)
Construct a new ChannelException

ChannelException(String message)
Construct a new ChannelException

ChannelException(String message, Exception wrapped)
Construct a new ChannelException

Method Summary

int	getReturnCode()
Exception	getWrappedException()
void	printStackTrace()

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Field Detail

UNKNOWN_CHANNEL

public static String UNKNOWN_CHANNEL

Message indicating that the Channel cannot login with the specified credentials, because the channel name is not found on the server.

NOT_AUTHORIZED

public static String NOT_AUTHORIZED

Message indicating that the Channel cannot login with the specified credentials, because either the password is incorrect, or the server does not accept Channel connections.

NOT_LOGGED_IN

public static String NOT_LOGGED_IN

Message indicating that the Channel needs to be logged in to perform the action

COVER_NOT_SET

public static String COVER_NOT_SET

Message indicating that the Channel needs to call setCover before attempting to perform the action.

INTERNAL_ERROR

public static String INTERNAL_ERROR

Message indicating that an otherwise unspecified internal error occurred

Constructor Detail

ChannelException

public ChannelException(String message)

Construct a new ChannelException

Parameters:

message - the message for this ChannelException

ChannelException

public ChannelException(int returnCode,
                        String message)

Construct a new ChannelException

Parameters:

returnCode - the status as returned by the server the Channel tried to contact

message - the message for this ChannelException

ChannelException

public ChannelException(String message,
                        Exception wrapped)

Construct a new ChannelException

Parameters:

message - the message for this ChannelException

wrapped - the underlying Exception that caused this ChannelException to be thrown

ChannelException

public ChannelException(int returnCode,
                        String message,
                        Exception wrapped)

Construct a new ChannelException

Parameters:

returnCode - the status as returned by the server the Channel tried to contact

message - the message for this ChannelException

wrapped - the underlying Exception that caused this ChannelException to be thrown

Method Detail

getWrappedException

public Exception getWrappedException()

Returns:

the underlying Exception that caused this ChannelException to be thrown, or null

getReturnCode

public int getReturnCode()

Returns:

the status as returned by the server the Channel tried to contact, or 0 (zero)

printStackTrace

public void printStackTrace()

Overrides:

printStackTrace in class Throwable