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

Interface SubConfigModel

All Superinterfaces:

AMAdminConstants, AMModel

All Known Implementing Classes:

SubConfigModelImpl

public interface SubConfigModel
extends AMModel

Field Summary

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

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 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

Method Detail

getAddConfigPropertyXML

String getAddConfigPropertyXML(String name)
                        throws AMConsoleException

Returns property sheet XML for adding new sub configuration.

Parameters:

name - Name of Schema.

Returns:

property sheet XML for adding new sub configuration.

Throws:

AMConsoleException

getEditConfigPropertyXML

String getEditConfigPropertyXML(String viewbeanClassName)
                         throws AMConsoleException

Returns property sheet XML for editing sub configuration.

Parameters:

viewbeanClassName - Class name of view bean.

Returns:

property sheet XML for editing sub configuration.

Throws:

AMConsoleException

getCreateableSubSchemaNames

Map getCreateableSubSchemaNames()

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

Returns:

Map of sub schema name to its localized name.

getAttributeNames

Set getAttributeNames(String schemaName)

Returns a set of attribute names for a sub schema.

Parameters:

schemaName - Name of Schema.

Returns:

Set of attribute names for a sub schema.

createSubConfig

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

Creates a new sub configuration.

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

Map getSubConfigAttributeValues()
                         throws AMConsoleException

Returns attribute values.

Returns:

attribute values.

Throws:

AMConsoleException - if attribute values cannot be determined.

setSubConfigAttributeValues

void setSubConfigAttributeValues(Map values)
                          throws AMConsoleException

Set attribute values.

Parameters:

values - Attribute values.

Throws:

AMConsoleException - if attribute values cannot be set.

getServiceSchemaDefaultValues

Map getServiceSchemaDefaultValues(String name)
                           throws AMConsoleException

Returns default values of a schema.

Parameters:

name - Name of Schema.

Returns:

default values of a schema.

Throws:

AMConsoleException - if default values cannot be determined.

hasGlobalSubSchema

boolean hasGlobalSubSchema()

Returns true if this service has global sub schema.

Returns:

true if this service has global sub schema.

getSubConfigurations

List getSubConfigurations()

Returns list of sub configuration objects.

Returns:

list of sub configuration objects.

See Also:

SMSubConfig

deleteSubConfigurations

void deleteSubConfigurations(Set names)
                      throws AMConsoleException

Deletes sub configurations.

Parameters:

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

Throws:

AMConsoleException - if sub configuration cannot be deleted.

getSelectableSubConfigNamesPlugin

String getSelectableSubConfigNamesPlugin(String subSchemaName)

Returns plugin name for returning possible sub configuration names.

Parameters:

subSchemaName - Name of sub schema.

Returns:

plugin name for returning possible sub configuration names.

getSelectableConfigNames

Set getSelectableConfigNames(String subSchemaName)

Returns a set of possible names of sub configuration.

Parameters:

subSchemaName - Name of sub schema

Returns:

a set of possible names of sub configuration.

getDisplayName

String getDisplayName()

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

Returns:

the sub configuration's display name.

getName

String getName()

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

Returns:

the sub configuration's name.