public interface

WebIServerSessionList

implements WebSessionInfoList
com.microstrategy.web.objects.WebIServerSessionList

Class Overview

The WebIServerSessionList interface represents a list of WebIServerSession objects. This interface extends the WebSessionInfoList 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.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
Public Methods
abstract WebIServerSession getByKey(String key)
This method will return the session that is identified by the given unique key.
abstract WebIServerSession[] getByProject(String projectName)
This method will search for sessions with given project name in the collection.
abstract WebIServerSession[] getByServer(String serverName, int port)
This method will search for sessions with given server name and port number in the collection.
abstract WebIServerSession[] getByServerProject(String serverName, int port, String projectName)
This method will search for sessions with given server name, port number, and project in the collection.
abstract WebIServerSession newSession(WebIServerSession credentials, String projectName)
This method will create a new WebIServerSession object and add it to the list.
abstract WebIServerSession newSession()
This method will create a new WebIServerSession object and add it to the list.
abstract WebIServerSession newSession(WebIServerSession credentials, String projectName, String serverName, int port)
This method will create a new WebIServerSession object and add it to the list.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.objects.WebSessionInfoList

Public Methods

public abstract WebIServerSession getByKey (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.

public abstract WebIServerSession[] getByProject (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.

public abstract WebIServerSession[] getByServer (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.

public abstract WebIServerSession[] getByServerProject (String serverName, int port, 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.

public abstract WebIServerSession newSession (WebIServerSession credentials, String projectName)

This method will create a new WebIServerSession 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

public abstract WebIServerSession newSession ()

This method will create a new WebIServerSession object and add it to the list. The newly created object will be returned from this method.

Returns

public abstract WebIServerSession newSession (WebIServerSession credentials, String projectName, String serverName, int port)

This method will create a new WebIServerSession 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