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

Class STSInstanceModelBase

java.lang.Object

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

com.sun.identity.console.base.model.AMServiceProfileModelImpl

com.sun.identity.console.sts.model.STSInstanceModelBase

All Implemented Interfaces:

AMAdminConstants, AMModel, AMServiceProfileModel, STSHomeViewBeanModel, STSInstanceModel

Direct Known Subclasses:

RestSTSInstanceModel, SoapSTSInstanceModel

public abstract class STSInstanceModelBase
extends AMServiceProfileModelImpl
implements STSInstanceModel

See Also:

This class extends the AMServiceProfileModelImpl because this class provides functionality for reading values corresponding to propertySheets.

Nested Class Summary

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

STSHomeViewBeanModel.STSType

Field Summary

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

serviceName, xmlBuilder

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
STSInstanceModelBase(jakarta.servlet.http.HttpServletRequest req, String serviceName, Map map)

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.
void	deleteInstances(STSHomeViewBeanModel.STSType stsType, Set<String> instanceNames)	Performs DELETEs against the rest-sts publish endpoint to remove the published instances
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.
Set<String>	getPublishedInstances(STSHomeViewBeanModel.STSType stsType, String realm)	Returns the set of rest sts instances in the SMS under the given realm.
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 class com.sun.identity.console.base.model.AMServiceProfileModelImpl

addMoreAttributeSchemasForModification, getAttributeValues, getAttributeValues, getDisplaySchemaTypes, getPageTitle, getPropertiesViewBean, getPropertySheetXML, getServiceSchemaManager, setAttributeValues

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

STSInstanceModelBase

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

Throws:

AMConsoleException

Method Detail

getPublishedInstances

public Set<String> getPublishedInstances(STSHomeViewBeanModel.STSType stsType,
                                         String realm)
                                  throws AMConsoleException

Description copied from interface: STSHomeViewBeanModel

Returns the set of rest sts instances in the SMS under the given realm.

Specified by:

getPublishedInstances in interface STSHomeViewBeanModel

Parameters:

stsType - is the request for soap or rest instances

realm - the realm to consult for the rest sts instances.

Returns:

The names of rest sts instances in the SMS

Throws:

AMConsoleException - if the SMS cannot be successfully consulted

deleteInstances

public void deleteInstances(STSHomeViewBeanModel.STSType stsType,
                            Set<String> instanceNames)
                     throws AMConsoleException

Description copied from interface: STSHomeViewBeanModel

Performs DELETEs against the rest-sts publish endpoint to remove the published instances

Specified by:

deleteInstances in interface STSHomeViewBeanModel

Parameters:

stsType - is the request for soap or rest instances

instanceNames - the set of instances to be deleted

Throws:

AMConsoleException - If an IOException occurs in making the DELETE

createInstance

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

Description copied from interface: STSInstanceModel

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

Specified by:

createInstance in interface STSInstanceModel

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

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

Description copied from interface: STSInstanceModel

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

Specified by:

updateInstance in interface STSInstanceModel

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

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

Description copied from interface: STSInstanceModel

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

Specified by:

getInstanceState in interface STSInstanceModel

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

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

Description copied from interface: STSInstanceModel

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

Specified by:

validateConfigurationState in interface STSInstanceModel

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.