Package com.sun.identity.console.service.model

Interface ServerSiteModel

All Superinterfaces:

AMAdminConstants, AMModel

All Known Implementing Classes:

ServerSiteModelImpl

public interface ServerSiteModel
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	cloneServer(String origServer, String cloneServer)	Clones a server.
void	createServer(String name)	Creates a server.
void	createSite(String name, String url)	Creates a site.
void	deleteServers(Set servers)	Deletes a set of servers.
void	deleteSites(Set sites)	Deletes a set of sites.
String	getEditServerPageTitle(String serverName)	Returns edit server title page.
String	getEditSitePageTitle(String siteName)	Returns edit site title page.
ServerConfigXML	getServerConfigObject(String serverName)	Returns the server configuration XML object.
Map	getServerConfiguration(String serverName)	Returns server configuration.
Map	getServerDefaults()	Returns default server configuration.
Set	getServerNames()	Returns a set of server names.
String	getServerSite(String name)	Returns a site name of which server belongs to.
Set	getSiteFailoverURLs(String name)	Returns a set of failover URLs of site.
Set	getSiteNames()	Returns a set of site names.
String	getSitePrimaryURL(String name)	Returns primary URL of site.
Set	getSiteServers(String name)	Returns a set of servers that belong to site.
void	modifyServer(String serverName, String parentSite, Map values)	Modifies server profile.
void	modifySite(String siteName, String primaryURL, Set failoverURLs)	Modifies site profile.
void	setServerConfigXML(String serverName, String xml)	Sets the server configuration XML.
void	updateServerConfigInheritance(String serverName, Set toInherit, Set notToInherit)	Updates server property inheritance settings.

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

getSiteNames

Set getSiteNames()
          throws AMConsoleException

Returns a set of site names.

Returns:

a set of site names.

Throws:

AMConsoleException - if error occurs when getting the site names.

getSitePrimaryURL

String getSitePrimaryURL(String name)
                  throws AMConsoleException

Returns primary URL of site.

Parameters:

name - Name of Site.

Returns:

a primary URL of site.

Throws:

AMConsoleException - if error occurs when getting the site primary URL.

getSiteFailoverURLs

Set getSiteFailoverURLs(String name)
                 throws AMConsoleException

Returns a set of failover URLs of site.

Parameters:

name - Name of Site.

Returns:

a set of failover URLs of site.

Throws:

AMConsoleException - if error occurs when getting the site primary URL.

getSiteServers

Set getSiteServers(String name)
            throws AMConsoleException

Returns a set of servers that belong to site.

Parameters:

name - Name of Site.

Returns:

a set of servers that belong to site.

Throws:

AMConsoleException - if error occurs when getting the servers set.

createSite

void createSite(String name,
                String url)
         throws AMConsoleException

Creates a site.

Parameters:

name - Name of Site.

url - Primary URL of Site.

Throws:

AMConsoleException - if error occurs when creating site.

createServer

void createServer(String name)
           throws AMConsoleException

Creates a server.

Parameters:

name - Name of Server.

Throws:

AMConsoleException - if error occurs when creating server.

deleteSites

void deleteSites(Set sites)
          throws AMConsoleException

Deletes a set of sites.

Parameters:

sites - Set of of sites to be deleted.

Throws:

AMConsoleException - if error occurs when getting the site name.

getServerNames

Set getServerNames()
            throws AMConsoleException

Returns a set of server names.

Returns:

a set of server names.

Throws:

AMConsoleException - if error occurs when getting the server names.

getServerSite

String getServerSite(String name)
              throws AMConsoleException

Returns a site name of which server belongs to.

Parameters:

name - Name of Server.

Returns:

a site name.

Throws:

AMConsoleException - if error occurs when getting the site name.

deleteServers

void deleteServers(Set servers)
            throws AMConsoleException

Deletes a set of servers.

Parameters:

servers - Set of of servers to be deleted.

Throws:

AMConsoleException - if error occurs when getting the site name.

getEditSitePageTitle

String getEditSitePageTitle(String siteName)

Returns edit site title page.

Parameters:

siteName - Name of site.

Returns:

edit site title page.

modifySite

void modifySite(String siteName,
                String primaryURL,
                Set failoverURLs)
         throws AMConsoleException

Modifies site profile.

Parameters:

siteName - name of site.

primaryURL - Primary URL.

failoverURLs - Failover URLs.

Throws:

AMConsoleException - if site profile cannot be modified.

cloneServer

void cloneServer(String origServer,
                 String cloneServer)
          throws AMConsoleException

Clones a server.

Parameters:

origServer - Name of the server to be cloned.

cloneServer - Name of clone server.

Throws:

AMConsoleException - if server cannot be cloned.

getEditServerPageTitle

String getEditServerPageTitle(String serverName)

Returns edit server title page.

Parameters:

serverName - Name of server.

Returns:

edit server title page.

getServerConfiguration

Map getServerConfiguration(String serverName)
                    throws AMConsoleException

Returns server configuration.

Parameters:

serverName - name of server.

Returns:

server configuration.

Throws:

AMConsoleException - if server profile cannot be retrieved.

getServerDefaults

Map getServerDefaults()

Returns default server configuration.

Returns:

server configuration.

modifyServer

void modifyServer(String serverName,
                  String parentSite,
                  Map values)
           throws AMConsoleException,
                  UnknownPropertyNameException

Modifies server profile.

Parameters:

serverName - name of server.

parentSite - Parent site.

values - Property Values.

Throws:

AMConsoleException - if server profile cannot be modified.

UnknownPropertyNameException - if property names are unknown.

updateServerConfigInheritance

void updateServerConfigInheritance(String serverName,
                                   Set toInherit,
                                   Set notToInherit)
                            throws AMConsoleException

Updates server property inheritance settings.

Parameters:

serverName - Name of server.

toInherit - Properties to inherit.

notToInherit - Properties not to inherit.

Throws:

AMConsoleException - if server profile cannot be updated.

getServerConfigObject

ServerConfigXML getServerConfigObject(String serverName)
                               throws AMConsoleException

Returns the server configuration XML object.

Parameters:

serverName - Name of server.

Returns:

the server configuration XML object.

Throws:

AMConsoleException - if server configuration XML object cannot be return.

setServerConfigXML

void setServerConfigXML(String serverName,
                        String xml)
                 throws AMConsoleException

Sets the server configuration XML.

Parameters:

serverName - Name of server.

xml - the server configuration XML.

Throws:

AMConsoleException - if server configuration XML cannot be set.