com.tsgrp.opencontent.s3.core.config

Class S3ConfigServiceImpl

java.lang.Object

com.tsgrp.opencontent.s3.core.config.S3ConfigServiceImpl

All Implemented Interfaces:

IConfigService

public class S3ConfigServiceImpl
extends java.lang.Object
implements IConfigService

S3 implementation of IConfigService

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	jsonMimeType

Constructor Summary

Constructors

Constructor and Description
S3ConfigServiceImpl()

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) (non-Javadoc)
java.io.ByteArrayOutputStream	exportConfigByPath(java.lang.String ticket, java.lang.Boolean userPref, java.lang.String appId, java.util.List<java.lang.String> failedDocs) (non-Javadoc)
java.util.Map<java.lang.String,java.lang.String>	extractFolder(java.lang.String zipName, java.lang.String ticket, java.io.InputStream configStream) (non-Javadoc)
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) (non-Javadoc)
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) (non-Javadoc)
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) (non-Javadoc)
java.util.List	getConfigByType(java.lang.String type, java.lang.String ticket, boolean latest, boolean fullConfigs, java.lang.String appId) (non-Javadoc)
java.lang.String	getKey(java.lang.String appId, java.lang.String type, java.lang.String name) Returns config path
java.lang.String	getRootPath() (non-Javadoc)
static void	getShallow(org.json.JSONObject jsonObj) Creates a shallow version of the json object
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) (non-Javadoc)
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) (non-Javadoc)
java.lang.String	updateConfigById(java.lang.String type, java.lang.String id, java.lang.String ticket, javax.servlet.http.HttpServletRequest request) (non-Javadoc)

Methods inherited from class java.lang.Object

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

Field Detail

jsonMimeType

public static final java.lang.String jsonMimeType

See Also:

Constant Field Values

Constructor Detail

S3ConfigServiceImpl

public S3ConfigServiceImpl()

Method Detail

getConfigByType

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

(non-Javadoc)

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:

See Also:

com.tsgrp.opencontent.core.config.IConfigService#getConfigByType(java.lang. String, java.lang.String, boolean, boolean)

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)

(non-Javadoc)

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:

See Also:

com.tsgrp.opencontent.core.config.IConfigService#getConfigByName(java.lang. String, java.lang.String, java.lang.String, boolean, boolean, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

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)

(non-Javadoc)

Specified by:

getConfigByName in interface IConfigService

Returns:

HPI config as a JSONObjectg

See Also:

com.tsgrp.opencontent.core.config.IConfigService#getConfigByName(java.lang. String, java.lang.String, java.lang.String, boolean, boolean, java.lang.String)

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)

(non-Javadoc)

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

See Also:

com.tsgrp.opencontent.core.config.IConfigService#getConfigByPathId(java.lang. String, java.lang.String, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

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)

(non-Javadoc)

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:

See Also:

com.tsgrp.opencontent.core.config.IConfigService#saveConfig(java.lang.String, java.lang.String, java.lang.String, javax.servlet.http.HttpServletRequest)

updateConfigById

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

(non-Javadoc)

Specified by:

updateConfigById in interface IConfigService

Parameters:

type - - the object type

id - - the object id

ticket - - The resolved session ticket

request - the request

Returns:

See Also:

com.tsgrp.opencontent.core.config.IConfigService#updateConfigById(java.lang. String, java.lang.String, java.lang.String, javax.servlet.http.HttpServletRequest)

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)

(non-Javadoc)

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:

See Also:

com.tsgrp.opencontent.core.config.IConfigService#updateConfig(java.lang. String, java.lang.String, java.lang.String, javax.servlet.http.HttpServletRequest)

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)

(non-Javadoc)

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:

See Also:

com.tsgrp.opencontent.core.config.IConfigService#deleteConfig(java.lang. String, java.lang.String, java.lang.String, javax.servlet.http.HttpServletRequest)

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)

(non-Javadoc)

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

See Also:

com.tsgrp.opencontent.core.config.IConfigService#exportConfigByPath(java.lang .String, java.lang.Boolean, java.lang.String, java.util.List)

extractFolder

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

(non-Javadoc)

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

See Also:

com.tsgrp.opencontent.core.config.IConfigService#extractFolder(java.lang. String, java.lang.String, java.io.InputStream)

getRootPath

public java.lang.String getRootPath()

(non-Javadoc)

Specified by:

getRootPath in interface IConfigService

Returns:

the root path to hpi

See Also:

IConfigService.getRootPath()

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

getShallow

public static void getShallow(org.json.JSONObject jsonObj)

Creates a shallow version of the json object

Parameters:

{JSONObject} - json object

getKey

public java.lang.String getKey(java.lang.String appId,
                               java.lang.String type,
                               java.lang.String name)

Returns config path

Parameters:

{String} - appId

{String} - type

{String} - name

Returns:

{String} config path