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

Interface EntityModel

All Superinterfaces:

AMAdminConstants, AMModel

All Known Subinterfaces:

IDFFModel, SAMLv2Model, WSFedPropertiesModel

All Known Implementing Classes:

EntityModelImpl, IDFFModelImpl, SAMLv2ModelImpl, WSFedPropertiesModelImpl

public interface EntityModel
extends AMModel

Field Summary

Fields

Modifier and Type	Field	Description
static String	AFFILIATE
static String	GENERAL
static String	HOSTED
static String	IDENTITY_PROVIDER
static String	IDFF
static String	IDFF_AFFILAITAE
static String	LOCATION
static String	POLICY_DECISION_POINT_DESCRIPTOR
static String	POLICY_ENFORCEMENT_POINT_DESCRIPTOR
static String	PROTOCOL
static String	REALM
static String	REMOTE
static String	ROLE
static String	SAML_ATTRAUTHORITY
static String	SAML_ATTRQUERY
static String	SAML_AUTHNAUTHORITY
static String	SAMLV2
static String	SAMLv2_AFFILAITAE
static String	SERVICE_PROVIDER
static String	WSFED

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	createEntity(Map data)	Creates an entity.
void	deleteEntities(String name, String protocol, String realm)	Deletes the entity specified.
Map	getEntities()	Returns a map with all entities including data about what realm, the roles, and location of each entity.
Map	getIDFFEntities()	Returns a map of all the idff entities including data about what realm, the roles, and location of each entity.
List	getIDFFRoles(String entity, String realm)	Returns List of IDFF roles.
Map	getSAMLv2Entities()	Returns a map of all the samlv2 entities including data about what realm, the roles, and location of each entity.
List	getSAMLv2Roles(String entity, String realm)	Returns List of SAMLv2 roles.
List	getTabMenu(String protocol, String name, String realm)
Map	getWSFedEntities()	Returns a map of all the wsfed entities including data about what realm, the roles, and location of each entity.
boolean	isAffiliate(String protocol, String realm, String name)	Returns true if entity descriptor is an affiliate.

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

Field Detail

LOCATION

static final String LOCATION

See Also:

Constant Field Values

ROLE

static final String ROLE

See Also:

Constant Field Values

PROTOCOL

static final String PROTOCOL

See Also:

Constant Field Values

REALM

static final String REALM

See Also:

Constant Field Values

WSFED

static final String WSFED

See Also:

Constant Field Values

SAMLV2

static final String SAMLV2

See Also:

Constant Field Values

IDFF

static final String IDFF

See Also:

Constant Field Values

HOSTED

static final String HOSTED

See Also:

Constant Field Values

REMOTE

static final String REMOTE

See Also:

Constant Field Values

IDENTITY_PROVIDER

static final String IDENTITY_PROVIDER

See Also:

Constant Field Values

SERVICE_PROVIDER

static final String SERVICE_PROVIDER

See Also:

Constant Field Values

POLICY_DECISION_POINT_DESCRIPTOR

static final String POLICY_DECISION_POINT_DESCRIPTOR

See Also:

Constant Field Values

POLICY_ENFORCEMENT_POINT_DESCRIPTOR

static final String POLICY_ENFORCEMENT_POINT_DESCRIPTOR

See Also:

Constant Field Values

GENERAL

static final String GENERAL

See Also:

Constant Field Values

AFFILIATE

static final String AFFILIATE

See Also:

Constant Field Values

SAML_ATTRAUTHORITY

static final String SAML_ATTRAUTHORITY

See Also:

Constant Field Values

SAML_ATTRQUERY

static final String SAML_ATTRQUERY

See Also:

Constant Field Values

SAML_AUTHNAUTHORITY

static final String SAML_AUTHNAUTHORITY

See Also:

Constant Field Values

IDFF_AFFILAITAE

static final String IDFF_AFFILAITAE

See Also:

Constant Field Values

SAMLv2_AFFILAITAE

static final String SAMLv2_AFFILAITAE

See Also:

Constant Field Values

Method Detail

getEntities

Map getEntities()
         throws AMConsoleException

Returns a map with all entities including data about what realm, the roles, and location of each entity.

Throws:

AMConsoleException - if unable to retrieve the entities.

getSAMLv2Entities

Map getSAMLv2Entities()
               throws AMConsoleException

Returns a map of all the samlv2 entities including data about what realm, the roles, and location of each entity.

Throws:

AMConsoleException - if unable to retrieve the Samlv2 entities.

getIDFFEntities

Map getIDFFEntities()
             throws AMConsoleException

Returns a map of all the idff entities including data about what realm, the roles, and location of each entity.

Throws:

AMConsoleException - if unable to retrieve the IDFF entities.

getWSFedEntities

Map getWSFedEntities()
              throws AMConsoleException

Returns a map of all the wsfed entities including data about what realm, the roles, and location of each entity.

Throws:

AMConsoleException - if unable to retrieve the WSFED entities.

deleteEntities

void deleteEntities(String name,
                    String protocol,
                    String realm)
             throws AMConsoleException

Deletes the entity specified.

Parameters:

name - Name of entity descriptor.

protocol - Protocol to which entity belongs.

realm - the realm in which the entity resides.

Throws:

AMConsoleException - if unable to delete entitiy.

createEntity

void createEntity(Map data)
           throws AMConsoleException

Creates an entity.

Parameters:

data - which contains the attributes of the entity to be created.

Throws:

AMConsoleException - if unable to create entity.

getTabMenu

List getTabMenu(String protocol,
                String name,
                String realm)

isAffiliate

boolean isAffiliate(String protocol,
                    String realm,
                    String name)
             throws AMConsoleException

Returns true if entity descriptor is an affiliate.

Parameters:

protocol - the Protocol to which entity belongs.

realm - the realm in which the entity resides.

name - Name of entity descriptor.

Returns:

true if entity descriptor is an affiliate.

Throws:

AMConsoleException

getSAMLv2Roles

List getSAMLv2Roles(String entity,
                    String realm)

Returns List of SAMLv2 roles.

Parameters:

entity - Name of entity descriptor.

realm - the realm in which the entity resides.

Returns:

list of SAMLv2 roles.

getIDFFRoles

List getIDFFRoles(String entity,
                  String realm)

Returns List of IDFF roles.

Parameters:

entity - Name of entity descriptor.

realm - the realm in which the entity resides.

Returns:

list of IDFF roles.