com.ibm.ecm.configuration

Class UserConfig

java.lang.Object

com.ibm.ecm.configuration.ConfigurationObject

com.ibm.ecm.configuration.UserConfig

All Implemented Interfaces:

UserBasedConfig, java.io.Serializable

public class UserConfig
extends ConfigurationObject
implements java.io.Serializable, UserBasedConfig

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	FAVORITE_CAP
static int	RECENT_ITEM_CAP
static int	RECENT_SEARCH_CAP
static int	RECENT_SIMPLE_SEARCH_CAP
static int	RECENT_TEAMSPACE_CAP
static int	RECENT_VIEW_CAP
static int	SYNC_ITEM_CAP

Fields inherited from class com.ibm.ecm.configuration.ConfigurationObject

ARRAY_DELIMITER, cloned, configuration, DEFAULT_PROPERTY_VALUE_MAP, ERROR_MISSING_KEY, fromTenant, KEY_DELIMITER, LIST_ESC_CHAR, LIST_SEPARATOR, MODIFIER, PLACEHOLDER_SECRET, properties, returnCopyFromCache

Constructor Summary

Constructors

Constructor and Description
UserConfig(org.apache.commons.configuration.Configuration configuration, java.lang.String idPrefix, java.lang.String id)

Method Summary

Modifier and Type	Method and Description
void	addRecentContent(RecentContentConfig recentContentConfig)
void	addRecentItem(RecentItemConfig recentItemConfig)
<T extends ConfigurationObject> void	addRecentItem(T recentItemConfig, java.lang.String key, java.lang.Class<T> configClass)
void	addRecentSearch(RecentSearchConfig recentSearchConfig)
void	addRecentSimpleSearch(RecentSimpleSearchConfig recentSimpleSearchConfig)
void	addRecentTeamspace(RecentTeamspaceConfig recentTeamspaceConfig)
java.lang.String	getCurrentUserId()
protected java.lang.Class	getDataType(java.lang.String key) Returns the datatype of a configuration property.
java.util.Collection<FavoriteConfig>	getFavoriteList()
java.lang.String[]	getFavoritesId()
java.util.Map<java.lang.String,FavoriteConfig>	getFavoritesIdMap()
java.util.Map<java.lang.String,FavoriteConfig>	getFavoritesMap()
java.util.Collection	getList(java.lang.String type, java.lang.String appName, javax.servlet.http.HttpServletRequest request) Abstract method that needs to be override in concrete class to a return a collection back by type.
OAuthTokenConfig	getOAuthTokenConfig(java.lang.String clientId)
java.util.Collection<OAuthTokenConfig>	getOAuthTokenList()
java.util.Map<java.lang.String,OAuthTokenConfig>	getOAuthTokenMap()
java.lang.String	getObjectType() Abstract method to return object type.
java.util.Collection<RecentContentConfig>	getRecentContentList()
java.util.Collection<RecentItemConfig>	getRecentItemList()
java.util.Collection<RecentSearchConfig>	getRecentSearchList()
java.util.Collection<RecentSimpleSearchConfig>	getRecentSimpleSearchList()
java.util.Collection<RecentTeamspaceConfig>	getRecentTeamspaceList()
SimpleSearchSettingsConfig	getSimpleSearchSettings()
java.lang.String[]	getSyncItemId()
java.util.Map<java.lang.String,SyncItemConfig>	getSyncItemIdMap()
java.util.Collection<SyncItemConfig>	getSyncItemList()
java.util.Map<java.lang.String,SyncItemConfig>	getSyncItemMap()
java.util.Collection<SyncItemConfig>	initSyncItemListFromFavorites() Copy Favorite sync items to initial sync item list.
boolean	isFavorteMax()
boolean	isRecentSearchMax()
boolean	isSyncItemMax()
void	putOAuthToken(java.lang.String clientId, java.lang.String refreshToken, java.lang.String userDisplayName)
boolean	removeOAuthToken(java.lang.String clientId)
void	removeValuesFromList(java.lang.String key, java.util.List<java.lang.String> deleteValues, java.util.Properties props)
void	save() Saves the object back to the configuration store.
void	setCurrentUserId(java.lang.String userId)
void	setFavoritesId(java.lang.String[] favorites)
void	setSimpleSearchSettings(SimpleSearchSettingsConfig simpleSearchSettings)
void	setSyncItemId(java.lang.String[] syncItems)
void	validateObjectId()

