com.tsgrp.opencontent.core.config.persistence

Class FilesystemConfigServiceImpl

java.lang.Object

com.tsgrp.opencontent.core.config.persistence.FilesystemConfigServiceImpl

All Implemented Interfaces:

IConfigService

public class FilesystemConfigServiceImpl
extends java.lang.Object
implements IConfigService

Filesystem implementation of config service

Constructor Summary

Constructors

Constructor and Description
FilesystemConfigServiceImpl()

Method Summary

Modifier and Type	Method and Description
java.lang.String	deleteConfig(java.lang.String name, java.lang.String type, java.lang.String ticket, java.lang.String appId, javax.servlet.http.HttpServletRequest request) Delete the config by name
java.io.ByteArrayOutputStream	exportConfigByPath(java.lang.String ticket, java.lang.Boolean userPref, java.lang.String appId, java.util.List<java.lang.String> failedDocs) This method builds up a ZipOutputStream and an oco of the config folder (appId) to be zipped and exported and then calls the zipSubDirectory on that folder, which returns a byte array output stream containing the zip for the browser to download
java.util.Map<java.lang.String,java.lang.String>	extractFolder(java.lang.String zipName, java.lang.String ticket, java.io.InputStream configStream) Import configs - this method receives zip file data from the front end and extracts those files into the users docbase by creating versions if the files already exist, or creating new ones if they do not
void	findOrCreateAppIdFolder(java.lang.String ticket, java.lang.String appId) Looks for the app id folder and creates it if it does not exist
org.json.JSONObject	getConfigByName(java.lang.String type, java.lang.String name, java.lang.String ticket, boolean latest, boolean shallow, java.lang.String appId) Return a TSG configuration for internal use in OpenContent.
java.lang.String	getConfigByName(java.lang.String type, java.lang.String name, java.lang.String ticket, boolean latest, boolean shallow, java.lang.String appId, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method returns a TSG configuration.
java.lang.Object	getConfigByPathId(java.lang.String id, java.lang.String ticket, java.lang.String appId, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method returns a config by id.
java.util.List	getConfigByType(java.lang.String type, java.lang.String ticket, boolean latest, boolean fullConfigs, java.lang.String appId) This method returns a TSG configuration.
java.lang.String	getConfigPath(java.lang.String ticket, javax.servlet.http.HttpServletRequest request)
java.lang.String	getRootPath() returns the injected root path for hpi
java.lang.String	saveConfig(java.lang.String name, java.lang.String type, java.lang.String ticket, java.lang.String appId, javax.servlet.http.HttpServletRequest request) Save config
void	setConfigPath(java.lang.String configPath) Sets the config path.
java.lang.String	updateConfig(java.lang.String name, java.lang.String type, java.lang.String ticket, java.lang.String appId, javax.servlet.http.HttpServletRequest request) Update config
java.lang.String	updateConfigById(java.lang.String type, java.lang.String id, java.lang.String ticket, javax.servlet.http.HttpServletRequest request) Update config by id rather then name

Methods inherited from class java.lang.Object

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

Constructor Detail

FilesystemConfigServiceImpl

public FilesystemConfigServiceImpl()

Method Detail

getConfigByType

public java.util.List getConfigByType(java.lang.String type,
                                      java.lang.String ticket,
                                      boolean latest,
                                      boolean fullConfigs,
                                      java.lang.String appId)

Description copied from interface: IConfigService

This method returns a TSG configuration. Returns the active config by default, but can return the latest as well.

Specified by:

getConfigByType in interface IConfigService

Parameters:

type - - The type of config

ticket - - The resolved session ticket

latest - - By default returns the 'active' config. If true this will return the current version of the configuration.

appId - - The application id that allows for separation of configs.

Returns:

getConfigByName

public java.lang.String getConfigByName(java.lang.String type,
                                        java.lang.String name,
                                        java.lang.String ticket,
                                        boolean latest,
                                        boolean shallow,
                                        java.lang.String appId,
                                        javax.servlet.http.HttpServletRequest request,
                                        javax.servlet.http.HttpServletResponse response)

Description copied from interface: IConfigService

This method returns a TSG configuration. Returns the active config by default, but can return the latest as well.

Specified by:

getConfigByName in interface IConfigService

Parameters:

type - - The type of config

name - - The name of the config object

ticket - - The resolved session ticket

latest - - By default returns the 'active' config. If true this will return the current version of the configuration.

appId - - The application id that allows for separation of configs.

Returns:

getConfigByName

public org.json.JSONObject getConfigByName(java.lang.String type,
                                           java.lang.String name,
                                           java.lang.String ticket,
                                           boolean latest,
                                           boolean shallow,
                                           java.lang.String appId)

Description copied from interface: IConfigService

Return a TSG configuration for internal use in OpenContent.

Specified by:

getConfigByName in interface IConfigService

Returns:

HPI config as a JSONObjectg

getConfigByPathId

public java.lang.Object getConfigByPathId(java.lang.String id,
                                          java.lang.String ticket,
                                          java.lang.String appId,
                                          javax.servlet.http.HttpServletRequest request,
                                          javax.servlet.http.HttpServletResponse response)

Description copied from interface: IConfigService

This method returns a config by id. This can potentially return an entire config or just a piece. The 'id' here is the id construct we invented which is really a dot separated path into the json config type.name.keyone.keytwo_optionalIndexifKeytwoIsArray

Specified by:

getConfigByPathId in interface IConfigService

Parameters:

id - - id of object request

ticket - - The ticket from the request

appId - - The application id that allows for separation of configs.

Returns:

the json string

saveConfig

public java.lang.String saveConfig(java.lang.String name,
                                   java.lang.String type,
                                   java.lang.String ticket,
                                   java.lang.String appId,
                                   javax.servlet.http.HttpServletRequest request)

Description copied from interface: IConfigService

Save config

Specified by:

saveConfig in interface IConfigService

Parameters:

name - - The name of the config object

type - - The type of config object

ticket - - The resolved session ticket

appId - - The application id that allows for separation of configs

Returns:

updateConfigById

public java.lang.String updateConfigById(java.lang.String type,
                                         java.lang.String id,
                                         java.lang.String ticket,
                                         javax.servlet.http.HttpServletRequest request)

Description copied from interface: IConfigService

Update config by id rather then name

Specified by:

updateConfigById in interface IConfigService

Parameters:

type - - the object type

id - - the object id

ticket - - The resolved session ticket

request - the request

Returns:

updateConfig

public java.lang.String updateConfig(java.lang.String name,
                                     java.lang.String type,
                                     java.lang.String ticket,
                                     java.lang.String appId,
                                     javax.servlet.http.HttpServletRequest request)

Description copied from interface: IConfigService

Update config

Specified by:

updateConfig in interface IConfigService

Parameters:

name - - The name of the config object

type - - The type of config object

ticket - - The resolved session ticket

Returns:

deleteConfig

public java.lang.String deleteConfig(java.lang.String name,
                                     java.lang.String type,
                                     java.lang.String ticket,
                                     java.lang.String appId,
                                     javax.servlet.http.HttpServletRequest request)

Description copied from interface: IConfigService

Delete the config by name

Specified by:

deleteConfig in interface IConfigService

Parameters:

name - - The name of the config object

type - - The type of config object

ticket - - The resolved session ticket

appId - - The application id that allows for separation of configs.

Returns:

getConfigPath

public java.lang.String getConfigPath(java.lang.String ticket,
                                      javax.servlet.http.HttpServletRequest request)

setConfigPath

@Value(value="${restConfigService.rootpath}")
public void setConfigPath(java.lang.String configPath)

Sets the config path.

Parameters:

configPath - the new config path

exportConfigByPath

public java.io.ByteArrayOutputStream exportConfigByPath(java.lang.String ticket,
                                                        java.lang.Boolean userPref,
                                                        java.lang.String appId,
                                                        java.util.List<java.lang.String> failedDocs)

Description copied from interface: IConfigService

This method builds up a ZipOutputStream and an oco of the config folder (appId) to be zipped and exported and then calls the zipSubDirectory on that folder, which returns a byte array output stream containing the zip for the browser to download

Specified by:

exportConfigByPath in interface IConfigService

Parameters:

ticket - - the session/cookie ticket from HPI

userPref - - boolean indicating whether to include user preferences

appId - - the name of the config folder, located at /hpi/"appId"

failedDocs - - used by addDocumentToZip to keep track of documents that fail to add to the zip

extractFolder

public java.util.Map<java.lang.String,java.lang.String> extractFolder(java.lang.String zipName,
                                                                      java.lang.String ticket,
                                                                      java.io.InputStream configStream)

Description copied from interface: IConfigService

Import configs - this method receives zip file data from the front end and extracts those files into the users docbase by creating versions if the files already exist, or creating new ones if they do not

Specified by:

extractFolder in interface IConfigService

ticket - - The resolved session ticket

configStream - - a ZipStream containing all of the file data from the front end

Returns:

Map containing info about import

getRootPath

public java.lang.String getRootPath()

Description copied from interface: IConfigService

returns the injected root path for hpi

Specified by:

getRootPath in interface IConfigService

Returns:

the root path to hpi

findOrCreateAppIdFolder

public void findOrCreateAppIdFolder(java.lang.String ticket,
                                    java.lang.String appId)

Description copied from interface: IConfigService

Looks for the app id folder and creates it if it does not exist

Specified by:

findOrCreateAppIdFolder in interface IConfigService