Package com.sun.identity.console.federation.model

Interface FSAuthDomainsModel

All Superinterfaces:

AMAdminConstants, AMModel

All Known Implementing Classes:

FSAuthDomainsModelImpl

public interface FSAuthDomainsModel
extends AMModel

Field Summary

Fields

Modifier and Type	Field	Description
static String	SINGLE_CHOICE_REALM	Attribute Name for Authenticaton Domain realm.
static String	SINGLE_CHOICE_STATUS	Attribute Name for Authenticaton Domain Status.
static String	TF_DESCRIPTION	Attribute Name for Authenticaton Domain Description.
static String	TF_IDFF_READER_SERVICE_URL	Attribute Name for Reader Service URL.
static String	TF_IDFF_WRITER_SERVICE_URL	Attribute Name for Writer Service URL.
static String	TF_NAME	Attribute Name for Authenticaton Domain Description.
static String	TF_SAML2_READER_SERVICE_URL	Attribute Name for Reader Service URL.
static String	TF_SAML2_WRITER_SERVICE_URL	Attribute Name for Writer Service URL.

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	addProviders(String realm, String cotName, Collection names)	Adds providers.
void	createAuthenticationDomain(Map attrValues, Set providers)	Creates authentication domain.
void	deleteAuthenticationDomain(String realm, String cotName)	Deletes authentication domains.
Set	getAllProviderNames(String realm)	Returns a set of provider names.
Map	getAttributeValues(String realm, String name)	Returns attribute values.
Set	getAuthenticationDomains()	Returns authentication domains
Set	getCircleOfTrustDescriptors()	Returns a Set of COT descriptors
Map	getDataMap()	Returns a map of authentication domain attributes.
String	getRealm(String name)	Returns the realm associated with the given circle of trust.
Set	getRealmNames(String base, String filter)	Returns realms that have names matching with a filter.
Set	getTrustedProviderNames(String realm, String name)	Returns a set of provider names under a authentication domain.
void	setAttributeValues(String realm, String name, Map values)	Set attribute values.

Methods inherited from interface com.sun.identity.console.base.model.AMModel

getClientType, getConsoleDirectory, getErrorString, getLocalizedServiceName, getLocalizedString, getLocationDN, getPageSize, getRandomString, getServicePropertiesViewBeanURL, getSpecialUsers, getStartDN, getStartDSDN, getSupportedAgentTypes, getSupportedEntityTypes, getUniversalID, getUserDisplayName, getUserDN, getUserLocale, getUserName, getUserSSOToken, ignoreUserProfile, isAmadminUser, isAMSDKEnabled, logEvent, setLocationDN

Field Detail

TF_NAME

static final String TF_NAME

Attribute Name for Authenticaton Domain Description.

See Also:

Constant Field Values

TF_DESCRIPTION

static final String TF_DESCRIPTION

Attribute Name for Authenticaton Domain Description.

See Also:

Constant Field Values

TF_IDFF_WRITER_SERVICE_URL

static final String TF_IDFF_WRITER_SERVICE_URL

Attribute Name for Writer Service URL.

See Also:

Constant Field Values

TF_IDFF_READER_SERVICE_URL

static final String TF_IDFF_READER_SERVICE_URL

Attribute Name for Reader Service URL.

See Also:

Constant Field Values

TF_SAML2_WRITER_SERVICE_URL

static final String TF_SAML2_WRITER_SERVICE_URL

Attribute Name for Writer Service URL.

See Also:

Constant Field Values

TF_SAML2_READER_SERVICE_URL

static final String TF_SAML2_READER_SERVICE_URL

Attribute Name for Reader Service URL.

See Also:

Constant Field Values

SINGLE_CHOICE_STATUS

static final String SINGLE_CHOICE_STATUS

Attribute Name for Authenticaton Domain Status.

See Also:

Constant Field Values

SINGLE_CHOICE_REALM

static final String SINGLE_CHOICE_REALM

Attribute Name for Authenticaton Domain realm.

See Also:

Constant Field Values

Method Detail

getAuthenticationDomains

Set getAuthenticationDomains()

Returns authentication domains

Returns:

authentication domains

getCircleOfTrustDescriptors

Set getCircleOfTrustDescriptors()

Returns a Set of COT descriptors

Returns:

Set of COT descriptors

createAuthenticationDomain

void createAuthenticationDomain(Map attrValues,
                                Set providers)
                         throws AMConsoleException

Creates authentication domain.

Parameters:

attrValues - Map of attribute name to set of attribute values.

Throws:

AMConsoleException - if authentication domain cannot be created.

deleteAuthenticationDomain

void deleteAuthenticationDomain(String realm,
                                String cotName)
                         throws AMConsoleException

Deletes authentication domains.

Parameters:

realm - the realm containing the authentication domain

cotName - Name of circle of trust

Throws:

AMConsoleException - if authentication domains cannot be deleted.

getAttributeValues

Map getAttributeValues(String realm,
                       String name)
                throws AMConsoleException

Returns attribute values.

Parameters:

realm - the realm containing the authentication domain

name - Name of authentication domain.

Returns:

attribute values.

Throws:

AMConsoleException - if attribute values cannot be obtained.

setAttributeValues

void setAttributeValues(String realm,
                        String name,
                        Map values)
                 throws AMConsoleException

Set attribute values.

Parameters:

realm - Realm of authentication domain.

name - Name of authentication domain.

values - Map of attribute name to value.

Throws:

AMConsoleException - if attribute values cannot be set.

getDataMap

Map getDataMap()

Returns a map of authentication domain attributes.

Returns:

Map of authentication domain attributes.

getAllProviderNames

Set getAllProviderNames(String realm)
                 throws AMConsoleException

Returns a set of provider names.

Parameters:

realm - the realm to search for provider names

Returns:

a set of provider names.

Throws:

AMConsoleException - if provider names cannot be obtained.

getTrustedProviderNames

Set getTrustedProviderNames(String realm,
                            String name)
                     throws AMConsoleException

Returns a set of provider names under a authentication domain.

Parameters:

realm - the realm containing the authentication domain

name - Name of authentication domain.

Returns:

a set of provider names under a authentication domain.

Throws:

AMConsoleException - if provider names cannot be obtained.

addProviders

void addProviders(String realm,
                  String cotName,
                  Collection names)
           throws AMConsoleException

Adds providers.

Parameters:

realm - realm of circle of trust

cotName - Name of circle of trust

names - Names provider to be added.

Throws:

AMConsoleException - if provider cannot be added.

getRealmNames

Set getRealmNames(String base,
                  String filter)
           throws AMConsoleException

Returns realms that have names matching with a filter.

Specified by:

getRealmNames in interface AMModel

Parameters:

base - Base realm name for this search. null indicates root suffix.

filter - Filter string.

Returns:

realms that have names matching with a filter.

Throws:

AMConsoleException - if search fails.

getRealm

String getRealm(String name)
         throws AMConsoleException

Returns the realm associated with the given circle of trust.

Parameters:

name - circle of trust name.

Returns:

realm where the circle of trust exists.

Throws:

AMConsoleException - if search fails.