com.sssw.rts.adminapi
Interface AgiAdmServer

All Superinterfaces:

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

All Known Subinterfaces:

AgiAdmClusterServer, AgiServer

public interface AgiAdmServer

extends AgiAdmContainer, AgiPrincipalFactory

Implemented by objects that represent SilverStream Servers.

This interface provides the element type SERVER, which is returned from the getType method when called from an AgiAdmServer reference. (To get an AgiAdmServer, use the AgAdmin.getServer() method.)

This interface contains many server properties (listed below by category) that can be set and retrieved using the setProperty and getProperty methods. (Following the table is an alphabetical list of all the fields defined in AgiAdmServer.)

Category	Fields
Database connection properties	AgiAdmServer.INFO_DATABASE_NAME AgiAdmServer.PROP_MAXDBCONNS AgiAdmServer.PROP_MAXCLIENTCONNS AgiAdmServer.PROP_FREECLIENTCONNSBUSY AgiAdmServer.PROP_FREECLIENTCONNSLIGHT AgiAdmServer.PROP_IDLECLIENTCONNSBUSY AgiAdmServer.PROP_IDLECLIENTCONNSLIGHT
Load balancing properties	AgiAdmServer.PROP_LB_CONNECT_TRY_INTERVAL AgiAdmServer.PROP_LB_CONNECT_TRY_COUNT AgiAdmServer.PROP_LB_CONNECT_SLEEP_INTERVAL AgiAdmServer.PROP_LB_CONNECT_SLEEP_COUNT AgiAdmServer.PROP_CMGR_START_SLEEP_INTERVAL AgiAdmServer.PROP_CMGR_START_TRY_COUNT AgiAdmServer.PROP_CMGR_RECONNECT_SLEEP_INTERVAL AgiAdmServer.PROP_CMGR_RECONNECT_TRY_COUNT
NIS+ security properties	AgiAdmServer.PROP_IGNORE_NIS_SECURITY AgiAdmServer.PROP_NISPLUS_SERVERS
LDAP security properties	AgiAdmServer.PROP_IGNORE_LDAP_SECURITY AgiAdmServer.PROP_LDAP_SERVERS AgiAdmServer.PROP_VALUE_NONE AgiAdmServer.PROP_VALUE_ALL AgiAdmServer.PROP_LDAP_GROUPS_LOCATION AgiAdmServer.PROP_LDAP_GROUP_OBJECT_CLASS AgiAdmServer.PROP_LDAP_GROUP_DESCR_ATTR AgiAdmServer.PROP_LDAP_GROUP_ADDITIONAL_ATTRS AgiAdmServer.PROP_LDAP_GROUP_USERS_ATTR AgiAdmServer.PROP_LDAP_USERS_LOCATION AgiAdmServer.PROP_LDAP_USER_OBJECT_CLASS AgiAdmServer.PROP_LDAP_USER_FULL_NAME_ATTR AgiAdmServer.PROP_LDAP_USER_DESCR_ATTR AgiAdmServer.PROP_LDAP_USER_ADDITIONAL_ATTRS
Other security properties	AgiAdmServer.GET_CERTS_CA AgiAdmServer.GET_CERTS_SRV_DSA AgiAdmServer.GET_CERTS_SRV_RSA AgiAdmServer.PROP_ENABLEAUTHENTICATION AgiAdmServer.PROP_IGNORE_SILVER_SECURITY AgiAdmServer.PROP_IGNORE_NT_SECURITY
Server logging properties	AgiAdmServer.PROP_STANDARDLOGGING AgiAdmServer.PROP_ERRORLOGGING AgiAdmServer.PROP_TRACELOGGING AgiAdmServer.PROP_SRV_LOGGER
Server cache management properties	AgiAdmServer.PROP_CACHE_ENABLE AgiAdmServer.PROP_CACHE_MAX_CONTENT_SIZE AgiAdmServer.PROP_CACHE_MEM_MAX_SIZE AgiAdmServer.PROP_CACHE_DISK_MAX_CONTENT_SIZE AgiAdmServer.PROP_CACHE_DISK_MAX_SIZE AgiAdmServer.PROP_CACHE_DISK_DIR
Server port properties	AgiAdmServer.INFO_PORT_NUMBER AgiAdmServer.PROP_RMI_LISTEN AgiAdmServer.PROP_SRV_PORT AgiAdmServer.PROP_HTTPS_RSA_PORT AgiAdmServer.PROP_HTTPS_DSA_PORT AgiAdmServer.PROP_HTTPS_LISTEN_RSA_PORT AgiAdmServer.PROP_HTTPS_LISTEN_DSA_PORT
Other server properties	AgiAdmServer.PROP_AGENT_DEBUG AgiAdmServer.PROP_CLIENT_DEBUG AgiAdmServer.PROP_LOADER_DEBUG AgiAdmServer.PROP_MAILCHECKFREQUENCY AgiAdmServer.PROP_ORB_KEY AgiAdmServer.PROP_REQUEST_TIMEOUT AgiAdmServer.PROP_REPLY_BUFF_SIZE AgiAdmServer.PROP_PREFETCHBUFFERS AgiAdmServer.PROP_PROCESS_USERNAME AgiAdmServer.PROP_SESSION_TIMEOUT AgiAdmServer.PROP_DISABLE_DIR_LISTING

Field Summary

