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

Class SubConfigModelImpl

java.lang.Object

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

com.sun.identity.console.service.model.SubConfigModelImpl

All Implemented Interfaces:

AMAdminConstants, AMModel, SubConfigModel

public class SubConfigModelImpl
extends AMModelBase
implements SubConfigModel

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
SubConfigModelImpl(jakarta.servlet.http.HttpServletRequest req, String serviceName, String parentId, Map map)	Creates a simple model using default resource bundle.

Method Summary

Modifier and Type	Method	Description
void	createSubConfig(String name, String schemaName, Map values)	Creates a new sub configuration.
void	deleteSubConfigurations(Set names)	Deletes sub configurations.
String	getAddConfigPropertyXML(String name)	Returns property sheet XML for adding new sub configuration.
Set	getAttributeNames(String schemaName)	Returns a set of attribute names for a sub schema.
Map	getCreateableSubSchemaNames()	/** Returns a map of sub schema name to its localized name.
String	getDisplayName()	Get the display name for the sub configuration represented by this model.
String	getEditConfigPropertyXML(String viewbeanClassName)	Returns property sheet XML for editing sub configuration.
String	getName()	Get the name for the sub configuration represented by this model.
Set	getSelectableConfigNames(String subSchemaName)	Returns a set of possible names of sub configuration.
String	getSelectableSubConfigNamesPlugin(String subSchemaName)	Returns plugin name for returning possible sub configuration names.
Map	getServiceSchemaDefaultValues(String name)	Returns default values of a schema.
Map	getSubConfigAttributeValues()	Returns attribute values.
List	getSubConfigurations()	Returns list of sub configuration objects.
boolean	hasGlobalSubSchema()	Returns true if this service has global sub schema.
void	setSubConfigAttributeValues(Map values)	Set attribute values.

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

SubConfigModelImpl

public SubConfigModelImpl(jakarta.servlet.http.HttpServletRequest req,
                          String serviceName,
                          String parentId,
                          Map map)
                   throws AMConsoleException

Creates a simple model using default resource bundle.

Parameters:

req - HTTP Servlet Request

serviceName - Name of Service.

parentId - Parent Id.

map - of user information

Throws:

AMConsoleException

Method Detail

getAddConfigPropertyXML

public String getAddConfigPropertyXML(String name)
                               throws AMConsoleException

Returns property sheet XML for adding new sub configuration.

Specified by:

getAddConfigPropertyXML in interface SubConfigModel

Parameters:

name - Name of Schema.

Returns:

property sheet XML for adding new sub configuration.

Throws:

AMConsoleException

getEditConfigPropertyXML

public String getEditConfigPropertyXML(String viewbeanClassName)
                                throws AMConsoleException

Returns property sheet XML for editing sub configuration.

Specified by:

getEditConfigPropertyXML in interface SubConfigModel

Parameters:

viewbeanClassName - Class name of view bean.

Returns:

property sheet XML for editing sub configuration.

Throws:

AMConsoleException

getCreateableSubSchemaNames

public Map getCreateableSubSchemaNames()

/** Returns a map of sub schema name to its localized name. We should be able to create sub configuration with these names.

Specified by:

getCreateableSubSchemaNames in interface SubConfigModel

Returns:

Map of sub schema name to its localized name.

getAttributeNames

public Set getAttributeNames(String schemaName)

Returns a set of attribute names for a sub schema.

Specified by:

getAttributeNames in interface SubConfigModel

Parameters:

schemaName - Name of Schema.

Returns:

Set of attribute names for a sub schema.

createSubConfig

public void createSubConfig(String name,
                            String schemaName,
                            Map values)
                     throws AMConsoleException

Creates a new sub configuration.

Specified by:

createSubConfig in interface SubConfigModel

Parameters:

name - Name of sub configuration.

schemaName - Name of schema name.

values - Map of attribute name to its values.

Throws:

AMConsoleException - if sub configuration cannot be created.

getSubConfigAttributeValues

public Map getSubConfigAttributeValues()
                                throws AMConsoleException

Returns attribute values.

Specified by:

getSubConfigAttributeValues in interface SubConfigModel

Returns:

attribute values.

Throws:

AMConsoleException - if attribute values cannot be determined.

setSubConfigAttributeValues

public void setSubConfigAttributeValues(Map values)
                                 throws AMConsoleException

Set attribute values.

Specified by:

setSubConfigAttributeValues in interface SubConfigModel

Parameters:

values - Attribute values.

Throws:

AMConsoleException - if attribute values cannot be set.

getServiceSchemaDefaultValues

public Map getServiceSchemaDefaultValues(String name)
                                  throws AMConsoleException

Returns default values of a schema.

Specified by:

getServiceSchemaDefaultValues in interface SubConfigModel

Parameters:

name - Name of Schema.

Returns:

default values of a schema.

Throws:

AMConsoleException - if default values cannot be determined.

hasGlobalSubSchema

public boolean hasGlobalSubSchema()

Returns true if this service has global sub schema.

Specified by:

hasGlobalSubSchema in interface SubConfigModel

Returns:

true if this service has global sub schema.

getSubConfigurations

public List getSubConfigurations()

Returns list of sub configuration objects.

Specified by:

getSubConfigurations in interface SubConfigModel

Returns:

list of sub configuration objects.

See Also:

SMSubConfig

deleteSubConfigurations

public void deleteSubConfigurations(Set names)
                             throws AMConsoleException

Deletes sub configurations.

Specified by:

deleteSubConfigurations in interface SubConfigModel

Parameters:

names - Names of sub configuration which are to be deleted.

Throws:

AMConsoleException - if sub configuration cannot be deleted.

getSelectableSubConfigNamesPlugin

public String getSelectableSubConfigNamesPlugin(String subSchemaName)

Returns plugin name for returning possible sub configuration names.

Specified by:

getSelectableSubConfigNamesPlugin in interface SubConfigModel

Parameters:

subSchemaName - Name of sub schema.

Returns:

plugin name for returning possible sub configuration names.

getSelectableConfigNames

public Set getSelectableConfigNames(String subSchemaName)

Returns a set of possible names of sub configuration.

Specified by:

getSelectableConfigNames in interface SubConfigModel

Parameters:

subSchemaName - Name of sub schema

Returns:

a set of possible names of sub configuration.

getName

public String getName()

Description copied from interface: SubConfigModel

Get the name for the sub configuration represented by this model.

Specified by:

getName in interface SubConfigModel

Returns:

the sub configuration's name.

getDisplayName

public String getDisplayName()

Description copied from interface: SubConfigModel

Get the display name for the sub configuration represented by this model.

Specified by:

getDisplayName in interface SubConfigModel

Returns:

the sub configuration's display name.