Package com.sun.identity.console.authentication.model

Interface AuthPropertiesModel

All Superinterfaces:

AMAdminConstants, AMModel

All Known Implementing Classes:

AuthPropertiesModelImpl

public interface AuthPropertiesModel
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	createAuthInstance(String name, String type)
Set	getAuthInstances()
Map	getAuthTypes()
Map	getInstanceValues(String name)
String	getServiceName(String type)
Map	getValues()	Returns all the values for the core authentication service.
boolean	hasAuthAttributes(String type)	Returns true if there are attributes for a authentication type.
void	removeAuthInstance(Set names)
void	setCurrentRealm(String realm)
void	setInstanceValues(String name, Map value)
void	setValues(Map modifiedValues)	Sets the specified attribute values in the service configuration.

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

getValues

Map getValues()
       throws AMConsoleException

Returns all the values for the core authentication service.

Returns:

Map of attribute values. Returns the EMPTY_SET if the values could not be retrieved.

Throws:

AMConsoleException

getAuthTypes

Map getAuthTypes()

Returns:

map of auth-type/localized-auth-type pairs

removeAuthInstance

void removeAuthInstance(Set names)
                 throws AMConsoleException

Throws:

AMConsoleException

createAuthInstance

void createAuthInstance(String name,
                        String type)
                 throws AMConsoleException

Throws:

AMConsoleException

setValues

void setValues(Map modifiedValues)
        throws AMConsoleException

Sets the specified attribute values in the service configuration. The service name is defined in the subclass. Each attribute passed will be set even if the value has not changed. It is the responsibility of the invoking view bean to pass only those values that are to be set. Each attribute will also cause one log record to be written for each successful set operation.

Parameters:

modifiedValues - that will be set in the service configuration data.

Throws:

AMConsoleException - on any error condition.

getAuthInstances

Set getAuthInstances()

getServiceName

String getServiceName(String type)

getInstanceValues

Map getInstanceValues(String name)

setInstanceValues

void setInstanceValues(String name,
                       Map value)
                throws AMConsoleException

Throws:

AMConsoleException

setCurrentRealm

void setCurrentRealm(String realm)

hasAuthAttributes

boolean hasAuthAttributes(String type)

Returns true if there are attributes for a authentication type.

Parameters:

type - Authtentication type.

Returns:

true if there are attributes for a authentication type.