com.tsgrp.opencontent.core.config

Interface IConfigService

All Known Implementing Classes:

FilesystemConfigServiceImpl, RepositoryConfigServiceImpl, S3ConfigServiceImpl

public interface IConfigService

This interface provides access to implementations of the config service.

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.Object	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	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
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

Method Detail

getConfigByType

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. Returns the active config by default, but can return the latest as well.

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.

fullConfigs -

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

Returns:

getConfigByName

java.lang.Object 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. Returns the active config by default, but can return the latest as well.

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.

shallow -

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

Returns:

getConfigByName

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.

Parameters:

type -

name -

ticket -

latest -

shallow -

request -

response -

Returns:

HPI config as a JSONObjectg

getConfigByPathId

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. 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

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

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

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

request -

Returns:

updateConfigById

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

Parameters:

type - - the object type

id - - the object id

ticket - - The resolved session ticket

request - the request

Returns:

updateConfig

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

Parameters:

name - - The name of the config object

type - - The type of config object

ticket - - The resolved session ticket

request -

Returns:

deleteConfig

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

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.

request -

Returns:

exportConfigByPath

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

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

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

Throws:

java.io.IOException

OCRuntimeException

extractFolder

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

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

Parameters:

ticket - - The resolved session ticket

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

Returns:

Map containing info about import

Throws:

java.io.FileNotFoundException

java.io.IOException

OCRuntimeException

findOrCreateAppIdFolder

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

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

getRootPath

java.lang.String getRootPath()

returns the injected root path for hpi

Returns:

the root path to hpi