Module io.github.tonywasher.joceanus.prometheus.core

Package io.github.tonywasher.joceanus.prometheus.data

Class PrometheusDataKeySet

java.lang.Object

io.github.tonywasher.joceanus.metis.field.MetisFieldVersionedItem

io.github.tonywasher.joceanus.prometheus.data.PrometheusDataItem

io.github.tonywasher.joceanus.prometheus.data.PrometheusDataKeySet

All Implemented Interfaces:

MetisDataItem.MetisDataDeletableItem, MetisDataItem.MetisDataIndexedItem, MetisDataItem.MetisDataObjectFormat, MetisFieldItem, MetisFieldItem.MetisFieldTableItem, MetisFieldVersion.MetisFieldUpdatableItem, MetisFieldVersion.MetisFieldVersionedItemCtl, PrometheusCryptographyData.PrometheusDataKeySetCtl, PrometheusData.PrometheusDataItemCtl, PrometheusTableItem, Comparable<Object>

public class PrometheusDataKeySet
extends PrometheusDataItem
implements PrometheusCryptographyData.PrometheusDataKeySetCtl

ControlKey definition and list. The Control Key represents the passwordHash that controls securing of the dataKeys. It maintains a map of the associated DataKeys.

Author:

Tony Washer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PrometheusDataKeySet.PrometheusDataKeySetList	DataKeySet List.

Nested classes/interfaces inherited from interface io.github.tonywasher.joceanus.metis.field.MetisFieldItem

MetisFieldItem.MetisFieldDef, MetisFieldItem.MetisFieldItemType, MetisFieldItem.MetisFieldSetCtl<T extends MetisFieldItem>, MetisFieldItem.MetisFieldSetDef, MetisFieldItem.MetisFieldTableItem, MetisFieldItem.MetisFieldVersionedDef

Nested classes/interfaces inherited from interface io.github.tonywasher.joceanus.prometheus.data.PrometheusTableItem

PrometheusTableItem.PrometheusTableList<T extends PrometheusTableItem>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	LIST_NAME	List name.
static final String	OBJECT_NAME	Object name.
static final int	WRAPLEN	KeySetWrapLength.

Fields inherited from class io.github.tonywasher.joceanus.prometheus.data.PrometheusDataItem

DESCLEN, ERROR_CREATEITEM, ERROR_DISABLED, ERROR_DUPLICATE, ERROR_EXIST, ERROR_INVALIDCHAR, ERROR_LENGTH, ERROR_MISSING, ERROR_MULT, ERROR_NEGATIVE, ERROR_POSITIVE, ERROR_RANGE, ERROR_RESOLUTION, ERROR_UNKNOWN, ERROR_VALIDATION, ERROR_ZERO, NAMELEN

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PrometheusDataKeySet(PrometheusDataKeySet.PrometheusDataKeySetList pList, PrometheusCryptographyData.PrometheusControlKeySetCtl pControlKeySet)	Constructor for a new DataKeySet.
protected	PrometheusDataKeySet(PrometheusDataKeySet.PrometheusDataKeySetList pList, PrometheusDataKeySet pSource)	Copy Constructor.

Method Summary

Modifier and Type	Method	Description
int	compareValues(PrometheusDataItem pThat)	compareTo another dataItem.
protected void	deleteDataKeySet()	Delete the old set of DataKeySet and DataKeys.
PrometheusDataKeySet	getBase()	Get the base item for this item.
final PrometheusCryptographyData.PrometheusControlKeyCtl	getControlKey()	Get the ControlKey.
final PrometheusCryptographyData.PrometheusControlKeySetCtl	getControlKeySet()	Get the ControlKeySet.
Integer	getControlKeySetId()	Get the ControlKeyId for this item.
MetisFieldItem.MetisFieldSetDef	getDataFieldSet()	Obtain the fieldSet.
PrometheusEncryptor	getEncryptor()	Get the Encryptor.
GordianKeySet	getKeySet()	Get the KeySet.
PrometheusDataKeySet.PrometheusDataKeySetList	getList()	Obtain the list.
final byte[]	getSecuredKeySetDef()	Get the securedKeySetDef.
void	resolveDataSetLinks()	Resolve all references to current dataSet.

Methods inherited from class io.github.tonywasher.joceanus.prometheus.data.PrometheusDataItem

addError, adjustMapForItem, applyChanges, byteLength, clearActive, clearTouches, compareId, compareTo, deRegister, equals, fieldChanged, formatObject, getBaseState, getDataSet, getFieldState, getItemState, getItemType, getNextVersion, getStyle, getTouchStatus, getValueSetVersion, hashCode, includeXmlField, indexOf, isActive, isDisabled, isEditable, isHeader, isListLocked, isLocked, popHistory, removeItem, resolveDataLink, resolveDataLink, rewindToVersion, setBase, setHeader, setHistory, setNewVersion, setValidEdit, touchItem, touchOnUpdate, touchUnderlyingItems, unLink, updateMaps, validate, validString

