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

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

Class PrometheusControlData

java.lang.Object

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

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

io.github.tonywasher.joceanus.prometheus.data.PrometheusControlData

All Implemented Interfaces:

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

public class PrometheusControlData
extends PrometheusDataItem
implements PrometheusCryptographyData.PrometheusControlDataCtl

ControlData definition and list. The Control Data represents the data version of the entire data set, allowing for migration code to be written to map between different versions. It also holds a pointer to the active ControlKey.

When code is loaded from a database, it is possible that more than one control key will be active. This will occur if a failure occurs when we are writing the results of a renewSecurity request to the database, and we have changed some records, but not all, to the required controlKey. This record points to the active controlKey. All records that are not encrypted by the correct controlKey should be re-encrypted and written to the database.

Author:

Tony Washer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PrometheusControlData.PrometheusControlDataList	Control Data 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	ERROR_CTLEXISTS	Error message for already exists.
static final String	LIST_NAME	List name.
static final String	OBJECT_NAME	Object name.

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	PrometheusControlData(PrometheusControlData.PrometheusControlDataList pList, PrometheusControlData pSource)	Copy Constructor.

Method Summary

Modifier and Type	Method	Description
int	compareValues(PrometheusDataItem pThat)	compareTo another dataItem.
PrometheusControlData	getBase()	Get the base item for this item.
PrometheusControlKey	getControlKey()	Get the control key.
Integer	getControlKeyId()	Get the ControlKeyId for this item.
MetisFieldItem.MetisFieldSetDef	getDataFieldSet()	Obtain the fieldSet.
Integer	getDataVersion()	Get the data version.
PrometheusControlData.PrometheusControlDataList	getList()	Obtain the list.
void	resolveDataSetLinks()	Resolve all references to current dataSet.
void	setControlKey(PrometheusCryptographyData.PrometheusControlKeyCtl pControl)	Set a new ControlKey.

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.

ERROR_CTLEXISTS

public static final String ERROR_CTLEXISTS

Error message for already exists.

Constructor Details

PrometheusControlData

protected PrometheusControlData(PrometheusControlData.PrometheusControlDataList pList,
 PrometheusControlData pSource)

Copy Constructor.

Parameters:

pList - the associated list

pSource - The source

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

getDataVersion

public Integer getDataVersion()

Get the data version.

Returns:

data version

getControlKey

public PrometheusControlKey getControlKey()

Description copied from interface: PrometheusCryptographyData.PrometheusControlDataCtl

Get the control key.

Specified by:

getControlKey in interface PrometheusCryptographyData.PrometheusControlDataCtl

Returns:

the control key

getControlKeyId

public Integer getControlKeyId()

Get the ControlKeyId for this item.

Returns:

the ControlKeyId

getBase

public PrometheusControlData 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 PrometheusControlData.PrometheusControlDataList 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

setControlKey

public void setControlKey(PrometheusCryptographyData.PrometheusControlKeyCtl pControl)
                   throws OceanusException

Description copied from interface: PrometheusCryptographyData.PrometheusControlDataCtl

Set a new ControlKey.

Specified by:

setControlKey in interface PrometheusCryptographyData.PrometheusControlDataCtl

Parameters:

pControl - the new control key

Throws:

OceanusException - on error