Package org.cyclos.impl.access

Class OidcClientServiceImpl

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.impl.BaseServiceImpl

org.cyclos.impl.CRUDServiceImpl<OidcClient,QOidcClient,OidcClientDTO,OidcClientData,Void>

org.cyclos.impl.access.OidcClientServiceImpl

All Implemented Interfaces:

OidcClientServiceLocal, CRUDServiceLocal<OidcClient,OidcClientDTO,OidcClientData,Void>, OidcClientService, CRUDService<OidcClientDTO,OidcClientData,Void>, CRUDWithConfirmationPasswordService<OidcClientDTO,OidcClientData,Void>, Service

@Service
public class OidcClientServiceImpl
extends CRUDServiceImpl<OidcClient,QOidcClient,OidcClientDTO,OidcClientData,Void>
implements OidcClientServiceLocal

Local interface for OidcClientService

Field Summary

Fields inherited from class org.cyclos.impl.CRUDServiceImpl

$, ATTR_CURRENT_COPY, cacheHandler, dtoClass, entityClass, extensionPointService, idPath, internalNamePath, namePath, ownerEntityIdPath, ownerEntityPath, ownerEntityPropertyName, passwordHandler, richTextHandler, withConfirmationPassword

Fields inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

authHandler, conversionHandler, customFieldValueHandler, entityManagerHandler, groupsHandler, productsHandler, restBeanPropertyMapping, userLocatorHandler

Fields inherited from class org.cyclos.impl.AbstractServerComponent

accountHandler, configurationHandler, dataTranslationHandler, notificationHandler, profileFieldHandler, transactionHandler, translationHandler

Fields inherited from interface org.cyclos.services.access.OidcClientService

CLIENT_SECRET_LENGTH

Constructor Summary

Constructors

Constructor	Description
OidcClientServiceImpl()

Method Summary

Modifier and Type	Method	Description
OidcClient	getByClientId(String internalName)	Returns a client by clientId (internal name), or null if not found
protected OidcClientData	getData(OidcClient entity)	Returns details data for the given entity
protected MessageKey	getEntityInternalNameKey()	NOTE: This method will be only invoked if the entity is an IInternalNamedEntity.
protected Object[]	getExcludedPropertiesToEntity(OidcClientDTO dto)	May be overridden in order to exclude properties when converting the given DTO to entity
OidcClientSearchData	getSearchData()	Returns data for searching OpenID Connect clients
protected boolean	isEntityInternalNameRequired()	NOTE: This method will be only invoked if the entity is an IInternalNamedEntity.
List<OidcClient>	listEnabled()	Returns all enabled clients
OidcClient	newEntity(Void params)	Should be implemented in order to instantiate a new entity based on the given context parameters
protected void	onAfterSave(OidcClient entity, OidcClient currentCopy, Object dataFromOnBeforeSave)	May be overridden in order to perform custom logic after saving an entity
protected void	onBeforeRemove(OidcClient entity)	May be overridden in order to perform custom logic before removing an entity
protected Object	onBeforeSave(OidcClient client, OidcClient currentCopy)	May be overridden in order to perform custom logic before saving an entity.
protected void	preProcessCurrentCopy(OidcClientDTO dto, OidcClient currentCopy)	This method is invoked before saving the entity and also, if the log is enabled, before removing.
protected void	registerNetworkMappings(NetworkPathRegistry networkPathRegistry)	Needs to be overridden by subclasses to register the path up to the network
protected Validator	resolveValidator(OidcClientDTO dto)
Page<OidcClientVO>	search(OidcClientQuery params)	Searches for OpenID Connect clients
OidcClient	toEntity(OidcClientDTO dto)	Converts the given DTO in an entity, handling the CRUDServiceImpl.subClassMappings() mappings for subclasses

Methods inherited from class org.cyclos.impl.CRUDServiceImpl

