com.businessobjects.enterprise.connection
Interface Connection

All Superinterfaces:

InfoObject

public interface Connection
extends InfoObject

Views the metrics for each existing active connection to a Central Management Server.

The Connection class allows you to view the metrics for each existing active connection to an CMS server. Its properties provide general authentication, logon, access, and user 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 Connection object is destroyed.

Note: This object cannot be imported or exported.

Nested Class Summary

static class

Connection.Factory A class with methods for creating instances of the Connection type.

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

CollateralIds	addNewCollateralIds() Appends and returns a new empty CollateralIds object as the last element of the array.
CustomProperties	addNewCustomProperties() Appends and returns a new empty CustomProperties object as the last element of the array.
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.
CollateralIds	getCollateralIds() Returns the collection of collateral IDs associated with this connection.
boolean	getConcurrent() Internal Use Only.
CustomProperties	getCustomProperties() Returns the custom properties.
int	getFailedLogonCount() Returns the number of failed logon attempts since the last successful logon.
java.lang.String	getFailoverToken() Returns the failover token.
java.util.Calendar	getLastAccess() Returns the last date and time that this user accessed the CMS server.
java.util.Calendar	getLastLogon() Returns the last date and time this user connected to the CMS.
int	getLocale() Internal Use Only.
int	getNumberOfUses() Internal Use Only.
int	getPasswordExpiry() Internal Use Only.
boolean	getServerLogonSession() Internal Use Only.
java.lang.String	getUserAlias() Returns the user alias.
java.lang.String	getUserID() Returns the user ID.
java.util.Calendar	getValidUntil() Internal Use Only.
boolean	isSetAuthenticationMethod() Checks if the authentication method has been set.
boolean	isSetCMSName() Checks if the CMS Name is set.
boolean	isSetCollateralIds() Checks if the CollateralIds have been set.
boolean	isSetConcurrent() Internal Use Only.
boolean	isSetCustomProperties() Checks if the custom properties have been set.
boolean	isSetFailedLogonCount() Checks if the failed logon count has been set.
boolean	isSetFailoverToken() Checks if the failover token has been set.
boolean	isSetLastAccess() Checks if the last date and time have been set.
boolean	isSetLastLogon() Checks if the last date and time this use connected has been set.
boolean	isSetLocale() Internal Use Only.
boolean	isSetNumberOfUses() Internal Use Only.
boolean	isSetPasswordExpiry() Internal Use Only.
boolean	isSetServerLogonSession() Internal Use Only.
boolean	isSetUserAlias() Checks if the UserAlias has been set.
boolean	isSetUserID() Checks if the UserID has been set.
boolean	isSetValidUntil() Internal Use Only.
void	setAuthenticationMethod(java.lang.String authenticationMethod) Internal Use Only.
void	setCMSName(java.lang.String cmsName) Internal Use Only.
void	setCollateralIds(CollateralIds collateralIds) Sets the collection of collateral IDs associated with this connection.
void	setConcurrent(boolean concurrent) Internal Use Only.
void	setCustomProperties(CustomProperties customProperties) Sets the custom properties.
void	setFailedLogonCount(int failedLogonCount) Internal Use Only.
void	setFailoverToken(java.lang.String failoverToken) Internal Use Only.
void	setLastAccess(java.util.Calendar lastAccess) Internal Use Only.
void	setLastLogon(java.util.Calendar lastLogon) Internal Use Only.
void	setLocale(int locale) Internal Use Only.
void	setNumberOfUses(int numberOfUses) Internal Use Only.
void	setPasswordExpiry(int passwordExpiry) Internal Use Only.
void	setServerLogonSession(boolean serverLogonSession) Internal Use Only.
void	setUserAlias(java.lang.String userAlias) Internal Use Only.
void	setUserID(java.lang.String userID) Internal Use Only.
void	setValidUntil(java.util.Calendar validUntil) Internal Use Only.
void	unsetAuthenticationMethod() Internal Use Only.
void	unsetCMSName() Internal Use Only.
void	unsetCollateralIds() Deletes or unsets the CollateralIds array.
void	unsetConcurrent() Internal Use Only.
void	unsetCustomProperties() Deletes or unsets the CollateralIds array.
void	unsetFailedLogonCount() Deletes or unsets the UserID element.
void	unsetFailoverToken() Internal Use Only.
void	unsetLastAccess() Deletes or unsets the last date and time element.
void	unsetLastLogon() Deletes or unsets the last date and time this user logged on.
void	unsetLocale() Internal Use Only.
void	unsetNumberOfUses() Internal Use Only.
void	unsetPasswordExpiry() Internal Use Only.
void	unsetServerLogonSession() Internal Use Only.
void	unsetUserAlias() Internal Use Only.
void	unsetUserID() Deletes or unsets the UserID element.
void	unsetValidUntil() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetAuthenticationMethod() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetCMSName() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetConcurrent() Internal Use Only.
org.apache.xmlbeans.XmlInt	xgetFailedLogonCount() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetFailoverToken() Internal Use Only.
org.apache.xmlbeans.XmlDateTime	xgetLastAccess() Internal Use Only.
org.apache.xmlbeans.XmlDateTime	xgetLastLogon() Internal Use Only.
org.apache.xmlbeans.XmlInt	xgetLocale() Internal Use Only.
org.apache.xmlbeans.XmlInt	xgetNumberOfUses() Internal Use Only.
org.apache.xmlbeans.XmlInt	xgetPasswordExpiry() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetServerLogonSession() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetUserAlias() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetUserID() Internal Use Only.
org.apache.xmlbeans.XmlDateTime	xgetValidUntil() Internal Use Only.
void	xsetAuthenticationMethod(org.apache.xmlbeans.XmlString authenticationMethod) Internal Use Only.
void	xsetCMSName(org.apache.xmlbeans.XmlString cmsName) Internal Use Only.
void	xsetConcurrent(org.apache.xmlbeans.XmlBoolean concurrent) Internal Use Only.
void	xsetFailedLogonCount(org.apache.xmlbeans.XmlInt failedLogonCount) Internal Use Only.
void	xsetFailoverToken(org.apache.xmlbeans.XmlString failoverToken) Internal Use Only.
void	xsetLastAccess(org.apache.xmlbeans.XmlDateTime lastAccess) Internal Use Only.
void	xsetLastLogon(org.apache.xmlbeans.XmlDateTime lastLogon) Internal Use Only.
void	xsetLocale(org.apache.xmlbeans.XmlInt locale) Internal Use Only.
void	xsetNumberOfUses(org.apache.xmlbeans.XmlInt numberOfUses) Internal Use Only.
void	xsetPasswordExpiry(org.apache.xmlbeans.XmlInt passwordExpiry) Internal Use Only.
void	xsetServerLogonSession(org.apache.xmlbeans.XmlBoolean serverLogonSession) Internal Use Only.
void	xsetUserAlias(org.apache.xmlbeans.XmlString userAlias) Internal Use Only.
void	xsetUserID(org.apache.xmlbeans.XmlString userID) Internal Use Only.
void	xsetValidUntil(org.apache.xmlbeans.XmlDateTime validUntil) Internal Use Only.

