com.inductiveautomation.ignition.common.licensing

Class UnlicensedFeatureException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.inductiveautomation.ignition.common.LocalizedException

com.inductiveautomation.ignition.common.licensing.UnlicensedFeatureException

All Implemented Interfaces:

java.io.Serializable

public class UnlicensedFeatureException
extends LocalizedException

A exception thrown whenever the system tries to do or access something that has not been licensed. Contains a "feature id" describing what was not licensed. It is free form text that should make clear what was not allowed. The message of the exception is localized, and contains the feature id.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UnlicensedFeatureException(java.lang.String featureId) Instantiate a exception for the given unlicensed feature.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFeatureId()

Methods inherited from class com.inductiveautomation.ignition.common.LocalizedException

getMessage

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, 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 Detail

UnlicensedFeatureException

public UnlicensedFeatureException(java.lang.String featureId)

Instantiate a exception for the given unlicensed feature.

Parameters:

featureId - a string that will be included in the error message to represent the unlicensed feature. Should be identifiable and hopefully make clear exactly what isn't licensed.

Method Detail

getFeatureId

public java.lang.String getFeatureId()