org.cyclos.impl.access

Interface PrincipalTypeServiceLocal

All Superinterfaces:

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

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

Local interface for PrincipalTypeService

Author:

luis

Method Summary

Modifier and Type	Method and Description
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	getUsername() Returns the username principal type
java.util.List<AccessClientPrincipalType>	listAccessClients() Returns a list with all access clients
java.util.List<TokenPrincipalType>	listActivatableTokenPrincipalTypes(BasicUser user) Returns a list of TokenPrincipalType of type TokenType.NFC_TAG available for activation (i.e.
java.util.List<TokenPrincipalType>	listActivatableTokenPrincipalTypes(UserGroup group, boolean asMember) Returns a list of TokenPrincipalType of type TokenType.NFC_TAG available for activation (i.e.
java.util.List<PrincipalType>	listAll() Returns all principal types
java.util.List<PrincipalType>	listByNatures(PrincipalTypeNature... natures) List the principal types filtering by principal type natures
java.util.List<TokenPrincipalType>	listByType(TokenType type) List the token principal types filtering by token type
java.util.List<PrincipalType>	listForConfiguration(ConfigurationAccessor configuration, Channel channel, org.cyclos.impl.access.PrincipalTypeContext context) Returns the principal types which can be used on channel configurations under the given channel and context
java.util.List<PrincipalType>	listForLogin(ChannelConfiguration channelConfiguration) Returns the principal types which can be used for login in the given channel configuration
java.util.List<TokenPrincipalType>	listInitializableTokenPrincipalTypes() Returns the list of token principal types allowed to initialize for a manager user.
java.util.List<AccessClientPrincipalType>	listVisibleAccessClients(User user) Returns the access client types the logged user can see over the given user
java.util.List<TokenPrincipalType>	listVisibleTokenPrincipalTypes(BasicUser user, boolean forUserManagement) Returns the list of token principal types visible to the given user If the user is null it returns the ones visible to the logged user.
PrincipalType	load(java.lang.String internalName) Loads a principal type by internal name
void	sort(java.util.List<PrincipalType> principalTypes) Sorts the given list of principal types according to the search order

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

list

Methods inherited from interface org.cyclos.impl.CRUDServiceLocal

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

Methods inherited from interface org.cyclos.services.CRUDService

getData, getDataForNew, load, remove, removeAll, save

Method Detail

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)

getUsername

BuiltInPrincipalType getUsername()

Returns the username principal type

listAccessClients

java.util.List<AccessClientPrincipalType> listAccessClients()

Returns a list with all access clients

listActivatableTokenPrincipalTypes

java.util.List<TokenPrincipalType> listActivatableTokenPrincipalTypes(BasicUser user)

Returns a list of TokenPrincipalType of type TokenType.NFC_TAG available for activation (i.e. personalization) and enabled for the specified user according to the logged user.

Parameters:

user - If null then returns all available for personalization for the logged user. Otherwise the result is restricted only for those enabled for the user.

If the logged user is a manager of the given basic user then it will retrieve the types returned by UserManagementProduct.getUserTokenTypes(). Otherwise, if the logged user is related to the user or the given user is an operator and the logged is the owner then it retrieve the types returnes by MemberProduct.getActivateUserTokenTypes().

listActivatableTokenPrincipalTypes

java.util.List<TokenPrincipalType> listActivatableTokenPrincipalTypes(UserGroup group,
                                                                      boolean asMember)

Returns a list of TokenPrincipalType of type TokenType.NFC_TAG available for activation (i.e. personalization) and enabled for the specified user group according to the logged user.

Parameters:

asMember - Flag used to get the list of token types to chkeck. Only used if the logged user is a broker.

See Also:

listActivatableTokenPrincipalTypes(BasicUser)

listAll

java.util.List<PrincipalType> listAll()

Returns all principal types

listByNatures

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

List the principal types filtering by principal type natures

listByType

java.util.List<TokenPrincipalType> listByType(TokenType type)

List the token principal types filtering by token type

listForConfiguration

java.util.List<PrincipalType> listForConfiguration(ConfigurationAccessor configuration,
                                                   Channel channel,
                                                   org.cyclos.impl.access.PrincipalTypeContext context)

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

listForLogin

java.util.List<PrincipalType> listForLogin(ChannelConfiguration channelConfiguration)

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

listInitializableTokenPrincipalTypes

java.util.List<TokenPrincipalType> listInitializableTokenPrincipalTypes()

Returns the list of token principal types allowed to initialize for a manager user. See UserManagementProduct.getUserTokenTypes().

listVisibleAccessClients

java.util.List<AccessClientPrincipalType> listVisibleAccessClients(User user)

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

listVisibleTokenPrincipalTypes

java.util.List<TokenPrincipalType> listVisibleTokenPrincipalTypes(BasicUser user,
                                                                  boolean forUserManagement)

Returns the list of token principal types visible to the given user If the user is null it returns the ones visible to the logged user. The forUserManagement flag indicates if the visible types are the ones that are configured for user management.

load

PrincipalType load(java.lang.String internalName)

Loads a principal type by internal name

sort

void sort(java.util.List<PrincipalType> principalTypes)

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