Overview

Package

Class

Tree

Serialized

Deprecated

Index

Help

PREV class NEXT class

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.lotus.cs
Class SametimeService

java.lang.Object
  com.lotus.cs.SametimeService

All Implemented Interfaces:

CSBaseService

public class SametimeService

extends java.lang.Object

implements CSBaseService

Field Summary
static java.lang.String	DEFAULT_RECONNECT
static java.lang.String	DEFAULT_TIMEOUT
static java.lang.String	ST_PROP_AUTHOR_SEP
static java.lang.String	ST_PROP_INIT_class
static java.lang.String	ST_PROP_NAME_FORMAT
static java.lang.String	ST_PROP_NAME_SEP
static java.lang.String	ST_PROP_RECONNECT
static java.lang.String	ST_PROP_SERVERAPPPORT copyright statement
static java.lang.String	ST_PROP_TIMEOUT
static java.lang.String	ST_PROP_USE_LTPA
static java.lang.String	ST_PROP_WATCHNAME_FORMAT

Method Summary
void	cleanup() Always call the cleanup() method when finished with the Service object.
java.lang.String	getAuthorSeparator()
java.lang.String	getDefaultReconnect() Returns the internal default Sametime reconnect interval (in seconds), which is how often to attempt to reconnect to the Sametime server after being disconnected, or not connected.
java.lang.String	getDefaultTimeout() Returns the internal default Sametime timeout value (in seconds), which is the maximum amount of time to wait for a response from the Sametime server.
java.lang.String	getFullURL() Returns the Sametime server full URL, ie.
java.lang.String	getInitClass() Returns the class name to be used to obtain information for logging into ST, such as username, key, isToken, and whether ST enabled for this person.
java.lang.String	getNameFormat() Returns the name format to use when resolving the WPS logged in user with the Sametime server.
java.lang.String	getNameSeparator() Returns the character to use to separate distinguished names.
java.lang.String	getPort() Returns the Sametime server port
java.lang.String	getProtocol() Returns the Sametime server protocol
java.lang.String	getReconnect() Returns the Sametime reconnect interval (in seconds), which is how often to attempt to reconnect to the Sametime server after being disconnected, or not connected.
int	getReconnectValue() Returns the Sametime reconnect interval (in milliseconds as an integer), which is how often to attempt to reconnect to the Sametime server after being disconnected, or not connected.
java.lang.String	getServer() Returns the Sametime server hostname, ie.
java.lang.String	getServerappPort() Returns the Sametime server app port, which is the port that the ST server app should connect through.
java.lang.String	getTimeout() Returns the Sametime timeout value (in seconds), which is the maximum amount of time to wait for a response from the Sametime server.
int	getTimeoutValue() Returns the Sametime timeout value (in milliseconds as an integer), which is the maximum amount of time to wait for a response from the Sametime server.
java.lang.String	getUseLTPAToken() Returns whether to use the LTPA token for logging into Sametime from the browser.
java.lang.String	getVersion() Returns the Sametime server version
java.lang.String	getWatchNameFormat() Returns the watchNameFormat.
void	init(CSCredentials cred, java.lang.String server, java.lang.String protocol) Do not call the init() method.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ST_PROP_SERVERAPPPORT

public static final java.lang.String ST_PROP_SERVERAPPPORT

copyright statement

See Also:

Constant Field Values

ST_PROP_RECONNECT

public static final java.lang.String ST_PROP_RECONNECT

See Also:

Constant Field Values

ST_PROP_TIMEOUT

public static final java.lang.String ST_PROP_TIMEOUT

See Also:

Constant Field Values

ST_PROP_NAME_FORMAT

public static final java.lang.String ST_PROP_NAME_FORMAT

See Also:

Constant Field Values

ST_PROP_NAME_SEP

public static final java.lang.String ST_PROP_NAME_SEP

See Also:

Constant Field Values

ST_PROP_AUTHOR_SEP

public static final java.lang.String ST_PROP_AUTHOR_SEP

See Also:

Constant Field Values

ST_PROP_USE_LTPA

public static final java.lang.String ST_PROP_USE_LTPA

See Also:

Constant Field Values

ST_PROP_INIT_class

public static final java.lang.String ST_PROP_INIT_class

See Also:

Constant Field Values

ST_PROP_WATCHNAME_FORMAT

public static final java.lang.String ST_PROP_WATCHNAME_FORMAT

See Also:

Constant Field Values

DEFAULT_TIMEOUT

public static final java.lang.String DEFAULT_TIMEOUT

See Also:

Constant Field Values

DEFAULT_RECONNECT

public static final java.lang.String DEFAULT_RECONNECT

See Also:

Constant Field Values

Method Detail

init

public void init(CSCredentials cred,
                 java.lang.String server,
                 java.lang.String protocol)

Do not call the init() method. init is called internally by CSFactory as part of the getService.

Specified by:

init in interface CSBaseService

See Also:

CSBaseService.init(com.lotus.cs.CSCredentials, java.lang.String, java.lang.String)

cleanup

public void cleanup()

Always call the cleanup() method when finished with the Service object.

Specified by:

cleanup in interface CSBaseService

See Also:

CSBaseService.cleanup()

getServer

public java.lang.String getServer()

Returns the Sametime server hostname, ie. my.server.com

Returns:

server name

getVersion

public java.lang.String getVersion()

Returns the Sametime server version

Returns:

version

getProtocol

public java.lang.String getProtocol()

Returns the Sametime server protocol

Returns:

protocol

getFullURL

public java.lang.String getFullURL()

Returns the Sametime server full URL, ie. http://my.server.com:80

Returns:

url

getPort

public java.lang.String getPort()

Returns the Sametime server port

Returns:

port

getServerappPort

public java.lang.String getServerappPort()

Returns the Sametime server app port, which is the port that the ST server app should connect through. The default connection is configured to connect through the Sametime mux. If you want to connect directly to the server, set the port explicitly in CSEnvironment.properties. Note: this setting pertains to the server-to-server connection between the portal server and the ST server. This connection exists for the sole purpose of obtaining Sametime tokens for users. These tokens are then used to log users into Sametime from their web browsers.

Returns:

serverappPort

getReconnect

public java.lang.String getReconnect()

Returns the Sametime reconnect interval (in seconds), which is how often to attempt to reconnect to the Sametime server after being disconnected, or not connected. 0 indicates that we should not attempt to reconnect. If not set, an internal default is used. Returns null if a value was not specified in the CSEnvironment.properties file. Note: this setting pertains to the server-to-server connection between the portal server and the ST server. This connection exists for the sole purpose of obtaining Sametime tokens for users. These tokens are then used to log users into Sametime from their web browsers.

Returns:

reconnect

See Also:

getDefaultReconnect(), getReconnectValue()

getTimeout

public java.lang.String getTimeout()

Returns the Sametime timeout value (in seconds), which is the maximum amount of time to wait for a response from the Sametime server. If not set, an internal default is used. Returns null if a value was not specified in the CSEnvironment.properties file. Note: this setting pertains to the server-to-server connection between the portal server and the ST server. This connection exists for the sole purpose of obtaining Sametime tokens for users. These tokens are then used to log users into Sametime from their web browsers.

Returns:

timeout

See Also:

getDefaultTimeout(), getTimeoutValue()

getNameFormat

public java.lang.String getNameFormat()

Returns the name format to use when resolving the WPS logged in user with the Sametime server. Valid values are cn/dn/loginName Note: this setting pertains to the server-to-server connection between the portal server and the ST server. This connection exists for the sole purpose of obtaining Sametime tokens for users. These tokens are then used to log users into Sametime from their web browsers.

Returns:

nameFormat

getNameSeparator

public java.lang.String getNameSeparator()

