Package org.cyclos.impl.system

Class ConfigurationImageServiceImpl

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.impl.BaseServiceImpl

org.cyclos.impl.system.BaseImageServiceImpl<ConfigurationImage,QConfigurationImage,NewConfigurationImageParams>

org.cyclos.impl.system.ConfigurationImageServiceImpl

All Implemented Interfaces:

BaseImageServiceLocal<ConfigurationImage,NewConfigurationImageParams>, ConfigurationImageServiceLocal, Service, BaseImageService<NewConfigurationImageParams>, ConfigurationImageService

@Service
public class ConfigurationImageServiceImpl
extends BaseImageServiceImpl<ConfigurationImage,QConfigurationImage,NewConfigurationImageParams>
implements ConfigurationImageServiceLocal

Implementation for ConfigurationImageService

Field Summary

Fields inherited from class org.cyclos.impl.system.BaseImageServiceImpl

$, imageHandler, imageType, nature

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
ConfigurationImageServiceImpl()

Method Summary

Modifier and Type	Method	Description
ConfigurationImage	find(Long id)	Finds an image by id
String	getCurrentUrl(Configuration configuration, ConfigurationImageType type)	Returns the URL for the given configuration image type and current configuration
ConfigurationImageVO	getImageVO(ConfigurationVO configurationVO, @NotNull ConfigurationImageType type)	Returns data about a configuration image, for a given type.
ConfigurationImagesListData	getListData(ConfigurationVO configurationVO)	Returns data to list images in a given configuration
String	getUrl(Configuration configuration, ConfigurationImageType type)	Returns the URL for the given configuration image type and specific configuration
List<ConfigurationImageVO>	list(ConfigurationVO configurationVO)	Lists a configuration's images, optionally including inherited images from parent configurations
ConfigurationImageVO	load(@NotNull Long id)	Returns metadata of a configuration image by id
ConfigurationImage	newImage(NewConfigurationImageParams param)	Returns a new image for the given parameters
SerializableInputStream	readByConfigurationAndType(Long configurationId, ConfigurationImageType type)	Returns the content of a given configuration image, for the given configuration
protected void	registerNetworkMappings(NetworkPathRegistry networkPathRegistry)	Needs to be overridden by subclasses to register the path up to the network
void	removeByConfigurationAndType(ConfigurationVO configurationVO, ConfigurationImageType type)	Removes a configuration image, making it inherit the default (either from a parent configuration or the hardcoded default)
ConfigurationImageVO	save(NewConfigurationImageParams param, String name, SerializableInputStream content, String contentType)	Saves the given image for the given parameter (which depends on each image type), returning the descriptor
ConfigurationImage	saveImageContent(Configuration configuration, ConfigurationImageType type, String name, SerializableInputStream in, String contentType)	Saves an image content

Methods inherited from class org.cyclos.impl.system.BaseImageServiceImpl

findByKey, getImageNature, isUseImageLimits, onAfterRemove, onAfterSave, onBeforeRemove, readContent, readContentByKey, remove, removeAll, saveName, setDataAndPersist, setImageName, validateMaxImages

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, toDate, toDateTime, validate

Methods inherited from class org.cyclos.impl.AbstractServerComponent

dataTranslationProxy, delete, detach, 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.system.BaseImageService

remove, removeAll, saveName

Methods inherited from interface org.cyclos.impl.system.BaseImageServiceLocal

getImageNature, readContent, readContentByKey

Constructor Detail

ConfigurationImageServiceImpl

public ConfigurationImageServiceImpl()

Method Detail

find

public ConfigurationImage find(Long id)

Description copied from interface: BaseImageServiceLocal

Finds an image by id

Specified by:

find in interface BaseImageServiceLocal<ConfigurationImage,NewConfigurationImageParams>

Overrides:

find in class BaseImageServiceImpl<ConfigurationImage,QConfigurationImage,NewConfigurationImageParams>

