com.tsgrp.opencontent.core.preferences

Class GenericPreferencesService

java.lang.Object

com.tsgrp.opencontent.core.preferences.GenericPreferencesService

All Implemented Interfaces:

IPreferencesService

public class GenericPreferencesService
extends java.lang.Object
implements IPreferencesService

Constructor Summary

Constructors

Constructor and Description
GenericPreferencesService()

Method Summary

Modifier and Type	Method and Description
java.lang.String	deletePreferencesByName(java.lang.String ticket, java.lang.String name, java.lang.String appId) Deletes the preferences object at the given path + name.
org.json.JSONObject	getPreferencesByName(java.lang.String ticket, java.lang.String name, boolean shallow, java.lang.String appId) Gets a JSON object of the preferences at the path + name specified; if shallow is true, we remove any complex keys.
org.json.JSONObject	getPreferencesByName(java.lang.String ticket, java.lang.String name, java.lang.String appId) Gets a JSONObject of the preferences at the path + name specified
java.util.Map<java.lang.String,java.lang.Object>	getPreferencesMapByName(java.lang.String ticket, java.lang.String name, boolean latest, boolean shallow, long lastModifiedDate, java.lang.String appId, javax.servlet.http.HttpServletResponse response) Returns the preferences found with the given name, as a hashmap.
java.util.Map<java.lang.String,java.lang.Object>	savePreferencesByName(java.lang.String ticket, java.io.InputStream jsonStream, java.lang.String name, java.lang.String id, java.lang.String appId) * Saves the preferences within the given path with the given name.
java.util.Map<java.lang.String,java.lang.Object>	updatePreferencesByName(java.lang.String ticket, java.io.InputStream jsonStream, java.lang.String name, java.lang.String id, java.lang.String appId, boolean errorstate) Updates the preferences within the given path with the given name

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericPreferencesService

public GenericPreferencesService()

Method Detail

getPreferencesMapByName

public java.util.Map<java.lang.String,java.lang.Object> getPreferencesMapByName(java.lang.String ticket,
                                                                                java.lang.String name,
                                                                                boolean latest,
                                                                                boolean shallow,
                                                                                long lastModifiedDate,
                                                                                java.lang.String appId,
                                                                                javax.servlet.http.HttpServletResponse response)

Description copied from interface: IPreferencesService

Returns the preferences found with the given name, as a hashmap. Throws an exception if the object is not found. Returns "not-modified" as a string if the object has not been modified since last time user retrieved (using lastModifiedDate).

Specified by:

getPreferencesMapByName in interface IPreferencesService

appId - - This is the application ID for HPI, if multiple/separate config files are desired.

Returns:

savePreferencesByName

public java.util.Map<java.lang.String,java.lang.Object> savePreferencesByName(java.lang.String ticket,
                                                                              java.io.InputStream jsonStream,
                                                                              java.lang.String name,
                                                                              java.lang.String id,
                                                                              java.lang.String appId)

Description copied from interface: IPreferencesService

* Saves the preferences within the given path with the given name.

Specified by:

savePreferencesByName in interface IPreferencesService

id - value to prepend to the "_id" identifier for the JSON Object

appId - - This is the application ID for HPI, if multiple/separate config files are desired.

Returns:

updatePreferencesByName

public java.util.Map<java.lang.String,java.lang.Object> updatePreferencesByName(java.lang.String ticket,
                                                                                java.io.InputStream jsonStream,
                                                                                java.lang.String name,
                                                                                java.lang.String id,
                                                                                java.lang.String appId,
                                                                                boolean errorstate)

Description copied from interface: IPreferencesService

Updates the preferences within the given path with the given name

Specified by:

updatePreferencesByName in interface IPreferencesService

appId - - This is the application ID for HPI, if multiple/separate config files are desired.

Returns:

deletePreferencesByName

public java.lang.String deletePreferencesByName(java.lang.String ticket,
                                                java.lang.String name,
                                                java.lang.String appId)

Description copied from interface: IPreferencesService

Deletes the preferences object at the given path + name.

Specified by:

deletePreferencesByName in interface IPreferencesService

appId - - This is the application ID for HPI, if multiple/separate config files are desired.

Returns:

getPreferencesByName

public org.json.JSONObject getPreferencesByName(java.lang.String ticket,
                                                java.lang.String name,
                                                java.lang.String appId)
                                         throws java.io.IOException,
                                                org.json.JSONException

Description copied from interface: IPreferencesService

Gets a JSONObject of the preferences at the path + name specified

Specified by:

getPreferencesByName in interface IPreferencesService

appId - - This is the application ID for HPI, if multiple/separate config files are desired.

Returns:

Throws:

java.io.IOException

org.json.JSONException

getPreferencesByName

public org.json.JSONObject getPreferencesByName(java.lang.String ticket,
                                                java.lang.String name,
                                                boolean shallow,
                                                java.lang.String appId)
                                         throws java.io.IOException,
                                                org.json.JSONException

Description copied from interface: IPreferencesService

Gets a JSON object of the preferences at the path + name specified; if shallow is true, we remove any complex keys.

Specified by:

getPreferencesByName in interface IPreferencesService

appId - - This is the application ID for HPI, if multiple/separate config files are desired.

Returns:

Throws:

java.io.IOException

org.json.JSONException