com.solacesystems.jcsmp

Class JCSMPLoginFailureException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.apache.commons.lang.exception.NestableException

com.solacesystems.common.ChainedException

com.solacesystems.jcsmp.JCSMPException

com.solacesystems.jcsmp.JCSMPOperationException

com.solacesystems.jcsmp.JCSMPLoginFailureException

All Implemented Interfaces:

Serializable, org.apache.commons.lang.exception.Nestable

public class JCSMPLoginFailureException
extends JCSMPOperationException

Indicates a producer or consumer was unable to login to the 3200 Series appliance.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	TYPE_CONSUMER
static int	TYPE_PRODUCER

Constructor Summary

Constructors

Constructor and Description
JCSMPLoginFailureException(int user_t, String userName, int responseCode, String responsePhrase) Construct a JCSMPLoginFailureException

Method Summary

Modifier and Type	Method and Description
int	getResponseCode() Get the SMF response code.
String	getResponsePhrase() Get the response phrase.

Methods inherited from class com.solacesystems.jcsmp.JCSMPException

getExtraInfo, setExtraInfo

Methods inherited from class org.apache.commons.lang.exception.NestableException

getCause, getMessage, getMessage, getMessages, getThrowable, getThrowableCount, getThrowables, indexOfThrowable, indexOfThrowable, printPartialStackTrace, printStackTrace, printStackTrace, printStackTrace

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getLocalizedMessage, getStackTrace, getSuppressed, initCause, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_CONSUMER

public static final int TYPE_CONSUMER

See Also:

Constant Field Values

TYPE_PRODUCER

public static final int TYPE_PRODUCER

See Also:

Constant Field Values

Constructor Detail

JCSMPLoginFailureException

public JCSMPLoginFailureException(int user_t,
                                  String userName,
                                  int responseCode,
                                  String responsePhrase)

Construct a JCSMPLoginFailureException

Parameters:

user_t - The type of user the exception is raised for (PRODUCER | CONSUMER).

userName - The user name of the client that attempted login.

responseCode - The SMF response code.

responsePhrase - A short phrase associated with the response code.

Method Detail

getResponseCode

public int getResponseCode()

Get the SMF response code.

Returns:

The SMF response code.

getResponsePhrase

public String getResponsePhrase()

Get the response phrase.

Returns:

The phrase associated with the response code, or null if the phrase is not provided.