static int	GET_CERTS_CA A mask for the flags parameter of the getCertificates(int flags) method.
static int	GET_CERTS_SRV_DSA A mask for the flags parameter of the getCertificates(int flags) method.
static int	GET_CERTS_SRV_RSA A mask for the flags parameter of the getCertificates(int flags) method.
static int	GET_DSA_SUITES A mask for the flags parameter of the getCipherSuites method.
static int	GET_RSA_SUITES A mask for the flags parameter of the getCipherSuites method.
static String	INFO_DATABASE_NAME Database name.
static String	INFO_GROUP_NAME Group name.
static String	INFO_PORT_NUMBER Port number.
static String	PROP_AGENT_DEBUG Debugging setting: when set to true, makes the server print agent- related debug messages into the server console.
static String	PROP_ALLOW_USER_SELF_MOD The AllowUserSelfModification determines whether a user can modify their own user attributes (pasword, full name, description, etc).
static String	PROP_CACHE_DISK_DIR The directory in which the disk cache entries are stored.
static String	PROP_CACHE_DISK_MAX_CONTENT_SIZE The maximum size of any file that will be cached in the disk cache, in bytes.
static String	PROP_CACHE_DISK_MAX_SIZE The maximum size of the disk cache, in bytes.
static String	PROP_CACHE_ENABLE Enables or disables the content cache.
static String	PROP_CACHE_MAX_CONTENT_SIZE The maximum size of any file that will be cached in the in-memory cache, in bytes.
static String	PROP_CACHE_MEM_MAX_SIZE The maximum size of the in-memory cache, in bytes.
static String	PROP_CLIENT_CERT_LEVEL The "Client Certificate level in HTTPS" property.
static String	PROP_CLIENT_DEBUG Debugging setting: when set to true, makes the server print debug messages into the server console.
static String	PROP_CMGR_RECONNECT_SLEEP_INTERVAL Deprecated. Use AgiAdmCluster.PROP_CMGR_RECONNECT_SLEEP_INTERVAL to set the value on the cluster level or AgiAdmClusterServer.PROP_CMGR_RECONNECT_SLEEP_INTERVAL to set the value on the level of a cluster server. Default value: 10 seconds Value type: Integer Usage: setProperty, getProperty
static String	PROP_CMGR_RECONNECT_TRY_COUNT Deprecated. Use AgiAdmCluster.PROP_CMGR_RECONNECT_TRY_COUNT to set the value on the cluster level or AgiAdmClusterServer.PROP_CMGR_RECONNECT_TRY_COUNT to set the value on the level of a cluster server. Default value: 10 seconds Value type: Integer Usage: setProperty, getProperty
static String	PROP_CMGR_START_SLEEP_INTERVAL Deprecated. Use AgiAdmCluster.PROP_CMGR_START_SLEEP_INTERVAL to set the value on the cluster level or AgiAdmClusterServer.PROP_CMGR_START_SLEEP_INTERVAL to set the value on the level of a cluster server. Default value: 30 seconds Value type: Integer Usage: setProperty, getProperty
static String	PROP_CMGR_START_TRY_COUNT Deprecated. Use AgiAdmCluster.PROP_CMGR_START_TRY_COUNT to set the value on the cluster level or AgiAdmClusterServer.PROP_CMGR_START_TRY_COUNT to set the value on the level of a cluster server. Default value: 10 seconds Value type: Integer Usage: setProperty, getProperty
static String	PROP_DEFAULT_SECURITY_AUTHORITY If specified, this property defines the authority for any login name that does not contain security authority information.
static String	PROP_DEFAULT_SECURITY_REALM If specified, this property defines the security realm for any login name that does not contain realm information.
static String	PROP_DISABLE_DIR_LISTING Tells whether to disable HTML directory listings.
static String	PROP_DSA_SUITES Deprecated. Use the getCipherSuites and setCipherSuites methods to manage cipher suites. The property for DSA cipher suites. Value type: String. Default value: none (by default, the property is not present on the server). This property, if present, is represented as a string of integer values delimited by the vertical bar character ('|'). See the documentation on cipher suites in the Administrator's Guide.
static String	PROP_ENABLEAUTHENTICATION Name of the property indicating whether authorization for incomming requests should be required.
static String	PROP_ERROR_LOGNAME Name of the property indicating the error log file.
static String	PROP_ERRORLOGGING Error logging property.
static String	PROP_FREECLIENTCONNSBUSY Used internally.
static String	PROP_FREECLIENTCONNSLIGHT Determines when the Server is considered to be light or busy.
static String	PROP_FTS_INDEXER_TIME FullText Indexer interval time in minutes.
static String	PROP_FTS_MAX_SEARCH_ROWS Maximum result row count for a FullText Search query.
static String	PROP_FTS_NO_FULL_INDEX Initial FullText Search criteria (true=partial re-index; false=full re-index).
static String	PROP_FTS_NO_INDEX_ON_SEARCH Ignore the index status of a table prior to a full-text search.
static String	PROP_HTTP_LISTEN Name of the property that is used indicate whether to listen on HTTP port.
static String	PROP_HTTPS_DSA_PORT The HTTPS port setting (the server HTTPS DSA property).
static String	PROP_HTTPS_LISTEN_DSA_PORT Tells whether the server is to listen on the HTTPS DSA port.
static String	PROP_HTTPS_LISTEN_RSA_PORT Tells whether the server is to listen on the HTTPS RSA port.
static String	PROP_HTTPS_RSA_PORT The HTTPS port setting (the server HTTPS RSA port property).
static String	PROP_IDLECLIENTCONNSBUSY The minimum number of idle client connections the server keeps connected.
static String	PROP_IDLECLIENTCONNSLIGHT Used internally.
static String	PROP_IGNORE_CERTIFICATE_SECURITY Tells the server to ignore the Certificate users security realm if the value is set to TRUE.
static String	PROP_IGNORE_LDAP_SECURITY Tells the server to ignore the LDAP security realm if the value is set to TRUE.
static String	PROP_IGNORE_NIS_SECURITY Tells the server to ignore the NIS+ security realm if the value is set to TRUE.
static String	PROP_IGNORE_NT_SECURITY Tells the server to ignore the Windows NT security realm if the value is set to TRUE.
static String	PROP_IGNORE_SILVER_SECURITY Tells the server to ignore the SilverStream security realm if the value is set to TRUE.
static String	PROP_LB_CONNECT_SLEEP_COUNT Deprecated. Use AgiAdmCluster.PROP_LB_CONNECT_SLEEP_COUNT to set the value on the cluster level or AgiAdmClusterServer.PROP_LB_CONNECT_SLEEP_COUNT to set the value on the level of a cluster server. Default value: 10 seconds Value type: Integer Usage: setProperty, getProperty
static String	PROP_LB_CONNECT_SLEEP_INTERVAL Deprecated. Use AgiAdmCluster.PROP_LB_CONNECT_SLEEP_INTERVAL to set the value on the cluster level or AgiAdmClusterServer.PROP_LB_CONNECT_SLEEP_INTERVAL to set the value on the level of a cluster server. Default value: 10 seconds Value type: Integer Usage: setProperty, getProperty
static String	PROP_LB_CONNECT_TRY_COUNT Deprecated. Use AgiAdmCluster.PROP_LB_CONNECT_TRY_COUNT to set the value on the cluster level or AgiAdmClusterServer.PROP_LB_CONNECT_TRY_COUNT to set the value on the level of a cluster server. Default value: 10 seconds Value type: Integer Usage: setProperty, getProperty
static String	PROP_LB_CONNECT_TRY_INTERVAL Deprecated. Use AgiAdmCluster.PROP_LB_CONNECT_TRY_INTERVAL to set the value on the cluster level or AgiAdmClusterServer.PROP_LB_CONNECT_TRY_INTERVAL to set the value on the level of a cluster server. Default value: 30 seconds Value type: Integer Usage: setProperty, getProperty
static String	PROP_LDAP_CONNECTION_PASSWORD The password for the account that has valid access to a particular LDAP server.
static String	PROP_LDAP_CONNECTION_USER The user name for the account that has valid access to a particular LDAP server.
static String	PROP_LDAP_GROUP_ADDITIONAL_ATTRS Defines the set of additional LDAP group attributes that are of interest to the API users.
static String	PROP_LDAP_GROUP_DESCR_ATTR Defines what LDAP attribute is to be considered the description of an LDAP group.
static String	PROP_LDAP_GROUP_OBJECT_CLASS Defines what an LDAP group is by specifying the object class which is to be considered "group".
static String	PROP_LDAP_GROUP_USERS_ATTR Specifies the LDAP attribute that defines a user within a group Value type: String
static String	PROP_LDAP_GROUPS_LOCATION Defines the point in the LDAP tree where the server is expected to start searching for groups.
static String	PROP_LDAP_SERVERS Lists the LDAP servers that the SilverStream Server knows about.
static String	PROP_LDAP_USER_ADDITIONAL_ATTRS Defines the set of additional LDAP user attributes that are of interest to the API users.
static String	PROP_LDAP_USER_DESCR_ATTR Defines what LDAP attribute is to be considered the description of an LDAP user.
static String	PROP_LDAP_USER_FULL_NAME_ATTR Defines what LDAP attribute is to be considered the full name of an LDAP user.
static String	PROP_LDAP_USER_LOGIN_ATTRIBUTE If this property is set, it defines an LDAP attribute that can be used to uniquely identify a user (it is the responsibility of the administrator to pick an attribute that is unique for all users).
static String	PROP_LDAP_USER_OBJECT_CLASS Defines what an LDAP user is by specifying the object class which is to be considered "user".
static String	PROP_LDAP_USERS_LOCATION Defines the point in the LDAP tree where the server is expected to start searching for users.
static String	PROP_LOADER_DEBUG Debugging setting: when set to true, makes the server print classloader related debug messages into the server console.
static String	PROP_MAILCHECKFREQUENCY The time interval for the mail server to check for incoming mail messages.
static String	PROP_MAXCLIENTCONNS The total number of allowable connections.
static String	PROP_MAXDBCONNS The maximum number of open connections per database.
static String	PROP_MINDBCONNS The minimum number of open connections per database.
static String	PROP_NISPLUS_SERVERS Lists the NIS+ servers that the SilverStream Server knows about.
static String	PROP_ORB_KEY The description of the ORB that the server is using.
static String	PROP_PREFETCHBUFFERS Number of fetch-ahead result threads (prefetch buffers) to allocate.
static String	PROP_PROCESS_USERNAME The user name the server is to be run under, on UNIX servers only.
static String	PROP_REPLY_BUFF_SIZE The buffer size used for bufferring replies.
static String	PROP_REQUEST_TIMEOUT The timeout on an individual server request.
static String	PROP_RMI_LISTEN The SilverStream server exports a "remote server object" via RMI/IIOP, so that non-SilverStream clients that want to call invoked business objects or, especially, EJBs on the SilverStream Server don't need to get an HTTP session on the server.
static String	PROP_RSA_SUITES Deprecated. Use the getCipherSuites and setCipherSuites methods to manage cipher suites. The property for RSA cipher suites. Value type: String. Default value: none (by default, the property is not present on the server). This property, if present, is represented as a string of integer values delimited by the vertical bar character ('|'). See the documentation on cipher suites in the Administrator's Guide.
static String	PROP_SECURITY_RESOURCE_TIMEOUT This property controls the timeout value for security resources from 3rd party systems (NT, NISPLUS, LDAP).
static String	PROP_SESSION_TIMEOUT Session timeout setting.
static String	PROP_SET_LOCKSMITH_ENABLED The SetLocksmithEnabled property controls whether the locksmith privilege can be set for another user or group.
static String	PROP_SILVERMASTER Name of the property indicating the SilverMaster data source name.
static String	PROP_SQL_DEBUG Debugging setting: when set to true, makes the server print SQL- related debug messages into the server console.
static String	PROP_SRV_LOGGER Tells what class is used to do logging.
static String	PROP_SRV_NAMESERVICE_PORT The port of the nameservice that the server is using.
static String	PROP_SRV_PORT Server port.
static String	PROP_STANDARD_LOGNAME Name of the property indicating the standard HTTP log file.
static String	PROP_STANDARDLOGGING Standard logging property.
static String	PROP_TRACE_LOGNAME Name of the property indicating the server trace log file.
static String	PROP_TRACELOGGING Trace logging property.
static String	PROP_VALUE_ALL Predefined value to use for the PROP_LDAP_GROUP_ADDITIONAL_ATTRS and PROP_LDAP_USER_ADDITIONAL_ATTRS properties to tell the server that all of the additional properties (attributes) should be returned for LDAP groups or LDAP users, respectively, when a request is made to obtain their properties.
static String	PROP_VALUE_NONE Predefined value to use for the PROP_LDAP_GROUP_ADDITIONAL_ATTRS and PROP_LDAP_USER_ADDITIONAL_ATTRS properties to tell the server that no additional properties (attributes) should be returned for LDAP groups or LDAP users, respectively, when a request is made to obtain their properties.
static String	SERVER Server element type.

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

