ACMSessionIdResolver

clear removes all session ids (Master, Configuration and Project Session Ids) from the maps. The set of Session Ids that need to be closed as a result of this action is returned.

This is used to close everything which is good when shutting down or during testing

close shuts down the internal scheduler and waits for it to destroy the thread

createConfigSessionId adds a Configuration Session Id under the input Master Session Id

createMasterSessionId creates a new MasterSessionId from the input ConfigSessionId, Jwt and CreateSession parameters. The MasterSessionId and data are put into the maps. The Jwt is needed so that PMasterSessionIds can be created on different IServers. The create parameters are needed so that the ProjectSessionId and the ConfigSessionId are matched

enumCsids will return a copy of all the session ids. It's a copy so you can freely walk through the structure without a lock

extendTtlsByIdleTimeout will update the TTL, using Now as the time, for the input Session Id and it's associated Master Session Id. The trick here is that the idle timeout is only known by the MAPs, that's because the idle timeout may be different for different clusters of IServers; thus its not a globally known value.

getAllProjectsToConnect returns a list of Project Ids that need to be connected for the given existing and valid Master Session Id

getConfigSessionInfos gets a list of all the Config Session Info objects under the input Master Session Id. Guaranteed to not be null, but it may be empty

getInstance will return the singleton ACMSessionIdResolver instance. It must be a singleton, that way all the session ids are managed together

getMasterSessionId finds and returns the Master Session Id associated with the input session id. If the input session id is already a Master it is returned. If the input session id is a project or configuration session id, it's associated Master is returned. If the input session id is not found, which can happen if the session id was created using the old CreateSession methods, then null is returned.

@return

getPreferredConfigSessionId will find an existing config session and return it, or it will create a new one. Guaranteed to not return null. If a failure to create a new connection occurs, this method will throw a MSTRWebAPIException@return

getPreferredConfigSessionId will find an existing config session and return it. If iReturnNullIfNotFound is true and no session currently exists, it will return null. If iReturnNullIfNotFound is false, then this method behaves exactly like getPreferredConfigSessionId@return

getProjectId gets the Project Id for the input Project Session Id

getProjectSessionId gets an existing Project Session Id for the input Configuration Session Id/Project Id combination. If its not found, null is returned

getProjectSessionInfos gets a list of all the Project Session Info objects under the input Master Session Id.

getServersToConnect returns an ordered list of all the IServers that can be used to connect to the Project. You should connect to these from the first one being the most preferable. All IServers that cannot be used (does not have the project, or are fenced out) will not be in this list getServerToConnect@return

getSessionBundle gets the ACMSessionBundle associated with the input session id

getSessionId gets the Master, Configuration, or Project Session Id. If the Session Id does not exist in the maps, then null is returned

getTtl gets the time-to-live for the input session id

@return

@return

printContents prints out to a log file all the contents of the maps. This is useful for debugging

removeSessionId removes the Session Ids (Configuration, Project Session Id) from the maps. The set of Session Ids that need to be closed as a result of this action is returned.

If the Session Id is a Master Session Id, then we may need to close all the associated Configuration and Project Session Ids too. That is why the removeSessionId() methods return a collection

resolveSessionId resolves the Session ID. This will transform a Master Session Id into a Project Session Id if the Master Session Id has project id information. If this is an old fashioned session id (created with CreateSession or CreateSessionEx), it will simply return it; this maintains backward compatibility. If iReturnNullIfNotFound is false then if the master session id does not have the configuration or project session needed, then this method will create a new one. If iReturnNullIfNotFound is true, then this method will return null if the configuration or project session do not already exist

setTtls will update the TTL based on the time passed in for the input Session Id and it's associated Master Session Id. This is useful in the update thread where the actual time last used is gotten from the IServer directly and we now want to synch up

start must be called at the beginning of the application, before sessions are created. This constructs the resources required for session creation. For example, an internal thread is created for managing the sessions.

In Web this is called by WebContextListener.contextInitialized()

startCreateConfigSessionId begins the process that adds a Config Session Id under the input Master Session Id SimultaneousSessionCreationManager.finish is used to finish the add

startCreateProjectSessionId begins the process that adds a Project Session Id under the input Master Session Id SimultaneousSessionCreationManager.finish is used to finish the add

stop should be called at the end of the application, after all session creations are complete. This will free the resources for session creation. For example, the internal thread is closed.

In Web this is called by WebContextListener.contextDestroyed()

stopThread will stop the ACMRefreshThread. Use this at shut down. stopThread will internally call wakeThread so there is no need to call both