SilverStream
Application Server 3.5

com.sssw.rts.adminapi
Interface AgiAdmCluster

All Superinterfaces:
AgiAdmChanges, AgiAdmContainerBase, AgiAdmElement, AgiAdmElementBase, AgiAdmLBContainer, AgiAdmLBElement, AgiAdmPropertyBag

public interface AgiAdmCluster
extends AgiAdmLBContainer, AgiAdmElement

Objects implementing this interface represent SilverStream clusters of servers.


Field Summary
static String CLUSTER
          The Cluster type of load balancing container object.
static String PROP_ALLOW_USER_SELF_MOD
          This property determines whether a user can modify their own user attributes (pasword, full name, description, etc).
static String PROP_CLIENT_CERT_LEVEL
          The "Client Certificate level in HTTPS" property.
static String PROP_CMGR_RECONNECT_SLEEP_INTERVAL
          The sleep interval between series of attempts to make contact with SilverStream Cache Manager.
static String PROP_CMGR_RECONNECT_TRY_COUNT
          The number of series of attempts to make contact with SilverStream Cache Manager.
static String PROP_CMGR_START_SLEEP_INTERVAL
          The sleep interval between attempts to make contact with SilverStream Cache Manager.
static String PROP_CMGR_START_TRY_COUNT
          The number of attempts to make contact with SilverStream Cache Manager.
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
          The property for DSA cipher suites.
static String PROP_ENABLEAUTHENTICATION
          Name of the property indicating whether authorization for incomming requests should be required.
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_IGNORE_CERTIFICATE_SECURITY
          Tells the server to ignore the Certificate users security realm if the value is set to Boolean.TRUE.
static String PROP_IGNORE_LDAP_SECURITY
          Tells the server to ignore the LDAP security realm if the value is set to Boolean.TRUE.
static String PROP_IGNORE_NIS_SECURITY
          Tells the server to ignore the NIS+ security realm if the value is set to Boolean.TRUE.
static String PROP_IGNORE_NT_SECURITY
          Tells the server to ignore the Windows NT security realm if the value is set to Boolean.TRUE.
static String PROP_IGNORE_SILVER_SECURITY
          Tells the server to ignore the SilverStream security realm if the value is set to Boolean.TRUE.
static String PROP_LB_CONNECT_SLEEP_COUNT
          The number of series of attempts to make contact with SilverStream Load Balancer.
static String PROP_LB_CONNECT_SLEEP_INTERVAL
          The sleep interval between series of attempts to make contact with SilverStream Load Balancer.
static String PROP_LB_CONNECT_TRY_COUNT
          The number of attempts to make contact with SilverStream Load Balancer.
static String PROP_LB_CONNECT_TRY_INTERVAL
          The interval between attempts to make contact SilverStream Load Balancer.
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
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_MAILCHECKFREQUENCY
          The time interval for the mail server to check for incoming mail messages.
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 servers in the cluster are using.
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
          The property for RSA cipher suites.
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.
 
Fields inherited from interface com.sssw.rts.adminapi.AgiAdmLBContainer
CACHE_MGR_GROUP, CLUSTER, DISP_GROUP, LOAD_MGR_GROUP, PROP_DATE_CREATED, PROP_DATE_LASTMOD, PROP_DISP_GROUP_ID
 
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.AgiAdmLBElement
CACHE_MGR, CLUSTER_SERVER, DISPATCHER, LOAD_MGR, PROP_HOST, PROP_HTTP_PORT, PROP_HTTPS_PORT_DSA, PROP_HTTPS_PORT_RSA, PROP_ID, PROP_OLD_HOST, PROP_OLD_PORT, PROP_PORT, PROP_WEIGHT
 
Fields inherited from interface com.sssw.rts.adminapi.AgiAdmContainerBase
GET_CHILDREN_DFLT
 
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
 

Field Detail

CLUSTER

public static final String CLUSTER
The Cluster type of load balancing container object.

PROP_ALLOW_USER_SELF_MOD