void	addCertificate(String sourceDirectory, String sourceName) Add a certificate to the server.
Acl	createAcl() Create an ACL object.
AclEntry	createAclEntry() Create an ACL Entry object.
void	deactivate() Deactivate the server, preventing any future client sessions from being established.
void	deleteCertificate(AgiAdmCertificate cert) Delete a certificate from the server.
void	deleteIdleDatabaseConnections() Terminate all the idle database connections.
void	deleteLicense(String license) Removes a license from the server.
String	getBuildDescription() Get the description of the server build.
Enumeration	getCacheManagerGroups() Get the list of available Cache Manager Groups.
AgiAdmCertificate	getCertificateObject() Deprecated. This method is deprecated as it does nothing useful.
Enumeration	getCertificates() Deprecated. Use AgiAdmServer.getCertificates(int flags) instead. Retrieve information about certificates from the server.
Enumeration	getCertificates(int flags) Retrieve information about certificates from the server.
Enumeration	getCipherSuites(int flags) Enumerate available/supported cipher suites.
Enumeration	getClusters() Get the list of available Clusters.
Enumeration	getDatabaseDriverList() Enumerate the available database drivers.
Enumeration	getDatabasePlatformList() Enumerate the available database platforms.
Enumeration	getDispatcherGroups() Get the list of available Dispatcher Groups.
AgiAdmElementBase	getElement(String name, String type, Hashtable info) Create an object with the specified name and type.
Enumeration	getJdbcDriverList() Enumerate the available JDBC drivers.
Enumeration	getLdsKeyList() Enumerate the LDS keys.
Enumeration	getLicenses() Retrieve information about licenses from the server.
Enumeration	getLoadManagerGroups() Get the list of available Load Manager Groups.
AgiAdmMailAccount	getMailAccountObject() Create a mail account object.
Enumeration	getMailAccounts() Retrieve information about mail accounts.
Enumeration	getOrbDisplayNameList() Enumerate the available ORBs.
Enumeration	getOrbKeyList() Enumerate the available ORBs.
Enumeration	getSessions() Enumerate sessions the server is currently maintaining.
AgiAdmStatistics	getStatistics() Get server statistics.
Enumeration	getThreads() Enumerate server threads.
boolean	isAlive(boolean force) Return true if the server is alive, false otherwise.
boolean	isCompatible() Exchange version number information with the server.
boolean	loginUser() Allow a user to log on to the server.
void	logoutUser() Allow a user to log out from the server.
void	resetMinMaxDatabaseConnections(boolean min, boolean max, boolean sysmin, boolean sysmax, AgiAdmDatabase database) Reset the values of minimum and/or maximum database connections for one database or for all databases on the server.
void	setCipherSuites(Enumeration suites) Set the state (enabled or disabled) of the specified cipher suites.
void	setMailAccounts(Enumeration accounts) Set up mail accounts.
void	shutdown(boolean deactivate, boolean restart, String[][] options) Shut down the server.
void	shutdown(boolean restart, String[][] options) Shut down the server.

Methods implemented from interface com.sssw.rts.acl.AgiPrincipalFactory

getCurrentPrincipal, getWorldPrincipal, isWorldPrincipal, parseGroup, parseUser

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

Field Detail

SERVER

public static final String SERVER

Server element type.

Usage: AgiAdmElement.getElement

This element type is provided for completeness. If the caller wants to get an AgiAdmServer, they should use the AgAdmin.getServer method.

The SERVER identifier is returned when getType is called from an AgiAdmServer reference.

PROP_STANDARDLOGGING

public static final String PROP_STANDARDLOGGING

Standard logging property. Value type: Boolean.

Use TRUE to turn the standard logging on, and FALSE to turn it off.

Usage: setProperty, getProperty

PROP_ERRORLOGGING

public static final String PROP_ERRORLOGGING

Error logging property. Value type: Boolean.

Use TRUE to turn the error logging on, and FALSE to turn it off.

Usage: setProperty, getProperty

PROP_TRACELOGGING

public static final String PROP_TRACELOGGING

Trace logging property. Value type: Boolean.

Use TRUE to turn the trace logging on, and FALSE to turn it off.

Usage: setProperty, getProperty

PROP_MINDBCONNS

public static final String PROP_MINDBCONNS

The minimum number of open connections per database. Value type: Integer.

Usage: setProperty, getProperty

This is the value that is used for every database on the server; this property cannot be set/retrieved per database; the latter capability has been deprecated.

PROP_MAXDBCONNS

public static final String PROP_MAXDBCONNS

The maximum number of open connections per database. Value type: Integer.

Usage: setProperty, getProperty

This is the value that is used for every database on the server; this property cannot be set/retrieved per database; the latter capability has been deprecated.

PROP_PREFETCHBUFFERS

public static final String PROP_PREFETCHBUFFERS

Number of fetch-ahead result threads (prefetch buffers) to allocate. Value type: Integer.

Usage: setProperty, getProperty

PROP_MAXCLIENTCONNS

public static final String PROP_MAXCLIENTCONNS

The total number of allowable connections. Value type: Integer.

Usage: setProperty, getProperty

PROP_FREECLIENTCONNSBUSY

public static final String PROP_FREECLIENTCONNSBUSY

Used internally. Set to same value as PROP_FREECLIENTCONNSLIGHT. See the Administrator's Guide for more information. Value type: Integer.

Usage: setProperty, getProperty

PROP_FREECLIENTCONNSLIGHT

public static final String PROP_FREECLIENTCONNSLIGHT

Determines when the Server is considered to be light or busy. See the Administrator's Guide for more information. Value type: Integer.

Usage: setProperty, getProperty

PROP_IDLECLIENTCONNSBUSY

public static final String PROP_IDLECLIENTCONNSBUSY

The minimum number of idle client connections the server keeps connected. Default value: 0. Value type: Integer.

Usage: setProperty, getProperty

PROP_IDLECLIENTCONNSLIGHT

public static final String PROP_IDLECLIENTCONNSLIGHT

Used internally. Set to same value as PROP_MAXCLIENTCONNS. See the Administrator's Guide for more information. Value type: Integer.

Usage: setProperty, getProperty

PROP_MAILCHECKFREQUENCY

public static final String PROP_MAILCHECKFREQUENCY

The time interval for the mail server to check for incoming mail messages. When set to zero, the server does not check for mail. Value type: Integer.

Usage: setProperty, getProperty

PROP_ENABLEAUTHENTICATION

public static final String PROP_ENABLEAUTHENTICATION

Name of the property indicating whether authorization for incomming requests should be required. Value type: Boolean.

Usage: setProperty, getProperty

PROP_REQUEST_TIMEOUT

public static final String PROP_REQUEST_TIMEOUT

The timeout on an individual server request. Value type: Integer

Usage: setProperty, getProperty

PROP_REPLY_BUFF_SIZE

public static final String PROP_REPLY_BUFF_SIZE

The buffer size used for bufferring replies. Value type: Integer

Usage: setProperty, getProperty

PROP_CACHE_ENABLE

public static final String PROP_CACHE_ENABLE

Enables or disables the content cache. If set to false, all content caching is turned off. Value type: Boolean

Usage: setProperty, getProperty

PROP_CACHE_MAX_CONTENT_SIZE

public static final String PROP_CACHE_MAX_CONTENT_SIZE

The maximum size of any file that will be cached in the in-memory cache, in bytes. Files less than or equal to this size will be cached in the in-memory cache. Default value: 131072 Value type: Boolean

Usage: setProperty, getProperty

PROP_CACHE_MEM_MAX_SIZE

public static final String PROP_CACHE_MEM_MAX_SIZE

The maximum size of the in-memory cache, in bytes. The total size of all files in the cache will always be less than or equal to this. If set to 0, the in-memory cache is effectively disabled. Default value: 4194304 Value type: Integer

Usage: setProperty, getProperty

PROP_CACHE_DISK_MAX_CONTENT_SIZE

public static final String PROP_CACHE_DISK_MAX_CONTENT_SIZE

The maximum size of any file that will be cached in the disk cache, in bytes. Files less than or equal to this size but too large for the in-memory cache will be cached in the disk cache. Files greater than this size will not be cached. Value type: Integer

Usage: setProperty, getProperty

PROP_CACHE_DISK_MAX_SIZE

public static final String PROP_CACHE_DISK_MAX_SIZE

The maximum size of the disk cache, in bytes. The total size of all files in the cache will always be less than or equal to this. If set to 0, the disk cache is effectively disabled. Value type: Integer

Usage: setProperty, getProperty

PROP_CACHE_DISK_DIR

public static final String PROP_CACHE_DISK_DIR

The directory in which the disk cache entries are stored. By default, this will be a subdirectory of the directory where SilverStream is installed (typically /SilverStream). The server will try to create this directory if it doesn't exist. The server also tries to clear out all the cache files from this directory when it starts up, so it's a good idea to have a directory that's dedicated to the cache.

If the server can't find and can't create this directory, the disk cache is effectively disabled.

Default value: /SilverStream/ContentCache Value type: String

Usage: setProperty, getProperty

PROP_PROCESS_USERNAME

public static final String PROP_PROCESS_USERNAME

The user name the server is to be run under, on UNIX servers only. Value type: String

Usage: setProperty, getProperty

PROP_IGNORE_SILVER_SECURITY

public static final String PROP_IGNORE_SILVER_SECURITY

Tells the server to ignore the SilverStream security realm if the value is set to TRUE. Value type: Boolean

Usage: setProperty, getProperty

PROP_IGNORE_NT_SECURITY

public static final String PROP_IGNORE_NT_SECURITY

Tells the server to ignore the Windows NT security realm if the value is set to TRUE. Value type: Boolean

Usage: setProperty, getProperty

PROP_IGNORE_LDAP_SECURITY

public static final String PROP_IGNORE_LDAP_SECURITY

Tells the server to ignore the LDAP security realm if the value is set to TRUE. Value type: Boolean

Usage: setProperty, getProperty

PROP_IGNORE_NIS_SECURITY

public static final String PROP_IGNORE_NIS_SECURITY

Tells the server to ignore the NIS+ security realm if the value is set to TRUE. Value type: Boolean

Usage: setProperty, getProperty

PROP_IGNORE_CERTIFICATE_SECURITY

public static final String PROP_IGNORE_CERTIFICATE_SECURITY

Tells the server to ignore the Certificate users security realm if the value is set to TRUE. Value type: Boolean

Usage: setProperty, getProperty

PROP_LDAP_SERVERS

public static final String PROP_LDAP_SERVERS

Lists the LDAP servers that the SilverStream Server knows about. Value type: String

Usage: setProperty, getProperty

Multiple LDAP servers should be listed as a "|"-separated name list, for example, "server1|server2|server3".

PROP_NISPLUS_SERVERS

public static final String PROP_NISPLUS_SERVERS

