Package org.cyclos.entities.access

Class Pin

java.lang.Object

org.cyclos.entities.SimpleEntity

org.cyclos.entities.NetworkedEntity

org.cyclos.entities.BaseEntity

org.cyclos.entities.NamedEntity

org.cyclos.entities.access.Pin

All Implemented Interfaces:

Cloneable, Comparable<NamedEntity>, HasNetwork, ProcessableForProxying, DelegatingMutableUserPrincipal, DelegatingUserPrincipal, UserPrincipal, IEntity, INamedEntity

@Entity
public class Pin
extends NamedEntity
implements DelegatingMutableUserPrincipal

This class represents user pins that can be used on a device (mainly the mobile app). Also known as Device PINs This will avoid the hardness of entering complex passwords by just entering a simple pin. The pin's value + a random SALT (32 chars long) will be stored hashed (BCrypt) and a random principal will be stored plain.

Nested Class Summary

Nested classes/interfaces inherited from class org.cyclos.entities.SimpleEntity

SimpleEntity.EntityLoadNotifier

Constructor Summary

Constructors

Constructor	Description
Pin()

Method Summary

Modifier and Type	Method	Description
AccessClient	getAccessClient()
UserAccountType	getAccountType()
BasicUser	getBasicUser()
Channel	getChannel()
UserCustomFieldValue	getCustomFieldValue()
Date	getDate()
MobilePhone	getMobilePhone()
Network	getNetwork()	Returns the network this entity belongs to
PasswordType	getPasswordType()
String	getPinPrincipal()	WARNING: This method returns the generated principal associated with the PIN.
PrincipalType	getPrincipalType()
Set<Session>	getSessions()
Token	getToken()
TrustedDevice	getTrustedDevice()
BasicUser	getUser()
UserCustomFieldValue	getUserCustomFieldvalue()
String	getValue()
void	setAccessClient(AccessClient accessClient)
void	setAccountType(UserAccountType accountType)
void	setBasicUser(BasicUser basicUser)
void	setChannel(Channel channel)
void	setCustomFieldValue(UserCustomFieldValue customFieldValue)
void	setDate(Date date)
void	setMobilePhone(MobilePhone mobilePhone)
void	setPasswordType(PasswordType passwordType)
void	setPinPrincipal(String pinPrincipal)
void	setPrincipalType(PrincipalType principalType)
void	setToken(Token token)
void	setTrustedDevice(TrustedDevice trustedDevice)
void	setUser(BasicUser user)
void	setUserCustomFieldvalue(UserCustomFieldValue userCustomFieldvalue)
void	setValue(String value)

Methods inherited from class org.cyclos.entities.NamedEntity

compareTo, getName, getNames, setName, toShortString, toString

Methods inherited from class org.cyclos.entities.BaseEntity

getDataTranslationType, getVersion

Methods inherited from class org.cyclos.entities.NetworkedEntity

isGlobal

Methods inherited from class org.cyclos.entities.SimpleEntity

equals, getId, hashCode, id, ids, isPersistent, isTransient, register, setId, uniqueIds, uniqueIds

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.cyclos.entities.users.DelegatingMutableUserPrincipal

initFrom

Methods inherited from interface org.cyclos.entities.users.DelegatingUserPrincipal

getDelegate, getPrincipal

Methods inherited from interface org.cyclos.model.IEntity

getId, matches

Methods inherited from interface org.cyclos.entities.ProcessableForProxying

getProxyClass

Constructor Detail

Pin

public Pin()

Method Detail

getAccessClient

public AccessClient getAccessClient()

Specified by:

getAccessClient in interface UserPrincipal

getAccountType

public UserAccountType getAccountType()

Specified by:

getAccountType in interface UserPrincipal

getBasicUser

public BasicUser getBasicUser()

Specified by:

getBasicUser in interface UserPrincipal

getChannel

public Channel getChannel()

getCustomFieldValue

public UserCustomFieldValue getCustomFieldValue()

Specified by:

getCustomFieldValue in interface UserPrincipal

getDate

public Date getDate()

getMobilePhone

public MobilePhone getMobilePhone()

Specified by:

getMobilePhone in interface UserPrincipal

getNetwork

public Network getNetwork()

Description copied from interface: HasNetwork

Returns the network this entity belongs to

Specified by:

getNetwork in interface HasNetwork

getPasswordType

public PasswordType getPasswordType()

getPinPrincipal

public String getPinPrincipal()

WARNING: This method returns the generated principal associated with the PIN. To get the principal associated with the UserPrincipal, use DelegatingUserPrincipal.getPrincipal().

getPrincipalType

public PrincipalType getPrincipalType()

Specified by:

getPrincipalType in interface UserPrincipal

getSessions

public Set<Session> getSessions()

getToken

public Token getToken()

Specified by:

getToken in interface UserPrincipal

getTrustedDevice

public TrustedDevice getTrustedDevice()

Specified by:

getTrustedDevice in interface UserPrincipal

getUser

public BasicUser getUser()

getUserCustomFieldvalue

public UserCustomFieldValue getUserCustomFieldvalue()

getValue

public String getValue()

setAccessClient

public void setAccessClient(AccessClient accessClient)

Specified by:

setAccessClient in interface DelegatingMutableUserPrincipal

setAccountType

public void setAccountType(UserAccountType accountType)

Specified by:

setAccountType in interface DelegatingMutableUserPrincipal

setBasicUser

public void setBasicUser(BasicUser basicUser)

Specified by:

setBasicUser in interface DelegatingMutableUserPrincipal

setChannel

public void setChannel(Channel channel)

setCustomFieldValue

public void setCustomFieldValue(UserCustomFieldValue customFieldValue)

Specified by:

setCustomFieldValue in interface DelegatingMutableUserPrincipal

setDate

public void setDate(Date date)

setMobilePhone

public void setMobilePhone(MobilePhone mobilePhone)

Specified by:

setMobilePhone in interface DelegatingMutableUserPrincipal

setPasswordType

public void setPasswordType(PasswordType passwordType)

setPinPrincipal

public void setPinPrincipal(String pinPrincipal)

setPrincipalType

public void setPrincipalType(PrincipalType principalType)

Specified by:

setPrincipalType in interface DelegatingMutableUserPrincipal

setToken

public void setToken(Token token)

Specified by:

setToken in interface DelegatingMutableUserPrincipal

setTrustedDevice

public void setTrustedDevice(TrustedDevice trustedDevice)

Specified by:

setTrustedDevice in interface DelegatingMutableUserPrincipal

setUser

public void setUser(BasicUser user)

setUserCustomFieldvalue

public void setUserCustomFieldvalue(UserCustomFieldValue userCustomFieldvalue)

setValue

public void setValue(String value)