Methods inherited from interface com.businessobjects.enterprise.infoobject.InfoObject

addNewAlerts, addNewPluginInfo, addNewRolesOnObject, addNewSecurityInfo, addNewSecurityInfo2, addNewSharedDoc, addNewStatusInfo, getAlerts, getChildrenObjects, getCreationTime, getCUID, getDescription, getEndTime, getErrorMessage, getID, getInstance, getInstanceObject, getIsApplicationObject, getIsComponent, getIsHiddenObject, getIsPluginObject, getIsRecurring, getIsRunnableObject, getIsSendable, getIsSystemObject, getKey, getKeywords, getKind, getLastRunTime, getLastSuccessfulInstanceCUID, getName, getNewJobID, getNextRunTime, getObjectIsContainer, getOwner, getOwnerCUID, getParentCUID, getPluginInfo, getRolesOnObject, getRUID, getSchedulable, getSecurityInfo, getSecurityInfo2, getSharedDoc, getStartTime, getStatusInfo, getUiStatus, getUpdateTime, isSetAlerts, isSetChildrenObjects, isSetCreationTime, isSetCUID, isSetDescription, isSetEndTime, isSetErrorMessage, isSetID, isSetInstance, isSetInstanceObject, isSetIsApplicationObject, isSetIsComponent, isSetIsHiddenObject, isSetIsPluginObject, isSetIsRecurring, isSetIsRunnableObject, isSetIsSendable, isSetIsSystemObject, isSetKey, isSetKeywords, isSetKind, isSetLastRunTime, isSetLastSuccessfulInstanceCUID, isSetNewJobID, isSetNextRunTime, isSetObjectIsContainer, isSetOwner, isSetOwnerCUID, isSetParentCUID, isSetPluginInfo, isSetRolesOnObject, isSetRUID, isSetSchedulable, isSetSecurityInfo, isSetSecurityInfo2, isSetSharedDoc, isSetStartTime, isSetStatusInfo, isSetUiStatus, isSetUpdateTime, setAlerts, setChildrenObjects, setCreationTime, setCUID, setDescription, setEndTime, setErrorMessage, setID, setInstance, setInstanceObject, setIsApplicationObject, setIsComponent, setIsHiddenObject, setIsPluginObject, setIsRecurring, setIsRunnableObject, setIsSendable, setIsSystemObject, setKey, setKeywords, setKind, setLastRunTime, setLastSuccessfulInstanceCUID, setName, setNewJobID, setNextRunTime, setObjectIsContainer, setOwner, setOwnerCUID, setParentCUID, setPluginInfo, setRolesOnObject, setRUID, setSchedulable, setSecurityInfo, setSecurityInfo2, setSharedDoc, setStartTime, setStatusInfo, setUiStatus, setUpdateTime, unsetAlerts, unsetChildrenObjects, unsetCreationTime, unsetCUID, unsetDescription, unsetEndTime, unsetErrorMessage, unsetID, unsetInstance, unsetInstanceObject, unsetIsApplicationObject, unsetIsComponent, unsetIsHiddenObject, unsetIsPluginObject, unsetIsRecurring, unsetIsRunnableObject, unsetIsSendable, unsetIsSystemObject, unsetKey, unsetKeywords, unsetKind, unsetLastRunTime, unsetLastSuccessfulInstanceCUID, unsetNewJobID, unsetNextRunTime, unsetObjectIsContainer, unsetOwner, unsetOwnerCUID, unsetParentCUID, unsetPluginInfo, unsetRolesOnObject, unsetRUID, unsetSchedulable, unsetSecurityInfo, unsetSecurityInfo2, unsetSharedDoc, unsetStartTime, unsetStatusInfo, unsetUiStatus, unsetUpdateTime, xgetChildrenObjects, xgetCreationTime, xgetCUID, xgetDescription, xgetEndTime, xgetErrorMessage, xgetID, xgetInstance, xgetInstanceObject, xgetIsApplicationObject, xgetIsComponent, xgetIsHiddenObject, xgetIsPluginObject, xgetIsRecurring, xgetIsRunnableObject, xgetIsSendable, xgetIsSystemObject, xgetKey, xgetKeywords, xgetKind, xgetLastRunTime, xgetLastSuccessfulInstanceCUID, xgetName, xgetNewJobID, xgetNextRunTime, xgetObjectIsContainer, xgetOwner, xgetOwnerCUID, xgetParentCUID, xgetRUID, xgetSchedulable, xgetStartTime, xgetUiStatus, xgetUpdateTime, xsetChildrenObjects, xsetCreationTime, xsetCUID, xsetDescription, xsetEndTime, xsetErrorMessage, xsetID, xsetInstance, xsetInstanceObject, xsetIsApplicationObject, xsetIsComponent, xsetIsHiddenObject, xsetIsPluginObject, xsetIsRecurring, xsetIsRunnableObject, xsetIsSendable, xsetIsSystemObject, xsetKey, xsetKeywords, xsetKind, xsetLastRunTime, xsetLastSuccessfulInstanceCUID, xsetName, xsetNewJobID, xsetNextRunTime, xsetObjectIsContainer, xsetOwner, xsetOwnerCUID, xsetParentCUID, xsetRUID, xsetSchedulable, xsetStartTime, xsetUiStatus, xsetUpdateTime

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getUserID