Methods inherited from class com.ibm.ecm.configuration.ConfigurationObject

addIdNameToJSONModel, addValueToList, arrayToString, arrayToString, clone, covertEmptyStringtoNull, createJSONModelField, createJSONModelToggleField, createJSONModelValidationField, delete, dump, fromJSONModel, getBooleanPropertyValue, getConfigurationObject, getDataTypeValue, getDoublePropertyValue, getIdPrefix, getIntPropertyValue, getKey, getLongPropertyValue, getMap, getName, getObjectId, getObjectIdAlias, getPropertyNames, getPropertyValue, getPropertyValue, getPropertyValue, getPropertyValue, hasProperties, isEmpty, isNew, load, performSyncedUpdate, propertiesToString, removeValuesFromList, resetNonTenantSettings, returnCopyFromCache, setDefaultValue, setProperties, setProperty, setValues, setValues, setValues, setValues, skipThisPropertyWhenSaving, stringToArray, stringToList, toJSON, toJSON, toJSONModel, toString, validate, writeConfigurationToFile

Methods inherited from class java.lang.Object

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

Field Detail

FAVORITE_CAP

public static final int FAVORITE_CAP

See Also:

Constant Field Values

SYNC_ITEM_CAP

public static final int SYNC_ITEM_CAP

See Also:

Constant Field Values

RECENT_SEARCH_CAP

public static final int RECENT_SEARCH_CAP

See Also:

Constant Field Values

RECENT_SIMPLE_SEARCH_CAP

public static final int RECENT_SIMPLE_SEARCH_CAP

See Also:

Constant Field Values

RECENT_TEAMSPACE_CAP

public static final int RECENT_TEAMSPACE_CAP

See Also:

Constant Field Values

RECENT_ITEM_CAP

public static final int RECENT_ITEM_CAP

See Also:

Constant Field Values

RECENT_VIEW_CAP

public static final int RECENT_VIEW_CAP

See Also:

Constant Field Values

Constructor Detail

UserConfig

public UserConfig(org.apache.commons.configuration.Configuration configuration,
                  java.lang.String idPrefix,
                  java.lang.String id)

Method Detail

getObjectType

public java.lang.String getObjectType()

Description copied from class: ConfigurationObject

Abstract method to return object type.

Specified by:

getObjectType in class ConfigurationObject

Returns:

a string object type back, for example "desktop", "repository"...

getCurrentUserId

public java.lang.String getCurrentUserId()

Specified by:

getCurrentUserId in interface UserBasedConfig

setCurrentUserId

public void setCurrentUserId(java.lang.String userId)

Specified by:

setCurrentUserId in interface UserBasedConfig

validateObjectId

public void validateObjectId()

Overrides:

validateObjectId in class ConfigurationObject

getDataType

protected java.lang.Class getDataType(java.lang.String key)

Description copied from class: ConfigurationObject

Returns the datatype of a configuration property. This is implemented in subclasses and is used to properly serialize the properties. The default implementation returns null which indicates that compatible behavior should be used, which inspects the property value itself and guesses at the type of the property.

Overrides:

getDataType in class ConfigurationObject

Parameters:

key - ths name of the property

Returns:

a Class instance describing the datatype of the property.

getList

public java.util.Collection getList(java.lang.String type,
                                    java.lang.String appName,
                                    javax.servlet.http.HttpServletRequest request)

Description copied from class: ConfigurationObject

Abstract method that needs to be override in concrete class to a return a collection back by type.

Overrides:

getList in class ConfigurationObject

Parameters:

type - - A string value of object type.

appName - - A string value of application name.

request - - A HttpServletRequest object.

Returns:

a collection of type.

getOAuthTokenList

public java.util.Collection<OAuthTokenConfig> getOAuthTokenList()

Since:

2.0.3.5

getOAuthTokenMap

public java.util.Map<java.lang.String,OAuthTokenConfig> getOAuthTokenMap()

Since:

2.0.3.5

getOAuthTokenConfig

public OAuthTokenConfig getOAuthTokenConfig(java.lang.String clientId)

Since:

2.0.3.6

putOAuthToken

public void putOAuthToken(java.lang.String clientId,
                          java.lang.String refreshToken,
                          java.lang.String userDisplayName)
                   throws java.io.IOException

