Package com.microstrategy.web.objects
Interface WebIServerSessionList
-
- All Superinterfaces:
EnumWebPersistableState
,Persistable
,WebSessionInfoList
public interface WebIServerSessionList extends WebSessionInfoList
The WebIServerSessionList interface represents a list ofWebIServerSession
objects. This interface extends theWebSessionInfoList
interface, which contains the methods to obtain items from the list by index, to remove items from the list, to set items in the list as active, and the Persistable interface, which gives the capability to save and restore the list. In addition to that functionality, this interface provides the capability to create a new session in the list and get sessions based on server name, port number, project name, and/or key.- Since:
- MicroStrategy Web 8.0.1
-
-
Field Summary
-
Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState
BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description WebIServerSession
getByKey(java.lang.String key)
This method will return the session that is identified by the given unique key.WebIServerSession[]
getByProject(java.lang.String projectName)
This method will search for sessions with given project name in the collection.WebIServerSession[]
getByServer(java.lang.String serverName, int port)
This method will search for sessions with given server name and port number in the collection.WebIServerSession[]
getByServerProject(java.lang.String serverName, int port, java.lang.String projectName)
This method will search for sessions with given server name, port number, and project in the collection.WebIServerSession
newSession()
This method will create a newWebIServerSession
object and add it to the list.WebIServerSession
newSession(WebIServerSession credentials, java.lang.String projectName)
This method will create a newWebIServerSession
object and add it to the list.WebIServerSession
newSession(WebIServerSession credentials, java.lang.String projectName, java.lang.String serverName, int port)
This method will create a newWebIServerSession
object and add it to the list.-
Methods inherited from interface com.microstrategy.utils.serialization.Persistable
restoreState, restoreState, saveState, saveState, saveState, saveState
-
Methods inherited from interface com.microstrategy.web.objects.WebSessionInfoList
get, getActiveSession, getFactory, remove, remove, removeAll, removeAll, setActiveSession, size
-
-
-
-
Method Detail
-
newSession
WebIServerSession newSession()
This method will create a newWebIServerSession
object and add it to the list. The newly created object will be returned from this method.- Returns:
- The newly created
WebIServerSession
object.
-
newSession
WebIServerSession newSession(WebIServerSession credentials, java.lang.String projectName)
This method will create a newWebIServerSession
object and add it to the list. The newly created session will have the same properties as the credentials object being passed in, excep that the project name will be changed to the given value. This will also ensure that the session ID in the given credentials session will not be copied over. The newly created object will be returned from this method.- Returns:
- The newly created
WebIServerSession
object.
-
newSession
WebIServerSession newSession(WebIServerSession credentials, java.lang.String projectName, java.lang.String serverName, int port)
This method will create a newWebIServerSession
object and add it to the list. The newly created session will have the same properties as the credentials object being passed in, excep that the project name, server name, and port will be changed to the given value. This will also ensure that the session ID in the given credentials session will not be copied over. The newly created object will be returned from this method.- Returns:
- The newly created
WebIServerSession
object.
-
getByServer
WebIServerSession[] getByServer(java.lang.String serverName, int port)
This method will search for sessions with given server name and port number in the collection. It will return all those sessions with matching server name and port number. Note that for the purpose of clustering, all servers in the cluster are considered to be equivalent - if any of those server names are passed in, all sessions on all servers in the cluster will be returned.- Parameters:
serverName
- The server name of the server to search for.port
- The port number of the server to search for.- Returns:
- An array of WebIServerSession objects that are the result of the search. If none are found, then this array will be empty.
-
getByProject
WebIServerSession[] getByProject(java.lang.String projectName)
This method will search for sessions with given project name in the collection. It will return all those sessions with matching project name.- Parameters:
projectName
- The name of the project to search for.- Returns:
- An array of WebIServerSession objects that are the result of the search. If none are found, then this array will be empty.
-
getByServerProject
WebIServerSession[] getByServerProject(java.lang.String serverName, int port, java.lang.String projectName)
This method will search for sessions with given server name, port number, and project in the collection. It will return all those sessions with matching server name, port number, and project. Note that for the purpose of clustering, all servers in the cluster are considered to be equivalent - if any of those server names are passed in, all sessions on all servers in the cluster will be considered to match the given server.- Parameters:
serverName
- The server name of the server to search for.port
- The port number of the server to search for.projectName
- The name of the project to search for.- Returns:
- An array of WebIServerSession objects that are the result of the search. If none are found, then this array will be empty.
-
getByKey
WebIServerSession getByKey(java.lang.String key)
This method will return the session that is identified by the given unique key.- Parameters:
key
- The key that identifies the session to return.- Returns:
- The
WebIServerSession
object corresponding to the given key, or null if no such object is found.
-
-