Package org.cyclos.impl.system

Class NetworkServiceImpl

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.impl.BaseServiceImpl

org.cyclos.impl.CRUDServiceImpl<Network,QNetwork,NetworkDTO,NetworkData,Void>

org.cyclos.impl.system.NetworkServiceImpl

All Implemented Interfaces:

CRUDServiceLocal<Network,NetworkDTO,NetworkData,Void>, NetworkServiceLocal, CRUDService<NetworkDTO,NetworkData,Void>, CRUDWithConfirmationPasswordService<NetworkDTO,NetworkData,Void>, Service, NetworkService

@Service
public class NetworkServiceImpl
extends CRUDServiceImpl<Network,QNetwork,NetworkDTO,NetworkData,Void>
implements NetworkServiceLocal

Implementation for NetworkService

Field Summary

Fields inherited from class org.cyclos.impl.CRUDServiceImpl

$, ATTR_CURRENT_COPY, 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.system.NetworkService

GLOBAL_INTERNAL_NAME

Constructor Summary

Constructors

Constructor	Description
NetworkServiceImpl()

Method Summary

Modifier and Type	Method	Description
protected void	addCustomInternalNameValidations(Property internalName, NetworkDTO dto)	This method may be overridden to add custom validations for the INTERNAL_NAME property.
Long	createWithData(NetworkDTO dto, NetworkInitialDataDTO data)	Creates a new network with initial data
Network	findEnabled(NetworkVO networkVO)	Finds an enabled network, or throws EntityNotFoundException if none is found
protected NetworkData	getData(Network network)	Returns details data for the given entity
NetworkWithInitialDataData	getDataForNewWithData()	Returns data for creating a new network with initial data
Network	getDefault()	Returns the default network if any (and is enabled).
NetworkInitialDataDTO	getInitialData(BasicNetworkInitialDataDTO basicData)	Returns an initial data pre-populated with fields according to the given initial selections
List<NetworkVO>	getManagedNetworks()	Returns the managed networks for the current admin
NetworkSearchData	getSearchData()	Returns data for searching networks
protected boolean	isEntityInternalNameRequired()	NOTE: This method will be only invoked if the entity is an IInternalNamedEntity.
Network	newEntity(Void params)	Should be implemented in order to instantiate a new entity based on the given context parameters
protected void	onAfterRemove(Network network)	May be overridden in order to perform custom logic after removing an entity
protected void	onAfterSave(Network network, Network currentCopy, Object dataFromOnBeforeSave)	May be overridden in order to perform custom logic after saving an entity
protected Object	onBeforeSave(Network network, Network currentCopy)	May be overridden in order to perform custom logic before saving an entity.
protected void	registerNetworkMappings(NetworkPathRegistry networkPathRegistry)	Needs to be overridden by subclasses to register the path up to the network
String	resolveNetworkUrl(NetworkVO networkVO)	Returns the URL a global admin can use to access the given network
protected Validator	resolveValidator(NetworkDTO dto)
Page<NetworkVO>	search(NetworkQuery params)	Searches for networks according to the given criteria
NetworkDTO	toDTO(Network entity)	Converts the given entity in a DTO, handling the CRUDServiceImpl.subClassMappings() mappings for subclasses

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, onBeforeRemove, preProcessCurrentCopy, remove, remove, removeAll, removeAll, removeAllWithConfirmationPassword, removeWithConfirmationPassword, resolveDTOType, resolveEntityType, resolveExtensionPointAccessor, save, saveOrder, saveSkippingEntityLog, saveWithConfirmationPassword, shouldCheckConfirmationPassword, subClassMappings, 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, toEntity, validate

Constructor Detail

NetworkServiceImpl

public NetworkServiceImpl()

Method Detail

createWithData

public Long createWithData(NetworkDTO dto,
                           NetworkInitialDataDTO data)
                    throws FrameworkException

Description copied from interface: NetworkService

