Package org.cyclos.impl.access

Interface PrincipalTypeServiceLocal

All Superinterfaces:

CRUDService<PrincipalTypeDTO,PrincipalTypeData,PrincipalTypeNature>, CRUDServiceLocal<PrincipalType,PrincipalTypeDTO,PrincipalTypeData,PrincipalTypeNature>, PrincipalTypeService, Service

All Known Implementing Classes:

PrincipalTypeServiceImpl

public interface PrincipalTypeServiceLocal
extends PrincipalTypeService, CRUDServiceLocal<PrincipalType,PrincipalTypeDTO,PrincipalTypeData,PrincipalTypeNature>

Local interface for PrincipalTypeService

Method Summary

Modifier and Type	Method	Description
PrincipalType	find(String internalName, Network network)	Finds a principal by internal name in the specified network
BuiltInPrincipalType	getAccountNumber()	Returns the account number principal type
CustomFieldPrincipalType	getCustomField(UserCustomField field)	Returns the principal type for the given custom field
BuiltInPrincipalType	getEmail()	Returns the e-mail principal type
BuiltInPrincipalType	getMobilePhone()	Returns the mobilePhone principal type
byte[]	getPiccMasterKey(NFCTokenPrincipalType nfcTokenPrincipalType)	Returns the encryption key set for the given NFCTokenPrincipalType.
BuiltInPrincipalType	getTrustedDevice()	Returns the trustedDevice principal type
BuiltInPrincipalType	getUsername()	Returns the username principal type
List<AccessClientPrincipalType>	listAccessClients()	Returns a list with all access clients
List<PrincipalType>	listAll()	Returns all principal types
List<PrincipalType>	listByNatures(PrincipalTypeNature... natures)	List the principal types filtering by principal type natures
List<TokenPrincipalType>	listByType(TokenType type)	List the token principal types filtering by token type
List<PrincipalType>	listForConfiguration(ConfigurationAccessor configuration, Channel channel, PrincipalTypeContext context)	Returns the principal types which can be used on channel configurations under the given channel and context
List<PrincipalType>	listForLogin()	Returns the principal types which can be used for login
List<PrincipalType>	listForLogin(ChannelConfiguration channelConfiguration)	Returns the principal types which can be used for login in the given channel configuration
List<TokenPermissionsVO>	listUserTokenPermissions(BasicUser user)	Returns the permissions over tokens for the given user.
List<TokenPermissionsVO>	listUserTokenPermissions(UserGroup group, boolean asMember)	Returns the permissions over tokens on a user registration.
List<AccessClientPrincipalType>	listVisibleAccessClients(User user)	Returns the access client types the logged user can see over the given user
PrincipalType	load(String internalName)	Loads a principal type by internal name
void	sort(List<PrincipalType> principalTypes)	Sorts the given list of principal types according to the search order

Methods inherited from interface org.cyclos.services.CRUDService

getData, getDataForNew, load, remove, removeAll, save

Methods inherited from interface org.cyclos.impl.CRUDServiceLocal

find, findAll, getEntityClass, newEntity, remove, removeAll, saveEntity, saveSkippingEntityLog, toDTO, toEntity, validate

Methods inherited from interface org.cyclos.services.access.PrincipalTypeService

list, listUserTokenPermissions

Method Detail

find

PrincipalType find(String internalName,
                   Network network)

Finds a principal by internal name in the specified network

getAccountNumber

BuiltInPrincipalType getAccountNumber()

Returns the account number principal type

getCustomField

CustomFieldPrincipalType getCustomField(UserCustomField field)

Returns the principal type for the given custom field

getEmail

BuiltInPrincipalType getEmail()

Returns the e-mail principal type

getMobilePhone

BuiltInPrincipalType getMobilePhone()

Returns the mobilePhone principal type

getPiccMasterKey

byte[] getPiccMasterKey(NFCTokenPrincipalType nfcTokenPrincipalType)

Returns the encryption key set for the given NFCTokenPrincipalType. This plain key will be sent at NFCToken's initialization.

See Also:

TokenService.initializeNFCTag(org.cyclos.model.access.tokens.NFCTagInitializeDTO)

getTrustedDevice

BuiltInPrincipalType getTrustedDevice()

Returns the trustedDevice principal type

getUsername

BuiltInPrincipalType getUsername()

Returns the username principal type

listAccessClients

List<AccessClientPrincipalType> listAccessClients()

Returns a list with all access clients

listAll

List<PrincipalType> listAll()

Returns all principal types

listByNatures

List<PrincipalType> listByNatures(PrincipalTypeNature... natures)

List the principal types filtering by principal type natures

listByType

List<TokenPrincipalType> listByType(TokenType type)

List the token principal types filtering by token type

listForConfiguration

List<PrincipalType> listForConfiguration(ConfigurationAccessor configuration,
                                         Channel channel,
                                         PrincipalTypeContext context)

Returns the principal types which can be used on channel configurations under the given channel and context

listForLogin

List<PrincipalType> listForLogin()

Returns the principal types which can be used for login

listForLogin

List<PrincipalType> listForLogin(ChannelConfiguration channelConfiguration)

Returns the principal types which can be used for login in the given channel configuration

listUserTokenPermissions

List<TokenPermissionsVO> listUserTokenPermissions(BasicUser user)

Returns the permissions over tokens for the given user. If the user is null, returns permissions over other managed users.

listUserTokenPermissions

List<TokenPermissionsVO> listUserTokenPermissions(UserGroup group,
                                                  boolean asMember)

Returns the permissions over tokens on a user registration. If the group is null, don't filter by enabled token types for that group.

listVisibleAccessClients

List<AccessClientPrincipalType> listVisibleAccessClients(User user)

Returns the access client types the logged user can see over the given user

load

PrincipalType load(String internalName)

Loads a principal type by internal name

sort

void sort(List<PrincipalType> principalTypes)

Sorts the given list of principal types according to the search order