com.ibm.ecm.extension

Class PluginRepositoryLogonException

  1. java.lang.Object
  2. extended byjava.lang.Throwable
  3. extended byjava.lang.Exception
  4. extended bycom.ibm.ecm.extension.PluginRepositoryLogonException
All implemented interfaces:
java.io.Serializable
  1. public class PluginRepositoryLogonException
  2. extends java.lang.Exception
This exception is thrown by a plug-in repository to indicate various logon failures.
Since:
2.0.3
See Also:
Serialized Form

Field Summary

Modifier and Type Field and Description
  1. static
  2. int
 LOGON_FAILURE_BAD_USERID_OR_PASSWORD
Logon status indicating that the userid or password is not correct.
  1. static
  2. int
 LOGON_FAILURE_NO_PERMISSIONS
Logon status indicating that the user does not have the permissions needed to use the server.
  1. static
  2. int
 LOGON_FAILURE_PASSWORD_EXPIRED
Logon status indicating that the password has expired.
  1. static
  2. int
 LOGON_FAILURE_SERVER
Logon status indicating that some unspecific server error has occurred.
  1. static
  2. int
 LOGON_FAILURE_SERVER_UNAVAILABLE
Logon status indicating that the server is not available.
  1. static
  2. int
 LOGON_FAILURE_USERID_LOCKED
Logon status indicating that the userid is locked and requires an administrative action (outside of the repository logon to unlock before it can be used.

Constructor Summary

Constructor and Description
PluginRepositoryLogonException(int logonFailure)
Use this constructor for logon errors that can be described with the predefined LOGON_FAILURE codes.
PluginRepositoryLogonException(java.lang.Throwable cause)
Use this constructor to throw logon errors for other reasons beyond those in the predefined LOGON_FAILURE codes.

Method Summary

Modifier and Type Method and Description
  1. int
 getLogonFailure()
Returns the reason for the logon failure.
Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

LOGON_FAILURE_SERVER

  1. public static final int LOGON_FAILURE_SERVER
Logon status indicating that some unspecific server error has occurred.
See Also:
Constant Field Values

LOGON_FAILURE_SERVER_UNAVAILABLE

  1. public static final int LOGON_FAILURE_SERVER_UNAVAILABLE
Logon status indicating that the server is not available.
See Also:
Constant Field Values

LOGON_FAILURE_BAD_USERID_OR_PASSWORD

  1. public static final int LOGON_FAILURE_BAD_USERID_OR_PASSWORD
Logon status indicating that the userid or password is not correct.
See Also:
Constant Field Values

LOGON_FAILURE_PASSWORD_EXPIRED

  1. public static final int LOGON_FAILURE_PASSWORD_EXPIRED
Logon status indicating that the password has expired.
See Also:
Constant Field Values

LOGON_FAILURE_USERID_LOCKED

  1. public static final int LOGON_FAILURE_USERID_LOCKED
Logon status indicating that the userid is locked and requires an administrative action (outside of the repository logon to unlock before it can be used.
See Also:
Constant Field Values

LOGON_FAILURE_NO_PERMISSIONS

  1. public static final int LOGON_FAILURE_NO_PERMISSIONS
Logon status indicating that the user does not have the permissions needed to use the server.
See Also:
Constant Field Values

Constructor Detail

PluginRepositoryLogonException

  1. public PluginRepositoryLogonException( int logonFailure)
Use this constructor for logon errors that can be described with the predefined LOGON_FAILURE codes.
Parameters:
logonFailure - One of the LOGON_FAILURE codes defined in this class.

PluginRepositoryLogonException

  1. public PluginRepositoryLogonException( java.lang.Throwable cause)
Use this constructor to throw logon errors for other reasons beyond those in the predefined LOGON_FAILURE codes. (The logonFailure will be LOGON_FAILURE_SERVER in these cases.)
Parameters:
cause - An exception with additional information about the original cause of the logon failure.

Method Detail

getLogonFailure

  1. public int getLogonFailure()
Returns the reason for the logon failure.
Returns:
one of the LOGON_FAILURE codes as defined in this class.