Package de.xima.fc.api.entity

Class UserProfileAPI

java.lang.Object

de.xima.fc.api.ASubAPI

de.xima.fc.api.entity.AEntityAPI<UserProfile>

de.xima.fc.api.entity.UserProfileAPI

public class UserProfileAPI
extends AEntityAPI<UserProfile>

API class for reading and writing UserProfile entities.

Since:

8.0.0

Author:

XIMA Media GmbH

Field Summary

Fields

Modifier and Type	Field	Description
static String	USER_CONTEXT_PARAM_REF_CLIENTS
static String	USER_CTX_ATTR_INITIALIZE_HIBERNATE_PROXIES

Fields inherited from class de.xima.fc.api.entity.AEntityAPI

entityClass

Constructor Summary

Constructors

Constructor	Description
UserProfileAPI()

Method Summary

Modifier and Type	Method	Description
UserProfile	acceptDirectClientAuthorization(UserContext uc, UserProfile profile, DirectClientAuthorization authorization)	Adds the given client authorization to the given profile and accepts it.
UserProfile	addDirectClientAuthorization(UserContext uc, UserProfile userProfile, DirectClientAuthorization authorization)	Adds the given client authorizations to the user profile.
boolean	canBeDeleted(UserContext uc, UserProfile profile)	Checks whether or not the user profile can be deleted.
@NotBlank String	findUniqueUserName(UserContext uc, String candidate, UserProfile exclude)	Finds a unique user name for the given candidate.
UserProfile	getById(UserContext uc, Long id)	Reads the entity with the given ID.
UserProfile	getByLoginId(UserContext uc, String loginId)	Finds the user profile by the given login ID.
UserProfile	getByUserName(UserContext uc, String userName)	Finds the user profile with the given user name
UserProfile	getByUserProfile(UserContext uc, org.pac4j.core.profile.UserProfile pac4jProfile)	Finds the formcycle user profile for the given pac4j profile.
UserProfile	getByUuid(UserContext uc, String uuid)	Finds the user profile with the given UUID.
UserProfile	getByUuid(UserContext uc, UUID uuid)	Finds the user credentials with the given UUID.
UserProfile	getByVerifiedCallback(UserContext uc, String identifier, String clientName)	Finds the user profile by the given callback information.
UserProfile	getByVerifiedEmailAddress(UserContext uc, String email)	Finds the user profile with the given verified email address.
UserProfile	getByVerifiedPrimaryEmailAddress(UserContext uc, String email)	Finds the user profile with the given verified primary email address.
boolean	isUserNameExisiting(UserContext uc, String name)	Checks if the given user name exists within the system.
@NotNull UserProfile	mergeUserProfiles(UserContext uc, UserProfile main, UserProfile toBeMerged)	Merges the a profile into another.
UserProfile	update(UserContext uc, UserProfile entity)	Updates the given user profile and returns the updated entity.
UserProfile	validateUserLogin(UserContext uc, String loginId, String password)	Validates the given user credentials and returns the user profile if successfull.

Methods inherited from class de.xima.fc.api.entity.AEntityAPI

create, create, delete, delete, deleteAllBy, deleteById, deleteById, getAll, getAllBy, getAttributes, getAttributes, getBy, getById, getEntityRefs, getSingleAttributes, getSingleAttributes, resultTotalCount, resultTotalCount, update

Methods inherited from class de.xima.fc.api.ASubAPI

getHandlerProvider

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

USER_CTX_ATTR_INITIALIZE_HIBERNATE_PROXIES

public static final String USER_CTX_ATTR_INITIALIZE_HIBERNATE_PROXIES

See Also:

Constant Field Values

USER_CONTEXT_PARAM_REF_CLIENTS

public static final String USER_CONTEXT_PARAM_REF_CLIENTS

See Also:

Constant Field Values

Constructor Detail

UserProfileAPI

public UserProfileAPI()

Method Detail

getById

public UserProfile getById(UserContext uc,
                           Long id)

Reads the entity with the given ID. Hibernate proxy fields may be initialized if requested.

Overrides:

getById in class AEntityAPI<UserProfile>

Parameters:

uc - user context for accessing the database

id - of the entity

Returns:

the entity with the given ID with possibly initialized hibernate fields.

update

public UserProfile update(UserContext uc,
                          UserProfile entity)

Updates the given user profile and returns the updated entity. Hibernate proxy fields may be initialized if requested.

Overrides:

update in class AEntityAPI<UserProfile>

Parameters:

uc - user context for accessing the database

entity - to update

Returns:

the updated entity with possibly initialized hibernate fields.

getByLoginId

public UserProfile getByLoginId(UserContext uc,
                                String loginId)

Finds the user profile by the given login ID. This ID may be the users primary email address or user name.

Parameters:

uc - user context for accessing the database

loginId - primary email address (case irrelevant) or user name of the user profile.

Returns:

The user profile for the given login ID or null.

getByVerifiedEmailAddress

public UserProfile getByVerifiedEmailAddress(UserContext uc,
                                             String email)

Finds the user profile with the given verified email address.

Parameters:

uc - User context for database transactions.

