All Superinterfaces:

AMAdminConstants

All Known Subinterfaces:

AgentDumpModel, AgentExportPolicyModel, AgentsModel, AMServiceProfileModel, AuthConfigurationModel, AuthPropertiesModel, CoreAttributesModel, CreateMetaDataModel, DelegationModel, EntitiesModel, EntityModel, EntityResourceOfferingModel, FSAuthDomainsModel, FSSAMLServiceModel, IdentitySubjectModel, IDFFModel, IDRepoModel, ImportEntityModel, MAPDeviceProfileModel, OAuth2Model, PolicyModel, RealmResourceOfferingModel, RMRealmModel, SAMLv2Model, SCConfigModel, SCModel, SCPlatformModel, SCPolicyModel, SecurityTokenServiceModel, SelectRealmModel, ServerSiteModel, ServicesModel, ServicesProfileModel, SMDiscoveryServiceModel, SMProfileModel, SocialAuthNModel, STSExportPolicyModel, STSHomeViewBeanModel, STSInstanceModel, SubConfigModel, SubSchemaModel, TaskModel, UMChangeUserPasswordModel, UMUserPasswordResetOptionsModel, UMUserResourceOfferingModel, WSFedPropertiesModel

All Known Implementing Classes:

AbstractAuditModel, AgentDumpModelImpl, AgentExportPolicyModelImpl, AgentsModelImpl, AMModelBase, AMServiceProfileModelImpl, AuthConfigurationModelImpl, AuthProfileModelImpl, AuthPropertiesModelImpl, CoreAttributesModelImpl, CreateMetaDataModelImpl, DelegationModelImpl, EntitiesModelImpl, EntityModelImpl, EntityResourceOfferingModelImpl, FSAuthDomainsModelImpl, FSSAMLServiceModelImpl, GlobalAuditConfigModel, IdentitySubjectModelImpl, IDFFModelImpl, IDRepoModelImpl, ImportEntityModelImpl, MAPCreateDeviceModelImpl, MAPDeviceProfileModelImpl, MAPModelBase, MAPServiceModelImpl, OAuth2ModelImpl, PolicyModelImpl, RealmAuditConfigModel, RealmResourceOfferingModelImpl, RestSTSInstanceModel, RMRealmModelImpl, SAMLv2ModelImpl, SCConfigModelImpl, SCConsolePropertiesModelImpl, SCModelBase, SCPlatformModelImpl, SCPolicyModelImpl, SCSAML2SOAPBindingModelImpl, SCSOAPBindingModelImpl, SecurityTokenServiceModelImpl, SelectRealmModelImpl, ServerSiteModelImpl, ServicesModelImpl, ServicesProfileModelImpl, SMDiscoveryServiceModelImpl, SMG11NModelImpl, SMProfileModelImpl, SoapSTSInstanceModel, SocialAuthNModelImpl, STSExportPolicyModelImpl, STSHomeViewBeanModelImpl, STSInstanceModelBase, SubConfigModelImpl, SubSchemaModelImpl, TaskModelImpl, TimePolicyModelImpl, UMChangeUserPasswordModelImpl, UMUserPasswordResetOptionsModelImpl, UMUserResourceOfferingModelImpl, WSAuthNServicesModelImpl, WSFedPropertiesModelImpl, WSPersonalProfileServiceModelImpl
```
public interface AMModel
extends AMAdminConstants
```
This defines a set of methods that are exposed to view beans.

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`CONSOLE_PAGING_SIZE_ATTR`	Name of paging page size limit.
`static String`	`CONSOLE_SEARCH_RESULT_LIMIT_ATTR`	Name of maximum search result.
`static String`	`CONSOLE_SEARCH_TIME_LIMIT_ATTR`	Name of maximum search time.
`static int`	`DEFAULT_PAGE_SIZE`	Default paging size.
`static int`	`DEFAULT_SEARCH_RESULT_LIMIT`	Default search results limit.
`static int`	`DEFAULT_SEARCH_TIME_LIMIT`	Default search time out limit.

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

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`getClientType()`	Returns client type from SSO token
`String`	`getConsoleDirectory()`
`String`	`getErrorString(Throwable ex)`	Returns a localized error message from an exception.
`String`	`getLocalizedServiceName(String service)`	Returns the localized service name.
`String`	`getLocalizedString(String key)`	Returns localized string.
`String`	`getLocationDN()`
`int`	`getPageSize()`	Returns paging page size from template if one exists otherwise page size that is defined globally.
`String`	`getRandomString()`	Returns random string
`Set`	`getRealmNames(String base, String filter)`
`String`	`getServicePropertiesViewBeanURL(String serviceName)`	Returns properties view bean URL of a service.
`Set`	`getSpecialUsers(String realmName)`	Returns a set of special user identities.
`String`	`getStartDN()`	Gets start DN
`String`	`getStartDSDN()`	Returns directory managemenet start DN
`Map`	`getSupportedAgentTypes()`	Returns a map of supported agent type to its localized name.
`Map`	`getSupportedEntityTypes(String realmName)`	Returns a map of suppported entity type to its localized name.
`String`	`getUniversalID()`	Returns universal ID of user.
`String`	`getUserDisplayName(AMIdentity id)`	Returns the formated display name for user identities.
`String`	`getUserDN()`	Returns DN of currently logged in user.
`Locale`	`getUserLocale()`	Returns the preferred locale of currently logged in user.
`String`	`getUserName()`	Returns currently logged in user.
`SSOToken`	`getUserSSOToken()`	Returns user's single sign on token.
`boolean`	`ignoreUserProfile()`	Returns true if the user profile is to be ignored by the console.
`boolean`	`isAmadminUser(AMIdentity amid)`	Returns `true` if identity is amadmin user.
`boolean`	`isAMSDKEnabled()`	Returns `true` if server is running with `AMSDK` repo enabled.
`void`	`logEvent(String id, String[] data)`	Writes log event.
`void`	`setLocationDN(String location)`

