com.sssw.srv.api
Interface AgiServer

All Superinterfaces:

AgiAdmChanges, AgiAdmContainer, AgiAdmContainerBase, AgiAdmElement, AgiAdmElementBase, AgiAdmPropertyBag, AgiAdmServer, AgiDatabaseMgr, AgiPrincipalFactory

public interface AgiServer

extends AgiAdmServer, AgiPrincipalFactory, AgiDatabaseMgr

Server-side interface that represents the server. It provides access to other server-side objects such as AgiDatabases, AgiTables, and AgiMailAccounts. This interface extends AgiAdmServer and adds some public methods.

When business object server events are fired, the source of those events (available via evt.getSource()) will be an object implementing this interface. From a page, the following code will return an object implementing AgiServer:

       AgiServer s = ((AgoHttpRequestEvent)getCurrentRequest()).getServer();
 

See Also:

AgiAdmServer, AgiPrincipalFactory

Fields inherited from interface com.sssw.rts.adminapi.AgiAdmServer

GET_CERTS_CA, GET_CERTS_SRV_DSA, GET_CERTS_SRV_RSA, GET_DSA_SUITES, GET_RSA_SUITES, INFO_DATABASE_NAME, INFO_GROUP_NAME, INFO_PORT_NUMBER, PROP_AGENT_DEBUG, PROP_ALLOW_USER_SELF_MOD, PROP_CACHE_DISK_DIR, PROP_CACHE_DISK_MAX_CONTENT_SIZE, PROP_CACHE_DISK_MAX_SIZE, PROP_CACHE_ENABLE, PROP_CACHE_MAX_CONTENT_SIZE, PROP_CACHE_MEM_MAX_SIZE, PROP_CLIENT_CERT_LEVEL, PROP_CLIENT_DEBUG, PROP_CMGR_RECONNECT_SLEEP_INTERVAL, PROP_CMGR_RECONNECT_TRY_COUNT, PROP_CMGR_START_SLEEP_INTERVAL, PROP_CMGR_START_TRY_COUNT, PROP_DEFAULT_SECURITY_AUTHORITY, PROP_DEFAULT_SECURITY_REALM, PROP_DISABLE_DIR_LISTING, PROP_DSA_SUITES, PROP_ENABLEAUTHENTICATION, PROP_ERROR_LOGNAME, PROP_ERRORLOGGING, PROP_FREECLIENTCONNSBUSY, PROP_FREECLIENTCONNSLIGHT, PROP_FTS_INDEXER_TIME, PROP_FTS_MAX_SEARCH_ROWS, PROP_FTS_NO_FULL_INDEX, PROP_FTS_NO_INDEX_ON_SEARCH, PROP_HTTP_LISTEN, PROP_HTTPS_DSA_PORT, PROP_HTTPS_LISTEN_DSA_PORT, PROP_HTTPS_LISTEN_RSA_PORT, PROP_HTTPS_RSA_PORT, PROP_IDLECLIENTCONNSBUSY, PROP_IDLECLIENTCONNSLIGHT, PROP_IGNORE_CERTIFICATE_SECURITY, PROP_IGNORE_LDAP_SECURITY, PROP_IGNORE_NIS_SECURITY, PROP_IGNORE_NT_SECURITY, PROP_IGNORE_SILVER_SECURITY, PROP_LB_CONNECT_SLEEP_COUNT, PROP_LB_CONNECT_SLEEP_INTERVAL, PROP_LB_CONNECT_TRY_COUNT, PROP_LB_CONNECT_TRY_INTERVAL, PROP_LDAP_CONNECTION_PASSWORD, PROP_LDAP_CONNECTION_USER, PROP_LDAP_GROUP_ADDITIONAL_ATTRS, PROP_LDAP_GROUP_DESCR_ATTR, PROP_LDAP_GROUP_OBJECT_CLASS, PROP_LDAP_GROUP_USERS_ATTR, PROP_LDAP_GROUPS_LOCATION, PROP_LDAP_SERVERS, PROP_LDAP_USER_ADDITIONAL_ATTRS, PROP_LDAP_USER_DESCR_ATTR, PROP_LDAP_USER_FULL_NAME_ATTR, PROP_LDAP_USER_LOGIN_ATTRIBUTE, PROP_LDAP_USER_OBJECT_CLASS, PROP_LDAP_USERS_LOCATION, PROP_LOADER_DEBUG, PROP_MAILCHECKFREQUENCY, PROP_MAXCLIENTCONNS, PROP_MAXDBCONNS, PROP_MINDBCONNS, PROP_NISPLUS_SERVERS, PROP_ORB_KEY, PROP_PREFETCHBUFFERS, PROP_PROCESS_USERNAME, PROP_REPLY_BUFF_SIZE, PROP_REQUEST_TIMEOUT, PROP_RMI_LISTEN, PROP_RSA_SUITES, PROP_SECURITY_RESOURCE_TIMEOUT, PROP_SESSION_TIMEOUT, PROP_SET_LOCKSMITH_ENABLED, PROP_SILVERMASTER, PROP_SQL_DEBUG, PROP_SRV_LOGGER, PROP_SRV_NAMESERVICE_PORT, PROP_SRV_PORT, PROP_STANDARD_LOGNAME, PROP_STANDARDLOGGING, PROP_TRACE_LOGNAME, PROP_TRACELOGGING, PROP_VALUE_ALL, PROP_VALUE_NONE, SERVER

