Package de.xima.fc.api.entity

Class IndirectClientAuthorizationAPI

java.lang.Object

de.xima.fc.api.ASubAPI

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

de.xima.fc.api.entity.IndirectClientAuthorizationAPI

public class IndirectClientAuthorizationAPI
extends AEntityAPI<IndirectClientAuthorization>

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_CTX_ATTR_INITIALIZE

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

entityClass

Constructor Summary

Constructors

Constructor	Description
IndirectClientAuthorizationAPI()

Method Summary

Modifier and Type	Method	Description
Set<IndirectClientAuthorization>	getAllByIds(UserContext uc, Set<Long> ids)	Retrieves all indirect client authorizations with one of the given IDs.
List<IndirectClientAuthorization>	getByAuthenticator(UserContext uc, IAuthenticator<?> auth)	Retrieves all indirect client authorizations that use the given authenticator.
List<IndirectClientAuthorization>	getByUserProfile(UserContext uc, org.pac4j.core.profile.UserProfile userProfile)	Returns all indirect client authorizations which match the profile based on the configured filter.

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

create, create, delete, delete, deleteAllBy, deleteById, deleteById, getAll, getAllBy, getAttributes, getAttributes, getBy, getById, getById, getEntityRefs, getSingleAttributes, getSingleAttributes, resultTotalCount, resultTotalCount, update, 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

public static final String USER_CTX_ATTR_INITIALIZE

See Also:

Constant Field Values

Constructor Detail

IndirectClientAuthorizationAPI

public IndirectClientAuthorizationAPI()

Method Detail

getAllByIds

public Set<IndirectClientAuthorization> getAllByIds(UserContext uc,
                                                    Set<Long> ids)

Retrieves all indirect client authorizations with one of the given IDs.

Parameters:

uc - User context for database transactions.

ids - of the entities.

Returns:

A set of indirect client authorizations that have one of the given IDs.

Since:

8.0.4

getByAuthenticator

public List<IndirectClientAuthorization> getByAuthenticator(UserContext uc,
                                                            IAuthenticator<?> auth)

Retrieves all indirect client authorizations that use the given authenticator.

Parameters:

uc - User context for database transactions.

auth - The authenticator that is used by the indirect client authorization.

Returns:

A list of all indirect client authorizations that use the authenticator.

getByUserProfile

public List<IndirectClientAuthorization> getByUserProfile(UserContext uc,
                                                          org.pac4j.core.profile.UserProfile userProfile)

Returns all indirect client authorizations which match the profile based on the configured filter.

Parameters:

uc - user context for database transactions

userProfile - to check for

Returns:

a list of indirect client authorizations which match the profile based on the configured filter.