com.crystaldecisions.sdk.plugin.desktop.connection
Interface IConnectionBase

All Known Subinterfaces:

IConnection

public interface IConnectionBase

This interface allows you to access general connection information. Each time a user logs on to the CMS server a Connection info object is created. This object allows you to view the metrics for each active connection to an CMS server. The properties provide general authentication, logon, access and user information. Once the user logs off the CMS the IConnection object is destroyed.

Field Summary

static java.lang.String	KIND The Kind used to query for Connection objects.
static java.lang.String	PROGID The ProgID for the Connection Class.

Method Summary

java.lang.String	getApsName() Deprecated. should use IConnectionBase.getCMSName() instead
java.lang.String	getAuthenticationMethod() Returns the authentication method used to logon.
java.lang.String	getCMSName() Returns the name of the CMS server this user is connected to.
int	getFailedLogonCount() Returns the number of failed logon attempts since the last successful logon.
java.util.Date	getLastAccess() Deprecated. Functionality does not exist, use IConnectionBase.getLastLogon() instead
java.util.Date	getLastLogon() Returns the last date and time this user connected to the CMS.
java.lang.String	getUserAlias() Returns the user alias.
java.lang.String	getUserID() Returns the user ID.

Field Detail

KIND

static final java.lang.String KIND

The Kind used to query for Connection objects.

See Also:

Constant Field Values

PROGID

static final java.lang.String PROGID

The ProgID for the Connection Class.

ProgID	CrystalEnterprise.Connection
Query Category	CI_SYSTEMOBJECTS
Associated Interface	com.crystaldecisions.sdk.plugin.desktop.connection.IConnection

Query syntax:

SELECT
	SI_APSNAME, SI_AUTHEN_METHOD, SI_FAILEDLOGONCOUNT, SI_LAST_ACCESS, SI_LASTLOGONTIME, SI_LOGON_ALIAS, SI_USERID
FROM
	CI_SYSTEMOBJECTS
WHERE
	SI_PROGID='CrystalEnterprise.Connection'

The CePropertyIDs named in the SELECT statement are those that are required to access data through the IConnection interface. For more information on their associations with the interface's methods, see IConnection

See Also:

Constant Field Values

Method Detail

getUserAlias

java.lang.String getUserAlias()

Returns the user alias.

Returns:

A String containing the user alias.

InfoObject properties to query for:

SI_LOGON_ALIAS

getUserID

java.lang.String getUserID()

Returns the user ID.

Returns:

A String containing the user ID.

InfoObject properties to query for:

SI_USERID

getCMSName

java.lang.String getCMSName()

Returns the name of the CMS server this user is connected to.

Returns:

A String containing the name of the CMS server.

InfoObject properties to query for:

SI_APSNAME

getApsName

java.lang.String getApsName()

Deprecated. should use IConnectionBase.getCMSName() instead

Returns:

InfoObject properties to query for:

SI_APSNAME

getLastAccess

java.util.Date getLastAccess()

Deprecated. Functionality does not exist, use IConnectionBase.getLastLogon() instead

Returns the last date and time that this user accessed the CMS server.

Returns:

A Date object containing the last date and time that this user accessed the CMS server.

InfoObject properties to query for:

SI_LAST_ACCESS

getLastLogon

java.util.Date getLastLogon()

Returns the last date and time this user connected to the CMS.

Returns:

A Date object containing the last date and time this user connected to the CMS.

InfoObject properties to query for:

SI_LASTLOGONTIME

getFailedLogonCount

int getFailedLogonCount()

Returns the number of failed logon attempts since the last successful logon.

Returns:

An int specifying the number of failed logon attempts since the last successful logon.

InfoObject properties to query for:

SI_FAILEDLOGONCOUNT

getAuthenticationMethod

java.lang.String getAuthenticationMethod()

Returns the authentication method used to logon.

Returns:

A String specifying the authentication method used to logon. For example, secEnterprise or secLDAP.

InfoObject properties to query for:

SI_AUTHEN_METHOD