com.ibm.ecm.configuration

Class AccessRoleConfig

java.lang.Object

com.ibm.ecm.configuration.ConfigurationObject

com.ibm.ecm.configuration.AccessRoleConfig

All Implemented Interfaces:

java.io.Serializable

public class AccessRoleConfig
extends ConfigurationObject
implements java.io.Serializable

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AccessRoleConfig.AccessRights

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String[]	CATEGORIES
static java.lang.String	CATEGORY_DESKTOPS
static java.lang.String	CATEGORY_FILENET
static java.lang.String	CATEGORY_ICON_MAPPING
static java.lang.String	CATEGORY_LABELS
static java.lang.String	CATEGORY_MENUS
static java.lang.String	CATEGORY_ON_DEMAND
static java.lang.String	CATEGORY_PLUGINS
static java.lang.String	CATEGORY_REPOSITORIES
static java.lang.String	CATEGORY_ROLES
static java.lang.String	CATEGORY_SETTINGS
static java.lang.String	CATEGORY_SYNC
static java.lang.String	CATEGORY_THEMES
static java.lang.String	CATEGORY_VIEWER
static java.lang.String	CATEGORY_VIEWONE

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
AccessRoleConfig(org.apache.commons.configuration.Configuration configuration, java.lang.String idPrefix, java.lang.String id)

Method Summary

Modifier and Type	Method and Description
AccessRoleConfig	add(AccessRoleConfig config)
static java.lang.String	getCategoryByConfigName(java.lang.String configName)
int	getMask(java.lang.String topic)
java.lang.String	getObjectType() Abstract method to return object type.
protected java.util.Map<java.lang.String,java.lang.String>	getPropertyNames() Return a map of string of all the fields name in the class where field is a private static final string
boolean	hasCreateRight(java.lang.String category)
boolean	hasDeleteRight(java.lang.String category)
boolean	hasModifyRight(java.lang.String category)
boolean	hasRight(AccessRoleConfig.AccessRights right, java.lang.String category)
boolean	hasRights(AccessRoleConfig.AccessRights[] rights, java.lang.String category)
boolean	hasViewRight(java.lang.String category)
boolean	isCustomCategory(java.lang.String category)

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

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

Methods inherited from class java.lang.Object

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

Field Detail

CATEGORY_DESKTOPS

public static final java.lang.String CATEGORY_DESKTOPS

See Also:

Constant Field Values

CATEGORY_REPOSITORIES

public static final java.lang.String CATEGORY_REPOSITORIES

See Also:

Constant Field Values

CATEGORY_SYNC

public static final java.lang.String CATEGORY_SYNC

See Also:

Constant Field Values

CATEGORY_FILENET

public static final java.lang.String CATEGORY_FILENET

See Also:

Constant Field Values

CATEGORY_ON_DEMAND

public static final java.lang.String CATEGORY_ON_DEMAND

See Also:

Constant Field Values

CATEGORY_VIEWONE

public static final java.lang.String CATEGORY_VIEWONE

See Also:

Constant Field Values

CATEGORY_VIEWER

public static final java.lang.String CATEGORY_VIEWER

See Also:

Constant Field Values

CATEGORY_PLUGINS

public static final java.lang.String CATEGORY_PLUGINS

See Also:

Constant Field Values

CATEGORY_MENUS

public static final java.lang.String CATEGORY_MENUS

See Also:

Constant Field Values

CATEGORY_LABELS

public static final java.lang.String CATEGORY_LABELS

See Also:

Constant Field Values

CATEGORY_THEMES

public static final java.lang.String CATEGORY_THEMES

See Also:

Constant Field Values

CATEGORY_ICON_MAPPING

public static final java.lang.String CATEGORY_ICON_MAPPING

See Also:

Constant Field Values

CATEGORY_SETTINGS

public static final java.lang.String CATEGORY_SETTINGS

See Also:

Constant Field Values

CATEGORY_ROLES

public static final java.lang.String CATEGORY_ROLES

See Also:

Constant Field Values

CATEGORIES

public static final java.lang.String[] CATEGORIES

Constructor Detail

AccessRoleConfig

public AccessRoleConfig(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"...

getCategoryByConfigName

public static java.lang.String getCategoryByConfigName(java.lang.String configName)

hasViewRight

public boolean hasViewRight(java.lang.String category)
                     throws java.lang.Exception

Throws:

java.lang.Exception

hasCreateRight

public boolean hasCreateRight(java.lang.String category)
                       throws java.lang.Exception

Throws:

java.lang.Exception

hasModifyRight

public boolean hasModifyRight(java.lang.String category)
                       throws java.lang.Exception

Throws:

java.lang.Exception

hasDeleteRight

public boolean hasDeleteRight(java.lang.String category)
                       throws java.lang.Exception

Throws:

java.lang.Exception

hasRight

public boolean hasRight(AccessRoleConfig.AccessRights right,
                        java.lang.String category)
                 throws java.lang.Exception

Throws:

java.lang.Exception

hasRights

public boolean hasRights(AccessRoleConfig.AccessRights[] rights,
                         java.lang.String category)
                  throws java.lang.Exception

Throws:

java.lang.Exception

getMask

public int getMask(java.lang.String topic)
            throws java.lang.Exception

Throws:

java.lang.Exception

isCustomCategory

public boolean isCustomCategory(java.lang.String category)

add

public AccessRoleConfig add(AccessRoleConfig config)
                     throws java.lang.Exception

Throws:

java.lang.Exception

getPropertyNames

protected java.util.Map<java.lang.String,java.lang.String> getPropertyNames()

Return a map of string of all the fields name in the class where field is a private static final string

Overrides:

getPropertyNames in class ConfigurationObject

Returns: