Package com.sun.identity.console.service.model

Class SCModelBase

java.lang.Object

com.sun.identity.console.base.model.AMModelBase

com.sun.identity.console.service.model.SCModelBase

All Implemented Interfaces:

AMAdminConstants, AMModel, SCModel

Direct Known Subclasses:

SCPolicyModelImpl

public abstract class SCModelBase
extends AMModelBase
implements SCModel

This class contains the common service management related calls used for global service configuration. Views that need service processing can implement this class and get many needed routines for free. The extending class needs to implement getServiceName() and return the appropriate service name.

Field Summary

Fields inherited from class com.sun.identity.console.base.model.AMModelBase

debug, locale, locationDN

Fields inherited from interface com.sun.identity.console.base.model.AMAdminConstants

ADMIN_CONSOLE_SERVICE, ADMIN_DISPLAY_ATTRIBUTE, ADMIN_DISPLAY_READONLY_ATTRIBUTE, AGENT_REPOSITORY_LOCATION_ATTR, AGENTS_NODE_ID, AMSDK_DEBUG_FILENAME, ATTR_USER_OLD_PASSWORD, ATTR_USER_PASSWORD, ATTR_USER_RESOURCE_OFFERING, ATTR_USER_STATUS, AUTH_CONFIG_SERVICE, CDM_CONTENT_TYPE_PROPERTY_NAME, CHOICES, CONFIGURATION_NODE_ID, CONSOLE_DEBUG_FILENAME, CONSOLE_LOCATION_DN, CONSOLE_ORG_CUSTOM_JSP_DIRECTORY, CONSOLE_UM_ENABLED_ATTR, CONSOLE_USER_ATTRS_SEARCH_KEY, CONSOLE_USER_SEARCH_KEY, CONSOLE_USER_SEARCH_RETURN_KEY, CORE_AUTH_SERVICE, CURRENT_ORG, CURRENT_PROFILE, CURRENT_REALM, DEFAULT_RB, DEFAULT_SEARCH_TIMEOUT, DISCOVERY_SERVICE, DISCOVERY_SERVICE_NAME_BOOTSTRAP_RES_OFF, DISCOVERY_SERVICE_NAME_DYNAMIC_DISCO_ENTRIES, DISCOVERY_SERVICE_PROVIDER_RESOURCE_ID_MAPPER, DISCOVERY_SERVICE_PROVIDER_RESOURCE_ID_MAPPER_ID_MAPPER, DISCOVERY_SERVICE_PROVIDER_RESOURCE_ID_MAPPER_PROVIDER_ID, DISPLAY_ATTRIBUTE, DISPLAY_READONLY_ATTRIBUTE, DYN_LINK_COMPONENT_NAME, ENCRYPTED, FED_TAB_ID, G11N_SERIVCE_COMMON_NAME_FORMAT, G11N_SERVICE_NAME, IDREPO_SERVICE_NAME, IMAGES_PRIMARY_PRODUCT_NAME_PNG, OPERATION_ADD, OPERATION_EDIT, OPTIONAL_ATTRIBUTE, ORGANIZATION_NODE_ID, PASSWORD, PERMISSION_DELEGATE, PERMISSION_MODIFY, PERMISSION_READ, PG_SESSION_INIT_PAGETRAIL, PLATFORM_SERVICE, POLICY_SELECTED_RESPONSE_PROVIDER, POLICY_SERVICE, PREVIOUS_ORGANIZATION, PREVIOUS_REALM, PREVIOUS_TAB_ID, PW_RESET_SERVICE, REALM_NODE_ID, REQUIRED_ATTRIBUTE, REST_STS_SERVICE, ROLE_DISPLAY_OPTION_ATTRIBUTE_NAME, SAML_SERVICE, SAVE_VB_NAME, SERVICE_NAME, SESSION_SERVICE, SESSIONS_NODE_ID, SOAP_STS_SERVICE, SSO_TOKEN_LOCALE_ATTRIBUTE_NAME, SSO_TOKEN_ORGANIZATION_ATTRIBUTE_NAME, STRING_ACTIVE, STRING_FALSE, STRING_INACTIVE, SUBJECTS_NODE_ID, TAB_AGENT_PREFIX, TAB_AGENT_PREFIX_INT, URL_LOGIN, URL_LOGOUT, USER_SERVICE, USER_SERVICE_PREFERRED_LOCALE, VALUES

Fields inherited from interface com.sun.identity.console.base.model.AMModel

CONSOLE_PAGING_SIZE_ATTR, CONSOLE_SEARCH_RESULT_LIMIT_ATTR, CONSOLE_SEARCH_TIME_LIMIT_ATTR, DEFAULT_PAGE_SIZE, DEFAULT_SEARCH_RESULT_LIMIT, DEFAULT_SEARCH_TIME_LIMIT

Constructor Summary

Constructors

Constructor	Description
SCModelBase(jakarta.servlet.http.HttpServletRequest req, Map map)	Creates a service data model implementation object

Method Summary

Modifier and Type	Method	Description
protected Set	getAttributeNames(SchemaType type)	Returns a set of attribute names that are defined for the given SchemaType.
protected Map	getAttributeValues(SchemaType type)	Gets the values for all the attributes defined for the specified type.
protected Map	getAttributeValues(SchemaType type, Set attributes)	Gets the values for the specified set of attributes defined for the specified type.
abstract String	getServiceName()
Map	getValues()	Returns the values for the GLOBAL, ORGANIZATION, and DYNAMIC attributes in the service.
protected void	setAttributeValues(SchemaType type, Map values)	Sets the attribute values for the specified schema type.
void	setValues(Map modifiedValues)	Sets the values for the attributes that are configurable for the service.

Methods inherited from class com.sun.identity.console.base.model.AMModelBase

encryptString, getAttributesToDisplay, getAuthenticatedOrgDN, getClientType, getConsoleAttributes, getConsoleDirectory, getErrorString, getGlobalPageSize, getGlobalSearchResultLimit, getGlobalSearchTimeOutLimit, getLocalizedServiceName, getLocalizedServiceName, getLocalizedString, getLocationDN, getLogoutURL, getPageSize, getRandomString, getRealmNames, getResourceBundle, getSearchResultLimit, getSearchTimeOutLimit, getServerInstanceForLogMsg, getServicePropertiesViewBeanURL, getServiceResourceBundle, getServiceSchemaManager, getSpecialUsers, getStartDN, getStartDN, getStartDSDN, getSupportedAgentTypes, getSupportedEntityTypes, getUniversalID, getUserAdditionalSearchAttributes, getUserDisplayAttribute, getUserDisplayName, getUserDN, getUserInfo, getUserLocale, getUserName, getUserOrganization, getUserSearchAttribute, getUserSSOToken, ignoreUserProfile, initialize, isAmadminUser, isAMSDKEnabled, isDisplayed, logEvent, setLocationDN, validateUserStatusEntry

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sun.identity.console.base.model.AMModel

getClientType, getConsoleDirectory, getErrorString, getLocalizedServiceName, getLocalizedString, getLocationDN, getPageSize, getRandomString, getRealmNames, getServicePropertiesViewBeanURL, getSpecialUsers, getStartDN, getStartDSDN, getSupportedAgentTypes, getSupportedEntityTypes, getUniversalID, getUserDisplayName, getUserDN, getUserLocale, getUserName, getUserSSOToken, ignoreUserProfile, isAmadminUser, isAMSDKEnabled, logEvent, setLocationDN

Constructor Detail

SCModelBase

public SCModelBase(jakarta.servlet.http.HttpServletRequest req,
                   Map map)

Creates a service data model implementation object

Parameters:

req - The HttpServletRequest object.

map - of user information.

Method Detail

getAttributeValues

protected Map getAttributeValues(SchemaType type)
                          throws AMConsoleException

Gets the values for all the attributes defined for the specified type.

Throws:

AMConsoleException

getAttributeValues

protected Map getAttributeValues(SchemaType type,
                                 Set attributes)
                          throws AMConsoleException

Gets the values for the specified set of attributes defined for the specified type.

Throws:

AMConsoleException

setAttributeValues

protected void setAttributeValues(SchemaType type,
                                  Map values)
                           throws AMConsoleException

Sets the attribute values for the specified schema type.

Throws:

AMConsoleException

getAttributeNames

protected Set getAttributeNames(SchemaType type)
                         throws AMConsoleException

Returns a set of attribute names that are defined for the given SchemaType. All attribute names are returned. There is no schema, display, or i18nkey checks performed here.

Throws:

AMConsoleException

getValues

public Map getValues()
              throws AMConsoleException

Returns the values for the GLOBAL, ORGANIZATION, and DYNAMIC attributes in the service.

Specified by:

getValues in interface SCModel

Returns:

Map property values.

Throws:

AMConsoleException

setValues

public void setValues(Map modifiedValues)
               throws AMConsoleException

Sets the values for the attributes that are configurable for the service. The policy service contains only global and organization attributes. To store the attributes, we first remove the global attributes and put them into another Map. This map is then stored in the service config. The values remaining in the original map are the organization attributes, which can then be stored in the service config.

Specified by:

setValues in interface SCModel

Parameters:

modifiedValues - that will be set in the service configuration data.

Throws:

AMConsoleException - on any error condition.

getServiceName

public abstract String getServiceName()