- Field Detail
  - CONSOLE_PAGING_SIZE_ATTR
```
static final String CONSOLE_PAGING_SIZE_ATTR
```
    Name of paging page size limit.
    
    See Also:
    
    Constant Field Values
  - CONSOLE_SEARCH_RESULT_LIMIT_ATTR
```
static final String CONSOLE_SEARCH_RESULT_LIMIT_ATTR
```
    Name of maximum search result.
    
    See Also:
    
    Constant Field Values
  - CONSOLE_SEARCH_TIME_LIMIT_ATTR
```
static final String CONSOLE_SEARCH_TIME_LIMIT_ATTR
```
    Name of maximum search time.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_PAGE_SIZE
```
static final int DEFAULT_PAGE_SIZE
```
    Default paging size.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SEARCH_RESULT_LIMIT
```
static final int DEFAULT_SEARCH_RESULT_LIMIT
```
    Default search results limit.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SEARCH_TIME_LIMIT
```
static final int DEFAULT_SEARCH_TIME_LIMIT
```
    Default search time out limit.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getClientType
```
String getClientType()
```
    Returns client type from SSO token
    
    Returns:
    
    client type
  - getRandomString
```
String getRandomString()
```
    Returns random string
    
    Returns:
    
    random string
  - getUserLocale
```
Locale getUserLocale()
```
    Returns the preferred locale of currently logged in user.
    
    Returns:
    
    java.util.Locale of currently logged in user.
  - getUserSSOToken
```
SSOToken getUserSSOToken()
```
    Returns user's single sign on token.
    
    Returns:
    
    user's single sign on token.
  - getUserDN
```
String getUserDN()
```
    Returns DN of currently logged in user.
    
    Returns:
    
    DN of currently logged in user.
  - getUserName
```
String getUserName()
```
    Returns currently logged in user.
    
    Returns:
    
    currently logged in user.
  - getUniversalID
```
String getUniversalID()
```
    Returns universal ID of user.
    
    Returns:
    
    Universal ID of user.
  - getLocalizedString
```
String getLocalizedString(String key)
```
    Returns localized string.
    
    Parameters:
    
    key - Key of resource string.
    
    Returns:
    
    localized string.
  - getPageSize
```
int getPageSize()
```
    Returns paging page size from template if one exists otherwise page size that is defined globally.
    
    Returns:
    
    paging page size
  - getErrorString
