Package com.sun.identity.console.sts.model

Interface STSInstanceModel

All Superinterfaces:

AMAdminConstants, AMModel, STSHomeViewBeanModel

All Known Implementing Classes:

RestSTSInstanceModel, SoapSTSInstanceModel, STSInstanceModelBase

public interface STSInstanceModel
extends STSHomeViewBeanModel

Defines the model functionality necessary to support the Rest/Soap Add/Edit ViewBean classes.

Nested Class Summary

Nested classes/interfaces inherited from interface com.sun.identity.console.sts.model.STSHomeViewBeanModel

STSHomeViewBeanModel.STSType

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
STSInstanceModelResponse	createInstance(STSHomeViewBeanModel.STSType stsType, Map<String,Set<String>> configurationState, String realm)	Publishes a rest sts instance by POSTing to the rest-sts publish endpoint.
Map<String,Set<String>>	getInstanceState(STSHomeViewBeanModel.STSType stsType, String realm, String instanceName)	Called by the RestSTSEditViewBean to obtain the instance state necessary to edit an existing rest sts instance.
STSInstanceModelResponse	updateInstance(STSHomeViewBeanModel.STSType stsType, Map<String,Set<String>> configurationState, String realm, String instanceName)	Updates a rest sts instance by PUTing to the rest-sts publish endpoint.
STSInstanceModelResponse	validateConfigurationState(STSHomeViewBeanModel.STSType stsType, Map<String,Set<String>> configurationState)	Called by the ViewBean context prior to updating or publishing a rest sts instance.

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

Methods inherited from interface com.sun.identity.console.sts.model.STSHomeViewBeanModel

deleteInstances, getPublishedInstances

Method Detail

createInstance

STSInstanceModelResponse createInstance(STSHomeViewBeanModel.STSType stsType,
                                        Map<String,Set<String>> configurationState,
                                        String realm)
                                 throws AMConsoleException

Publishes a rest sts instance by POSTing to the rest-sts publish endpoint.

Parameters:

stsType - is the request for soap or rest instances

configurationState - the configuration state defining the published instance

realm - the realm in which the instance should be published. Necessary to add the realm state to the configuration state, as the end-user should not be able to set this directly (i.e. it is implicit in the ViewBean display)

Returns:

A RestSTSModelResonse instance, which encapsulates success or failure, and a optional success/failure message

Throws:

AMConsoleException - If an IOException occurs in making the POST

updateInstance

STSInstanceModelResponse updateInstance(STSHomeViewBeanModel.STSType stsType,
                                        Map<String,Set<String>> configurationState,
                                        String realm,
                                        String instanceName)
                                 throws AMConsoleException

Updates a rest sts instance by PUTing to the rest-sts publish endpoint.

Parameters:

stsType - is the request for soap or rest instances

configurationState - the configuration state defining the updated instance

realm - the realm in which the instance should be published. Necessary to add the realm state to the configuration state, as the end-user should not be able to set this directly (i.e. it is implicit in the ViewBean display)

instanceName - The name of the instance, as set by the ViewBean. Used to constitute the PUT url.

Returns:

A RestSTSModelResonse instance, which encapsulates success or failure, and optional success/failure messages

Throws:

AMConsoleException - If an IOException occurs in making the PUT

getInstanceState

Map<String,Set<String>> getInstanceState(STSHomeViewBeanModel.STSType stsType,
                                               String realm,
                                               String instanceName)
                                        throws AMConsoleException

Called by the RestSTSEditViewBean to obtain the instance state necessary to edit an existing rest sts instance.

Parameters:

stsType - is the request for soap or rest instances

realm - the realm to which the instance has been published

instanceName - the instance name

Returns:

The state corresponding to the rest sts instance which is used to constitute the property-sheet displayed by the RestSTSEditViewBean

Throws:

AMConsoleException - If the SMS cannot be consulted.

validateConfigurationState

STSInstanceModelResponse validateConfigurationState(STSHomeViewBeanModel.STSType stsType,
                                                    Map<String,Set<String>> configurationState)

Called by the ViewBean context prior to updating or publishing a rest sts instance.

Parameters:

stsType - is the request for soap or rest instances

configurationState - the to-be-validated configuration state

Returns:

A STSInstanceModelResponse indicating validation success or failure. If validation was not successful, the message will indicate the validation error.