com.sun.sgs.protocol
Class LoginFailureException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          com.sun.sgs.protocol.LoginFailureException

All Implemented Interfaces:

Serializable

public class LoginFailureException
extends Exception

An exception that indicates a login request failed. The getMessage method returns a detail message containing an explanation for the failure, the getReason method returns the failure reason, and if the failure reason is LoginFailureException.FailureReason.OTHER, the getCause method returns the possibly-null cause of the failure.

See Also:

Serialized Form

Nested Class Summary

static class

LoginFailureException.FailureReason Reasons why a login fails.

Constructor Summary

LoginFailureException(String message, LoginFailureException.FailureReason reason)
Constructs an instance with the specified detail message and reason.

LoginFailureException(String message, Throwable cause)
Constructs an instance with the specified detail message and cause.

Method Summary

LoginFailureException.FailureReason

getReason() Returns a failure reason.

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

Constructor Detail

LoginFailureException

public LoginFailureException(String message,
                             LoginFailureException.FailureReason reason)

Constructs an instance with the specified detail message and reason.

Parameters:

message - a detail message, or null

reason - a failure reason

LoginFailureException

public LoginFailureException(String message,
                             Throwable cause)

Constructs an instance with the specified detail message and cause.

Parameters:

message - a detail message, or null

cause - the cause of this exception, or null

Method Detail

getReason

public LoginFailureException.FailureReason getReason()

Returns a failure reason. If the returned reason is LoginFailureException.FailureReason.OTHER, then the cause may contain an exception that caused the failure.

Returns:

a failure reason