Class ConflictingSessionException
- java.lang.Object
-
- java.lang.Throwable
-
- java.lang.Exception
-
- com.lightstreamer.interfaces.metadata.CreditsException
-
- com.lightstreamer.interfaces.metadata.ConflictingSessionException
-
- All Implemented Interfaces:
java.io.Serializable
public class ConflictingSessionException extends CreditsException
Thrown by theMetadataProvider.notifyNewSession(String, String, Map)
method 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 invokeMetadataProvider.notifyNewSession(String, String, Map)
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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getConflictingSessionID()
Returns 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.interfaces.metadata.CreditsException
getClientErrorCode, getClientErrorMsg
-
-
-
-
Constructor Detail
-
ConflictingSessionException
public ConflictingSessionException(int clientErrorCode, @Nullable java.lang.String msg, @Nullable java.lang.String userMsg, @Nullable 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.
-
-