Lists the NIS+ servers that the SilverStream Server knows about. Value type: String

Usage: setProperty, getProperty

Multiple NIS+ servers should be listed as a "|"-separated name list, for example, "server1|server2|server3".

PROP_LDAP_GROUPS_LOCATION

public static final String PROP_LDAP_GROUPS_LOCATION

Defines the point in the LDAP tree where the server is expected to start searching for groups. Value type: String

Usage: setProperty, getProperty

The caller must specify which LDAP server this setting pertains to by appending the LDAP server name to the property name, for example:

	AgiAdmServer server = AgAdmin.getServer("Montreal", -1);
	server.setProperty(		// or getProperty
		AgiAdmServer.PROP_LDAP_GROUPS_LOCATION + "ldapServer1",
		"ou=HQ, ou=Netscape Servers, o=SilverStream");
 

PROP_LDAP_GROUP_OBJECT_CLASS

public static final String PROP_LDAP_GROUP_OBJECT_CLASS

Defines what an LDAP group is by specifying the object class which is to be considered "group". Value type: String

Usage: setProperty, getProperty

The caller must specify which LDAP server this setting pertains to by appending the LDAP server name to the property name, for example:

	AgiAdmServer server = AgAdmin.getServer("Montreal", -1);
	server.setProperty(		// or getProperty
		AgiAdmServer.PROP_LDAP_GROUP_OBJECT_CLASS + "ldapServer1",
		"(objectclass=groupofUniqueNames)");
 

PROP_LDAP_GROUP_DESCR_ATTR

public static final String PROP_LDAP_GROUP_DESCR_ATTR

Defines what LDAP attribute is to be considered the description of an LDAP group. Value type: String

Usage: setProperty, getProperty

The caller must specify which LDAP server this setting pertains to by appending the LDAP server name to the property name, for example:

	AgiAdmServer server = AgAdmin.getServer("Montreal", -1);
	server.setProperty(		// or getProperty
		AgiAdmServer.PROP_LDAP_GROUP_DESCR_ATTR + "ldapServer1",
		"description");
 

PROP_LDAP_GROUP_ADDITIONAL_ATTRS

public static final String PROP_LDAP_GROUP_ADDITIONAL_ATTRS

Defines the set of additional LDAP group attributes that are of interest to the API users. Value type: String

Usage: setProperty, getProperty

The caller must specify which LDAP server this setting pertains to by appending the LDAP server name to the property name, for example:

	AgiAdmServer server = AgAdmin.getServer("Montreal", -1);
	server.setProperty(		// or getProperty
		AgiAdmServer.PROP_LDAP_GROUP_ADDITIONAL_ATTRS + "ldapServer1",
		"creatorsname|modifiersname");
 

The list of additional attributes may be:

• a "|"-separated list of LDAP attributes
• a value specifying "no additional attributes" (see PROP_VALUE_NONE)
• a value specifying "all available attributes" (see PROP_VALUE_ALL)

PROP_LDAP_GROUP_USERS_ATTR

public static final String PROP_LDAP_GROUP_USERS_ATTR

Specifies the LDAP attribute that defines a user within a group Value type: String

Usage: setProperty, getProperty

The caller must specify which LDAP server this setting pertains to by appending the LDAP server name to the property name, for example:

	AgiAdmServer server = AgAdmin.getServer("Montreal", -1);
	server.setProperty(		// or getProperty
		AgiAdmServer.PROP_LDAP_GROUP_USERS_ATTR + "ldapServer1",
		"uniquemember");
 

PROP_LDAP_USERS_LOCATION

public static final String PROP_LDAP_USERS_LOCATION

Defines the point in the LDAP tree where the server is expected to start searching for users. Value type: String

Usage: setProperty, getProperty

The caller must specify which LDAP server this setting pertains to by appending the LDAP server name to the property name, for example:

	AgiAdmServer server = AgAdmin.getServer("Montreal", -1);
	server.setProperty(		// or getProperty
		AgiAdmServer.PROP_LDAP_USERS_LOCATION + "ldapServer1",
		"ou=HQ, ou=Netscape Servers, o=SilverStream");
 

PROP_LDAP_USER_OBJECT_CLASS

public static final String PROP_LDAP_USER_OBJECT_CLASS

Defines what an LDAP user is by specifying the object class which is to be considered "user". Value type: String

Usage: setProperty, getProperty

The caller must specify which LDAP server this setting pertains to by appending the LDAP server name to the property name, for example:

	AgiAdmServer server = AgAdmin.getServer("Montreal", -1);
	server.setProperty(		// or getProperty
		AgiAdmServer.PROP_LDAP_USER_OBJECT_CLASS + "ldapServer1",
		"(objectclass=organizationalPerson)");
 

PROP_LDAP_USER_FULL_NAME_ATTR

public static final String PROP_LDAP_USER_FULL_NAME_ATTR

Defines what LDAP attribute is to be considered the full name of an LDAP user. Value type: String

Usage: setProperty, getProperty

The caller must specify which LDAP server this setting pertains to by appending the LDAP server name to the property name, for example:

	AgiAdmServer server = AgAdmin.getServer("Montreal", -1);
	server.setProperty(		// or getProperty
		AgiAdmServer.PROP_LDAP_USER_FULL_NAME_ATTR + "ldapServer1",
		"cn");
 

PROP_LDAP_USER_DESCR_ATTR

public static final String PROP_LDAP_USER_DESCR_ATTR

Defines what LDAP attribute is to be considered the description of an LDAP user. Value type: String

Usage: setProperty, getProperty

The caller must specify which LDAP server this setting pertains to by appending the LDAP server name to the property name, for example:

	AgiAdmServer server = AgAdmin.getServer("Montreal", -1);
	server.setProperty(		// or getProperty
		AgiAdmServer.PROP_LDAP_USER_DESCR_ATTR + "ldapServer1",
		"title");
 

PROP_LDAP_USER_ADDITIONAL_ATTRS

public static final String PROP_LDAP_USER_ADDITIONAL_ATTRS

Defines the set of additional LDAP user attributes that are of interest to the API users. Value type: String

Usage: setProperty, getProperty

The caller must specify which LDAP server this setting pertains to by appending the LDAP server name to the property name, for example:

	AgiAdmServer server = AgAdmin.getServer("Montreal", -1);
	server.setProperty(		// or getProperty
		AgiAdmServer.PROP_LDAP_GROUP_ADDITIONAL_ATTRS + "ldapServer1",
		"Email|Phone Number");
 

The list of additional attributes may be:

• a "|"-separated list of LDAP attributes
• a value specifying "no additional attributes" (see PROP_VALUE_NONE)
• a value specifying "all available attributes" (see PROP_VALUE_ALL)

PROP_LDAP_USER_LOGIN_ATTRIBUTE

public static final String PROP_LDAP_USER_LOGIN_ATTRIBUTE

If this property is set, it defines an LDAP attribute that can be used to uniquely identify a user (it is the responsibility of the administrator to pick an attribute that is unique for all users). When the user credentials are being verified during the logon sequence, a search is performed for the attribute specified, with a value that matches the Name portion of the login user name. The search starts from a point in the LDAP hierarchy identified by the property PROP_LDAP_USERS_LOCATION. Value type: String

Usage: getProperty, getProperties, setProperty, setProperties

The caller must specify which LDAP server this setting pertains to by appending the LDAP server name to the property name.

In LDAP, a user name is specified relative to the LDAP naming hierarchy as a distinguished name (DN). A distinguished name is a comma-separated list of nodes that contains attribute-name pairs from the leaf node where the user resides, all the way back to the root node. This name can be arbitrarily long and can be cumbersome to use as part of a login name. The "LDAP user login attribute" property is to alleviate this problem.

See Also:

AgiAdmServer.PROP_LDAP_USERS_LOCATION

PROP_LDAP_CONNECTION_USER

public static final String PROP_LDAP_CONNECTION_USER

The user name for the account that has valid access to a particular LDAP server. Value type: String

Usage: getProperty, getProperties, setProperty, setProperties

If the LDAP server does not allow anonymous access, the PROP_LDAP_CONNECTION_USER and PROP_LDAP_CONNECTION_PASSWORD properties can be used to set an account that has valid access. If anonymous access is allowed, the value for the LDAP Connection User can be set to ''. This will cause the SilverStream server to ignore these properties when connecting to the LDAP server.

See Also:

AgiAdmServer.PROP_LDAP_CONNECTION_PASSWORD

PROP_LDAP_CONNECTION_PASSWORD

public static final String PROP_LDAP_CONNECTION_PASSWORD

The password for the account that has valid access to a particular LDAP server. Value type: String

Usage: setProperty, setProperties

If the LDAP server does not allow anonymous access, the PROP_LDAP_CONNECTION_USER and PROP_LDAP_CONNECTION_PASSWORD properties can be used to set an account that has valid access. If anonymous access is allowed, the value for the LDAP Connection User can be set to ''. This will cause the SilverStream server to ignore these properties when connecting to the LDAP server.

This property is write-only, that is, its value may be set but not retrieved.

See Also:

AgiAdmServer.PROP_LDAP_CONNECTION_USER

PROP_VALUE_NONE

public static final String PROP_VALUE_NONE

Predefined value to use for the PROP_LDAP_GROUP_ADDITIONAL_ATTRS and PROP_LDAP_USER_ADDITIONAL_ATTRS properties to tell the server that no additional properties (attributes) should be returned for LDAP groups or LDAP users, respectively, when a request is made to obtain their properties.

Usage: setProperty, getProperty

Use only as value of PROP_LDAP_GROUP_ADDITIONAL_ATTRS or PROP_LDAP_USER_ADDITIONAL_ATTRS.

PROP_VALUE_ALL

public static final String PROP_VALUE_ALL

