org.asam.ods

Interface AoSessionOperations

All Known Subinterfaces:

AoSession

All Known Implementing Classes:

_AoSessionStub, AoSession, AoSession, AoSessionPOA

public interface AoSessionOperations

The ASAM ODS session interface.

Method Summary

Methods

Modifier and Type	Method and Description
void	abortTransaction() (3001) Abort (rollback) a transaction.
void	close() (3002) Close session to an ASAM ODS server.
void	commitTransaction() (3003) Commit a transaction.
Blob	createBlob() (3024) Create a new object with the Interface Blob on the server.
AoSession	createCoSession() (3025) Create a co-session.
QueryEvaluator	createQueryEvaluator() (3023) Create a QueryEvaluator object.
void	flush() (3014) Make the pending changes of the current transaction permanent.
ApplElemAccess	getApplElemAccess() (3018) Get the application element access object from the current session.
ApplicationStructure	getApplicationStructure() (3004) Get the application model from the current session by returning an object with the interface ApplicationStructure.
ApplicationStructureValue	getApplicationStructureValue() (3005) Get the application model as values from the current session.
BaseStructure	getBaseStructure() (3006) Get the ASAM ODS base model from the current session by returning an object with the interface BaseStructure.
NameValueIterator	getContext(java.lang.String varPattern) (3007) Get context variables from the session.
NameValue	getContextByName(java.lang.String varName) (3008) Get a context variable by its name from the session.
java.lang.String	getDescription() (3020) Get the description of the ASAM ODS session.
EnumerationAttributeStructure[]	getEnumerationAttributes() (3027) Get a list of all attributes of all elements in the application model which are of enumeration type.
EnumerationStructure[]	getEnumerationStructure() (3028) Get all enumerations used in the application model.
int	getId() (3029) Returns the Id of the session.
short	getLockMode() (3016) Get the current lock mode.
java.lang.String	getName() (3021) Get the name of the ASAM ODS session.
java.lang.String	getType() (3022) Get the type of the ASAM ODS session.
InstanceElement	getUser() (3026) Returns the instance element of the user logged in.
NameIterator	listContext(java.lang.String varPattern) (3009) List the names of context variables from the session.
void	removeContext(java.lang.String varPattern) (3010) Remove context variables from the session.
void	setContext(NameValue contextVariable) (3011) Set/modify a known context variable or add a new context variable to the session.
void	setContextString(java.lang.String varName, java.lang.String value) (3012) Set/modify a known context variable or add a new context variable to the session.
void	setCurrentInitialRights(InitialRight[] irlEntries, boolean set) (3015) Every new created session instance will set its initial rights to .
void	setLockMode(short lockMode) (3017) Set the new lock mode.
void	setPassword(java.lang.String username, java.lang.String oldPassword, java.lang.String newPassword) (3019) Change the password for user defined by to .
void	startTransaction() (3013) Start a transaction on the physical storage system (e.g. database system).

Method Detail

abortTransaction

void abortTransaction()
                      throws AoException

(3001) Abort (rollback) a transaction. The changes made in the transaction are lost.

Throws:

AoException - with the following possible error codes: AO_ACCESS_DENIED AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE AO_TRANSACTION_NOT_ACTIVE

close

void close()
           throws AoException

(3002) Close session to an ASAM ODS server. Active transactions are committed.

Throws:

AoException - with the following possible error codes: AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

commitTransaction

void commitTransaction()
                       throws AoException

(3003) Commit a transaction. The changes made in the transaction become permanent.

Throws:

AoException - with the following possible error codes: AO_ACCESS_DENIED AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE AO_TRANSACTION_NOT_ACTIVE

getApplicationStructure

ApplicationStructure getApplicationStructure()
                                             throws AoException

(3004) Get the application model from the current session by returning an object with the interface ApplicationStructure. The complete information on the application model is available through that interface.

Returns:

The application structure.

Throws:

AoException - with the following possible error codes: AO_ACCESS_DENIED AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

getApplicationStructureValue

ApplicationStructureValue getApplicationStructureValue()
                                                       throws AoException

(3005) Get the application model as values from the current session.

Returns:

The application structure as value.

Throws:

AoException - with the following possible error codes: AO_ACCESS_DENIED AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

getBaseStructure

BaseStructure getBaseStructure()
                               throws AoException

(3006) Get the ASAM ODS base model from the current session by returning an object with the interface BaseStructure. The complete information on the base model is available through that interface; it includes all possible base elements with all possible base attributes as specified by ASAM ODS.

Returns:

The base structure.

Throws:

AoException - with the following possible error codes: AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

getContext

NameValueIterator getContext(java.lang.String varPattern)
                             throws AoException

