com.softwareag.centrasite.api.session
Interface CentraSiteSession

All Superinterfaces:
java.io.Serializable

public interface CentraSiteSession
extends java.io.Serializable

CentraSiteSession interface provides instances of the CentraSite Object managers, and other specialized programs such as configurators, diagnostic handlers etc., based on the user who is currently mapped to the session.
The interface simplifies retrieving instances of the various managers, configurators, handlers etc., and reuses them as applicable with the user scope.


Method Summary
 void close()
          Closes a session, releases all resources, and performs an implicit logout.
 java.util.List<AboutTopic> getAboutTopics(ClientAboutInfo aboutClient)
           
 CSOActionManager getActionManager()
          Returns the action manager associated with this session.
 ActivityManager getActivityManager()
          Returns the activity manager associated with this session.
 ActivityManager getActivityManager(User user)
          Returns the activity manager for the given user.
 CSOSearchConditionManager getCentraSiteObjectConditionManager()
          Returns the condition manager associated with this session.
 CentraSiteObjectManager getCentraSiteObjectManager()
          Returns the object manager associated with this session.
 CSOSearchManager getCentraSiteObjectSearchManager()
          Returns the search manager associated with this session.
 CentraSiteObjectTypeManager getCentraSiteObjectTypeManager()
          Returns the type manager associated with this session.
 Configurator getConfigurator(Organization organization)
          Returns the organization specific configurator.
 Configurator getConfigurator(User user)
          Returns the user specific configurator.
 DiagnosticHandler getDiagnosticHandler()
          Returns the session diagnostic handler.
 java.util.Locale getDisplayLanguage()
           
 HelpCenter getHelpCenter()
          Return the HelpCenter which is used to access the available HelpCenterTopic's
 User getOwner()
          Returns the owner of this session.
 java.util.Locale getOwnerLocale()
          Returns the locale defined for the currently logged in user.
 CSOUriGenerator getURIGenerator()
          Returns the CSOUriGenerator for this session.
 boolean isClosed()
          Indicates whether the current session is active or inactive.
 void setHttpServletRequest(javax.servlet.http.HttpServletRequest request)
           
 void setURIGenerator(CSOUriGenerator uriGenerator)
          The URI format is not fixed but greatly depends on the CSO client.
 

Method Detail

getCentraSiteObjectManager

CentraSiteObjectManager getCentraSiteObjectManager()
                                                   throws CLLException
Returns the object manager associated with this session.

Returns:
CentraSiteObjectManager
Throws:
CLLException - in case of a failure to return the CentraSiteObjectManager associated with CentraSiteSession

getCentraSiteObjectTypeManager

CentraSiteObjectTypeManager getCentraSiteObjectTypeManager()
                                                           throws CLLException
Returns the type manager associated with this session.

Returns:
CentraSiteObjectTypeManager
Throws:
CLLException - in case of a failure to return the CentraSiteObjectTypeManager associated with CentraSiteSession

getCentraSiteObjectSearchManager

CSOSearchManager getCentraSiteObjectSearchManager()
                                                  throws CLLException
Returns the search manager associated with this session.

Returns:
CSOSearchManager
Throws:
CLLException - in case of a failure to return the CSOSearchManager associated with CentraSiteSession

getCentraSiteObjectConditionManager

CSOSearchConditionManager getCentraSiteObjectConditionManager()
                                                              throws CLLException
Returns the condition manager associated with this session.

Returns:
CSOSearchConditionManager
Throws:
CLLException - in case of a failure to return the CSOSearchConditionManager associated with CentraSiteSession

getActionManager

CSOActionManager getActionManager()
                                  throws CLLException
Returns the action manager associated with this session.

Returns:
CSOActionManager
Throws:
CLLException - in case of a failure to return the CSOActionManager associated with CentraSiteSession

getConfigurator

Configurator getConfigurator(User user)
                             throws CLLException
Returns the user specific configurator.

Parameters:
user - User
Returns:
Configurator which contains the given user-specific configuration derived from the configuration hierarchy model
Throws:
CLLException - in case of a failure to return an instance of Configurator for the given user

getConfigurator

Configurator getConfigurator(Organization organization)
                             throws CLLException
Returns the organization specific configurator.

Parameters:
organization - Organization
Returns:
Configurator which contains the given organization-specific configuration derived from the configuration hierarchy model
Throws:
CLLException - in case of a failure to return an instance of Configurator for the given organization

getDiagnosticHandler

DiagnosticHandler getDiagnosticHandler()
                                       throws CLLException
Returns the session diagnostic handler.

Returns:
DiagnosticHandler
Throws:
CLLException - in case of failure to return the DiagnosticsHandler for CentraSiteSession

getOwner

User getOwner()
              throws CLLException
Returns the owner of this session.

Returns:
User
Throws:
CLLException - in case of a failure to return the owner of CentraSiteSession

getActivityManager

ActivityManager getActivityManager()
                                   throws CLLException
Returns the activity manager associated with this session.

Returns:
ActivityManager
Throws:
CLLException - in case of a failure to return the ActivityManager associated with CentraSiteSession

getActivityManager

ActivityManager getActivityManager(User user)
                                   throws CLLException
Returns the activity manager for the given user.

Returns:
ActivityManager
Throws:
CLLException - in case of a failure to return the ActivityManager for the specific user

getOwnerLocale

java.util.Locale getOwnerLocale()
                                throws CLLException
Returns the locale defined for the currently logged in user.

Returns:
Locale
Throws:
CLLException - in case of a failure to return the Locale defined for the currently logged in user

close

void close()
           throws CLLException
Closes a session, releases all resources, and performs an implicit logout. A session once closed cannot be reused.

Throws:
CLLException - in case of a failure to release the resources held by the CentraSiteSession

isClosed

boolean isClosed()
Indicates whether the current session is active or inactive.

Returns:
boolean flag indicating whether the current CentraSiteSession is active or inactive.

setURIGenerator

void setURIGenerator(CSOUriGenerator uriGenerator)
The URI format is not fixed but greatly depends on the CSO client. For example, the BUI code requires a URI format that is much different from the URI format of Control. Sets the CSOUriGenerator for this session.

Parameters:
uriGenerator -

getURIGenerator

CSOUriGenerator getURIGenerator()
Returns the CSOUriGenerator for this session.

Returns:
CSOUriGenerator

getHelpCenter

HelpCenter getHelpCenter()
                         throws CLLException
Return the HelpCenter which is used to access the available HelpCenterTopic's

Returns:
HelpCenter
Throws:
CLLException - in case of failed to get the HelpCenter.

getAboutTopics

java.util.List<AboutTopic> getAboutTopics(ClientAboutInfo aboutClient)
                                          throws CLLException
Throws:
CLLException

getDisplayLanguage

java.util.Locale getDisplayLanguage()
                                    throws CLLException
Throws:
CLLException

setHttpServletRequest

void setHttpServletRequest(javax.servlet.http.HttpServletRequest request)