com.sap.ip.me.api.user
Class LogonException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          com.sap.ip.me.api.services.MEException
              com.sap.ip.me.api.user.LogonException

All Implemented Interfaces:

java.io.Serializable

public class LogonException

extends MEException

A LogonException will be thrown if logon fails, if a password change fails or if the creation of a new user fails.

Author:

SAP

See Also:

Serialized Form

Field Summary

static int	EMPTY_LOCAL_PASSWORD A message id.
static int	EMPTY_USER_NAME A message id.
static int	INVALID_LOCAL_PASSWORD_LENGTH A message id.
static int	INVALID_LOGONNAME Deprecated. Use EMPTY_USER_NAME instead of INVALID_LOGONNAME.
static int	INVALID_PASSWORD Deprecated. Without Replacement.
static int	INVALID_USER_NAME A message id.
static int	LOCAL_PASSWORD_CONFIRMATION_DIFFERS A message id.
static int	LOGON_FAILED A message id.
static int	NEW_LOCAL_PASSWORD_CONFIRMATION_DIFFERS A message id.
static int	RESERVED_USER_NAME A message id.
static int	SSO_IO_EXCEPTION A message id.
static int	SSO_LOGON_FAILURE A message id.
static int	SSO_MALFORMED_URL A message id.
static int	SSO_SERVER_NOT_REACHABLE A message id.
static int	SSO_USER_UNKNOWN A message id.
static int	UNKNOWNMESSAGE A message id.
static int	USER_ALREADY_EXISTS A message id.
static int	USER_CREATION_NOT_ALLOWED A message id.
static int	USER_IS_LOCKED A message id.
static int	USER_UNKNOWN A message id.
static int	WRONG_PASSWORD Deprecated. Use LOCAL_PASSWORD_CONFIRMATION_DIFFERS or NEW_LOCAL_PASSWORD_CONFIRMATION_DIFFERS instead of WRONG_PASSWORD.

Constructor Summary

LogonException(int messageId)
Constructor.

LogonException(int messageId, java.lang.Object[] arguments)
Constructor.

LogonException(int messageId, java.lang.Object[] arguments, java.lang.Throwable nestedException)
Constructor for the InstallationException.

Method Summary

java.lang.String	getLocalizedMessage() Returns a localized detailed error message.
java.lang.String	getMessage() Gets the message attribute of the InstallationException object
int	getMessageId() Gets the messageId attribute of the LogonException object
java.lang.Object[]	getMessageParameters() Gets the messageParameters attribute of the LogonException object

Methods inherited from class com.sap.ip.me.api.services.MEException

getNestedException, getReason, printStackTrace, printStackTrace, printStackTrace

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getStackTrace, initCause, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Field Detail

UNKNOWNMESSAGE

public static final int UNKNOWNMESSAGE

A message id. The message is no standard message.

See Also:

Constant Field Values

INVALID_LOGONNAME

public static final int INVALID_LOGONNAME

Deprecated. Use EMPTY_USER_NAME instead of INVALID_LOGONNAME.

A message id. Logon name cannot be null or an empty string.

See Also:

Constant Field Values

INVALID_PASSWORD

public static final int INVALID_PASSWORD

Deprecated. Without Replacement.

A message id. Logon password does not comply with the SAP password rules in the Security Guide

See Also:

Constant Field Values

WRONG_PASSWORD

public static final int WRONG_PASSWORD

Deprecated. Use LOCAL_PASSWORD_CONFIRMATION_DIFFERS or NEW_LOCAL_PASSWORD_CONFIRMATION_DIFFERS instead of WRONG_PASSWORD.

A message id. Password cannot be changed because old password does not match.

See Also:

Constant Field Values

USER_UNKNOWN

public static final int USER_UNKNOWN

A message id. The user is not known.

See Also:

Constant Field Values

USER_ALREADY_EXISTS

public static final int USER_ALREADY_EXISTS