Creates a new network with initial data

Specified by:

createWithData in interface NetworkService

Throws:

FrameworkException

findEnabled

public Network findEnabled(NetworkVO networkVO)
                    throws FrameworkException

Description copied from interface: NetworkServiceLocal

Finds an enabled network, or throws EntityNotFoundException if none is found

Specified by:

findEnabled in interface NetworkServiceLocal

Throws:

FrameworkException

getDataForNewWithData

public NetworkWithInitialDataData getDataForNewWithData()
                                                 throws FrameworkException

Description copied from interface: NetworkService

Returns data for creating a new network with initial data

Specified by:

getDataForNewWithData in interface NetworkService

Throws:

FrameworkException

getDefault

public Network getDefault()

Description copied from interface: NetworkServiceLocal

Returns the default network if any (and is enabled). Otherwise, returns null.

Specified by:

getDefault in interface NetworkServiceLocal

getInitialData

public NetworkInitialDataDTO getInitialData(BasicNetworkInitialDataDTO basicData)
                                     throws FrameworkException

Description copied from interface: NetworkService

Returns an initial data pre-populated with fields according to the given initial selections

Specified by:

getInitialData in interface NetworkService

Throws:

FrameworkException

getManagedNetworks

public List<NetworkVO> getManagedNetworks()
                                   throws FrameworkException

Description copied from interface: NetworkServiceLocal

Returns the managed networks for the current admin

Specified by:

getManagedNetworks in interface NetworkServiceLocal

Throws:

FrameworkException

getSearchData

public NetworkSearchData getSearchData()

Description copied from interface: NetworkService

Returns data for searching networks

Specified by:

getSearchData in interface NetworkService

newEntity

public Network 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<Network,NetworkDTO,NetworkData,Void>

Specified by:

newEntity in class CRUDServiceImpl<Network,QNetwork,NetworkDTO,NetworkData,Void>

resolveNetworkUrl

public String resolveNetworkUrl(NetworkVO networkVO)
                         throws FrameworkException

Description copied from interface: NetworkService

Returns the URL a global admin can use to access the given network

Specified by:

resolveNetworkUrl in interface NetworkService

Throws:

FrameworkException

search

public Page<NetworkVO> search(NetworkQuery params)

Description copied from interface: NetworkService

Searches for networks according to the given criteria

Specified by:

search in interface NetworkService

toDTO

public NetworkDTO toDTO(Network entity)

Description copied from class: CRUDServiceImpl

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

Specified by:

toDTO in interface CRUDServiceLocal<Network,NetworkDTO,NetworkData,Void>

Overrides:

toDTO in class CRUDServiceImpl<Network,QNetwork,NetworkDTO,NetworkData,Void>

addCustomInternalNameValidations

protected void addCustomInternalNameValidations(Property internalName,
                                                NetworkDTO 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<Network,QNetwork,NetworkDTO,NetworkData,Void>

getData

protected NetworkData getData(Network network)

Description copied from class: CRUDServiceImpl

Returns details data for the given entity

Specified by:

getData in class CRUDServiceImpl<Network,QNetwork,NetworkDTO,NetworkData,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<Network,QNetwork,NetworkDTO,NetworkData,Void>

Returns:

false (optional by default)

onAfterRemove

protected void onAfterRemove(Network network)

Description copied from class: CRUDServiceImpl

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

Overrides:

onAfterRemove in class CRUDServiceImpl<Network,QNetwork,NetworkDTO,NetworkData,Void>

onAfterSave

protected void onAfterSave(Network network,
                           Network 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<Network,QNetwork,NetworkDTO,NetworkData,Void>

onBeforeSave

protected Object onBeforeSave(Network network,
                              Network 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<Network,QNetwork,NetworkDTO,NetworkData,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(NetworkDTO dto)

Specified by:

resolveValidator in class CRUDServiceImpl<Network,QNetwork,NetworkDTO,NetworkData,Void>