java.lang.String getUserID()

Returns the user ID.

Returns:

A String containing the user ID.

xgetUserID

org.apache.xmlbeans.XmlString xgetUserID()

Internal Use Only.

isSetUserID

boolean isSetUserID()

Checks if the UserID has been set.

Returns:

true if the UserID element has been set, otherwise false.

setUserID

void setUserID(java.lang.String userID)

Internal Use Only.

xsetUserID

void xsetUserID(org.apache.xmlbeans.XmlString userID)

Internal Use Only.

unsetUserID

void unsetUserID()

Deletes or unsets the UserID element.

getLastAccess

java.util.Calendar getLastAccess()

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

Returns:

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

xgetLastAccess

org.apache.xmlbeans.XmlDateTime xgetLastAccess()

Internal Use Only.

isSetLastAccess

boolean isSetLastAccess()

Checks if the last date and time have been set.

Returns:

true if the LastAccess element has been set, otherwise false.

setLastAccess

void setLastAccess(java.util.Calendar lastAccess)

Internal Use Only.

xsetLastAccess

void xsetLastAccess(org.apache.xmlbeans.XmlDateTime lastAccess)

Internal Use Only.

unsetLastAccess

void unsetLastAccess()

Deletes or unsets the last date and time element.

getFailedLogonCount

