com.inductiveautomation.ignition.common.licensing.runtimelock

Interface RuntimeLock

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

RuntimeLockFactory.MissingOEMLock, RuntimeLockFactory.SimpleOEMLock, RuntimeLockFactory.SymmetricEncryptedLock

public interface RuntimeLock
extends java.io.Serializable

The RuntimeLock (OEM-Lock) is a feature that lets the system lock projects so that unauthorized installations cannot modify them. In this way, OEMs can protect the investment made in developing a project.

The actual lock is created from a license file. Depending on the values present in the file, different types of locks can be created. The system will look for the runtime lock in various places and react differently based on its presence and capabilities.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DETAIL_CAN_EDIT If the value of this license key is "true", then the current system can edit locked projects.
static java.lang.String	LICENSE_DETAIL Name of the detail in the license file that dictates the type of lock
static java.lang.String	LOCK_OWNER_NAME Name of the detail in the license file that holds the name of the company who owns this lock

Method Summary

Modifier and Type	Method and Description
java.lang.String	getLockId() Should return a short string identifying this particular lock.
byte[]	lockResource(byte[] data) Takes some data and returns a locked version of it.
boolean	supportsEditing() Returns whether this lock has the ability to edit resources (ie lock) resources.
byte[]	unlockResource(byte[] data) Takes a locked version of data and returns it in unlocked form.

Field Detail

LICENSE_DETAIL

static final java.lang.String LICENSE_DETAIL

Name of the detail in the license file that dictates the type of lock

See Also:

Constant Field Values

LOCK_OWNER_NAME

static final java.lang.String LOCK_OWNER_NAME

Name of the detail in the license file that holds the name of the company who owns this lock

See Also:

Constant Field Values

DETAIL_CAN_EDIT

static final java.lang.String DETAIL_CAN_EDIT

If the value of this license key is "true", then the current system can edit locked projects.

See Also:

Constant Field Values

Method Detail

getLockId

java.lang.String getLockId()

Should return a short string identifying this particular lock. It will be stored along with locked objects, so that it will always be possible to identify which lock was used to protect them. Therefore, this value should not change after it has been used to project a resource.

supportsEditing

boolean supportsEditing()

Returns whether this lock has the ability to edit resources (ie lock) resources. If false, calls to lockResource will throw an exception, effectively preventing modifications to resources.

lockResource

byte[] lockResource(byte[] data)
             throws java.lang.Exception

Takes some data and returns a locked version of it. Can only be called if this OEMLock supports editing, otherwise will throw an exception.

Throws:

UnlicensedFeatureException - if the write lock isn't present, other exceptions for normal stuff.

java.lang.Exception

unlockResource

byte[] unlockResource(byte[] data)
               throws java.lang.Exception

Takes a locked version of data and returns it in unlocked form. An OEMLock should always be able to unlock data that was locked with it, even if the current lock doesn't have the ability to modify it.

Throws:

java.lang.Exception