LoginException class

This is the base class for all login/authentication exceptions.

Syntax

public class LoginException extends AgentryException

Derived classes

Members

All members of LoginException, including inherited members.

Constructors
Modifier and Type Constructor Description
public LoginException() Constructs a new login exception.
public LoginException(String) Constructs a new login exception with the given error message, which will be passed to the Agentry client.
public LoginException(String, Throwable) Constructs a new login exception with the given error message, which will be passed to the Agentry client.
Inherited members from AgentryException
Modifier and Type Member Description
public AgentryException(String) Constructs a new AgentryException object.
public AgentryException(String, Throwable) Constructs a new AgentryException object.
public AgentryException(String, String, String, Throwable) Constructs a new AgentryException object, for methods that support throwing exceptions that may appear in the client.
public AgentryException(String, String, String) Constructs a new AgentryException object, for methods that support throwing exceptions that may appear in the client.
public final String getNotificationText() Returns the notification window text.
public final String getNotificationTitle() Returns the notification window title.
public final String getOkButtonLabel() Returns the notification window button label.

Usage

Subclasses of this exception are thrown from the login methods of the Server class.

If given message text, this class will place the message text into the notificationText field of AgentryException as well as using it for the exception's message. This is done to make it easier for the Java Back End to retrieve the unadulterated message text, since the C++ exception wrapper classes sometimes augment the exception's message text.