int getFailedLogonCount()

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

Returns:

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

xgetFailedLogonCount

org.apache.xmlbeans.XmlInt xgetFailedLogonCount()

Internal Use Only.

isSetFailedLogonCount

boolean isSetFailedLogonCount()

Checks if the failed logon count has been set.

Returns:

true if the FailedLogonCount element has been set, otherwise false.

setFailedLogonCount

void setFailedLogonCount(int failedLogonCount)

Internal Use Only.

xsetFailedLogonCount

void xsetFailedLogonCount(org.apache.xmlbeans.XmlInt failedLogonCount)

Internal Use Only.

unsetFailedLogonCount

void unsetFailedLogonCount()

Deletes or unsets the UserID element.

getUserAlias

java.lang.String getUserAlias()

Returns the user alias.

Returns:

The user alias.

xgetUserAlias

org.apache.xmlbeans.XmlString xgetUserAlias()

Internal Use Only.

isSetUserAlias

boolean isSetUserAlias()

Checks if the UserAlias has been set.

Returns:

true if the UserAlias element has been set, otherwise false.

setUserAlias

void setUserAlias(java.lang.String userAlias)

Internal Use Only.

xsetUserAlias

void xsetUserAlias(org.apache.xmlbeans.XmlString userAlias)

Internal Use Only.

unsetUserAlias

void unsetUserAlias()

Internal Use Only.

getConcurrent

boolean getConcurrent()

Internal Use Only.

xgetConcurrent

org.apache.xmlbeans.XmlBoolean xgetConcurrent()

Internal Use Only.

isSetConcurrent

boolean isSetConcurrent()

Internal Use Only.

setConcurrent

void setConcurrent(boolean concurrent)

Internal Use Only.

xsetConcurrent

void xsetConcurrent(org.apache.xmlbeans.XmlBoolean concurrent)

Internal Use Only.

unsetConcurrent

void unsetConcurrent()

Internal Use Only.

getLastLogon

java.util.Calendar getLastLogon()

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

Returns:

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

xgetLastLogon

org.apache.xmlbeans.XmlDateTime xgetLastLogon()

Internal Use Only.

isSetLastLogon

boolean isSetLastLogon()

Checks if the last date and time this use connected has been set.

Returns:

true if the LastLogon element has been set, otherwise false.

setLastLogon

void setLastLogon(java.util.Calendar lastLogon)

Internal Use Only.

xsetLastLogon

void xsetLastLogon(org.apache.xmlbeans.XmlDateTime lastLogon)

Internal Use Only.

unsetLastLogon

void unsetLastLogon()

Deletes or unsets the last date and time this user logged on.

getNumberOfUses

int getNumberOfUses()

Internal Use Only.

xgetNumberOfUses

org.apache.xmlbeans.XmlInt xgetNumberOfUses()

Internal Use Only.

isSetNumberOfUses

boolean isSetNumberOfUses()

Internal Use Only.

setNumberOfUses

void setNumberOfUses(int numberOfUses)

Internal Use Only.

xsetNumberOfUses

void xsetNumberOfUses(org.apache.xmlbeans.XmlInt numberOfUses)

Internal Use Only.

unsetNumberOfUses

void unsetNumberOfUses()

Internal Use Only.

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.

xgetAuthenticationMethod

org.apache.xmlbeans.XmlString xgetAuthenticationMethod()

Internal Use Only.

isSetAuthenticationMethod

boolean isSetAuthenticationMethod()

Checks if the authentication method has been set.

Returns:

true if the AuthenticationMethod element has been set, otherwise false.

setAuthenticationMethod

void setAuthenticationMethod(java.lang.String authenticationMethod)

Internal Use Only.

xsetAuthenticationMethod

void xsetAuthenticationMethod(org.apache.xmlbeans.XmlString authenticationMethod)

Internal Use Only.

unsetAuthenticationMethod

void unsetAuthenticationMethod()

Internal Use Only.

getFailoverToken

java.lang.String getFailoverToken()

Returns the failover token.

Returns:

The failover token.

xgetFailoverToken

org.apache.xmlbeans.XmlString xgetFailoverToken()

Internal Use Only.

isSetFailoverToken

boolean isSetFailoverToken()

Checks if the failover token has been set.

Returns:

true if the FailoverToken element has been set, otherwise false.

setFailoverToken

void setFailoverToken(java.lang.String failoverToken)

Internal Use Only.