Predefined value to use for the PROP_LDAP_GROUP_ADDITIONAL_ATTRS and PROP_LDAP_USER_ADDITIONAL_ATTRS properties to tell the server that all of the additional properties (attributes) should be returned for LDAP groups or LDAP users, respectively, when a request is made to obtain their properties.

Usage: setProperty, getProperty

Use only as value of PROP_LDAP_GROUP_ADDITIONAL_ATTRS or PROP_LDAP_USER_ADDITIONAL_ATTRS.

PROP_SESSION_TIMEOUT

public static final String PROP_SESSION_TIMEOUT

Session timeout setting. This property gives, in milliseconds, the timeout to use for sessions that remain idle, waiting for reconnect. Default value: 300000 milliseconds. Value type: Integer

Usage: setProperty, getProperty

PROP_SRV_PORT

public static final String PROP_SRV_PORT

Server port. Default value: 80 Value type: Integer

Usage: setProperty, getProperty

A changed value will not take effect until the server is restarted.

PROP_HTTPS_RSA_PORT

public static final String PROP_HTTPS_RSA_PORT

The HTTPS port setting (the server HTTPS RSA port property). At initialization time, the server will bind its accepting socket to the host it runs on, and to the provided port. The server will use an RSA certificate and encription algorithms for SSL on this port. Default value: 443. Value type: Integer

Usage: setProperty, getProperty

PROP_HTTPS_DSA_PORT

public static final String PROP_HTTPS_DSA_PORT

The HTTPS port setting (the server HTTPS DSA property). At initialization time, the server will bind its accepting socket to the host it runs on, and to the provided port. The server will use a DSA/Diffie-Hellman certificate and encription algorithms for SSL on this port. Default value: 444. Value type: Integer

Usage: setProperty, getProperty

PROP_HTTPS_LISTEN_RSA_PORT

public static final String PROP_HTTPS_LISTEN_RSA_PORT

Tells whether the server is to listen on the HTTPS RSA port. Default value: true. Value type: Boolean

Usage: setProperty, getProperty

PROP_HTTPS_LISTEN_DSA_PORT

public static final String PROP_HTTPS_LISTEN_DSA_PORT

Tells whether the server is to listen on the HTTPS DSA port. Default value: true. Value type: Boolean

Usage: setProperty, getProperty

PROP_CLIENT_CERT_LEVEL

public static final String PROP_CLIENT_CERT_LEVEL

The "Client Certificate level in HTTPS" property. Value for level of server request of client certificate when the communication is going on via SSL from a browser. Default value: 0. Value type: Integer

Usage: setProperty, getProperty

PROP_DISABLE_DIR_LISTING

public static final String PROP_DISABLE_DIR_LISTING

Tells whether to disable HTML directory listings. Default value: false. Value type: Boolean

Usage: setProperty, getProperty

This property may be set to "true" to disable the HTML-format listings of server directory contents in a browser when the browser does a GET on the directory's URL. If the property is set to true, instead of returning a directory listing, the server returns a FORBIDDEN error.

The intent of this is to allow deployment sites to add a little bit of additional security, by making it difficult for random users to browser around their site hierarachies. It is recommended that most deployed servers set this parameter to true.

PROP_SRV_LOGGER

public static final String PROP_SRV_LOGGER

Tells what class is used to do logging. Allowed values: AgLogger and CommonLogger. AgLogger does logging to database, CommonLogger does logging to file. Default value: AgLogger Value type: String

Usage: getProperty

PROP_LB_CONNECT_TRY_INTERVAL

public static final String PROP_LB_CONNECT_TRY_INTERVAL

Deprecated. Use AgiAdmCluster.PROP_LB_CONNECT_TRY_INTERVAL to set the value on the cluster level or AgiAdmClusterServer.PROP_LB_CONNECT_TRY_INTERVAL to set the value on the level of a cluster server.

Default value: 30 seconds Value type: Integer Usage: setProperty, getProperty

The interval between attempts to make contact SilverStream Load Balancer.

PROP_LB_CONNECT_TRY_COUNT

public static final String PROP_LB_CONNECT_TRY_COUNT

Deprecated. Use AgiAdmCluster.PROP_LB_CONNECT_TRY_COUNT to set the value on the cluster level or AgiAdmClusterServer.PROP_LB_CONNECT_TRY_COUNT to set the value on the level of a cluster server.

Default value: 10 seconds Value type: Integer Usage: setProperty, getProperty

The number of attempts to make contact with SilverStream Load Balancer.

PROP_LB_CONNECT_SLEEP_INTERVAL

public static final String PROP_LB_CONNECT_SLEEP_INTERVAL

Deprecated. Use AgiAdmCluster.PROP_LB_CONNECT_SLEEP_INTERVAL to set the value on the cluster level or AgiAdmClusterServer.PROP_LB_CONNECT_SLEEP_INTERVAL to set the value on the level of a cluster server.

Default value: 10 seconds Value type: Integer Usage: setProperty, getProperty

The sleep interval between series of attempts to make contact with SilverStream Load Balancer.

PROP_LB_CONNECT_SLEEP_COUNT

public static final String PROP_LB_CONNECT_SLEEP_COUNT

Deprecated. Use AgiAdmCluster.PROP_LB_CONNECT_SLEEP_COUNT to set the value on the cluster level or AgiAdmClusterServer.PROP_LB_CONNECT_SLEEP_COUNT to set the value on the level of a cluster server.

Default value: 10 seconds Value type: Integer Usage: setProperty, getProperty

The number of series of attempts to make contact with SilverStream Load Balancer.

PROP_CMGR_START_SLEEP_INTERVAL

public static final String PROP_CMGR_START_SLEEP_INTERVAL

Deprecated. Use AgiAdmCluster.PROP_CMGR_START_SLEEP_INTERVAL to set the value on the cluster level or AgiAdmClusterServer.PROP_CMGR_START_SLEEP_INTERVAL to set the value on the level of a cluster server.

Default value: 30 seconds Value type: Integer Usage: setProperty, getProperty

The sleep interval between attempts to make contact with SilverStream Cache Manager.

PROP_CMGR_START_TRY_COUNT

public static final String PROP_CMGR_START_TRY_COUNT

Deprecated. Use AgiAdmCluster.PROP_CMGR_START_TRY_COUNT to set the value on the cluster level or AgiAdmClusterServer.PROP_CMGR_START_TRY_COUNT to set the value on the level of a cluster server.

Default value: 10 seconds Value type: Integer Usage: setProperty, getProperty

The number of attempts to make contact with SilverStream Cache Manager.

PROP_CMGR_RECONNECT_SLEEP_INTERVAL

public static final String PROP_CMGR_RECONNECT_SLEEP_INTERVAL

Deprecated. Use AgiAdmCluster.PROP_CMGR_RECONNECT_SLEEP_INTERVAL to set the value on the cluster level or AgiAdmClusterServer.PROP_CMGR_RECONNECT_SLEEP_INTERVAL to set the value on the level of a cluster server.

Default value: 10 seconds Value type: Integer Usage: setProperty, getProperty

The sleep interval between series of attempts to make contact with SilverStream Cache Manager.

PROP_CMGR_RECONNECT_TRY_COUNT

public static final String PROP_CMGR_RECONNECT_TRY_COUNT

Deprecated. Use AgiAdmCluster.PROP_CMGR_RECONNECT_TRY_COUNT to set the value on the cluster level or AgiAdmClusterServer.PROP_CMGR_RECONNECT_TRY_COUNT to set the value on the level of a cluster server.

Default value: 10 seconds Value type: Integer Usage: setProperty, getProperty

The number of series of attempts to make contact with SilverStream Cache Manager.

PROP_CLIENT_DEBUG

public static final String PROP_CLIENT_DEBUG

Debugging setting: when set to true, makes the server print debug messages into the server console. Default value: 1 Value type: Integer (values may range from 1 to 5, where 5 gives the most details).

Usage: setProperty, getProperty

PROP_LOADER_DEBUG

public static final String PROP_LOADER_DEBUG

Debugging setting: when set to true, makes the server print classloader related debug messages into the server console. Default value: 1 Value type: Integer (values may range from 1 to 5, where 5 gives the most details).

Usage: setProperty, getProperty

PROP_AGENT_DEBUG

public static final String PROP_AGENT_DEBUG

Debugging setting: when set to true, makes the server print agent- related debug messages into the server console. Default value: 1 Value type: Integer (values may range from 1 to 5, where 5 gives the most details).

Usage: setProperty, getProperty

PROP_SQL_DEBUG

public static final String PROP_SQL_DEBUG

Debugging setting: when set to true, makes the server print SQL- related debug messages into the server console. Default value: 1 Value type: Integer (values may range from 1 to 5, where 5 gives the most details).

Usage: setProperty, getProperty

PROP_SECURITY_RESOURCE_TIMEOUT

public static final String PROP_SECURITY_RESOURCE_TIMEOUT

This property controls the timeout value for security resources from 3rd party systems (NT, NISPLUS, LDAP). Once the resource is older than this value the resource will be recomputed, allowing us to be in sync with changes made to the external systems. Default value: 900 seconds = 15 minutes Value type: Integer

Usage: setProperty, getProperty

PROP_SET_LOCKSMITH_ENABLED

public static final String PROP_SET_LOCKSMITH_ENABLED

The SetLocksmithEnabled property controls whether the locksmith privilege can be set for another user or group. If this value is disabled (false), then trying to set this on a user or group attribute will fail. If true, the user making the call must themselves have the locksmith privilege.

The locksmith account allows two special priviliges: it overrides the permissions check, thus allowing a user to see and modify permissions even if otherwise restricted, and it allows the master database to be read.

Default value: true Value type: Boolean

PROP_ALLOW_USER_SELF_MOD