public static final String PROP_ALLOW_USER_SELF_MOD
This property 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.

Value type: Boolean. Default value: true

This property is read/write on the cluster level and read-only on the cluster server level.

See Also:
AgiAdmServer.PROP_ALLOW_USER_SELF_MOD

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.

Value type: Integer. Default value: 0.

This property is read/write on the cluster level and read-only on the cluster server level.

See Also:
AgiAdmServer.PROP_CLIENT_CERT_LEVEL

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.

This property is read/write on the cluster level and read-only on the cluster server level.

See Also:
AgiAdmCluster.PROP_DEFAULT_SECURITY_REALM, AgiAdmCluster.PROP_CLIENT_CERT_LEVEL

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.

This property is read/write on the cluster level and read-only on the cluster server level.

See Also:
AgiAdmCluster.PROP_DEFAULT_SECURITY_AUTHORITY

PROP_DISABLE_DIR_LISTING

public static final String PROP_DISABLE_DIR_LISTING
Tells whether to disable HTML directory listings.

Value type: Boolean. Default value: false.

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.

This property is read/write on the cluster level and read-only on the cluster server level.

See Also:
AgiAdmServer.PROP_DISABLE_DIR_LISTING

PROP_DSA_SUITES

public static final String PROP_DSA_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 ('|').

This property is read/write on the cluster level and read-only on the cluster server level.

For more information, see the documentation on cipher suites in the Administrator's Guide.

See Also:
AgiAdmServer.PROP_DSA_SUITES

PROP_ENABLEAUTHENTICATION

public static final String PROP_ENABLEAUTHENTICATION
Name of the property indicating whether authorization for incomming requests should be required.

Value type: Boolean.

This property is read/write on the cluster level and read-only on the cluster server level.

See Also:
AgiAdmServer.PROP_ENABLEAUTHENTICATION

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 Boolean.TRUE.

Value type: Boolean.

This property is read/write on the cluster level and read-only on the cluster server level.

See Also:
AgiAdmServer.PROP_IGNORE_CERTIFICATE_SECURITY

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 Boolean.TRUE.

Value type: Boolean.

This property is read/write on the cluster level and read-only on the cluster server level.

See Also:
AgiAdmServer.PROP_IGNORE_LDAP_SECURITY

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 Boolean.TRUE.

Value type: Boolean.

This property is read/write on the cluster level and read-only on the cluster server level.

See Also:
AgiAdmServer.PROP_IGNORE_NIS_SECURITY

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 Boolean.TRUE.

Value type: Boolean.

This property is read/write on the cluster level and read-only on the cluster server level.

See Also:
AgiAdmServer.PROP_IGNORE_NT_SECURITY

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 Boolean.TRUE.

Value type: Boolean.

This property is read/write on the cluster level and read-only on the cluster server level.

See Also:
AgiAdmServer.PROP_IGNORE_SILVER_SECURITY

PROP_LDAP_SERVERS

public static final String PROP_LDAP_SERVERS
Lists the LDAP servers that the SilverStream server knows about.

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

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

This property is read/write on the cluster level and read-only on the cluster server level.

See Also:
AgiAdmServer.PROP_LDAP_SERVERS

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.

This property is read/write on the cluster level and read-only on the cluster server level.

See Also:
AgiAdmServer.PROP_MAILCHECKFREQUENCY

PROP_NISPLUS_SERVERS

public static final String PROP_NISPLUS_SERVERS
Lists the NIS+ servers that the SilverStream server knows about.

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

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

This property is read/write on the cluster level and read-only on the cluster server level.

See Also:
AgiAdmServer.PROP_NISPLUS_SERVERS

PROP_REQUEST_TIMEOUT

public static final String PROP_REQUEST_TIMEOUT
The timeout on an individual server request.

Value type: Integer.

This property is read/write on the cluster level and read-only on the cluster server level.

See Also:
AgiAdmServer.PROP_REQUEST_TIMEOUT

PROP_RSA_SUITES