xsetFailoverToken

void xsetFailoverToken(org.apache.xmlbeans.XmlString failoverToken)

Internal Use Only.

unsetFailoverToken

void unsetFailoverToken()

Internal Use Only.

getServerLogonSession

boolean getServerLogonSession()

Internal Use Only.

xgetServerLogonSession

org.apache.xmlbeans.XmlBoolean xgetServerLogonSession()

Internal Use Only.

isSetServerLogonSession

boolean isSetServerLogonSession()

Internal Use Only.

setServerLogonSession

void setServerLogonSession(boolean serverLogonSession)

Internal Use Only.

xsetServerLogonSession

void xsetServerLogonSession(org.apache.xmlbeans.XmlBoolean serverLogonSession)

Internal Use Only.

unsetServerLogonSession

void unsetServerLogonSession()

Internal Use Only.

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.

xgetCMSName

org.apache.xmlbeans.XmlString xgetCMSName()

Internal Use Only.

isSetCMSName

boolean isSetCMSName()

Checks if the CMS Name is set.

Returns:

true if the CMSName element has been set, otherwise false.

setCMSName

void setCMSName(java.lang.String cmsName)

Internal Use Only.

xsetCMSName

void xsetCMSName(org.apache.xmlbeans.XmlString cmsName)

Internal Use Only.

unsetCMSName

void unsetCMSName()

Internal Use Only.

getValidUntil

java.util.Calendar getValidUntil()

Internal Use Only.

xgetValidUntil

org.apache.xmlbeans.XmlDateTime xgetValidUntil()

Internal Use Only.

isSetValidUntil

boolean isSetValidUntil()

Internal Use Only.

setValidUntil

void setValidUntil(java.util.Calendar validUntil)

Internal Use Only.

xsetValidUntil

void xsetValidUntil(org.apache.xmlbeans.XmlDateTime validUntil)

Internal Use Only.

unsetValidUntil

void unsetValidUntil()

Internal Use Only.

getPasswordExpiry

int getPasswordExpiry()

Internal Use Only.

xgetPasswordExpiry

org.apache.xmlbeans.XmlInt xgetPasswordExpiry()

Internal Use Only.

isSetPasswordExpiry

boolean isSetPasswordExpiry()

Internal Use Only.

setPasswordExpiry

void setPasswordExpiry(int passwordExpiry)

Internal Use Only.

xsetPasswordExpiry

void xsetPasswordExpiry(org.apache.xmlbeans.XmlInt passwordExpiry)

Internal Use Only.

unsetPasswordExpiry

void unsetPasswordExpiry()

Internal Use Only.

getLocale

int getLocale()

Internal Use Only.

xgetLocale

org.apache.xmlbeans.XmlInt xgetLocale()

Internal Use Only.

isSetLocale

boolean isSetLocale()

Internal Use Only.

setLocale

void setLocale(int locale)

Internal Use Only.

xsetLocale

void xsetLocale(org.apache.xmlbeans.XmlInt locale)

Internal Use Only.

unsetLocale

void unsetLocale()

Internal Use Only.

getCollateralIds

CollateralIds getCollateralIds()

Returns the collection of collateral IDs associated with this connection.

Returns:

The collection of collateral IDs associated with this connection.

isSetCollateralIds

boolean isSetCollateralIds()

Checks if the CollateralIds have been set.

Returns:

true if the CollateralIds element has been set, otherwise false.

setCollateralIds

void setCollateralIds(CollateralIds collateralIds)

Sets the collection of collateral IDs associated with this connection.

Parameters:

collateralIds - The collection of collateral IDs associated with this connection.

addNewCollateralIds

CollateralIds addNewCollateralIds()

Appends and returns a new empty CollateralIds object as the last element of the array.

Returns:

A new CollateralIds object.

unsetCollateralIds

void unsetCollateralIds()

Deletes or unsets the CollateralIds array.

getCustomProperties

CustomProperties getCustomProperties()

Returns the custom properties.

Returns:

The custom properties.

isSetCustomProperties

boolean isSetCustomProperties()

Checks if the custom properties have been set.

Returns:

true if the element has been set, otherwise false.

setCustomProperties

void setCustomProperties(CustomProperties customProperties)

Sets the custom properties.

Parameters:

customProperties - The custom properties.

addNewCustomProperties

CustomProperties addNewCustomProperties()

Appends and returns a new empty CustomProperties object as the last element of the array.

Returns:

A new CustomProperties object.

unsetCustomProperties

void unsetCustomProperties()

Deletes or unsets the CollateralIds array.