addCustomInternalNameValidations, addCustomNameValidations, checkConfirmationPassword, doRemove, find, findAll, from, getConfirmationPasswordInput, getConfirmationPasswordInputForRemove, getData, getDataForNew, getDeviceConfirmationParams, getEntityClass, getExcludedPropertiesToDTO, getNameLabel, getUniqueInternalNameQuery, getUniqueNameQuery, isNameRequired, load, logEntity, onAfterRemove, remove, remove, removeAll, removeAll, removeAllWithConfirmationPassword, removeWithConfirmationPassword, resolveDTOType, resolveEntityType, resolveExtensionPointAccessor, save, saveOrder, saveSkippingEntityLog, saveWithConfirmationPassword, shouldCheckConfirmationPassword, subClassMappings, toDTO, validate

Methods inherited from class org.cyclos.impl.BaseServiceImpl

initializeNetworkMappings

Methods inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

canManage, checkManagesUser, checkPermission, checkRelatesToUser, checkValue, clearAlreadyValidated, getBaseEntityManagerHandler, getConfiguration, getLoggedBasicUser, getLoggedUser, getProducts, getTranslatedName, getTranslatedValue, hasPermission, hasValue, inSameNetwork, inSameNetworkOrGlobal, isAdmin, isAlreadyValidated, isBroker, isGlobalAdmin, isGlobalAdminInNetwork, isGuest, isLoggedIn, isMember, isMemberOnly, isNetworkAdmin, isOperator, isRelatedToUser, isSystem, isUserManager, isUserManagerOf, message, message, permission, permission, permissionOptionalValue, permissionOptionalValue, setAlreadyValidated, toDate, toDateTime, validate

Methods inherited from class org.cyclos.impl.AbstractServerComponent

dataTranslationProxy, dataTranslationProxy, delete, detach, doDataTranslationProxy, find, flush, from, getApplicationContext, getFormatter, getFormatter, getFormatter, getLogger, getRemoteAddress, getSessionData, mailContentBuilder, message, message, persist, processBatch, processBatch, refresh, remove, selectFrom, subQuery, update

Methods inherited from class java.lang.Object

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

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, remove, removeAll, saveEntity, saveSkippingEntityLog, toDTO, validate

Constructor Detail

OidcClientServiceImpl

public OidcClientServiceImpl()

Method Detail

getByClientId

public OidcClient getByClientId(String internalName)

Description copied from interface: OidcClientServiceLocal

Returns a client by clientId (internal name), or null if not found

Specified by:

getByClientId in interface OidcClientServiceLocal

getSearchData

public OidcClientSearchData getSearchData()
                                   throws FrameworkException

Description copied from interface: OidcClientService

Returns data for searching OpenID Connect clients

Specified by:

getSearchData in interface OidcClientService

Throws:

FrameworkException

listEnabled

public List<OidcClient> listEnabled()

Description copied from interface: OidcClientServiceLocal

Returns all enabled clients

Specified by:

listEnabled in interface OidcClientServiceLocal

newEntity

public OidcClient newEntity(Void params)

Description copied from class: CRUDServiceImpl

Should be implemented in order to instantiate a new entity based on the given context parameters

Specified by:

newEntity in interface CRUDServiceLocal<OidcClient,OidcClientDTO,OidcClientData,Void>

Specified by:

newEntity in class CRUDServiceImpl<OidcClient,QOidcClient,OidcClientDTO,OidcClientData,Void>

search

public Page<OidcClientVO> search(OidcClientQuery params)

Description copied from interface: OidcClientService

Searches for OpenID Connect clients

Specified by:

search in interface OidcClientService

toEntity

public OidcClient toEntity(OidcClientDTO dto)

Description copied from class: CRUDServiceImpl

Converts the given DTO in an entity, handling the CRUDServiceImpl.subClassMappings() mappings for subclasses

Specified by:

toEntity in interface CRUDServiceLocal<OidcClient,OidcClientDTO,OidcClientData,Void>

Overrides:

