Interface UserConnection
-
public interface UserConnection
The interfaceUserConnection
represents a single user connection.- Since:
- MicroStrategy Web 9.0.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getClientID()
Returns the client ID (a/k/a the client machine)int
getClientPort()
Returns the port of the user machineint
getClientType()
Returns the type of the client, fromEnumDSSXMLClientTypes
.java.util.Date
getConnectionTime()
Returns the time that the connection was connectedint
getDuration()
Returns the duration of the connection, in secondsjava.util.Date
getFirstJobTime()
Returns the time the first job was submittedjava.util.Date
getLastJobTime()
Returns the time the last job was submitted.int
getOpenJobs()
Returns the number of open jobs on the session.java.lang.String
getProjectDSSID()
Returns the DSS ID of the project that is connected to.int
getProjectID()
Returns the project ID of the project that is connected tojava.lang.String
getProjectName()
Returns the name of the project the connection is connected to.java.lang.String
getServerName()
Return the name of the server from which the user connection information is obtained.java.lang.String
getSessionID()
Returns the session ID of the connection.java.lang.String
getUserLoginName()
Returns the login name of the owner of the connectionjava.lang.String
getUserName()
Returns the full name of the owner of the connection
-
-
-
Method Detail
-
getUserName
java.lang.String getUserName()
Returns the full name of the owner of the connection- Returns:
- the full name of the owner of the connection
-
getProjectName
java.lang.String getProjectName()
Returns the name of the project the connection is connected to.- Returns:
- the name of the project the connection is connected to.
-
getOpenJobs
int getOpenJobs()
Returns the number of open jobs on the session.- Returns:
- the number of open jobs on the session.
-
getClientType
int getClientType()
Returns the type of the client, fromEnumDSSXMLClientTypes
.- Returns:
- the type of the client.
-
getConnectionTime
java.util.Date getConnectionTime()
Returns the time that the connection was connected- Returns:
- the time that the connection was connected
-
getFirstJobTime
java.util.Date getFirstJobTime()
Returns the time the first job was submitted- Returns:
- the time the first job was submitted
-
getLastJobTime
java.util.Date getLastJobTime()
Returns the time the last job was submitted.- Returns:
- the time the last job was submitted.
-
getDuration
int getDuration()
Returns the duration of the connection, in seconds- Returns:
- the duration of the connection, in seconds
-
getProjectID
int getProjectID()
Returns the project ID of the project that is connected to- Returns:
- the project ID of the project that is connected to
-
getProjectDSSID
java.lang.String getProjectDSSID()
Returns the DSS ID of the project that is connected to.- Returns:
- the DSS ID of the project that is connected to.
-
getSessionID
java.lang.String getSessionID()
Returns the session ID of the connection. Note that one sessionID can have multiple connections.- Returns:
- the session ID of the connection
-
getClientID
java.lang.String getClientID()
Returns the client ID (a/k/a the client machine)- Returns:
- the client ID.
-
getClientPort
int getClientPort()
Returns the port of the user machine- Returns:
- the port of the user machine
-
getServerName
java.lang.String getServerName()
Return the name of the server from which the user connection information is obtained.- Returns:
- the name of the server
-
getUserLoginName
java.lang.String getUserLoginName()
Returns the login name of the owner of the connection- Returns:
- the login name of the owner of the connection
-
-