A message id. The user already exists.

See Also:

Constant Field Values

EMPTY_USER_NAME

public static final int EMPTY_USER_NAME

A message id. User name must not be null or an empty string.

See Also:

Constant Field Values

RESERVED_USER_NAME

public static final int RESERVED_USER_NAME

A message id. User name is reserved by SAP and therefore invalid.

See Also:

Constant Field Values

INVALID_USER_NAME

public static final int INVALID_USER_NAME

A message id. User name contains invalid characters.

See Also:

Constant Field Values

EMPTY_LOCAL_PASSWORD

public static final int EMPTY_LOCAL_PASSWORD

A message id. Local password must not be null or an empty string.

See Also:

Constant Field Values

INVALID_LOCAL_PASSWORD_LENGTH

public static final int INVALID_LOCAL_PASSWORD_LENGTH

A message id. Local password has invalid length.

See Also:

Constant Field Values

LOGON_FAILED

public static final int LOGON_FAILED

A message id. A logon failed.

See Also:

Constant Field Values

LOCAL_PASSWORD_CONFIRMATION_DIFFERS

public static final int LOCAL_PASSWORD_CONFIRMATION_DIFFERS

A message id. The local password differs from its confirmation.

See Also:

Constant Field Values

NEW_LOCAL_PASSWORD_CONFIRMATION_DIFFERS

public static final int NEW_LOCAL_PASSWORD_CONFIRMATION_DIFFERS

A message id. The new local password differs from its confirmation.

See Also:

Constant Field Values

USER_IS_LOCKED

public static final int USER_IS_LOCKED

A message id. User is locked.

See Also:

Constant Field Values

SSO_LOGON_FAILURE

public static final int SSO_LOGON_FAILURE

A message id. SSO logon failure.

See Also:

Constant Field Values

SSO_SERVER_NOT_REACHABLE

public static final int SSO_SERVER_NOT_REACHABLE

A message id. Server not reachable.

See Also:

Constant Field Values

SSO_MALFORMED_URL

public static final int SSO_MALFORMED_URL

A message id. Malformed URL.

See Also:

Constant Field Values

SSO_IO_EXCEPTION

public static final int SSO_IO_EXCEPTION

A message id. IO exception.

See Also:

Constant Field Values

USER_CREATION_NOT_ALLOWED

public static final int USER_CREATION_NOT_ALLOWED

A message id. User creation is not allowed (Single User Mode detected).

See Also:

Constant Field Values

SSO_USER_UNKNOWN

public static final int SSO_USER_UNKNOWN

A message id. Unknown SSO user.

See Also:

Constant Field Values

Constructor Detail

LogonException

public LogonException(int messageId)

Constructor. Only message IDs offered by this class should be used.

Parameters:

messageId - Message ID that determines the detailed error message.

LogonException

public LogonException(int messageId,
                      java.lang.Object[] arguments)

Constructor. Only message IDs offered by this class should be used.

Parameters:

messageId - Message ID that determines the detailed error message.

arguments - Arguments that have to be used to create a detailed error message (via java.text.MessageFormat class.

LogonException

public LogonException(int messageId,
                      java.lang.Object[] arguments,
                      java.lang.Throwable nestedException)

Constructor for the InstallationException.

Parameters:

nestedException - A nested exception.

Method Detail

getMessage

public java.lang.String getMessage()

Gets the message attribute of the InstallationException object

Returns:

The message value

getLocalizedMessage

public java.lang.String getLocalizedMessage()

Returns a localized detailed error message. If no localized detailed error message can be found, the default detailed error message is returned.

Returns:

Localized detailed error message.

getMessageId

public int getMessageId()

Gets the messageId attribute of the LogonException object

Returns:

The messageId value

getMessageParameters

public java.lang.Object[] getMessageParameters()

Gets the messageParameters attribute of the LogonException object

Returns:

The messageParameters value