com.aspc.DBObj.Misc

Class SecureVault

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.DBObj.Misc.SecureVault

All Implemented Interfaces:

SecondaryCacheGroup

public class SecureVault
extends DBObject

The secure vault contains sensitive information of your system configuration, including SSL private keys. These configuration settings are encrypted on the disk at all times, using AES 256-bit encryption.

Only owners of the site can access these records.

data model
THREAD MODE: MIXED, SINGLE-THREADED when called from MutableDataSource else MULTI-THREADED

Since:

17 June 2015

Author:

Liam Itzhaki

Nested Class Summary

Nested classes/interfaces inherited from class com.aspc.DBObj.DBObject

DBObject.DenormalizeAction

Field Summary

Fields

Modifier and Type	Field and Description
static GlobalId	DBCLASS_GID The secure vault contains sensitive information of your system configuration, including SSL private keys.
static java.lang.String	DBCLASS_NAME The secure vault contains sensitive information of your system configuration, including SSL private keys.

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
SecureVault(DBClass theClass, DataSource dataSource)

Method Summary

Modifier and Type	Method and Description
static SecureVault	create(MutableDataSource mds) Make a new instance of this class.
static SecureVault	findKey(DataSource ds, java.lang.String key) Find the target for this class by the primary key
java.lang.String	getCode(java.lang.String... args)
java.lang.String	getSecret(java.lang.String... args)
static DBQuery<SecureVault>	makeQuery(DataSource ds) Make a new QUERY for this class.
SecureVault	setCode(java.lang.String value, java.lang.String... args)
SecureVault	setSecret(java.lang.String value, java.lang.String... args)

Methods inherited from class com.aspc.DBObj.DBObject

addReloadEventListener, archiveCheck, autoEnterCreate, calculateValue, calculateValue, calculateValue, callingRestoreByJournal, changeThreadMode, checkCreateAccess, checkDelete, checkDeleteAccess, checkModifyAccess, checkModifyAccess, checkReadAccess, clearCache, copy, copyFields, copyIncludeField, copyInwardLinks, delete, denormalizedResult, displayLogName, displayName, displayValue, doSearch, dump, equals, eventDataLoaded, eventFieldUpdated, extAutoEnterCreate, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extFixUp, extGetDerivedGlobalKey, extGetDerivedValue, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreSaveRecord, extPreValidate, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extSetValue, extUndelete, extValidateDelete, extValidateField, extValidateRecord, fetchLinkHolder, findGlobalKey, findGlobalKey, findGlobalKey, findGlobalKey, findLinkedObject, findLinkedObject, findLinkedObject, findRawData, fireEventDataLoaded, fixUp, forceLockedTransaction, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getChangedFieldInfo, getChangedFields, getDate, getDate, getDate, getDate, getDate, getDefaultValue, getDisableOnChangeEvent, getDouble, getDouble, getDouble, getDouble, getDouble, getFieldDouble, getFieldInt, getFieldLong, getFieldString, getFormattedString, getFormattedString, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getInt, getInt, getInt, getInt, getInt, getInt, getInwardLinkage, getKeyString, getKeyValue, getLinkedObject, getLinkedObject, getLinkedObject, getLinkedObjectByKey, getLinkedRowId, getLinkedRowId, getLinkedRowIdByData, getLinkHolder, getLockedTransaction, getLong, getLong, getLong, getLong, getLong, getLong, getMutableArrayValue, getMutableArrayValue, getOriginalKey, getOriginalValue, getOriginalValue, getProcessedValue, getPureValue, getRawData, getRawValue, getRawValue, getRowId, getRowKey, getSecondaryCacheGroupKey, getSrcLayerID, getString, getString, getString, getString, getString, getString, getValue, getValue, getValue, getValue, hasAutoChanged, hasAutoChanged, hasChanged, hasChangedByUser, hasChangedByUserField, hasChangedByUserField, hasFieldChanged, hasFieldChanged, hashCode, hasStoredResult, iCheckDeleteAccess, iCheckModifyAccess, iCheckReadAccess, iGetDenormalizedMap, iGetRawValue, iPlaceDenormalizedResult, iPostSaveOrDeleteRecord, iPreSaveOrDeleteRecord, iPreValidate, iRaiseEvents, iSaveOrDeleteRecord, isBrokenLink, isBrokenLink, isChanged, isDataCacheKnownToBeDirty, isDeleted, isEmpty, iSetValue, isForceReindex, isKeyWordField, isMandatory, isNew, isNull, isNull, isOnChange, isReindex, iValidateRecord, lastTouched, makeArchiveDataLoader, makeClone, makeDataLoader, makeDenormalizedDoc, makeLinkedArray, makeModifyAccessException, makeSearchPlan, makeWriteProvider, manualDenormalizeOnSave, markSavePoint, optLockedTransaction, registerWatchedObject, reindex, releaseDenormalized, removeReloadEventListener, restoreByJournal, rollbackTo, setBoolean, setBoolean, setBoolean, setBoolean, setDisableOnChangeEvent, setDouble, setDouble, setInt, setInt, setLong, setLong, setRawData, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, touch, undelete, validateField, validateRecord, validateSubType

Methods inherited from class java.lang.Object

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

Field Detail

DBCLASS_NAME

public static final java.lang.String DBCLASS_NAME

The secure vault contains sensitive information of your system configuration, including SSL private keys. These configuration settings are encrypted on the disk at all times, using AES 256-bit encryption.

Only owners of the site can access these records.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

The secure vault contains sensitive information of your system configuration, including SSL private keys. These configuration settings are encrypted on the disk at all times, using AES 256-bit encryption.

Only owners of the site can access these records.

Constructor Detail

SecureVault

public SecureVault(DBClass theClass,
                   DataSource dataSource)
            throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

getCode

@CheckReturnValue
 @Nonnull
public java.lang.String getCode(java.lang.String... args)

setCode

@Nonnull
public SecureVault setCode(java.lang.String value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:

java.lang.Exception

getSecret

@CheckReturnValue
 @Nonnull
public java.lang.String getSecret(java.lang.String... args)

setSecret

@Nonnull
public SecureVault setSecret(java.lang.String value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

create

@Nonnull
 @CheckReturnValue
public static SecureVault create(@Nonnull
                                                             MutableDataSource mds)
                                                      throws java.lang.Exception

Make a new instance of this class.

Parameters:

mds - the datasource

Returns:

the new record

Throws:

java.lang.Exception - an object of this class could not be created

makeQuery

@Nonnull
 @CheckReturnValue
public static DBQuery<SecureVault> makeQuery(@Nonnull
                                                                         DataSource ds)
                                                                  throws NotFoundException

Make a new QUERY for this class.

Parameters:

ds - the datasource

Returns:

the new QUERY

Throws:

NotFoundException - if class could not be found

findKey

@Nonnull
 @CheckReturnValue
public static SecureVault findKey(@Nonnull
                                                              DataSource ds,
                                                              @Nonnull
                                                              java.lang.String key)
                                                       throws NotFoundException,
                                                              java.lang.Exception

Find the target for this class by the primary key

Parameters:

ds - the datasource

key - the value

Returns:

the target

Throws:

NotFoundException - if target could not be found

java.lang.Exception - a serious problem