Package org.cyclos.impl.access

Class ChannelServiceImpl

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.impl.BaseServiceImpl

org.cyclos.impl.CRUDServiceImpl<Channel,QChannel,ChannelDTO,ChannelData,Void>

org.cyclos.impl.access.ChannelServiceImpl

All Implemented Interfaces:

ChannelServiceLocal, CRUDServiceLocal<Channel,ChannelDTO,ChannelData,Void>, ChannelService, CRUDService<ChannelDTO,ChannelData,Void>, CRUDWithConfirmationPasswordService<ChannelDTO,ChannelData,Void>, Service

@Service
public class ChannelServiceImpl
extends CRUDServiceImpl<Channel,QChannel,ChannelDTO,ChannelData,Void>
implements ChannelServiceLocal

implementation for ChannelService

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

Constructor Summary

Constructors

Constructor	Description
ChannelServiceImpl()

Method Summary

Modifier and Type	Method	Description
protected void	addCustomInternalNameValidations(Property internalName, ChannelDTO dto)	This method may be overridden to add custom validations for the INTERNAL_NAME property.
Channel	find(String internalName, Network network)	Finds a channel by internal name in the specified network
protected ChannelData	getData(Channel channel)	Returns details data for the given entity
Channel	getEasyInvoice()	Returns the easy invoice channel
Channel	getMain()	Returns the main channel
Channel	getMobile()	Returns the mobile channel
Channel	getOidc()	Returns the OAuth2 / OpenID Connect channel
Channel	getPos()	Returns the POS channel
Channel	getSms()	Returns the sms channel
Channel	getTicket()	Returns the ticket channel
Channel	getWebServices()	Returns the web services channel
protected boolean	isEntityInternalNameRequired()	NOTE: This method will be only invoked if the entity is an IInternalNamedEntity.
List<ChannelVO>	list()	List all available channels
List<Channel>	listAll()	Returns all channels
Channel	load(String internalName)	Loads a channel by internal name
Channel	newEntity(Void params)	Should be implemented in order to instantiate a new entity based on the given context parameters
protected void	onAfterSave(Channel channel, Channel currentCopy, Object dataFromOnBeforeSave)	May be overridden in order to perform custom logic after saving an entity
protected void	onBeforeRemove(Channel entity)	May be overridden in order to perform custom logic before removing an entity
protected void	registerNetworkMappings(NetworkPathRegistry networkPathRegistry)	Needs to be overridden by subclasses to register the path up to the network
protected Validator	resolveValidator(ChannelDTO dto)

Methods inherited from class org.cyclos.impl.CRUDServiceImpl

addCustomNameValidations, checkConfirmationPassword, doRemove, find, findAll, from, getConfirmationPasswordInput, getConfirmationPasswordInputForRemove, getData, getDataForNew, getDeviceConfirmationParams, getEntityClass, getEntityInternalNameKey, getExcludedPropertiesToDTO, getExcludedPropertiesToEntity, getNameLabel, getUniqueInternalNameQuery, getUniqueNameQuery, isNameRequired, load, logEntity, onAfterRemove, onBeforeSave, preProcessCurrentCopy, remove, remove, removeAll, removeAll, removeAllWithConfirmationPassword, removeWithConfirmationPassword, resolveDTOType, resolveEntityType, resolveExtensionPointAccessor, save, saveOrder, saveSkippingEntityLog, saveWithConfirmationPassword, shouldCheckConfirmationPassword, subClassMappings, toDTO, toEntity, 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, toEntity, validate

Constructor Detail

ChannelServiceImpl

public ChannelServiceImpl()

Method Detail

find

public Channel find(String internalName,
                    Network network)
             throws FrameworkException

Description copied from interface: ChannelServiceLocal

Finds a channel by internal name in the specified network

Specified by:

find in interface ChannelServiceLocal

Throws:

FrameworkException

getEasyInvoice

public Channel getEasyInvoice()

Description copied from interface: ChannelServiceLocal

Returns the easy invoice channel

Specified by:

getEasyInvoice in interface ChannelServiceLocal

getMain

public Channel getMain()

Description copied from interface: ChannelServiceLocal

Returns the main channel

Specified by:

getMain in interface ChannelServiceLocal

getMobile

public Channel getMobile()
                  throws FrameworkException

Description copied from interface: ChannelServiceLocal

Returns the mobile channel

Specified by:

getMobile in interface ChannelServiceLocal

Throws:

FrameworkException

getOidc

public Channel getOidc()

Description copied from interface: ChannelServiceLocal

Returns the OAuth2 / OpenID Connect channel

Specified by:

getOidc in interface ChannelServiceLocal

getPos

public Channel getPos()

Description copied from interface: ChannelServiceLocal

Returns the POS channel

Specified by:

getPos in interface ChannelServiceLocal

getSms

public Channel getSms()
               throws FrameworkException

Description copied from interface: ChannelServiceLocal

Returns the sms channel

Specified by:

getSms in interface ChannelServiceLocal

Throws:

FrameworkException

getTicket

public Channel getTicket()

Description copied from interface: ChannelServiceLocal

Returns the ticket channel

Specified by:

getTicket in interface ChannelServiceLocal

getWebServices

public Channel getWebServices()
                       throws FrameworkException

Description copied from interface: ChannelServiceLocal

Returns the web services channel

Specified by:

getWebServices in interface ChannelServiceLocal

Throws:

FrameworkException

list

public List<ChannelVO> list()

Description copied from interface: ChannelService

List all available channels

Specified by:

list in interface ChannelService

listAll

public List<Channel> listAll()
                      throws FrameworkException

Description copied from interface: ChannelServiceLocal

Returns all channels

Specified by:

listAll in interface ChannelServiceLocal

Throws:

FrameworkException

load

public Channel load(String internalName)

Description copied from interface: ChannelServiceLocal

Loads a channel by internal name

Specified by:

load in interface ChannelServiceLocal

newEntity

public Channel 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<Channel,ChannelDTO,ChannelData,Void>

Specified by:

newEntity in class CRUDServiceImpl<Channel,QChannel,ChannelDTO,ChannelData,Void>

addCustomInternalNameValidations

protected void addCustomInternalNameValidations(Property internalName,
                                                ChannelDTO dto)

Description copied from class: CRUDServiceImpl

This method may be overridden to add custom validations for the INTERNAL_NAME property.

Overrides:

addCustomInternalNameValidations in class CRUDServiceImpl<Channel,QChannel,ChannelDTO,ChannelData,Void>

getData

protected ChannelData getData(Channel channel)

Description copied from class: CRUDServiceImpl

Returns details data for the given entity

Specified by:

getData in class CRUDServiceImpl<Channel,QChannel,ChannelDTO,ChannelData,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<Channel,QChannel,ChannelDTO,ChannelData,Void>

Returns:

false (optional by default)

onAfterSave

protected void onAfterSave(Channel channel,
                           Channel 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<Channel,QChannel,ChannelDTO,ChannelData,Void>

onBeforeRemove

protected void onBeforeRemove(Channel entity)

Description copied from class: CRUDServiceImpl

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

Overrides:

onBeforeRemove in class CRUDServiceImpl<Channel,QChannel,ChannelDTO,ChannelData,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(ChannelDTO dto)

Specified by:

resolveValidator in class CRUDServiceImpl<Channel,QChannel,ChannelDTO,ChannelData,Void>