Returns the character to use to separate distinguished names. This character will be used when resolving names with the Sametime server, and also for the name used to login to Sametime from the browser. Valid values are the single character comma (,) or slash (/) Note: this setting pertains to the server-to-server connection between the portal server and the ST server. This connection exists for the sole purpose of obtaining Sametime tokens for users. These tokens are then used to log users into Sametime from their web browsers.

Returns:

nameSeparator

getAuthorSeparator

public java.lang.String getAuthorSeparator()

getUseLTPAToken

public java.lang.String getUseLTPAToken()

Returns whether to use the LTPA token for logging into Sametime from the browser. If the CS_SERVER_CUSTOM_CRED is enabled and the ssoTokenAttrib is specified, it will be used instead of the LTPA token. By default an internal Sametime token is used. This option should only be turned on if your Sametime server supports tokens produced by the portal server.

Returns:

"true", or "false"

getInitClass

public java.lang.String getInitClass()

Returns the class name to be used to obtain information for logging into ST, such as username, key, isToken, and whether ST enabled for this person.

Returns:

classname

getWatchNameFormat

public java.lang.String getWatchNameFormat()

Returns the watchNameFormat. This is the setting that tells the person tag what name format to send to ST Sametime. If the Sametime server is configured to accept only the name format email or dn, specify email or dn as the value. If the server is configured to accept cn, this setting is unnecessary. Default is to use the common name (cn). CS_SERVER_SAMETIME_1.watchnameformat=[email,dn]

Returns:

watchNameFormat

getDefaultTimeout

public java.lang.String getDefaultTimeout()

Returns the internal default Sametime timeout value (in seconds), which is the maximum amount of time to wait for a response from the Sametime server. This value is used only if the timeout is not specified in the CSEnvironment.properties file. Note: this setting pertains to the server-to-server connection between the portal server and the ST server. This connection exists for the sole purpose of obtaining Sametime tokens for users. These tokens are then used to log users into Sametime from their web browsers.

Returns:

default timeout

See Also:

getTimeout(), getTimeoutValue()

getTimeoutValue

public int getTimeoutValue()

Returns the Sametime timeout value (in milliseconds as an integer), which is the maximum amount of time to wait for a response from the Sametime server. This value is calculated using the timeout specified in the CSEnvironment.properties file, or the default timout if not specified, and converted into the number of milliseconds as an integer. This value can then be used directly by portlets that require a time length in that format. This is the recommended API for portlets to use to obtain the timeout value. Note: this setting pertains to the server-to-server connection between the portal server and the ST server. This connection exists for the sole purpose of obtaining Sametime tokens for users. These tokens are then used to log users into Sametime from their web browsers.

Returns:

the actual timeout used, in milliseconds

See Also:

getTimeout(), getDefaultTimeout()

getDefaultReconnect

public java.lang.String getDefaultReconnect()

Returns the internal default Sametime reconnect interval (in seconds), which is how often to attempt to reconnect to the Sametime server after being disconnected, or not connected. This value is used only if the reconnect is not specified in the CSEnvironment.properties file. Note: this setting pertains to the server-to-server connection between the portal server and the ST server. This connection exists for the sole purpose of obtaining Sametime tokens for users. These tokens are then used to log users into Sametime from their web browsers.

Returns:

default reconnect

See Also:

getReconnect(), getReconnectValue()

getReconnectValue

public int getReconnectValue()

Returns the Sametime reconnect interval (in milliseconds as an integer), which is how often to attempt to reconnect to the Sametime server after being disconnected, or not connected. 0 indicates that we should not attempt to reconnect. This value is calculated using the reconnect interval specified in the CSEnvironment.properties file, or the default reconnect interval if not specified, and converted into the number of milliseconds as an integer. This value can then be used directly by portlets that require a time length in that format. This is the recommended API for portlets to use to obtain the reconnect value. Note: this setting pertains to the server-to-server connection between the portal server and the ST server. This connection exists for the sole purpose of obtaining Sametime tokens for users. These tokens are then used to log users into Sametime from their web browsers.

Returns:

the actual reconnect used, in milliseconds

See Also:

getReconnect(), getDefaultReconnect()