(3007) Get context variables from the session. A pattern string can be specified to select groups of variables.

Parameters:

varPattern - The name or the search pattern for the context variable(s).

Returns:

A list of context variables.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_FOUND AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

getContextByName

NameValue getContextByName(java.lang.String varName)
                           throws AoException

(3008) Get a context variable by its name from the session.

Parameters:

varName - The name of the requested context variable.

Returns:

The requested context variable.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_FOUND AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

listContext

NameIterator listContext(java.lang.String varPattern)
                         throws AoException

(3009) List the names of context variables from the session. A pattern string can be specified to select groups of variables.

Parameters:

varPattern - The name or the search pattern for the context variable(s).

Returns:

A list of context variable names.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NOT_FOUND AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

removeContext

void removeContext(java.lang.String varPattern)
                   throws AoException

(3010) Remove context variables from the session. A pattern string can be specified to remove groups of variables.

Parameters:

varPattern - The name or the search pattern for the context variable(s) to be removed.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NOT_FOUND AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

setContext

void setContext(NameValue contextVariable)
                throws AoException

(3011) Set/modify a known context variable or add a new context variable to the session.

Parameters:

contextVariable - The context variable.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

setContextString

void setContextString(java.lang.String varName,
                    java.lang.String value)
                      throws AoException

(3012) Set/modify a known context variable or add a new context variable to the session. This is a convenience method for the frequently used string variable type. It uses setContext internally.

Parameters:

varName - The name of the context variable.

value - The value of the context variable.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

startTransaction

void startTransaction()
                      throws AoException

(3013) Start a transaction on the physical storage system (e.g. database system). Only when a transaction is started it is allowed to create or modify instances or measurement data. The changes will become permanent with a commit of the transaction or will be lost with an abort of the transaction. If the session is closed the transaction will be committed automatically. If a transaction is already active an exception is thrown.

Throws:

AoException - with the following possible error codes: AO_ACCESS_DENIED AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE AO_TRANSACTION_ALREADY_ACTIVE

flush

void flush()
           throws AoException

(3014) Make the pending changes of the current transaction permanent.

Throws:

AoException - with the following possible error codes: AO_ACCESS_DENIED AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE AO_TRANSACTION_NOT_ACTIVE

setCurrentInitialRights

void setCurrentInitialRights(InitialRight[] irlEntries,
                           boolean set)
                             throws AoException

(3015) Every new created session instance will set its initial rights to . This method overrides the default-methods for applying initial rights. The initial rights are only valid for the current session.

Parameters:

irlEntries - The current initial rights.

set - Set (1) or remove (0) the current initial rights. The previous initial rights get lost. If the parameter set is 0 (remove) the parameter irlEntries will be ignored.

Throws:

AoException - with the following possible error codes: AO_ACCESS_DENIED AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE AO_TRANSACTION_NOT_ACTIVE

getLockMode

short getLockMode()
                  throws AoException

(3016) Get the current lock mode. The lock mode tells the server which objects to lock for upcoming changes. Application elements, instance elements or children of elements can be locked.

Returns:

The current lock mode. The lock mode constants are defined in the interface LockMode. The interface definition language IDL does not allow to set the values of enumerations thus the constant definitions had to be done in an interface.

Throws:

AoException - with the following possible error codes: AO_ACCESS_DENIED AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

setLockMode

void setLockMode(short lockMode)
                 throws AoException

(3017) Set the new lock mode. The lock mode tells the server which objects to lock for upcoming changes. Application elements, instance elements or children of elements can be locked.

Parameters:

lockMode - The new lock mode. The lock mode constants are defined in the interface LockMode. The interface definition language IDL does not allow to set the values of enumerations thus the constant definitions had to be done in an interface.

Throws:

AoException - with the following possible error codes: AO_ACCESS_DENIED AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE AO_TRANSACTION_NOT_ACTIVE

getApplElemAccess

ApplElemAccess getApplElemAccess()
                                 throws AoException

(3018) Get the application element access object from the current session.

Returns:

The application element access object.

Throws:

AoException - with the following possible error codes: AO_ACCESS_DENIED AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

setPassword

void setPassword(java.lang.String username,
               java.lang.String oldPassword,
               java.lang.String newPassword)
                 throws AoException

(3019) Change the password for user defined by to . A normal user must supply his current password . The super user can change the password without supplying the current password . If no username is given the password of the user of the current session will be changed. The password is normally encrypted in the attribute of the user instance element. Creating a new user can be done by creating a new instance, afterwards the password must be set by the super user.

Parameters:

username - The name of the user for which the password will be changed. If no username is given the password of the current user will be changed. If the username differs from the current user the current user must be a super user.