public static final String PROP_ALLOW_USER_SELF_MOD

The AllowUserSelfModification determines whether a user can modify their own user attributes (pasword, full name, description, etc). Setting this to false means that only an administrator can modify attributes of a user. Default value: true Value type: Boolean

PROP_STANDARD_LOGNAME

public static final String PROP_STANDARD_LOGNAME

Name of the property indicating the standard HTTP log file. This property defaults to the log file in the server log directory. Value type: String. Default value: "log".

PROP_ERROR_LOGNAME

public static final String PROP_ERROR_LOGNAME

Name of the property indicating the error log file. This property defaults to the errlog file in the server log directory. Value type: String. Default value: "errlog".

PROP_TRACE_LOGNAME

public static final String PROP_TRACE_LOGNAME

Name of the property indicating the server trace log file. This property defaults to the trace file in the server log directory. Value type: String. Default value: "traces".

PROP_SILVERMASTER

public static final String PROP_SILVERMASTER

Name of the property indicating the SilverMaster data source name. Value type: String. Default value: "Silvermaster".

PROP_HTTP_LISTEN

public static final String PROP_HTTP_LISTEN

Name of the property that is used indicate whether to listen on HTTP port. This is used to shut off listening on HTTP port. Value type: Boolean. Default value: true, meaning do listen on HTTP port; the value of false means shut off listening on HTTP port.

PROP_RSA_SUITES

public static final String PROP_RSA_SUITES

Deprecated. Use the getCipherSuites and setCipherSuites methods to manage cipher suites.

The property for RSA cipher suites. Value type: String. Default value: none (by default, the property is not present on the server).

This property, if present, is represented as a string of integer values delimited by the vertical bar character ('|').

See the documentation on cipher suites in the Administrator's Guide.

PROP_DSA_SUITES

public static final String PROP_DSA_SUITES

Deprecated. Use the getCipherSuites and setCipherSuites methods to manage cipher suites.

The property for DSA cipher suites. Value type: String. Default value: none (by default, the property is not present on the server).

This property, if present, is represented as a string of integer values delimited by the vertical bar character ('|').

See the documentation on cipher suites in the Administrator's Guide.

PROP_DEFAULT_SECURITY_REALM

public static final String PROP_DEFAULT_SECURITY_REALM

If specified, this property defines the security realm for any login name that does not contain realm information. This property is useful in providing a shortcut to user login such that the user does not have to type in the security realm information. Value type: String

Allowed values: "SSSW" for SilverStream, "NT" for Windows NT, "LDAP" for LDAP, and "NISPLUS" for NIS+. Default value: PROP_VALUE_NONE.

By default, the server allows certain shortcuts to the full user login name. When only one part of the login name is specified, it is assumed to be the Name component; when two parts of the login name are present they are assumed to be the Authority and Name components. If a login name contains only the Name component, it is assumed to be a user defined by the local SilverStream server (equivalent to a name of the form SSSW\\Name). If the login contains both an Authority and a Name, it is assumed to be an NT user defined in an NT domain named by the Authority (equivalent to NT\Authority\Name). LDAP and NisPlus names must, by default, be fully specified.

An administrator can override the defaults for login name components. This allows users in an environment that has only one type of external security system (and perhaps only one external security authority), to provide a shortened name, thus simplifying login.

A full login name can always be specified, in which case the defaults will be ignored.

See Also:

AgiAdmServer.PROP_DEFAULT_SECURITY_AUTHORITY

Example:

	server.setProperty(AgiAdmServer.PROP_DEFAULT_SECURITY_REALM, "NISPLUS");
	server.setProperty(AgiAdmServer.PROP_DEFAULT_SECURITY_AUTHORITY, "myserver/domain1");
 

PROP_DEFAULT_SECURITY_AUTHORITY

public static final String PROP_DEFAULT_SECURITY_AUTHORITY

If specified, this property defines the authority for any login name that does not contain security authority information. This property is useful in providing a shortcut to user login such that the user does not have to type in the security authority information. Value type: String Default value: PROP_VALUE_NONE.

By default, the server allows certain shortcuts to the full user login name. When only one part of the login name is specified, it is assumed to be the Name component; when two parts of the login name are present they are assumed to be the Authority and Name components. If a login name contains only the Name component, it is assumed to be a user defined by the local SilverStream server (equivalent to a name of the form SSSW\\Name). If the login contains both an Authority and a Name, it is assumed to be an NT user defined in an NT domain named by the Authority (equivalent to NT\Authority\Name). LDAP and NisPlus names must, by default, be fully specified.

An administrator can override the defaults for login name components. This allows users in an environment that has only one type of external security system (and perhaps only one external security authority), to provide a shortened name, thus simplifying login.

A full login name can always be specified, in which case the defaults will be ignored.

See Also:

AgiAdmServer.PROP_DEFAULT_SECURITY_REALM

Example:

	server.setProperty(AgiAdmServer.PROP_DEFAULT_SECURITY_REALM, "NISPLUS");
	server.setProperty(AgiAdmServer.PROP_DEFAULT_SECURITY_AUTHORITY, "myserver/domain1");
 

PROP_RMI_LISTEN

public static final String PROP_RMI_LISTEN

The SilverStream server exports a "remote server object" via RMI/IIOP, so that non-SilverStream clients that want to call invoked business objects or, especially, EJBs on the SilverStream Server don't need to get an HTTP session on the server. This property is primarily used to shut this off.

Value type: Boolean. Default value: true, meaning the server will create the RMI object and accept RMI sessions. If set to false, the server will not create the RMI object and not accept RMI sessions.

PROP_ORB_KEY

public static final String PROP_ORB_KEY

The description of the ORB that the server is using. Value type: String The value of this property may be both set and retrieved.

PROP_SRV_NAMESERVICE_PORT

public static final String PROP_SRV_NAMESERVICE_PORT

The port of the nameservice that the server is using. Value type: Integer The value of this property may be both set and retrieved.

INFO_PORT_NUMBER

public static final String INFO_PORT_NUMBER

Port number. Value type: Integer. Usage: When getting an element of type AgiAdmServer.SERVER via the "info" argument of getElement.

INFO_DATABASE_NAME

public static final String INFO_DATABASE_NAME

Database name. getElement. Value type: String.

Usage: When getting an element of type AgiAdmDirectory or AgiAdmDesignElement via the "info" argument of

INFO_GROUP_NAME

public static final String INFO_GROUP_NAME

Group name. Value type: String.

Usage: When getting an element of type AgiAdmUserReference via the "info" argument of getElement.

GET_CERTS_CA

public static final int GET_CERTS_CA

A mask for the flags parameter of the getCertificates(int flags) method. Means "get the list of CA certificates". Can be or'ed with AgiAdmServer.GET_CERTS_SRV_DSA, AgiAdmServer.GET_CERTS_SRV_RSA.

GET_CERTS_SRV_DSA

public static final int GET_CERTS_SRV_DSA

A mask for the flags parameter of the getCertificates(int flags) method. Means "get the list of server DSA certificates". Can be or'ed with AgiAdmServer.GET_CERTS_CA, AgiAdmServer.GET_CERTS_SRV_RSA.

GET_CERTS_SRV_RSA

public static final int GET_CERTS_SRV_RSA

A mask for the flags parameter of the getCertificates(int flags) method. Means "get the list of server RSA certificates". Can be or'ed with AgiAdmServer.GET_CERTS_CA, AgiAdmServer.GET_CERTS_SRV_DSA.

PROP_FTS_NO_FULL_INDEX

public static final String PROP_FTS_NO_FULL_INDEX

Initial FullText Search criteria (true=partial re-index; false=full re-index). A full-text search property.

By default at startup time SilverStream Server marks all tables requiring full indexing, which means abandoning previous index data and re-indexing all data in the tables. Setting this property to true makes the server do partial indexing which leaves the previous index data and only picks up newly added rows in tables.

Value type: Boolean. Default value: true.

The value of this property may be both set and retrieved.

PROP_FTS_NO_INDEX_ON_SEARCH

public static final String PROP_FTS_NO_INDEX_ON_SEARCH

Ignore the index status of a table prior to a full-text search.

If this property is true, SilverStream will perform a full-text search on a table even if the table requires re-indexing due to updates. If this property is false, SilverStream will ensure that the table is re-indexed if necessary before doing the full-text search, so that the search result will be up-to-date.

This propery should only be set to true if there is an extremely large table that takes a long time to re-index, and there is a relatively large number of inserts into the table which affect the full-text search performance of the SilverStream Server.

Value type: Boolean. Default value: false.

The value of this property may be both set and retrieved.

PROP_FTS_INDEXER_TIME

public static final String PROP_FTS_INDEXER_TIME

FullText Indexer interval time in minutes. A full-text search property.

The indexer automatically updates the fulltext indices of modified tables periodically; this property controls the time between indexing rounds.

Value type: Integer. Default value: 20.

The value of this property may be both set and retrieved.

PROP_FTS_MAX_SEARCH_ROWS

public static final String PROP_FTS_MAX_SEARCH_ROWS

Maximum result row count for a FullText Search query. A full-text search property.

Value type: Integer. Default value: 1000.

The value of this property may be both set and retrieved.

GET_DSA_SUITES

public static final int GET_DSA_SUITES

A mask for the flags parameter of the getCipherSuites method. Means "get the list of cipher suites whose type is "DSA cipher suite". Can be or'ed with GET_RSA_SUITES and AgiAdmContainer.GET_CHILDREN_SORTED.

See Also:

AgiAdmServer.GET_RSA_SUITES

GET_RSA_SUITES

public static final int GET_RSA_SUITES

