com.inductiveautomation.ignition.common.licensing.runtimelock

Class RuntimeLockFactory.SymmetricEncryptedLock

java.lang.Object

com.inductiveautomation.ignition.common.licensing.runtimelock.RuntimeLockFactory.SymmetricEncryptedLock

All Implemented Interfaces:

RuntimeLock, java.io.Serializable

Enclosing class:

RuntimeLockFactory

protected static class RuntimeLockFactory.SymmetricEncryptedLock
extends java.lang.Object
implements RuntimeLock

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.inductiveautomation.ignition.common.licensing.runtimelock.RuntimeLock

DETAIL_CAN_EDIT, LICENSE_DETAIL, LOCK_OWNER_NAME

Constructor Summary

Constructors

Constructor and Description
SymmetricEncryptedLock(java.lang.String lockOwner, java.lang.String licenseKey, boolean canEdit) Creates a symmetric lock with the provided key.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getLockId() Should return a short string identifying this particular lock.
protected static org.apache.log4j.Logger	getLogger()
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SymmetricEncryptedLock

public SymmetricEncryptedLock(java.lang.String lockOwner,
                              java.lang.String licenseKey,
                              boolean canEdit)
                       throws java.lang.Exception

Creates a symmetric lock with the provided key.

Parameters:

lockOwner - The company who owns this lock

licenseKey - The symmetric encryption key. Should be a Base64'd version of a GatewaySec encrypted DESede key

canEdit - Whether or not this lock is allowed to edit locked projects

Throws:

java.lang.Exception

Method Detail

getLogger

protected static org.apache.log4j.Logger getLogger()

getLockId

public java.lang.String getLockId()

Description copied from interface: RuntimeLock

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.

Specified by:

getLockId in interface RuntimeLock

supportsEditing

public boolean supportsEditing()

Description copied from interface: RuntimeLock

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.

Specified by:

supportsEditing in interface RuntimeLock

lockResource

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

Description copied from interface: RuntimeLock

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

Specified by:

lockResource in interface RuntimeLock

Throws:

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

java.lang.Exception

unlockResource

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

Description copied from interface: RuntimeLock

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.

Specified by:

unlockResource in interface RuntimeLock

Throws:

java.lang.Exception