Fields inherited from interface com.sssw.rts.adminapi.AgiAdmContainer

GET_CHILDREN_EX, GET_CHILDREN_NTDOMAINS_PRIMARY_ONLY, GET_CHILDREN_NTDOMAINS_TRUSTED_ONLY, GET_CHILDREN_SORTED, GET_CHILDREN_WITH_INFO

Fields inherited from interface com.sssw.rts.adminapi.AgiAdmElement

ACL_KEY, APPLY_TO_DESC, APPLY_TO_DESC_SUPPORTED, DIRECTORY_LIST_SECURITY, GET_PERMS_AS_ACL, GET_PERMS_DEFAULT, PROP_CERTIFICATE, PROP_DESCRIPTION, PROP_DOMAIN, PROP_FULL_NAME, PROP_IS_LOCKSMITH, PROP_LDAP_SERVER, PROP_NAME, PROP_NISPLUS_SERVER, PROP_PARENT_URL, PROP_PASSWORD, PROP_QUAL_NAME, PROP_TYPE, PROP_URL, REQUIRE_LOGIN, REQUIRE_LOGIN_SUPPORTED

Fields inherited from interface com.sssw.rts.adminapi.AgiAdmContainerBase

GET_CHILDREN_DFLT

Method Summary

AgiCluster	getCluster() Return an AgiCluster object representing the cluster this server is in, or return null if the server is not in a clustered environment.
AgiMailAccount	getMailAccount(String acctName) Returns a reference to AgiMailAccount object.
File	getServerInstallDirectory() Get the application root, the location at which the server is installed.
AgiSession	getServerSession() Gets the session associated with this server object.
AgiAdmStatElement	getStatElement(String path) Get an AgiAdmStatElement object that is managed by the server
AgiAdmStatContainer	getStatServer() Get the AgiAdmStatContainer object (that handles server statisics and is the container to the rest of the statistics object for this server)
AgiAdmStatSet	getStatSet() Instantiate a statistics set object.

Methods implemented from interface com.sssw.rts.adminapi.AgiAdmServer

addCertificate, createAcl, createAclEntry, deactivate, deleteCertificate, deleteIdleDatabaseConnections, deleteLicense, getBuildDescription, getCacheManagerGroups, getCertificateObject, getCertificates, getCertificates, getCipherSuites, getClusters, getDatabaseDriverList, getDatabasePlatformList, getDispatcherGroups, getElement, getJdbcDriverList, getLdsKeyList, getLicenses, getLoadManagerGroups, getMailAccountObject, getMailAccounts, getOrbDisplayNameList, getOrbKeyList, getSessions, getStatistics, getThreads, isAlive, isCompatible, loginUser, logoutUser, resetMinMaxDatabaseConnections, setCipherSuites, setMailAccounts, shutdown, shutdown

Methods implemented from interface com.sssw.srv.api.AgiDatabaseMgr

getDatabase

Methods implemented from interface com.sssw.rts.adminapi.AgiAdmElement

getPermissions, getServerURL, getURL, getVariables, isAuthorized, setPermissions

Methods implemented from interface com.sssw.rts.adminapi.AgiAdmContainerBase

addChild, getChild, getChildren

Methods implemented from interface com.sssw.rts.adminapi.AgiAdmElementBase

delete, getName, getType

Methods implemented from interface com.sssw.rts.adminapi.AgiAdmPropertyBag

getProperties, getProperty, setProperties, setProperty

Methods implemented from interface com.sssw.rts.adminapi.AgiAdmChanges

cancelChanges, saveChanges

Method Detail

getServerSession

public AgiSession getServerSession()

Gets the session associated with this server object.

Usage:

Each client has a session associated it with and normally method will return that session. In addition, each server has a default server session that lasts the life of the server and this method when there isn't a client session available (e.g., in a server start business object, there is no client session associated with it) will return that session.

Example:

Rather than use this method, it is more likely one of the following would be used:

     // from a business object
     AgiSession sess = evt.getSession();
 
     // from a page
     AgiSession sess = ((AgoHttpRequestEvent)getCurrentRequest()).getSession();
 
     // with an AgiServer
     AgiSession sess = server.getServerSession();
 

getMailAccount

public AgiMailAccount getMailAccount(String acctName)

Returns a reference to AgiMailAccount object.

Usage:

An AgiMailAccount object is available only for mail accounts that the server is configured to get mail for.

Example:

The following code gets an AgiMailAccount object for a mail account called "mailinglist".

     AgiMailAccount acct = getMailAccount("mailinglist");
 

See Also:

AgiAdmServer.getMailAccountObject()

getCluster

public AgiCluster getCluster()

Return an AgiCluster object representing the cluster this server is in, or return null if the server is not in a clustered environment.

getServerInstallDirectory

public File getServerInstallDirectory()

Get the application root, the location at which the server is installed.

Returns:

a File object representing the installation directory

getStatServer

public AgiAdmStatContainer getStatServer()
                                  throws AgoUnrecoverableSystemException,
                                         AgoSecurityException

Get the AgiAdmStatContainer object (that handles server statisics and is the container to the rest of the statistics object for this server)

getStatElement

public AgiAdmStatElement getStatElement(String path)
                                 throws AgoUnrecoverableSystemException,
                                        AgoSecurityException

Get an AgiAdmStatElement object that is managed by the server

Parameters:

path -

getStatSet

public AgiAdmStatSet getStatSet()

Instantiate a statistics set object.