Package com.lightstreamer.interfaces.metadata

Class CreditsException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.lightstreamer.interfaces.metadata.CreditsException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ConflictingSessionException

public class CreditsException
extends Exception

Thrown by the notify* methods in MetadataProvider if some functionality cannot be allowed to the supplied User. This may occur if the user is not granted some resource or if the user would exceed the granted amount. Different kinds of problems can be distinguished by an error code. Both the error message detail and the error code will be forwarded by Lightstreamer Kernel to the Client.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
CreditsException(int clientErrorCode, String msg)	Constructs a CreditsException with supplied error code and message text.
CreditsException(int clientErrorCode, String msg, String userMsg)	Constructs a CreditsException with supplied error code and message text to be forwarded to the Client.

Method Summary

Modifier and Type	Method	Description
int	getClientErrorCode()	Returns the error code to be forwarded to the client.
String	getClientErrorMsg()	Returns the error detail message to be forwarded to the client.

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

CreditsException

public CreditsException(int clientErrorCode,
 @Nullable
 String msg,
 @Nullable
 String userMsg)

Constructs a CreditsException 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, in which case an empty string message will be forwarded. The message is free, but if it is not in simple ASCII or if it is multiline, it might be altered in order to be sent to very old non-TLCP clients.

CreditsException

public CreditsException(int clientErrorCode,
 @Nullable
 String msg)

Constructs a CreditsException with supplied error code and message text.

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.

Method Details

getClientErrorCode

public int getClientErrorCode()

Returns the error code to be forwarded to the client.

Returns:

error code or zero to mean an unspecified error.

getClientErrorMsg

@Nullable
public String getClientErrorMsg()

Returns the error detail message to be forwarded to the client. If the message is not in simple ASCII or is in multiline format, the real text sent to very old non-TLCP clients might be altered. If null, an empty string message will be forwarded instead.

Returns:

error detail message. It can be null.