com.lightstreamer.interfaces.metadata
Class ConflictingSessionException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by com.lightstreamer.interfaces.metadata.CreditsException
              extended by com.lightstreamer.interfaces.metadata.ConflictingSessionException
All Implemented Interfaces:
java.io.Serializable

public class ConflictingSessionException
extends CreditsException

Thrown by the MetadataProvider.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 name of the other Session is also supplied.
After receiving this exception, the Server may try to close the specified session and invoke MetadataProvider.notifyNewSession(String, String, Map) again.

See Also:
Serialized Form

Constructor Summary
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 to be forwarded to the Client.
 
Method Summary
 java.lang.String getConflictingSessionID()
          Returns the name 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
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ConflictingSessionException

public 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 to be forwarded to the Client. 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.
conflictingSessionID - Name of a Session that can be closed in order to eliminate the reported problem. It must not be null.
Method Detail

getConflictingSessionID

public java.lang.String getConflictingSessionID()
Returns the name of a Session that can be closed in order to eliminate the problem reported in this exception.

Returns:
name of a Session. It should not be null.