```
String getErrorString(Throwable ex)
```
    Returns a localized error message from an exception. If the exception is of type AMException the error code and any possible arguments will be extracted from the exception and the message will be generated from the code and arguments. All other exception types will return the message from Exception.getMessage.
    
    Parameters:
    
    ex - exception
    
    Returns:
    
    String error message localized to users locale
  - getLocalizedServiceName
```
String getLocalizedServiceName(String service)
```
    Returns the localized service name.
    
    Parameters:
    
    service - Name of service.
    
    Returns:
    
    the localized service name.
  - getServicePropertiesViewBeanURL
```
String getServicePropertiesViewBeanURL(String serviceName)
```
    Returns properties view bean URL of a service.
    
    Parameters:
    
    serviceName - Name of service.
    
    Returns:
    
    properties view bean URL of a service. Returns null if this URL is not defined in the schema.
  - getStartDN
```
String getStartDN()
```
    Gets start DN
    
    Returns:
    
    start DN
  - getStartDSDN
```
String getStartDSDN()
```
    Returns directory managemenet start DN
    
    Returns:
    
    start DN
  - getSupportedEntityTypes
```
Map getSupportedEntityTypes(String realmName)
```
    Returns a map of suppported entity type to its localized name.
    
    Parameters:
    
    realmName - Name of Realm.
    
    Returns:
    
    a map of suppported entity type to its localized name.
  - getSupportedAgentTypes
```
Map getSupportedAgentTypes()
```
    Returns a map of supported agent type to its localized name.
    
    Returns:
    
    a map of supported agent type to its localized name.
  - logEvent
```
void logEvent(String id,
              String[] data)
```
    Writes log event.
    
    Parameters:
    
    id - Log Message ID.
    
    data - Log Data.
  - getLocationDN
```
String getLocationDN()
```
  - setLocationDN
```
void setLocationDN(String location)
```
  - getConsoleDirectory
```
String getConsoleDirectory()
```
  - ignoreUserProfile
```
boolean ignoreUserProfile()
```
    Returns true if the user profile is to be ignored by the console. The authentication service sets a property in the users session based on the properties in the core authentication service.
    
    Returns:
    
    true if the user profile should be ignored.
  - getUserDisplayName
```
String getUserDisplayName(AMIdentity id)
```
    Returns the formated display name for user identities. This is needed to handle the situation where the attribute displayed for the user is not the same as the naming attribute. It is also possible that the attribute being displayed has multiple values. In the multiple value situation each of the values will be separated by a semicolon ";".
    
    Parameters:
    
    id - identity of the user being displayed.
    
    Returns:
    
    String value of the attribute to be displayed.
  - getSpecialUsers
```
Set getSpecialUsers(String realmName)
```
    Returns a set of special user identities. This set of identities typically should not be displayed in the console.
    
    Parameters:
    
    realmName - Name of Realm.
    
    Returns:
    
    a list of special user identities that cannot be displayed.
  - getRealmNames
```
Set getRealmNames(String base,
                  String filter)
           throws AMConsoleException
```
    Throws:
    
    AMConsoleException
  - isAMSDKEnabled
```
boolean isAMSDKEnabled()
```
    Returns true if server is running with AMSDK repo enabled.
    
    Returns:
    
    true if server is running with AMSDK repo enabled.
  - isAmadminUser
```
boolean isAmadminUser(AMIdentity amid)
```
    Returns true if identity is amadmin user.
    
    Parameters:
    
    amid - user object.
    
    Returns:
    
    true if identity is amadmin user.

Interface AMModel

Field Summary

Fields inherited from interface com.sun.identity.console.base.model.AMAdminConstants

Method Summary

Field Detail

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 Detail

getClientType

getRandomString

getUserLocale

getUserSSOToken

getUserDN

getUserName

getUniversalID

getLocalizedString

getPageSize

getErrorString

getLocalizedServiceName

getServicePropertiesViewBeanURL

getStartDN

getStartDSDN

getSupportedEntityTypes

getSupportedAgentTypes

logEvent

getLocationDN

setLocationDN

getConsoleDirectory

ignoreUserProfile

getUserDisplayName

getSpecialUsers

getRealmNames

isAMSDKEnabled

isAmadminUser