email - of the user profile (case irrelevant).

Returns:

The user profile with the given verified email or null.

getByVerifiedPrimaryEmailAddress

public UserProfile getByVerifiedPrimaryEmailAddress(UserContext uc,
                                                    String email)

Finds the user profile with the given verified primary email address.

Parameters:

uc - Current user context for database transactions.

email - of the user profile (case irrelevant).

Returns:

The user profile with the given verified primary email or null.

getByUserName

public UserProfile getByUserName(UserContext uc,
                                 String userName)

Finds the user profile with the given user name

Parameters:

uc - Current user context for database transactions.

userName - of the user profile

Returns:

The user profile with the given user name or null.

getByVerifiedCallback

public UserProfile getByVerifiedCallback(UserContext uc,
                                         String identifier,
                                         String clientName)

Finds the user profile by the given callback information. The callback information includes the client name which identifies the SystemAuthenticator or the authenticator type and the user identity identifier.

Parameters:

uc - User context for database transactions.

identifier - Identifier of the user identity.

clientName - Identifies the SystemAuthenticator or the authenticator type.

Returns:

The user profile matching the callback information.

getByUuid

public UserProfile getByUuid(UserContext uc,
                             String uuid)

Finds the user profile with the given UUID.

Parameters:

uc - Current user context for database transactions..

uuid - UUID of the user profile.

Returns:

The user profile with the given UUID.

getByUuid

public UserProfile getByUuid(UserContext uc,
                             UUID uuid)

Finds the user credentials with the given UUID.

Parameters:

uc - Current user context for database transactions..

uuid - of the user profile.

Returns:

The user profile with the given UUID.

getByUserProfile

public UserProfile getByUserProfile(UserContext uc,
                                    org.pac4j.core.profile.UserProfile pac4jProfile)

Finds the formcycle user profile for the given pac4j profile.

Parameters:

uc - User context for database transactions.

pac4jProfile - pac4j user profile to find the formcycle user profile for.

Returns:

The user profile from the Pac4J profile, if any.

findUniqueUserName

@NotBlank
public @NotBlank String findUniqueUserName(UserContext uc,
                                           String candidate,
                                           UserProfile exclude)

Finds a unique user name for the given candidate. If the candidate is not unique a random number will be appended.

Parameters:

uc - user context for database transactions.

candidate - desired user name.

exclude - user profile to be excluded from search.

Returns:

a unique user name.

isUserNameExisiting

public boolean isUserNameExisiting(UserContext uc,
                                   String name)

Checks if the given user name exists within the system.

Parameters:

uc - user context for database transactions.

name - user name to check.

Returns:

true if the user name exists already and false otherwise.

validateUserLogin

public UserProfile validateUserLogin(UserContext uc,
                                     String loginId,
                                     String password)

Validates the given user credentials and returns the user profile if successfull.

Parameters:

uc - Current user context for database transactions.

loginId - user name or primary email address of the user.

password - password for the user profile.

Returns:

user profile if validation was successful. null otherwise.

addDirectClientAuthorization

public UserProfile addDirectClientAuthorization(UserContext uc,
                                                UserProfile userProfile,
                                                DirectClientAuthorization authorization)

Adds the given client authorizations to the user profile. If the user profile already has an authorization to client than the authorizations will be merged, meaning that all roles and user groups will be added to the existing client authorization of the user profile.

Parameters:

uc - User context for database transactions.

userProfile - to add the direct client authorization to.

authorization - to add.

Returns:

the updated user profile or null if an error occurred and the client authorization could not be added.

mergeUserProfiles

@NotNull
public @NotNull UserProfile mergeUserProfiles(UserContext uc,
                                              UserProfile main,
                                              UserProfile toBeMerged)

Merges the a profile into another. Emails, identities, authorizations, permissions, roles, credentials, files will be added / merged. The custom user properties won't be affected. The profile that will be merged into the other profile will be deleted when the merge has completed.

Parameters:

uc - User context for database transactions.

main - to be extended by merging another profile into it.

toBeMerged - profile that will be merged into the main profile. This profile will be deleted when the merge has completed.

Returns:

the extended user profile.

acceptDirectClientAuthorization

public UserProfile acceptDirectClientAuthorization(UserContext uc,
                                                   UserProfile profile,
                                                   DirectClientAuthorization authorization)

Adds the given client authorization to the given profile and accepts it. If an authorization for the client already exists than the authorizations will be merged.

Parameters:

uc - User context for database transactions

profile - User profile to add the client authorization to.

authorization - Client authorization to accpet

Returns:

The user profile with the added client authorization.

canBeDeleted

public boolean canBeDeleted(UserContext uc,
                            UserProfile profile)

Checks whether or not the user profile can be deleted. User profiles can't be deleted if they are the only admin of existing clients. If the user profile can't be deleted the given user context will contain a set of clients for which the user profile is the only client admin (see USER_CONTEXT_PARAM_REF_CLIENTS).

Parameters:

uc - User context for database transactions.

profile - to check.

Returns:

true id the user profile can be deleted (is not the single admin of any existing clients) and false otherwise.