Methods inherited from class io.github.tonywasher.joceanus.metis.field.MetisFieldVersionedItem

adjustState, checkForHistory, clearErrors, clearHistory, condenseHistory, fieldChanged, getEditState, getFieldErrors, getFieldErrors, getFirstError, getIndexedId, getOriginalValues, getOriginalVersion, getState, getValidation, getValues, getValuesHistory, getVersion, getVersionedField, hasChanges, hasErrors, hasErrors, hasHistory, isDeleted, isValid, maybePopHistory, newVersionValues, pushHistory, pushHistory, resetHistory, setDeleted, setEditState, setHistory, setIndexedId, setItemType, setValues

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.tonywasher.joceanus.metis.data.MetisDataItem.MetisDataDeletableItem

isActive, isDeleted, setDeleted

Methods inherited from interface io.github.tonywasher.joceanus.metis.data.MetisDataItem.MetisDataIndexedItem

getIndexedId

Methods inherited from interface io.github.tonywasher.joceanus.metis.data.MetisDataItem.MetisDataObjectFormat

formatObject

Methods inherited from interface io.github.tonywasher.joceanus.metis.field.MetisFieldVersion.MetisFieldUpdatableItem

checkForHistory, getFieldErrors, getFieldErrors, getNextVersion, getOriginalValues, getValues, getValuesHistory, hasErrors, isEditable, popHistory, pushHistory, skipField

Methods inherited from interface io.github.tonywasher.joceanus.prometheus.data.PrometheusData.PrometheusDataItemCtl

setIndexedId

Methods inherited from interface io.github.tonywasher.joceanus.prometheus.data.PrometheusTableItem

isHeader

Field Details

OBJECT_NAME

public static final String OBJECT_NAME

Object name.

LIST_NAME

public static final String LIST_NAME

List name.

WRAPLEN

public static final int WRAPLEN

KeySetWrapLength.

Constructor Details

PrometheusDataKeySet

protected PrometheusDataKeySet(PrometheusDataKeySet.PrometheusDataKeySetList pList,
 PrometheusDataKeySet pSource)

Copy Constructor.

Parameters:

pList - the list the copy belongs to

pSource - The Key to copy

PrometheusDataKeySet

protected PrometheusDataKeySet(PrometheusDataKeySet.PrometheusDataKeySetList pList,
 PrometheusCryptographyData.PrometheusControlKeySetCtl pControlKeySet)
                        throws OceanusException

Constructor for a new DataKeySet.

Parameters:

pList - the list to which to add the keySet to

pControlKeySet - the control keySet

Throws:

OceanusException - on error

Method Details

getDataFieldSet

public MetisFieldItem.MetisFieldSetDef getDataFieldSet()

Description copied from interface: MetisFieldItem

Obtain the fieldSet.

Specified by:

getDataFieldSet in interface MetisFieldItem

Overrides:

getDataFieldSet in class MetisFieldVersionedItem

Returns:

the fieldSet

getControlKey

public final PrometheusCryptographyData.PrometheusControlKeyCtl getControlKey()

Get the ControlKey.

Returns:

the controlKey

getControlKeySet

public final PrometheusCryptographyData.PrometheusControlKeySetCtl getControlKeySet()

Get the ControlKeySet.

Returns:

the controlKeySet

getControlKeySetId

public Integer getControlKeySetId()

Get the ControlKeyId for this item.

Returns:

the ControlKeyId

getSecuredKeySetDef

public final byte[] getSecuredKeySetDef()

Get the securedKeySetDef.

Returns:

the securedKeySetDef

getKeySet

public GordianKeySet getKeySet()

Get the KeySet.

Returns:

the keySet

getEncryptor

public PrometheusEncryptor getEncryptor()

Get the Encryptor.

Returns:

the encryptor

getBase

public PrometheusDataKeySet getBase()

Description copied from class: PrometheusDataItem

Get the base item for this item.

Overrides:

getBase in class PrometheusDataItem

Returns:

the Base item or null

getList

public PrometheusDataKeySet.PrometheusDataKeySetList getList()

Description copied from class: PrometheusDataItem

Obtain the list.

Overrides:

getList in class PrometheusDataItem

Returns:

the list

compareValues

public int compareValues(PrometheusDataItem pThat)

Description copied from class: PrometheusDataItem

compareTo another dataItem.

Specified by:

compareValues in class PrometheusDataItem

Parameters:

pThat - the DataItem to compare

Returns:

the order

resolveDataSetLinks

public void resolveDataSetLinks()
                         throws OceanusException

Description copied from class: PrometheusDataItem

Resolve all references to current dataSet.

Overrides:

resolveDataSetLinks in class PrometheusDataItem

Throws:

OceanusException - on error

deleteDataKeySet

protected void deleteDataKeySet()

Delete the old set of DataKeySet and DataKeys.