Package com.storedobject.core

Class PIN

java.lang.Object

com.storedobject.core.StoredObject

com.storedobject.core.PIN

All Implemented Interfaces:

Displayable, StringFiller, HasId

public final class PIN
extends StoredObject

This class represents a PIN stored in the system corresponding to a StoredObject.

Field Summary

Fields inherited from class com.storedobject.core.StoredObject

logger

Constructor Summary

Constructors

Constructor	Description
PIN()	Constructor for internal use only
PIN(Id ownerId, String type)	Constructs a PIN.

Method Summary

Modifier and Type	Method	Description
void	changePIN(char[] currentPIN, char[] newPIN)	Change the pin.
static void	columns(Columns columns)
static String[]	displayColumns()
static PIN	get(Id owner, String type)
Date	getExpiry()
StoredObject	getOwner()	Gets the owner.
Id	getOwnerId()	Gets the Id of the owner.
String	getPIN()
PasswordPolicy	getPolicy()
int	getStatus()
String	getType()	Gets the type of the PIN.
static void	indices(Indices indices)
boolean	isExpired()
void	loaded()	This method is called whenever the instance is loaded from the database.
static String[]	protectedColumns()
void	resetPIN()
void	setExpiry(Date expiry)
void	setOwner(BigDecimal idValue)
void	setPIN(String pin)
void	setStatus(int status)
void	setType(String type)
static boolean	similar(char[] oldPassword, char[] newPassword)
void	validateData(TransactionManager tm)	The system will invoke this whenever the object is saved to the DB.
void	validateNewPIN(char[] currentPIN, char[] newPIN)
boolean	verify(char[] pin, boolean ignoreAuthenticator)
boolean	verify(char[] pin, int authenticatorCode)
static boolean	verify(Id ownerId, String type, char[] pin)

Methods inherited from class com.storedobject.core.StoredObject

addLink, addLink, addLink, addLink, addLink, addLink, addLink, addLink, checkCurrency, checkCurrency, checkForDuplicate, checkForDuplicate, checkTimeZone, checkTransaction, clearObjectLinks, contemporary, copy, copy, count, count, count, count, count, count, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, create, created, delete, delete, delete, deleted, directUpdate, equals, exists, exists, exists, exists, exists, existsFileData, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsMaster, existsMaster, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, family, family, family, family, fill, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, getActor, getAttachment, getAttachmentId, getChildren, getContemporaryOf, getDeleted, getDeleted, getExistsCondition, getExistsCondition, getFileData, getFileData, getHistorical, getId, getKeyIndex, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getNotExistsCondition, getNotExistsCondition, getParent, getParent, getParent, getParentId, getParentId, getParentId, getRelated, getRelated, getTransaction, getTransactionId, getTransactionIP, getUnique, getUniqueCondition, hashCode, inserted, isModified, isVirtual, list, list, list, list, list, list, list, list, list, list, list, list, list, listDeletedIds, listFileData, listFileData, listHistory, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listTree, listTree, listTree, listTree, listViaQuery, listViaQuery, load, load, load, load, loadAttributesFrom, loading, makeNew, makeVirtual, migrate, moduleName, nextVersion, objectLink, objectLink, objectLink, objectLinks, objectLinks, old, person, previousVersion, previousVersion, query, query, query, query, query, query, query, query, query, query, query, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, reload, reload, reloaded, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeReverseLinks, removeReverseLinks, save, save, save, save, save, save, save, save, save, save, save, save, save, save, save, saved, saving, setMaster, setRawValue, setTransaction, stringify, tableName, timestamp, toCode, toDisplay, toString, transacting, undelete, undelete, undeleted, updated, user, userId, validate, validateChildAttach, validateChildDetach, validateChildUpdate, validateDelete, validateInsert, validateParentAttach, validateParentDetach, validateParentUpdate, validateUndelete, validateUpdate, valueEquals

Methods inherited from class java.lang.Object

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

Constructor Details

PIN

public PIN(Id ownerId,
 String type)

Constructs a PIN.

Parameters:

ownerId - The Id of the object that owns this PIN.

type - PIN type.

PIN

public PIN()

Constructor for internal use only

Method Details

columns

public static void columns(Columns columns)

displayColumns

public static String[] displayColumns()

protectedColumns

public static String[] protectedColumns()

indices

public static void indices(Indices indices)

get

public static PIN get(Id owner,
 String type)

getType

@SetNotAllowed
public String getType()

Gets the type of the PIN.

Returns:

The type.

setType

public void setType(String type)

getOwnerId

@SetNotAllowed
@Column(style="(any)")
public Id getOwnerId()

Gets the Id of the owner.

Returns:

The Id of the owner.

setOwner

public void setOwner(BigDecimal idValue)

getOwner

public StoredObject getOwner()

Gets the owner.

Returns:

The owner.

getStatus

@SetNotAllowed
public int getStatus()

setStatus

public void setStatus(int status)

setExpiry

public void setExpiry(Date expiry)

getExpiry

public Date getExpiry()

isExpired

public boolean isExpired()

getPIN

@SetNotAllowed
public String getPIN()

setPIN

public void setPIN(String pin)

validateNewPIN

public void validateNewPIN(char[] currentPIN,
 char[] newPIN)
                    throws SOException

Throws:

SOException

changePIN

public void changePIN(char[] currentPIN,
 char[] newPIN)
               throws SOException

Change the pin.

Parameters:

currentPIN - Current PIN.

newPIN - New PIN.

Throws:

SOException - If PIN can not be set.

resetPIN

public void resetPIN()
              throws Exception

Throws:

Exception

loaded

public void loaded()

Description copied from class: StoredObject

This method is called whenever the instance is loaded from the database. Any additional logic can be here for extended classes.

Overrides:

loaded in class StoredObject

verify

public boolean verify(char[] pin,
 boolean ignoreAuthenticator)

verify

public boolean verify(char[] pin,
 int authenticatorCode)

verify

public static boolean verify(Id ownerId,
 String type,
 char[] pin)

validateData

public void validateData(TransactionManager tm)
                  throws Exception

Description copied from class: StoredObject

The system will invoke this whenever the object is saved to the DB. It will be invoked in all cases while creating new objects and updating/deleting/undeleting existing objects. If any exception is raised by this method, the process of saving to the DB will be abandoned.

Note: This method is mainly used to validate the data of all attributes of the object, and it may be used by others for validating the object. For example, front-end data-entry systems can use this method for validating the object.

Overrides:

validateData in class StoredObject

Parameters:

tm - Current transaction manager.

Throws:

Exception - If data is invalid.

getPolicy

public PasswordPolicy getPolicy()

similar

public static boolean similar(char[] oldPassword,
 char[] newPassword)