A mask for the flags parameter of the getCipherSuites method. Means "get the list of cipher suites whose type is "RSA cipher suite". Can be or'ed with GET_DSA_SUITES and AgiAdmContainer.GET_CHILDREN_SORTED.

See Also:

AgiAdmServer.GET_DSA_SUITES

Method Detail

isCompatible

public boolean isCompatible()
                     throws AgoUnrecoverableSystemException,
                            AgoSecurityException

Exchange version number information with the server. This is primarily a way to allow the server to check the protocol version being used by the client and to return a clean error status if the server doesn't support this client (the client could be either too old or too new).

Parameters:

none -

Returns:

boolean true if compatible, false if not

Example:

boolean compatible = server.isCompatible();

getDatabaseDriverList

public Enumeration getDatabaseDriverList()
                                  throws AgoUnrecoverableSystemException,
                                         AgoSecurityException

Enumerate the available database drivers.

Returns:

enumeration of Strings each of which is a driver name.

Example:

Enumeration e = server.getDatabaseDriverList();
 while (e.hasMoreElements())
 {
 	String driver = (String) e.nextElement();
 	// Do something with the driver name ...
 	// ...
 }
 

getJdbcDriverList

public Enumeration getJdbcDriverList()
                              throws AgoUnrecoverableSystemException,
                                     AgoSecurityException

Enumerate the available JDBC drivers.

Returns:

enumeration of Strings each of which is a JDBC driver name

Example:

Enumeration e = server.getJdbcDriverList();
 while (e.hasMoreElements())
 {
 	String jdbcDriver = (String) e.nextElement();
 	// Do something with the JDBC driver name...
 	// ...
 }
 

getLdsKeyList

public Enumeration getLdsKeyList()
                          throws AgoUnrecoverableSystemException,
                                 AgoSecurityException

Enumerate the LDS keys.

Returns:

enumeration of Strings each of which is an LDS key.

getDatabasePlatformList

public Enumeration getDatabasePlatformList()
                                    throws AgoUnrecoverableSystemException,
                                           AgoSecurityException

Enumerate the available database platforms.

Returns:

enumeration of AgiAdmDatabasePlatforms

Example:

Enumeration e = server.getDatabasePlatformList();
 while (e.hasMoreElements())
 {
 	AgiAdmDatabasePlatform dbpl = (AgiAdmDatabasePlatform) e.nextElement();
 	// Do something with the database platform information...
 	// ...
 }
 

See Also:

AgiAdmDatabasePlatform

getElement

public AgiAdmElementBase getElement(String name,
                                    String type,
                                    Hashtable info)
                             throws AgoUnrecoverableSystemException,
                                    AgoSecurityException

Create an object with the specified name and type. This method provides a shortcut for creating any new object on the server.

Parameters:

name - the name of the element

type - the type of the element

info - additional information

Returns:

AgiAdmElementBase a reference to the specified element

Usage:

When dealing with "well-known" directories, set both the name and the type to their element type, such as AgiAdmDirectory.FORMS or VIEWS etc.

For a list of element types to use with the type parameter, refer to this list:

• SERVER is the the server type of element (AgiAdmServer). NOTE: The SERVER type is provided here for completeness only. It is recommended that AgiAdmin.getServer be used instead.
• Design Element Types: AgiAdmDesignElement
• Directory Element Types: AgiAdmDirectory
• Database Element Types: AgiAdmDatabase
• Group Element Types: AgiAdmGroup
• User Element Types: AgiAdmUser
• CLUSTER_ENV is the the Cluster Environment type of a Load Balancing Container (AgiAdmLBClusterEnv)
• Load Balancing Element Types: AgiAdmLBElement
• Load Balancing Container Element Types: AgiAdmLBContainer

Use one the following with the info parameter:

• AgiAdmServer.INFO_PORT_NUMBER
• AgiAdmServer.INFO_DATABASE_NAME
• AgiAdmServer.INFO_GROUP_NAME

Example:

// Specify which database the element belongs to.
 Hashtable info = new Hashtable();
 info.put(AgiAdmServer.INFO_DATABASE_NAME, "myDatabase");
 // Get element.
 AgiAdmDesignElement myForm = (AgiAdmDesignElement) server.getElement(
 	"myform", AgiAdmDesignElement.FORM, info);
 

getCertificateObject

public AgiAdmCertificate getCertificateObject()

Deprecated. This method is deprecated as it does nothing useful.

Create a certificate object.

Returns:

a reference to the AgiAdmCertificate interface of the instantiated certificate object.

getMailAccountObject

public AgiAdmMailAccount getMailAccountObject()

Create a mail account object.

Returns:

a reference to the AgiAdmMailAccount interface of the instantiated mail account object

Example:

AgiAdmMailAccount acct = server.getMailAccountObject();
 

createAcl

public Acl createAcl()

Create an ACL object.

Returns:

a reference to Acl

Example:

Acl myacl = server.createAcl();
 

createAclEntry

public AclEntry createAclEntry()

Create an ACL Entry object.

Returns:

a reference to AclEntry

Example:

AclEntry myAclEntry = server.createAclEntry();
 

loginUser

public boolean loginUser()
                  throws AgoUnrecoverableSystemException,
                         AgoSecurityException

Allow a user to log on to the server.

Returns:

boolean: true if the user successfully logged in, false if the user canceled out of the login dialog.

Example:

if (server.loginUser())
 	System.out.println("User successfully logged in.");
 else
 	System.out.println("User canceled.");
 

logoutUser

public void logoutUser()
                throws AgoUnrecoverableSystemException,
                       AgoSecurityException

Allow a user to log out from the server.

Example:

server.logoutUser();
 

getMailAccounts

public Enumeration getMailAccounts()
                            throws AgoUnrecoverableSystemException,
                                   AgoSecurityException

Retrieve information about mail accounts.

Returns:

enumeration of AgiAdmMailAccounts

Example:

Enumeration e = server.getMailAccounts();
 while (e.hasMoreElements())
 {
 	AgiAdmMailAccount acct = (AgiAdmMailAccount) e.nextElement();
 	// Do something with the mail account info...
 	// ...
 }
 

See Also:

AgiAdmMailAccount

setMailAccounts

public void setMailAccounts(Enumeration accounts)
                     throws AgoUnrecoverableSystemException,
                            AgoSecurityException

Set up mail accounts. This can be used to create new accounts and delete existing ones.

Parameters:

accounts - an enumeration of AgiAdmMailAccounts

Example:

// a) Creating a set of new mail accounts.
 
 Vector v = new Vector();
 // Create a couple of mail accounts.
 AgiAdmMailAccount acct1 = server.getMailAccountObject();
 acct1.init(userName1, password1, mailServer1, port1);
 v.addElement(acct1);
 
 AgiAdmMailAccount acct2 = server.getMailAccountObject();
 acct2.init(userName2, password2, mailServer2, port2);
 v.addElement(acct2);
 
 // Set mail accounts.
 server.setMailAccounts(v.elements());
 // Send the changes to the server.
 server.saveChanges();
 
 // b) Changing existing mail accounts (e.g. changing the port in all of them).
 
 Vector v = new Vector();
 
 // Enumerate the existing mail accounts.
 Enumeration e = server.getMailAccounts();
 while (e.hasMoreElements())
 {
 	AgiAdmMailAccount acct = (AgiAdmMailAccount) e.nextElement();
 	// Change the port in each of the accounts.
 	acct.setPort(112);
 	v.addElement(acct);
 }
 // Set mail accounts.
 server.setMailAccounts(v.elements());
 // Send the changes to the server.
 server.saveChanges();
 

See Also:

AgiAdmMailAccount

getLicenses

public Enumeration getLicenses()
                        throws AgoUnrecoverableSystemException,
                               AgoSecurityException

Retrieve information about licenses from the server.

Returns:

enumeration of AgiAdmLicenses

Example:

Enumeration e = server.getLicenses();
 while (e.hasMoreElements())
 {
 	AgiAdmLicense license = (AgiAdmLicense) e.nextElement();
 	// Do something with the license info...
 	// ...
 }
 

See Also:

AgiAdmLicense

deleteLicense

public void deleteLicense(String license)
                   throws AgoUnrecoverableSystemException,
                          AgoSecurityException

Removes a license from the server.

Parameters:

license - the license key

Usage:

Use the AgiAdmServer.getLicenses() method to obtain an enumeration of the licenses that had been applied to the server; use the AgiAdmLicense.getSerialNumber() method to obtain the value to be used as the "license" parameter value.

Example:

// Get a license
 AgiAdmLicense license = ...;
 String licenseString = license.getLicenseString();
 server.deleteLicense(licenseString);
 server.saveChanges();
 

getCertificates

public Enumeration getCertificates()
                            throws AgoUnrecoverableSystemException,
                                   AgoSecurityException

Deprecated. Use AgiAdmServer.getCertificates(int flags) instead. Retrieve information about certificates from the server.

Returns:

enumeration of AgiAdmCertificate.

See Also:

AgiAdmCertificate

getCertificates

public Enumeration getCertificates(int flags)
                            throws AgoUnrecoverableSystemException,
                                   AgoSecurityException

Retrieve information about certificates from the server.

Returns:

enumeration of AgiAdmCertificates

See Also:

AgiAdmServer.addCertificate(String,String), AgiAdmServer.deleteCertificate(AgiAdmCertificate), AgiAdmCertificate

addCertificate

public void addCertificate(String sourceDirectory,
                           String sourceName)
                    throws AgoUnrecoverableSystemException,
                           AgoSecurityException

Add a certificate to the server.

Parameters:

sourceDirectory - the directory where the certificate file resides on the source machine

sourceName - the name of the certificate file

Example:

 server.addCertificate("d:\certs", "mycert.cer");
 

See Also:

AgiAdmServer.getCertificates(int), AgiAdmServer.deleteCertificate(AgiAdmCertificate), AgiAdmCertificate