Throws:

java.io.IOException

Since:

2.0.3.5

removeOAuthToken

public boolean removeOAuthToken(java.lang.String clientId)
                         throws java.io.IOException

Throws:

java.io.IOException

Since:

2.0.3.5

getSyncItemList

public java.util.Collection<SyncItemConfig> getSyncItemList()

getSyncItemIdMap

public java.util.Map<java.lang.String,SyncItemConfig> getSyncItemIdMap()

initSyncItemListFromFavorites

public java.util.Collection<SyncItemConfig> initSyncItemListFromFavorites()
                                                                   throws org.apache.commons.configuration.ConfigurationException,
                                                                          MissingValueException

Copy Favorite sync items to initial sync item list. Only used at the upgrade scenario

Throws:

MissingValueException

org.apache.commons.configuration.ConfigurationException

Since:

2.0.3.5

getSyncItemMap

public java.util.Map<java.lang.String,SyncItemConfig> getSyncItemMap()

Since:

2.0.3.5

getSyncItemId

public java.lang.String[] getSyncItemId()

Since:

2.0.3.5

setSyncItemId

public void setSyncItemId(java.lang.String[] syncItems)

Since:

2.0.3.5

isSyncItemMax

public boolean isSyncItemMax()

Since:

2.0.3.5

getFavoritesId

public java.lang.String[] getFavoritesId()

setFavoritesId

public void setFavoritesId(java.lang.String[] favorites)

getFavoriteList

public java.util.Collection<FavoriteConfig> getFavoriteList()

getFavoritesIdMap

public java.util.Map<java.lang.String,FavoriteConfig> getFavoritesIdMap()

isFavorteMax

public boolean isFavorteMax()

getFavoritesMap

public java.util.Map<java.lang.String,FavoriteConfig> getFavoritesMap()

isRecentSearchMax

public boolean isRecentSearchMax()

getRecentSearchList

public java.util.Collection<RecentSearchConfig> getRecentSearchList()

addRecentSearch

public void addRecentSearch(RecentSearchConfig recentSearchConfig)
                     throws java.io.IOException

Throws:

java.io.IOException

getRecentSimpleSearchList

public java.util.Collection<RecentSimpleSearchConfig> getRecentSimpleSearchList()

getRecentItemList

public java.util.Collection<RecentItemConfig> getRecentItemList()

getRecentContentList

public java.util.Collection<RecentContentConfig> getRecentContentList()

addRecentSimpleSearch

public void addRecentSimpleSearch(RecentSimpleSearchConfig recentSimpleSearchConfig)
                           throws java.io.IOException

Throws:

java.io.IOException

addRecentItem

public void addRecentItem(RecentItemConfig recentItemConfig)
                   throws java.io.IOException

Throws:

java.io.IOException

addRecentContent

public void addRecentContent(RecentContentConfig recentContentConfig)
                      throws java.io.IOException

Throws:

java.io.IOException

addRecentItem

public <T extends ConfigurationObject> void addRecentItem(T recentItemConfig,
                                                          java.lang.String key,
                                                          java.lang.Class<T> configClass)
                                                   throws java.io.IOException

Throws:

java.io.IOException

getRecentTeamspaceList

public java.util.Collection<RecentTeamspaceConfig> getRecentTeamspaceList()

addRecentTeamspace

public void addRecentTeamspace(RecentTeamspaceConfig recentTeamspaceConfig)
                        throws java.io.IOException

Throws:

java.io.IOException

removeValuesFromList

public void removeValuesFromList(java.lang.String key,
                                 java.util.List<java.lang.String> deleteValues,
                                 java.util.Properties props)

Overrides:

removeValuesFromList in class ConfigurationObject

getSimpleSearchSettings

public SimpleSearchSettingsConfig getSimpleSearchSettings()

setSimpleSearchSettings

public void setSimpleSearchSettings(SimpleSearchSettingsConfig simpleSearchSettings)
                             throws java.io.IOException

Throws:

java.io.IOException

save

public void save()
          throws org.apache.commons.configuration.ConfigurationException

Description copied from class: ConfigurationObject

Saves the object back to the configuration store.

Overrides:

save in class ConfigurationObject

Throws:

org.apache.commons.configuration.ConfigurationException