Package com.sun.identity.console.realm.model

Interface RMRealmModel

All Superinterfaces:

AMAdminConstants, AMModel

All Known Implementing Classes:

RMRealmModelImpl

public interface RMRealmModel
extends AMModel

Field Summary

Fields

Modifier and Type	Field	Description
static String	TF_NAME
static String	TF_PARENT

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	createSubRealm(String parentRealm, String name, Map attrValues)	Creates sub realm.
void	deleteSubRealms(String parentRealm, Collection names)	Deletes sub realms
Map	getAttributeValues(String name)	Returns attribute values.
String	getCreateRealmPropertyXML()	Returns sub realm creation property XML.
Map	getDataMap()	Returns Map of attribute name to empty set of values.
Map	getDefaultValues()	Returns Map of default realm attribute values.
String	getRealmProfilePropertyXML(String realmName, String viewbeanClassName)	Returns realm profile property XML.
void	setAttributeValues(String name, Map attributeValues)	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

Field Detail

TF_NAME

static final String TF_NAME

See Also:

Constant Field Values

TF_PARENT

static final String TF_PARENT

See Also:

Constant Field Values

Method Detail

getCreateRealmPropertyXML

String getCreateRealmPropertyXML()
                          throws AMConsoleException

Returns sub realm creation property XML.

Returns:

sub realm creation property XML.

Throws:

AMConsoleException - if there are no attributes to display.

getRealmProfilePropertyXML

String getRealmProfilePropertyXML(String realmName,
                                  String viewbeanClassName)
                           throws AMConsoleException

Returns realm profile property XML.

Parameters:

realmName - Name of Realm.

viewbeanClassName - Class name of View Bean

Returns:

realm profile property XML.

Throws:

AMConsoleException - if there are no attributes to display.

createSubRealm

void createSubRealm(String parentRealm,
                    String name,
                    Map attrValues)
             throws AMConsoleException

Creates sub realm.

Parameters:

parentRealm - Parent realm name.

name - Name of new sub realm.

attrValues - Map of attribute name to a set of attribute values.

Throws:

AMConsoleException - if sub realm cannot be created.

deleteSubRealms

void deleteSubRealms(String parentRealm,
                     Collection names)
              throws AMConsoleException

Deletes sub realms

Parameters:

parentRealm - Parent realm name.

names - List of realm names to be deleted.

Throws:

AMConsoleException - if sub realms cannot be deleted.

getDefaultValues

Map getDefaultValues()

Returns Map of default realm attribute values.

Returns:

attribute values.

getDataMap

Map getDataMap()

Returns Map of attribute name to empty set of values.

Returns:

attribute values.

getAttributeValues

Map getAttributeValues(String name)
                throws AMConsoleException

Returns attribute values. Map of attribute name to set of values.

Parameters:

name - Name of Realm.

Returns:

attribute values.

Throws:

AMConsoleException

setAttributeValues

void setAttributeValues(String name,
                        Map attributeValues)
                 throws AMConsoleException

Set attribute values.

Parameters:

name - Name of Realm.

attributeValues - Map of attribute values to set of values.

Throws:

AMConsoleException - if attribute values cannot be updated.