Interface XCEditorSession
-
public interface XCEditorSession
Interface for the XCEditorSession class, used for the session monitor bundle.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getClusterId()
Retrieves the clusterid of an editor session.String
getIpAddress()
Retrieves the ip address of the logged in client.long
getLoginTime()
Retrieves the timestamp of the login action for this session.String
getSessionId()
Retrieves the sessionid of an editor session.String
getUserAgent()
Retrieves the user agent of an editor session.String
getUserName()
Retrieves the user name of an editor session.int
getWebsiteId()
Retrieves the webid of an editor session.boolean
isCurrentSession()
Retrieves whether this session is the current one.void
setClusterId(String clusterId)
Sets the cluster id for this session.void
setCurrentSession(boolean current)
Flags whether this session is the current one.void
setIpAddress(String ipAddress)
Sets the IP address of the user of this session.void
setLoginTime(long loginTime)
Sets the timestamp for the login action for this session.void
setSessionId(String sessionId)
Sets the sessionid for this session.void
setUserAgent(String userAgent)
Sets the user agent for this session.void
setUserName(String userName)
Sets the user name for this session.void
setWebsiteId(int websiteId)
Sets the website id for this session.
-
-
-
Method Detail
-
getSessionId
String getSessionId()
Retrieves the sessionid of an editor session.- Returns:
- the sessionid of an editor session
-
setSessionId
void setSessionId(String sessionId)
Sets the sessionid for this session.- Parameters:
sessionId
- the sessionid of the session
-
getClusterId
String getClusterId()
Retrieves the clusterid of an editor session.- Returns:
- the clusterid of an editor session
-
setClusterId
void setClusterId(String clusterId)
Sets the cluster id for this session.- Parameters:
clusterId
- the cluster id of the session
-
getWebsiteId
int getWebsiteId()
Retrieves the webid of an editor session.- Returns:
- the webid of an editor session
-
setWebsiteId
void setWebsiteId(int websiteId)
Sets the website id for this session.- Parameters:
websiteId
- the website id of the session
-
getUserName
String getUserName()
Retrieves the user name of an editor session.- Returns:
- the user name of an editor session
-
setUserName
void setUserName(String userName)
Sets the user name for this session.- Parameters:
userName
- the user name of the session
-
getLoginTime
long getLoginTime()
Retrieves the timestamp of the login action for this session.- Returns:
- the timestamp of the login action for this session
-
setLoginTime
void setLoginTime(long loginTime)
Sets the timestamp for the login action for this session.- Parameters:
loginTime
- the timestamp for the login action for this session
-
getIpAddress
String getIpAddress()
Retrieves the ip address of the logged in client.- Returns:
- the ip address of the logged in client
-
setIpAddress
void setIpAddress(String ipAddress)
Sets the IP address of the user of this session.- Parameters:
ipAddress
- the IP address of the user of this session
-
getUserAgent
String getUserAgent()
Retrieves the user agent of an editor session.- Returns:
- the user agent of an editor session
-
setUserAgent
void setUserAgent(String userAgent)
Sets the user agent for this session.- Parameters:
userAgent
- the user agent for this session
-
isCurrentSession
boolean isCurrentSession()
Retrieves whether this session is the current one.- Returns:
- whether this session is the current one
-
setCurrentSession
void setCurrentSession(boolean current)
Flags whether this session is the current one.- Parameters:
current
- true when this session is the current one
-
-