public interface CentraSiteSession
extends java.io.Serializable
Modifier and Type | Method and Description |
---|---|
void |
addTempFile(java.io.File tempFile) |
void |
close()
Closes a session, releases all resources, and performs an implicit logout.
|
java.io.File |
createTempFile(java.lang.String prefix,
java.lang.String suffix,
java.io.File directory)
Creates a new empty file in the specified directory, using the given prefix and suffix strings to generate its name.
|
java.util.List<AboutTopic> |
getAboutTopics(ClientAboutInfo aboutClient)
Gets the topics to be displayed in the About page in BusinessUI.
|
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.
|
java.util.Map<java.lang.Object,java.lang.Object> |
getAllContextObjects()
Get all key-value pairs that are stored in this instance of CentraSiteSession.
|
AssetNavigatorManager |
getAssetNavigatorManager()
Returns the ImpactAnalysis Manager.
|
java.lang.String |
getBaseDir()
Gets the base directory.
|
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.
|
CentraSiteExporter |
getCentraSiteSwaggerExporter()
Gets the Swagger2.0 exporter which generates the Swagger2.0 formatted file for a REST API
|
Configurator |
getConfigurator(Organization organization)
Returns the organization specific configurator.
|
Configurator |
getConfigurator(User user)
Returns the user specific configurator.
|
com.centrasite.jaxr.CentraSiteConnection |
getConnection()
Returns underlying connection associated with this session.
|
CSODefaultAttributes |
getCSODefaultAttributes()
Get the CSO Default Attributes connected to this instance of CentraSiteSeassion
|
DeploymentManager |
getDeploymentManager()
Gets the deployment manager.
|
DiagnosticHandler |
getDiagnosticHandler()
Returns the session diagnostic handler.
|
java.util.Locale |
getDisplayLanguage()
Gets the display language set for this session.
|
HelpCenter |
getHelpCenter()
Return the HelpCenter which is used to access the available HelpCenterTopics.
|
java.lang.Object |
getObjectFromContext(java.lang.Object key)
Retrieve a key/value pair for being stored with this
CentaSiteSession instance
|
User |
getOwner()
Returns the owner of this session.
|
java.util.Locale |
getOwnerLocale()
Returns the locale defined for the currently logged in user.
|
RuntimeManager |
getRuntimeManager()
Gets the runtime manager instance.
|
ScheduledReportManager |
getScheduledReportManager()
Returns the scheduled-report manager associated with this session.
|
CSOUriGenerator |
getURIGenerator()
Returns the CSOUriGenerator for this session.
|
VirtualizationService |
getVirtualizationService()
Gets the virtualization service for this session.
|
boolean |
isClosed()
Indicates whether the current session is active or inactive.
|
boolean |
isDBAlive()
Checks whether the CentraSite DB is alive or down.
|
void |
putObjectsInContext(java.lang.Object key,
java.lang.Object value)
Passes a key/value pair for being stored with this
CentaSiteSession instance.
|
java.lang.Object |
removeObjectFromContext(java.lang.Object key)
Remove an Objects stored with particular key in this
CentaSiteSession instance
|
void |
setHttpServletRequest(javax.servlet.http.HttpServletRequest request)
Sets the HTTP servlet request for this session.
|
void |
setURIGenerator(CSOUriGenerator uriGenerator)
The URI format is not fixed but greatly depends on the CSO client.
|
com.centrasite.jaxr.CentraSiteConnection getConnection() throws CLLException
CentraSiteConnection
connection instance associated with this sessionCLLException
- In case of a failure to return the CentraSiteConnection
associated with CentraSiteSessionCentraSiteObjectManager getCentraSiteObjectManager() throws CLLException
CentraSiteObjectManager
instance associated with this sessionCLLException
- In case of a failure to return the CentraSiteObjectManager
associated with CentraSiteSessionCentraSiteObjectTypeManager getCentraSiteObjectTypeManager() throws CLLException
CentraSiteObjectTypeManager
instanceCLLException
- in case of a failure to return the CentraSiteObjectTypeManager
associated with CentraSiteSessionCSOSearchManager getCentraSiteObjectSearchManager() throws CLLException
CSOSearchManager
instanceCLLException
- in case of a failure to return the CSOSearchManager
associated with CentraSiteSessionCSOSearchConditionManager getCentraSiteObjectConditionManager() throws CLLException
CSOSearchConditionManager
instanceCLLException
- in case of a failure to return the CSOSearchConditionManager
associated with CentraSiteSessionCSOActionManager getActionManager() throws CLLException
CSOActionManager
instanceCLLException
- in case of a failure to return the CSOActionManager
associated with CentraSiteSessionConfigurator getConfigurator(User user) throws CLLException
user
- User
whose configurator is requiredConfigurator
object which contains the given user-specific configuration derived from the configuration hierarchy modelCLLException
- in case of a failure to return an instance of Configurator for the given userConfigurator getConfigurator(Organization organization) throws CLLException
organization
- Organization
whose configurator is requiredConfigurator
object which contains the given organization-specific configuration derived from the configuration hierarchy modelCLLException
- in case of a failure to return an instance of Configurator for the given organizationDiagnosticHandler getDiagnosticHandler() throws CLLException
DiagnosticHandler
for the sessionCLLException
- in case of failure to return the DiagnosticsHandler for CentraSiteSessionUser getOwner() throws CLLException
User
who is currently logged in.CLLException
- in case of a failure to return the owner of CentraSiteSessionActivityManager getActivityManager() throws CLLException
ActivityManager
instanceCLLException
- in case of a failure to return the ActivityManager
associated with CentraSiteSessionScheduledReportManager getScheduledReportManager() throws CLLException
ScheduledReportManager
instanceCLLException
- in case of a failure to return the ScheduledReportManager
associated with CentraSiteSessionActivityManager getActivityManager(User user) throws CLLException
user
- The User
whose Activity manager is requiredActivityManager
instanceCLLException
- in case of a failure to return the ActivityManager
for the specific userRuntimeManager getRuntimeManager() throws CLLException
RuntimeManager
instanceCLLException
- If an error occurs while getting the runtime manager instancejava.util.Locale getOwnerLocale() throws CLLException
Locale
for the logged in userCLLException
- in case of a failure to return the Locale
defined for the currently logged in uservoid close() throws CLLException
CLLException
- in case of a failure to release the resources held by the CentraSiteSessionboolean isClosed()
void setURIGenerator(CSOUriGenerator uriGenerator)
uriGenerator
- The CSOUriGenerator
to setCSOUriGenerator getURIGenerator()
CSOUriGenerator
instanceHelpCenter getHelpCenter() throws CLLException
HelpCenter
instanceCLLException
- In case of a failure to get the HelpCenter.java.util.List<AboutTopic> getAboutTopics(ClientAboutInfo aboutClient) throws CLLException
aboutClient
- The ClientAboutInfo
instance containing information about the logged in userList
of AboutTopic
sCLLException
- If an error occurs in getting the topicsjava.util.Locale getDisplayLanguage() throws CLLException
Locale
having the display languageCLLException
- If an error occurs while trying to get the localevoid setHttpServletRequest(javax.servlet.http.HttpServletRequest request)
request
- The HttpServletRequest
to setVirtualizationService getVirtualizationService() throws CLLException
VirtualizationService
instanceCLLException
- If an error occurs in getting the serviceDeploymentManager getDeploymentManager() throws CLLException
DeploymentManager
instanceCLLException
- If an error occurs in getting the deployment managerjava.lang.String getBaseDir() throws CLLException
CLLException
- If an error occurs while trying to get the base directory pathboolean isDBAlive()
true
the DB is up and running and false
otherwisevoid putObjectsInContext(java.lang.Object key, java.lang.Object value)
key
- A key that uniquely identifies this objectvalue
- Object that is to be stored in context.java.lang.Object getObjectFromContext(java.lang.Object key)
key
- A key that uniquely identifies the objectjava.lang.Object removeObjectFromContext(java.lang.Object key)
key
- A key that uniquely identifies the objectjava.util.Map<java.lang.Object,java.lang.Object> getAllContextObjects()
java.io.File createTempFile(java.lang.String prefix, java.lang.String suffix, java.io.File directory) throws java.io.IOException
File
.
The created temporary file will be removed when the session is closed.prefix
- The prefix string to be used in generating the file's name; must be at least three characters longsuffix
- The suffix string to be used in generating the file's name; may be null, in which case the suffix ".tmp" will be useddirectory
- The directory in which the file is to be created, or null if the default temporary-file directory is to be usedjava.io.IOException
- - If a file could not be createdvoid addTempFile(java.io.File tempFile)
AssetNavigatorManager getAssetNavigatorManager() throws java.lang.Exception
AssetNavigatorManager
instanceCLLException
- in case of a failure to return the AssetNavigatorManager
java.lang.Exception
CentraSiteExporter getCentraSiteSwaggerExporter() throws CLLException
CentraSiteExporter
CLLException
- if any internal errors while generating Swagger2.0 fileCSODefaultAttributes getCSODefaultAttributes() throws CLLException
CLLException