getCurrentUrl

public String getCurrentUrl(Configuration configuration,
                            ConfigurationImageType type)

Description copied from interface: ConfigurationImageServiceLocal

Returns the URL for the given configuration image type and current configuration

Specified by:

getCurrentUrl in interface ConfigurationImageServiceLocal

getImageVO

public ConfigurationImageVO getImageVO(ConfigurationVO configurationVO,
                                       @NotNull
                                       @NotNull ConfigurationImageType type)
                                throws FrameworkException

Description copied from interface: ConfigurationImageService

Returns data about a configuration image, for a given type. If the configuration is null, assumes the current configuration.

Specified by:

getImageVO in interface ConfigurationImageService

Throws:

FrameworkException

getListData

public ConfigurationImagesListData getListData(ConfigurationVO configurationVO)
                                        throws FrameworkException

Description copied from interface: ConfigurationImageService

Returns data to list images in a given configuration

Specified by:

getListData in interface ConfigurationImageService

Throws:

FrameworkException

getUrl

public String getUrl(Configuration configuration,
                     ConfigurationImageType type)

Description copied from interface: ConfigurationImageServiceLocal

Returns the URL for the given configuration image type and specific configuration

Specified by:

getUrl in interface ConfigurationImageServiceLocal

list

public List<ConfigurationImageVO> list(ConfigurationVO configurationVO)
                                throws FrameworkException

Description copied from interface: ConfigurationImageService

Lists a configuration's images, optionally including inherited images from parent configurations

Specified by:

list in interface ConfigurationImageService

Throws:

FrameworkException

load

public ConfigurationImageVO load(@NotNull
                                 @NotNull Long id)
                          throws FrameworkException

Description copied from interface: ConfigurationImageService

Returns metadata of a configuration image by id

Specified by:

load in interface ConfigurationImageService

Throws:

FrameworkException

newImage

public ConfigurationImage newImage(NewConfigurationImageParams param)

Description copied from class: BaseImageServiceImpl

Returns a new image for the given parameters

Specified by:

newImage in class BaseImageServiceImpl<ConfigurationImage,QConfigurationImage,NewConfigurationImageParams>

readByConfigurationAndType

public SerializableInputStream readByConfigurationAndType(Long configurationId,
                                                          ConfigurationImageType type)
                                                   throws FrameworkException

Description copied from interface: ConfigurationImageServiceLocal

Returns the content of a given configuration image, for the given configuration

Specified by:

readByConfigurationAndType in interface ConfigurationImageServiceLocal

Throws:

FrameworkException

removeByConfigurationAndType

public void removeByConfigurationAndType(ConfigurationVO configurationVO,
                                         ConfigurationImageType type)
                                  throws FrameworkException

Description copied from interface: ConfigurationImageService

Removes a configuration image, making it inherit the default (either from a parent configuration or the hardcoded default)

Specified by:

removeByConfigurationAndType in interface ConfigurationImageService

Throws:

FrameworkException

save

public ConfigurationImageVO save(NewConfigurationImageParams param,
                                 String name,
                                 SerializableInputStream content,
                                 String contentType)
                          throws FrameworkException

Description copied from interface: BaseImageService

Saves the given image for the given parameter (which depends on each image type), returning the descriptor

Specified by:

save in interface BaseImageService<NewConfigurationImageParams>

Overrides:

save in class BaseImageServiceImpl<ConfigurationImage,QConfigurationImage,NewConfigurationImageParams>

Throws:

FrameworkException

saveImageContent

public ConfigurationImage saveImageContent(Configuration configuration,
                                           ConfigurationImageType type,
                                           String name,
                                           SerializableInputStream in,
                                           String contentType)
                                    throws FrameworkException

Description copied from interface: ConfigurationImageServiceLocal

Saves an image content

Specified by:

saveImageContent in interface ConfigurationImageServiceLocal

Throws:

FrameworkException

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