Package com.lightstreamer.adapters.remote

Class ConflictingSessionException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.lightstreamer.adapters.remote.MetadataException

com.lightstreamer.adapters.remote.CreditsException

com.lightstreamer.adapters.remote.ConflictingSessionException

All Implemented Interfaces:

java.io.Serializable

public class ConflictingSessionException
extends CreditsException

Thrown by the notifyNewSession method of MetadataProvider if a User is not enabled to open a new Session but he would be enabled as soon as another Session were closed. By using this exception, the ID of the other Session is also supplied.
After receiving this exception, the Server may try to close the specified session and invoke notifyNewSession again.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ConflictingSessionException(int clientErrorCode, java.lang.String msg, java.lang.String userMsg, java.lang.String conflictingSessionID)	Constructs a ConflictingSessionException with supplied error code and message text that will be forwarded to the Client in case the Server can't solve the issue by closing the conflicting session.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getConflictingSessionID()	Gets the ID of a Session that can be closed in order to eliminate the problem reported in this exception.

Methods inherited from class com.lightstreamer.adapters.remote.CreditsException

getClientErrorCode, getClientErrorMsg

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

Constructor Details

ConflictingSessionException

public ConflictingSessionException(int clientErrorCode,
@Nullable
java.lang.String msg,
@Nullable
java.lang.String userMsg,
@Nonnull
java.lang.String conflictingSessionID)

Constructs a ConflictingSessionException with supplied error code and message text that will be forwarded to the Client in case the Server can't solve the issue by closing the conflicting session. An internal error message text can also be specified.

Parameters:

clientErrorCode - Error code that can be used to distinguish the kind of problem. It must be a negative integer, or zero to mean an unspecified problem.

msg - The detail message.

userMsg - A detail message to be forwarded to the Client. It can be null. The message should be in simple ASCII, otherwise it might be altered in order to be sent to the client; multiline text is also not allowed.

conflictingSessionID - ID of a Session that can be closed in order to eliminate the reported problem. It must not be null.

Method Details

getConflictingSessionID

@Nonnull
public final java.lang.String getConflictingSessionID()

Gets the ID of a Session that can be closed in order to eliminate the problem reported in this exception.

Returns:

the ID of a Session that can be closed in order to eliminate the problem reported in this exception.