toEntity in class CRUDServiceImpl<OidcClient,QOidcClient,OidcClientDTO,OidcClientData,Void>

getData

protected OidcClientData getData(OidcClient entity)

Description copied from class: CRUDServiceImpl

Returns details data for the given entity

Specified by:

getData in class CRUDServiceImpl<OidcClient,QOidcClient,OidcClientDTO,OidcClientData,Void>

getEntityInternalNameKey

protected MessageKey getEntityInternalNameKey()

Description copied from class: CRUDServiceImpl

NOTE: This method will be only invoked if the entity is an IInternalNamedEntity. Subclasses could override it if the internal name translation key is custom.

Overrides:

getEntityInternalNameKey in class CRUDServiceImpl<OidcClient,QOidcClient,OidcClientDTO,OidcClientData,Void>

Returns:

GeneralKeys.Ui.INTERNAL_NAME by default

getExcludedPropertiesToEntity

protected Object[] getExcludedPropertiesToEntity(OidcClientDTO dto)

Description copied from class: CRUDServiceImpl

May be overridden in order to exclude properties when converting the given DTO to entity

Overrides:

getExcludedPropertiesToEntity in class CRUDServiceImpl<OidcClient,QOidcClient,OidcClientDTO,OidcClientData,Void>

isEntityInternalNameRequired

protected boolean isEntityInternalNameRequired()

Description copied from class: CRUDServiceImpl

NOTE: This method will be only invoked if the entity is an IInternalNamedEntity. Subclasses could override it if the internal name is required.

Overrides:

isEntityInternalNameRequired in class CRUDServiceImpl<OidcClient,QOidcClient,OidcClientDTO,OidcClientData,Void>

Returns:

false (optional by default)

onAfterSave

protected void onAfterSave(OidcClient entity,
                           OidcClient currentCopy,
                           Object dataFromOnBeforeSave)

Description copied from class: CRUDServiceImpl

May be overridden in order to perform custom logic after saving an entity

Overrides:

onAfterSave in class CRUDServiceImpl<OidcClient,QOidcClient,OidcClientDTO,OidcClientData,Void>

onBeforeRemove

protected void onBeforeRemove(OidcClient entity)

Description copied from class: CRUDServiceImpl

May be overridden in order to perform custom logic before removing an entity

Overrides:

onBeforeRemove in class CRUDServiceImpl<OidcClient,QOidcClient,OidcClientDTO,OidcClientData,Void>

onBeforeSave

protected Object onBeforeSave(OidcClient client,
                              OidcClient currentCopy)

Description copied from class: CRUDServiceImpl

May be overridden in order to perform custom logic before saving an entity. Any returned value will be passed to the CRUDServiceImpl.onAfterSave(BaseEntity, BaseEntity, Object) method

Overrides:

onBeforeSave in class CRUDServiceImpl<OidcClient,QOidcClient,OidcClientDTO,OidcClientData,Void>

preProcessCurrentCopy

protected void preProcessCurrentCopy(OidcClientDTO dto,
                                     OidcClient currentCopy)

Description copied from class: CRUDServiceImpl

This method is invoked before saving the entity and also, if the log is enabled, before removing. Subclasses can override it to fetch lazy relationships, etc as the current copy will be detached. In case of removing (i.e the log is enabled for this entity) the dto parameter will be null.

Overrides:

preProcessCurrentCopy in class CRUDServiceImpl<OidcClient,QOidcClient,OidcClientDTO,OidcClientData,Void>

registerNetworkMappings

protected void registerNetworkMappings(NetworkPathRegistry networkPathRegistry)

Description copied from class: BaseServiceImpl

Needs to be overridden by subclasses to register the path up to the network

Specified by:

registerNetworkMappings in class BaseServiceImpl

resolveValidator

protected Validator resolveValidator(OidcClientDTO dto)

Specified by:

resolveValidator in class CRUDServiceImpl<OidcClient,QOidcClient,OidcClientDTO,OidcClientData,Void>