public static final String PROP_RSA_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 ('|').

This property is read/write on the cluster level and read-only on the cluster server level.

For more information, see the documentation on cipher suites in the Administrator's Guide.

See Also:
AgiAdmServer.PROP_RSA_SUITES

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.

Value type: Integer. Default value: 900 seconds = 15 minutes

This property is read/write on the cluster level and read-only on the cluster server level.

See Also:
AgiAdmServer.PROP_SECURITY_RESOURCE_TIMEOUT

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.

Value type: Integer. Default value: 300000 milliseconds.

This property is read/write on the cluster level and read-only on the cluster server level.

See Also:
AgiAdmServer.PROP_SESSION_TIMEOUT

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.

Value type: Boolean. default value: true

This property is read/write on the cluster level and read-only on the cluster server level.

See Also:
AgiAdmServer.PROP_SET_LOCKSMITH_ENABLED

PROP_LB_CONNECT_SLEEP_INTERVAL

public static final String PROP_LB_CONNECT_SLEEP_INTERVAL
The sleep interval between series of attempts to make contact with SilverStream Load Balancer.

Value type: Integer. Default value: 10 seconds

Usage: setProperty, getProperty

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.


PROP_LB_CONNECT_SLEEP_COUNT

public static final String PROP_LB_CONNECT_SLEEP_COUNT
The number of series of attempts to make contact with SilverStream Load Balancer.

Value type: Integer. Default value: 10 seconds

Usage: setProperty, getProperty

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.


PROP_LB_CONNECT_TRY_INTERVAL

public static final String PROP_LB_CONNECT_TRY_INTERVAL
The interval between attempts to make contact SilverStream Load Balancer.

Value type: Integer. Default value: 30 seconds

Usage: setProperty, getProperty

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.


PROP_LB_CONNECT_TRY_COUNT

public static final String PROP_LB_CONNECT_TRY_COUNT
The number of attempts to make contact with SilverStream Load Balancer.

Value type: Integer. Default value: 10 seconds

Usage: setProperty, getProperty

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.


PROP_CMGR_RECONNECT_SLEEP_INTERVAL

public static final String PROP_CMGR_RECONNECT_SLEEP_INTERVAL
The sleep interval between series of attempts to make contact with SilverStream Cache Manager.

Value type: Integer. Default value: 10 seconds

Usage: setProperty, getProperty

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.


PROP_CMGR_RECONNECT_TRY_COUNT

public static final String PROP_CMGR_RECONNECT_TRY_COUNT
The number of series of attempts to make contact with SilverStream Cache Manager.

Value type: Integer. Default value: 10 seconds

Usage: setProperty, getProperty

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.


PROP_CMGR_START_SLEEP_INTERVAL

public static final String PROP_CMGR_START_SLEEP_INTERVAL
The sleep interval between attempts to make contact with SilverStream Cache Manager.

Value type: Integer. Default value: 30 seconds

Usage: setProperty, getProperty

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.


PROP_CMGR_START_TRY_COUNT

public static final String PROP_CMGR_START_TRY_COUNT
The number of attempts to make contact with SilverStream Cache Manager.

Value type: Integer. Default value: 10 seconds

Usage: setProperty, getProperty

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.


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.


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.


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.


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.

The list of additional attributes may be:


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.


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.


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.


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.


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. The list of additional attributes may be:


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.


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 AgiAdmCluster.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.


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:
AgiAdmCluster.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, i.e. its value may be set but not retrieved.

See Also:
AgiAdmCluster.PROP_LDAP_CONNECTION_USER

PROP_ORB_KEY

public static final String PROP_ORB_KEY
The description of the ORB that the servers in the cluster are using.

Value type: String

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


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 servers in the cluster will create the RMI object and accept RMI sessions. If set to false, the servers will not create the RMI object and not accept RMI sessions.


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, that means abandoning previous index data and re-indexing all data in the tables. Setting this property to true makes the servers in the cluster 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.


SilverStream
Application Server 3.5