public class UserSession
extends java.lang.Object
DataProvider
with an OracleConnection
. An application creates a UserSession
with the createSession
method of a DataProvider
.
An application can have many UserSession
objects that share the same DataProvider
. Each UserSession
has a separate OracleConnection
. The metadata provided by the MdmMetadataProvider
of the DataProvider
is the same for all of the UserSession
objects.
To end a UserSession
, an application calls the closeSession
method of the UserSession
. Doing so closes any open CursorManager
objects and commits or rolls back any Transaction
objects associated with the UserSession
. It does not, however, close the associated OracleConnection
.
Modifier and Type | Method and Description |
---|---|
void |
closeSession()
Closes the
UserSession but does not close the associated OracleConnection . |
oracle.jdbc.OracleConnection |
getConnection()
Gets the
OracleConnection associated with the UserSession . |
DataProvider |
getDataProvider()
Gets the
DataProvider associated with the UserSession . |
java.lang.String |
getDefaultLanguage()
Gets the default language for the
UserSession . |
Transaction |
getRootTransaction()
Gets the root
Transaction associated with the UserSession . |
XMLParserCallback |
getServerXMLParserCallback()
Gets the
XMLParserCallback implementation that is associated with this UserSession . |
java.util.Properties |
getSettings()
Get the
Properties object that contains all of the settings used by this UserSession . |
void |
interrupt()
Terminates any operation that is currently executing in the
UserSession . |
boolean |
isOpen()
Indicates whether the
OracleConnection has an open connection to the database. |
void |
setServerXMLParserCallback(XMLParserCallback callback)
Specifies an
XMLParserCallback for Oracle OLAP to use when it retrieves a metadata object that is stored on the server. |
public Transaction getRootTransaction()
Transaction
associated with the UserSession
.Transaction
associated with the UserSession
.public oracle.jdbc.OracleConnection getConnection()
OracleConnection
associated with the UserSession
.OracleConnection
associated with the UserSession
.public boolean isOpen()
OracleConnection
has an open connection to the database.boolean
that is true
if the OracleConnection
is open or false
if it is not.public void closeSession()
UserSession
but does not close the associated OracleConnection
.public DataProvider getDataProvider()
DataProvider
associated with the UserSession
.DataProvider
associated with the UserSession
.public java.util.Properties getSettings()
Properties
object that contains all of the settings used by this UserSession
.Properties
object that contains the settings used by this UserSession
.public final java.lang.String getDefaultLanguage()
UserSession
. The language is the default language of the database and not that of the client application or the session.String
that identifies the default language for the UserSession
.public void setServerXMLParserCallback(XMLParserCallback callback)
XMLParserCallback
for Oracle OLAP to use when it retrieves a metadata object that is stored on the server. For example, if an application specifies an XMLParserCallback
with this method and then calls a method like MdmMetadataProvider.getMetadataObject(id)
or MdmDatabaseSchema.getTopLevelObject(name)
and the requested object is invalid, then Oracle OLAP calls a method of the XMLParserCallback
. A object stored on the server can become invalid if, for example, the column or table that the object references no longer exists in the database.
The XMLParserCallback.ERROR_BY_EXCEPTION
constant is not used by Oracle OLAP for an XMLParserCallback
specified by this method. If a method of the XMLParserCallback
returns the ERROR_BY_EXCEPTION
constant, then Oracle OLAP uses the default constant, which is ERROR_BY_SET_TO_NULL
.
The XMLParserCallback
specified by this method is not used by the MdmMetadataProvider.importXML
or the SyntaxObject.fromSyntax
methods. Those methods use the XMLParserCallback
that the application passes to them.
callback
- An implementation of the XMLParserCallback
interface.public XMLParserCallback getServerXMLParserCallback()
XMLParserCallback
implementation that is associated with this UserSession
.XMLParserCallback
associated with this UserSession
.public final void interrupt()
UserSession
. This method has the same effect as calling the oracle.jdbc.OracleConnection.cancel
method.
An application must call this method in a separate thread. An application can use this method to terminate a build operation that was initiated by a DataProvider.executeBuild
method.