deleteCertificate

public void deleteCertificate(AgiAdmCertificate cert)
                       throws AgoUnrecoverableSystemException,
                              AgoSecurityException

Delete a certificate from the server.

Parameters:

cert - the certificate to be deleted

Example:

 server.deleteCertificate(cert);
 

See Also:

AgiAdmServer.getCertificates(int), AgiAdmServer.addCertificate(String,String), AgiAdmCertificate

getSessions

public Enumeration getSessions()
                        throws AgoUnrecoverableSystemException,
                               AgoSecurityException

Enumerate sessions the server is currently maintaining.

Returns:

enumeration of AgiAdmSessions.

Example:

Enumeration sessions = server.getSessions();
 while (sessions.hasMoreElements())
 {
 	AgiAdmSession s = (AgiAdmSession) sessions.nextElement();
 	// Do something with the session info...
 	// ...
 }
 

See Also:

AgiAdmSession

getThreads

public Enumeration getThreads()
                       throws AgoUnrecoverableSystemException,
                              AgoSecurityException

Enumerate server threads.

Returns:

enumeration of AgiAdmThreads

Example:

Enumeration e = server.getThreads();
 while (e.hasMoreElements())
 {
 	AgiAdmThread th = (AgiAdmThread) e.nextElement();
 	// Do something with the thread info...
 	// ...
 }
 

See Also:

AgiAdmThread

getStatistics

public AgiAdmStatistics getStatistics()
                               throws AgoUnrecoverableSystemException,
                                      AgoSecurityException

Get server statistics.

Returns:

AgiAdmStatistics

Usage:

Currently, the client-side implementation of the API does not implement this method.

Example:

AgiAdmStatistics stats = server.getStatistics();

See Also:

AgiAdmStatistics

shutdown

public void shutdown(boolean restart,
                     String[][] options)
              throws AgoUnrecoverableSystemException,
                     AgoSecurityException

Shut down the server. Restart if "restart" is true.

Parameters:

restart - "true" means restart the server, "false" means shut it down

options - restart options (currently, no options for either shutdown or restart are available; this parameter is for future use)

Example:

// a) shutdown
 server.shutdown(false, null);
 // b) restart
 server.shutdown(true, null);
 

shutdown

public void shutdown(boolean deactivate,
                     boolean restart,
                     String[][] options)
              throws AgoUnrecoverableSystemException,
                     AgoSecurityException

Shut down the server. Restart if "restart" is true. If the parameter "deactivate" is true, wait until the server has become inactive before shutting the server down.

Parameters:

deactivate - "true" means wait until the server is inactive, "false" means shut it down now

restart - "true" means restart the server, "false" means shut it down

options - restart options (currently, no options for either shutdown or restart are available; this parameter is for future use)

deactivate

public void deactivate()
                throws AgoUnrecoverableSystemException,
                       AgoSecurityException

Deactivate the server, preventing any future client sessions from being established.

getBuildDescription

public String getBuildDescription()
                           throws AgoUnrecoverableSystemException,
                                  AgoSecurityException

Get the description of the server build.

Returns:

a String describing the server build

Example:

String descr = server.getBuildDescription();

getDispatcherGroups

public Enumeration getDispatcherGroups()
                                throws AgoUnrecoverableSystemException,
                                       AgoSecurityException

Get the list of available Dispatcher Groups.

Returns:

an enumeration of AgiAdmLBContainers whose type is AgiAdmLBContainer.DISP_GROUP.

Example:

Enumeration e = server.getDispatcherGroups();
 while (e.hasMoreElements())
 {
 	AgiAdmLBContainer dg = (AgiAdmLBContainer) e.nextElement();
 	// Do something with the dispatcher group...
 	// ...
 }

See Also:

AgiAdmLBContainer

getCacheManagerGroups

public Enumeration getCacheManagerGroups()
                                  throws AgoUnrecoverableSystemException,
                                         AgoSecurityException

Get the list of available Cache Manager Groups.

Returns:

an enumeration of AgiAdmLBContainers whose type is AgiAdmLBContainer.CACHE_MGR_GROUP.

Example:

Enumeration cmgroups = server.getCacheManagerGroups();
 while (cmgroups.hasMoreElements())
 {
 	// Get to a single cache manager group.
 	AgiAdmLBContainer cmgrp = (AgiAdmLBContainer) cmgroups.nextElement();
 	// Do something with the cache manager group...
 	// ...
 }

See Also:

AgiAdmLBContainer

getLoadManagerGroups

public Enumeration getLoadManagerGroups()
                                 throws AgoUnrecoverableSystemException,
                                        AgoSecurityException

Get the list of available Load Manager Groups.

Returns:

an enumeration of AgiAdmLBContainers whose type is AgiAdmLBContainer.LOAD_MGR_GROUP.

Example:

Enumeration e = server.getLoadManagerGroups();
 while (e.hasMoreElements())
 {
 	AgiAdmLBContainer lmg = (AgiAdmLBContainer) e.nextElement();
 	// Do something with the Load Manager Group...
 	// ...
 }
 

See Also:

AgiAdmLBContainer

getClusters

public Enumeration getClusters()
                        throws AgoUnrecoverableSystemException,
                               AgoSecurityException

Get the list of available Clusters.

Returns:

an enumeration of AgiAdmLBContainers whose type is AgiAdmLBContainer.CLUSTER.

Example:

Enumeration e = getClusters();
 while (e.hasMoreElements())
 {
 	AgiAdmLBContainer cluster = (AgiAdmLBContainer) e.nextElement();
 	// Do something with the cluster...
 	// ...
 }
 

See Also:

AgiAdmLBContainer

deleteIdleDatabaseConnections

public void deleteIdleDatabaseConnections()
                                   throws AgoUnrecoverableSystemException,
                                          AgoSecurityException

Terminate all the idle database connections.

Example:

server.deleteIdleDatabaseConnections();

getOrbKeyList

public Enumeration getOrbKeyList()
                          throws AgoUnrecoverableSystemException,
                                 AgoSecurityException

Enumerate the available ORBs.

Returns:

enumeration of Strings each of which is an ORB key

getOrbDisplayNameList

public Enumeration getOrbDisplayNameList()
                                  throws AgoUnrecoverableSystemException,
                                         AgoSecurityException

Enumerate the available ORBs.

Returns:

enumeration of Strings each of which is a display name of an ORB.

isAlive

public boolean isAlive(boolean force)
                throws AgoUnrecoverableSystemException,
                       AgoSecurityException

Return true if the server is alive, false otherwise. If this method is invoked in client-side code, then if the 'force' flag is supplied, the method forces an immediate 'ping' of the server (which may require a long timeout if the server is down); otherwise, the method depends on the last client heartbeat ping. If the method is invoked in the server- side code, it simply returns true; it is presumed the server is alive.

Parameters:

force - True to force an immediate ping of the server

Returns:

True if the server is up, false otherwise

getCipherSuites

public Enumeration getCipherSuites(int flags)
                            throws AgoUnrecoverableSystemException,
                                   AgoSecurityException

Enumerate available/supported cipher suites.

Parameters:

flags - specifies the type(s) of cipher suites to get, see GET_DSA_SUITES and GET_RSA_SUITES. These flags can be or'ed together.

Returns:

Enumeration of AgiAdmCipherSuites.

Usage:

In addition to GET_DSA_SUITES and GET_RSA_SUITES, you can use the AgiAdmContainer.GET_CHILDREN_SORTED flag if you want the results to be sorted by cipher suite name.

See also AgiAdmCipherSuite

Example:

	AgiAdmServer server = AgAdmin.getServer("localhost", -1);
	Enumeration suites = server.getCipherSuites(
		AgiAdmServer.GET_DSA_SUITES | AgiAdmServer.GET_RSA_SUITES);
	while(suites.hasMoreElements()) {
		AgiAdmCipherSuite suite = (AgiAdmCipherSuite)suites.nextElement();
		System.out.println("Name: " + cp.getName());
		System.out.println("Type: " + cp.getType());
	}
 

setCipherSuites

public void setCipherSuites(Enumeration suites)
                     throws AgoUnrecoverableSystemException,
                            AgoSecurityException

Set the state (enabled or disabled) of the specified cipher suites.

Parameters:

suites - an Enumeration of AgiAdmCipherSuites

Usage:

The passed in cipher suites may be of different types, DSA or RSA. They may be disabled or enabled; the server will disable or enable them according to their state specified in AgiAdmCipherSuite's.

If only some of all the available cipher suites are passed in, the server will merge the complete list with the list supplied via this method, and the states specified in 'suites' will take effect for the specified suites.

Example:

 Vector suites = ...
 server.setCipherSuites(suites.elements());
 

resetMinMaxDatabaseConnections

public void resetMinMaxDatabaseConnections(boolean min,
                                           boolean max,
                                           boolean sysmin,
                                           boolean sysmax,
                                           AgiAdmDatabase database)
                                    throws AgoUnrecoverableSystemException,
                                           AgoSecurityException

Reset the values of minimum and/or maximum database connections for one database or for all databases on the server.

Parameters:

min - whether to reset the minimum

max - whether to reset the maximum

sysmin - whether to reset the minimum for the shadow database (if there is a shadow database, that is, a different database where the SilverStream system tables are stored)

sysmax - whether to reset the maximum for the shadow database (if there is a shadow database)

database - a specific database to do the reset on; if null, then all the databases on the server will have the reset done on them

Example:

 // Reset the min and max for all databases on the server
 server.resetMinMaxDatabaseConnections(true, true, false, false,
   null);

 // Reset the min and max for a specific database and its
 // shadow database, where the system tables are
 // stored
 server.resetMinMaxDatabaseConnections(true, true, true, true,
   myDB);