Package com.sun.identity.console.task.model

Class SocialAuthNModelImpl

java.lang.Object

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

com.sun.identity.console.task.model.SocialAuthNModelImpl

All Implemented Interfaces:

AMAdminConstants, AMModel, SocialAuthNModel

public class SocialAuthNModelImpl
extends AMModelBase
implements SocialAuthNModel

Default implementation of the social authentication model.

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

Method Summary

Modifier and Type	Method	Description
String	getDefaultRedirectUrl()	The default URL to use for the OAuth2 redirect proxy.
String	getLocalizedProviderHelpMessage()	A localized message describing how to register with this particular social authentication provider.
String	getProviderDisplayName()	Get the name of this social authn provider suitable for display to a user.
SortedSet<String>	getRealms()	Get a set of all configured realms, sorted lexicographically.
boolean	isKnownProvider()	Indicates whether the provider has known settings or not.

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

SocialAuthNModelImpl

public SocialAuthNModelImpl(jakarta.servlet.http.HttpServletRequest req,
                            Map map)

Method Detail

getRealms

public SortedSet<String> getRealms()
                            throws AMConsoleException

Description copied from interface: SocialAuthNModel

Get a set of all configured realms, sorted lexicographically.

Specified by:

getRealms in interface SocialAuthNModel

Returns:

the set of all realms.

Throws:

AMConsoleException

getDefaultRedirectUrl

public String getDefaultRedirectUrl()

Description copied from interface: SocialAuthNModel

The default URL to use for the OAuth2 redirect proxy. This makes a best-effort guess based on the server configuration, but the user may have to override it to account for load balancers etc.

Specified by:

getDefaultRedirectUrl in interface SocialAuthNModel

Returns:

The default redirect URL.

isKnownProvider

public boolean isKnownProvider()

Description copied from interface: SocialAuthNModel

Indicates whether the provider has known settings or not. This controls whether we display additional fields.

Specified by:

isKnownProvider in interface SocialAuthNModel

Returns:

true if this is a known social authn provider or false if manual config is required.

getProviderDisplayName

public String getProviderDisplayName()

Description copied from interface: SocialAuthNModel

Get the name of this social authn provider suitable for display to a user.

Specified by:

getProviderDisplayName in interface SocialAuthNModel

Returns:

the (possibly localized) name of the authn provider.

getLocalizedProviderHelpMessage

public String getLocalizedProviderHelpMessage()

Description copied from interface: SocialAuthNModel

A localized message describing how to register with this particular social authentication provider. This is localized per provider to allow more detailed help messages to be given. If the provider is not known then this method returns null and some default message should be used.

Specified by:

getLocalizedProviderHelpMessage in interface SocialAuthNModel

Returns:

a localized help message for the provider, or null if provider unknown.