oldPassword - The current password of the user. A normal user must supply his current password. The super user can change the password without supplying the current password.

newPassword - The new password of the user.

Throws:

AoException - with the following possible error codes: AO_ACCESS_DENIED AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE AO_TRANSACTION_NOT_ACTIVE AO_WRONG_PASSWORD

getDescription

java.lang.String getDescription()
                                throws AoException

(3020) Get the description of the ASAM ODS session. The description of the session is identical with description of the ASAM ODS factory. If the description is not available an empty string is returned and no exception is thrown. The server loads the description from the base attribute "description" of the instance of AoEnvironment.

Returns:

The description of the ASAM ODS session.

Throws:

AoException - with the following possible error codes: AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE AO_CONNECTION_LOST

getName

java.lang.String getName()
                         throws AoException

(3021) Get the name of the ASAM ODS session. The name of the session is identical with the name of the ASAM ODS factory. If the name is not available an empty string is returned and no exception is thrown. The server loads the name from the base attribute "name" of the instance of AoEnvironment.

Returns:

The name of the ASAM ODS session.

Throws:

AoException - with the following possible error codes: AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE AO_CONNECTION_LOST

getType

java.lang.String getType()
                         throws AoException

(3022) Get the type of the ASAM ODS session. The type of the session is identical with the type of the ASAM ODS factory. If the type is not available an empty string is returned and no exception is thrown. The server loads the type from the base attribute "Application_model_type" of the instance of AoEnvironment.

Returns:

The type of the ASAM ODS session.

Throws:

AoException - with the following possible error codes: AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE AO_CONNECTION_LOST

createQueryEvaluator

QueryEvaluator createQueryEvaluator()
                                    throws AoException

(3023) Create a QueryEvaluator object. The object supports the query execution in synchronous and asynchronous mode.

Returns:

The new created query evaluator object

Throws:

AoException - with the following possible error codes: AO_ACCESS_DENIED AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

createBlob

Blob createBlob()
                throws AoException

(3024) Create a new object with the Interface Blob on the server. This object can be used to create an attribute value of the data type DT_BLOB.

Returns:

The reference of the blob object which is generated at the server.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

createCoSession

AoSession createCoSession()
                          throws AoException

(3025) Create a co-session. The co-session is the same session as the original session was at login time. The co-session has no relation to the original session except that the same authentication is used. A client application with components can give all components its own session to the ASAM ODS Server. So the component can close the session when it is ready, the component can start his own transaction without any conflict with other components. Only when the context variable CREATE_COSESSION_ALLOWED has been set to TRUE in the 'auth' parameter of the method newSession or method newSessionNameValue at the interface AoFactory, a new session will be created when calling createSession, otherwise the exception AO_ACCESS_DENIED is thrown.

Returns:

The co session.

Throws:

AoException - with the following possible error codes: AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_ACCESS_DENIED

getUser

InstanceElement getUser()
                        throws AoException

(3026) Returns the instance element of the user logged in. This is the instance element from the application element derived from AoUser, with the name given in the 'auth' parameter of the method newSession at the interface AoFactory (variable USER). When the client settings of the user are stored in the ASAM ODS application model, this method helps the client to get its settings.

Returns:

The instance element of the logged in user.

Throws:

AoException - with the following possible error codes: AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY

getEnumerationAttributes

EnumerationAttributeStructure[] getEnumerationAttributes()
                                                         throws AoException

(3027) Get a list of all attributes of all elements in the application model which are of enumeration type. Each entry of this list provides information about - the name of the application attribute that has an enumeration data type - the id of the application element to which this application attribute belongs - the name of the enumerastion whose items may be selected as value for the application attribute. The method also returns based application attributes (where the enumeration is already specified by ASAM ODS). In the (unusual) case the application model does not show any enumerastion type attribute, an empty list is returned.

Returns:

The list with attribute and there enumeration.

Throws:

AoException - with the following possible error codes: AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE AO_NOT_FOUND

getEnumerationStructure

EnumerationStructure[] getEnumerationStructure()
                                               throws AoException

(3028) Get all enumerations used in the application model. A list of all enumerations available in the application model is returned to the client. This list contains for each enumeration its name and all of its items (including item index and item name). The method also returns all enumerations of the ODS specification (which are specified by ASAM ODS), no matter whether these enumerations are used in any attribute of the application model.

Returns:

The enumeration with there Items.

Throws:

AoException - with the following possible error codes: AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

getId

int getId()
          throws AoException

(3029) Returns the Id of the session. The ODS server will give each session an unique Id. The ODS server returns this Id to the client.

Returns:

The Id of the session.

Throws:

AoException - with the following possible error codes: AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY