Package com.compuware.api.topaz.hostcredentials

Class UserIDException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.compuware.api.topaz.TopazAPIException

com.compuware.api.topaz.hostcredentials.HostCredentialsException

com.compuware.api.topaz.hostcredentials.UserIDException

All Implemented Interfaces:

Serializable

public class UserIDException
extends HostCredentialsException

UserIDException is the checked exception thrown when an attempt to connect to a host fails because the user ID is expired, not recognized, or revoked.

Since:

1.0.0

Version:

2.0.0

See Also:

IZOSHostConnection.connect(IZOSCredentials), Serialized Form

Constructor Summary

Constructors

Constructor	Description
UserIDException(String message, String localizedMessage, IHost host)	Constructs a new user ID exception with the specified detail messages and host.
UserIDException(String message, String localizedMessage, Throwable cause, IHost host)	Constructs a new user ID exception with the specified detail messages, cause, and host.

Method Summary

Methods inherited from class com.compuware.api.topaz.hostcredentials.HostCredentialsException

getHost

Methods inherited from class com.compuware.api.topaz.TopazAPIException

getLocalizedMessage

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

UserIDException

public UserIDException(String message,
                       String localizedMessage,
                       IHost host)

Constructs a new user ID exception with the specified detail messages and host. The cause is not initialized, and may subsequently be initialized by a call to Throwable.initCause(java.lang.Throwable).

Parameters:

message - the non-localized detail message (which is saved for later retrieval by the Throwable.getMessage() method).

localizedMessage - the localized description (which is saved for later retrieval by the TopazAPIException.getLocalizedMessage() method). (A null value is permitted, in which case getLocalizedMessage() will return the non-localized detail message.)

host - the host associated with this exception

Since:

1.0.0

UserIDException

public UserIDException(String message,
                       String localizedMessage,
                       Throwable cause,
                       IHost host)

Constructs a new user ID exception with the specified detail messages, cause, and host.

Note that the detail message associated with cause is not automatically incorporated in this exception's detail message.

Parameters:

message - the non-localized detail message (which is saved for later retrieval by the Throwable.getMessage() method).

localizedMessage - the localized description (which is saved for later retrieval by the TopazAPIException.getLocalizedMessage() method). (A null value is permitted, in which case getLocalizedMessage() will return the non-localized detail message.)

cause - the cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

host - the host associated with this exception

Since:

1.0.0