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

Interface AuthConfigurationModel

All Superinterfaces:

AMAdminConstants, AMModel

All Known Implementing Classes:

AuthConfigurationModelImpl

public interface AuthConfigurationModel
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	createAuthConfiguration(String name)	Creates a new named authentication configuration object.
void	deleteAuthConfiguration(String realm, Set names)	Deletes the named authentication configuration object.
Map	getCriteriaMap()	Returns a Map object containing the AuthenticationEntry criteria flags.
String	getModuleFlag(int moduleIndex)	Gets the module flag for the given module index in the current authentication configuration attributes
String	getModuleName(int moduleIndex)	Gets the module name for the given module index in the current authentication configuration attributes.
String	getModuleOptions(int moduleIndex)	Gets the module options string for the given module index in the current authentication configuration attributes
int	getNumberEntries()	Returns the number of entries in the current configuration.
String	getPostProcessingClass(String realm, String configuration)	Returns the value for the post processing class set for the current configuration object.
Map	getValues()	Returns a map of the attributes that make up an auth config entry.
String	getXMLValue(String realm, String config)	Returns the xml blob that represents the auth entries which make up the specified auth configuration.
void	initialize(String realm, String config)	Initialize configuration entry information for the given realm and named configuration.
void	removeAuthEntries(Integer[] entries)	Remove the entries selected in the UI.
void	reset(String realm, String config)	Used to restore the config data settings to their original values.
void	setEntries(List entries)	Stores locally the list of authentication entries for the auth config object.
void	setPostAuthPropertiesClass(String className)	Sets the value for the post authentication properties class.
void	setValues(Map data)	Sets the specified attributes in the auth config entry.
void	setXMLValue(String value)	Sets the xml blob that represents the auth entries which make up the specified auth configuration.
void	store(String realm, String config)	Save the value for the given realm and 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

createAuthConfiguration

void createAuthConfiguration(String name)
                      throws AMConsoleException

Creates a new named authentication configuration object. This object will be used by the various objects for authentication.

Parameters:

name - used to reference the configuration.

Throws:

AMConsoleException - if the configuration cannot be created.

deleteAuthConfiguration

void deleteAuthConfiguration(String realm,
                             Set names)
                      throws AMConsoleException

Deletes the named authentication configuration object.

Parameters:

realm - name where configuration is locate.

names - names of entries.

Throws:

AMConsoleException

getModuleName

String getModuleName(int moduleIndex)

Gets the module name for the given module index in the current authentication configuration attributes.

Parameters:

moduleIndex - the index of the module to retrieve name from.

Returns:

the module name

getModuleFlag

String getModuleFlag(int moduleIndex)

Gets the module flag for the given module index in the current authentication configuration attributes

Parameters:

moduleIndex - the index of the module to retrieve Flag from.

Returns:

the module flag

getModuleOptions

String getModuleOptions(int moduleIndex)

Gets the module options string for the given module index in the current authentication configuration attributes

Parameters:

moduleIndex - the index of the module to retrieve Flag from.

Returns:

the module options string

getPostProcessingClass

String getPostProcessingClass(String realm,
                              String configuration)

Returns the value for the post processing class set for the current configuration object. If the value is not present the emptry string will be returned.

Parameters:

realm - name where configuration is locate.

configuration - name of entry.

Returns:

value of postprocessing class

getNumberEntries

int getNumberEntries()

Returns the number of entries in the current configuration.

Returns:

number of entries

getXMLValue

String getXMLValue(String realm,
                   String config)

Returns the xml blob that represents the auth entries which make up the specified auth configuration.

Parameters:

realm - name where configuration exists.

config - name of the configuration object.

Returns:

String xml blob.

setXMLValue

void setXMLValue(String value)

Sets the xml blob that represents the auth entries which make up the specified auth configuration.

Parameters:

value - of the xml blob.

removeAuthEntries

void removeAuthEntries(Integer[] entries)

Remove the entries selected in the UI. This is done by creating a new List of the selected entries, then removing that List from the original list of all the entries.

Parameters:

entries - array of index id's

initialize

void initialize(String realm,
                String config)

Initialize configuration entry information for the given realm and named configuration.

Parameters:

realm - name where configuration is locate.

config - name of entry.

setEntries

void setEntries(List entries)

Stores locally the list of authentication entries for the auth config object.

Parameters:

entries - list of AuthConfigurationEntry objects.

setPostAuthPropertiesClass

void setPostAuthPropertiesClass(String className)

Sets the value for the post authentication properties class.

Parameters:

className - name of the class used for post authentication processing

store

void store(String realm,
           String config)
    throws AMConsoleException

Save the value for the given realm and configuration.

Parameters:

realm - name where configuration is locate.

config - name of entry.

Throws:

AMConsoleException

reset

void reset(String realm,
           String config)

Used to restore the config data settings to their original values.

Parameters:

realm - name where configuration is locate.

config - name of entry.

getCriteriaMap

Map getCriteriaMap()

Returns a Map object containing the AuthenticationEntry criteria flags. The key is the value and the display string is the value.

Returns:

map of criteria values.

getValues

Map getValues()
       throws AMConsoleException

Returns a map of the attributes that make up an auth config entry. The map will contain the success and failure url lists, the post processing class, and the list of auth modules that make up the auth configuration entry.

Returns:

Map of attribute values.

Throws:

AMConsoleException - if there is an error retrieving the data from the entry.

setValues

void setValues(Map data)

Sets the specified attributes in the auth config entry. The data will not be committed to the data store until store() is called.

Parameters:

data - that will be set in the config entry.