com.highqsoft.avalon

Class AoSession

java.lang.Object

org.omg.PortableServer.Servant

org.asam.ods.AoSessionPOA

com.highqsoft.avalon.AoSession

All Implemented Interfaces:

java.io.Serializable, AoSession, AoSessionOperations, org.omg.CORBA.Object, org.omg.CORBA.portable.IDLEntity, org.omg.CORBA.portable.InvokeHandler

public class AoSession
extends AoSessionPOA
implements AoSession

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AoSession.RefClassDescriptor Class to compare the objects in the list with references.
static class	AoSession.SessionCloseThread Thread which deactivate all the objects from the POA.
static class	AoSession.SessionDestroyThread Thread which has a short delay before the POA will be destroyed after the close method is finished.

Field Summary

Fields

Modifier and Type	Field and Description
protected long	cObjPtr
static int	DBG_ARG_LEVEL Method calls arguments will be reported with a DEBUGLEVEL above this value.
static int	DBG_CALL_LEVEL Method calls will be reported with a DEBUGLEVEL above this value.
static int	DBG_RETURN_LEVEL Method return will be reported with a DEBUGLEVEL above this value.
protected static int	debugLevel
protected static java.lang.String	newLogfileName
protected java.util.Vector<ODSReadTransfer>	openReads
protected java.util.Vector<FileTransactionEntry>	openTransactions
protected java.util.Vector<ODSWriteTransfer>	openWrites
protected org.omg.PortableServer.POA	poa The POA of the session, the POA will be destroyed after the session is close.
protected static java.util.HashMap<java.lang.Long,org.omg.CORBA.Object>	refCache
protected long	sessionCloseThread
protected java.lang.String	sessionCreatedTime
protected int	sessionNumber
protected long	sessionWillCloseThread
protected java.lang.String	userName
protected static boolean	workerModeActive
protected static java.lang.String	workerName

Constructor Summary

Constructors

Constructor and Description
AoSession() Constructors.
AoSession(long cObjPtr) The constructor

Method Summary

Methods

Modifier and Type	Method and Description
org.omg.CORBA.Request	_create_request(org.omg.CORBA.Context ctx, java.lang.String operation, org.omg.CORBA.NVList arg_list, org.omg.CORBA.NamedValue result)
org.omg.CORBA.Request	_create_request(org.omg.CORBA.Context ctx, java.lang.String operation, org.omg.CORBA.NVList arg_list, org.omg.CORBA.NamedValue result, org.omg.CORBA.ExceptionList exclist, org.omg.CORBA.ContextList ctxlist)
org.omg.CORBA.Object	_duplicate()
org.omg.CORBA.DomainManager[]	_get_domain_managers()
org.omg.CORBA.Policy	_get_policy(int policy_type)
int	_hash(int maximum)
boolean	_is_equivalent(org.omg.CORBA.Object other)
void	_release()
org.omg.CORBA.Request	_request(java.lang.String operation)
org.omg.CORBA.Object	_set_policy_override(org.omg.CORBA.Policy[] policies, org.omg.CORBA.SetOverrideType set_add)
void	abortTransaction() Abort (rollback) a transaction.
boolean	addFileTransactionEntry(FileTransactionEntry ft) Add a file transaction to the list of transactions.
void	addReadTransfer(ODSReadTransfer odsReadTransfer) Add the read transfer to the list of open read transfer for this session.
void	addWriteTransfer(ODSWriteTransfer odsWriteTransfer) Add the write transfer to the list of open write transfer for this session.
static void	aktivateWorkerMode()
void	checkLicense() Check if the license of the session is still active.
boolean	checkWrite(java.lang.String filename) Check if the file use used by this session for write transfer.
void	close() Close session to an ASAM-ODS server.
void	commitTransaction() Commit a transaction.
Blob	createBlob() Create a new object with the Interface Blob on the server.
AoSession	createCoSession() Create a co-session.
QueryEvaluator	createQueryEvaluator() Create a QueryEvaluator object.
void	deactivateFromPOA(org.omg.PortableServer.Servant servant) Deactivate a CORBA servant from the POA.
protected void	finalize()
void	flush() Make the changes permanent.
ApplElemAccess	getApplElemAccess() Get the application element access object from the current session.
ApplicationStructure	getApplicationStructure() Get the application structure from the current session.
ApplicationStructureValue	getApplicationStructureValue() Get the application structure as values from the current session.
BaseStructure	getBaseStructure() Get the base structure from the current session.
NameValueIterator	getContext(java.lang.String varPattern) Get context variables from the session.
NameValue	getContextByName(java.lang.String varName) Get a context variable by its name from the session.
java.lang.String	getCreateDateTime() Get the date / time the session is created.
static int	getDebugLevel() Get the debug level.
java.lang.String	getDescription() Get the description of the ASAM-ODS session.The description of the session is identical with description of the ASAM-ODS factory.
EnumerationAttributeStructure[]	getEnumerationAttributes() Get the list with the attributes of all elements and the enumeration name which has an enumeration.
EnumerationStructure[]	getEnumerationStructure() Get all enumerations used in the application model.
int	getId() Get the id of the ASAM-ODS session.
java.lang.String[]	getInfoList(java.lang.String varName) Get the value of a context variable.
static org.omg.CORBA.Object	getInstance(long cObjPtr) This method is only called from native code.
static org.omg.CORBA.Object	getInstance(long cObjPtr, int typeFlags) This method is only called from native code.
short	getLockMode() Get the current lock mode.
java.lang.String	getName() Get the name of the ASAM-ODS session.
int	getNotUsedFlag() Get the not used flag, the flag will be increased every time the method is used.
int	getNumberOfUsedObjects() Get the number of used objects.
static int	getSessionCloseCount() Get the session close count.
int	getSessionNumber() Get the number or id of the session.
org.omg.CORBA.Object	getSessionRef() Get the CORBA session reference.
java.lang.String	getType() Get the type of the ASAM-ODS session.
int	getTypeFlags()
int	getUseInstanceRefCache() Get flag use instance reference cache.
InstanceElement	getUser() 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 s given in the 'auth' parameter of the method newSession at the interface AoFactory (variable USER).
java.lang.String	getUserName() Get the name of the user logged on to the session
static java.lang.String	getWorkerLogFileSuffix()
static boolean	isWorkerMode()
NameIterator	listContext(java.lang.String varPattern) List the names of context variables from the session.
java.util.Collection<AvalonDestroyable>	listDestroyableObjects() Returns all the destroyable objects which belongs to this session sorted ascending based on last modification date.
UsedObject[]	listUsedObjects() Get the list of used objects from the POA map.
java.util.List<ValueMatrix>	listUsedValueMatrixes() Get the list of used ValueMatrix objects from the POA map.
void	log(java.lang.String msg) Log the message in the athos log file.
int	readNoAccess() Read the not used flag, the flag will be increased every time the method is used.
int	readNotUsedFlag() Read the not used flag, the flag will be increased every time the method is used.
org.omg.PortableServer.Servant	referenceToServant(org.omg.CORBA.Object reference) Convert a CORBA reference to a CORBA servant.
void	removeContext(java.lang.String varPattern) Remove context variables from the session.
void	removeReadTransfer(ODSReadTransfer odsReadTransfer) Remove the read transfer from the list of open read transfers.
void	removeWriteTransfer(ODSWriteTransfer odsWriteTransfer) Remove the write transfer from the list of write read transfers.
void	resetNotUsedFlag() Reset the not used flag, the flag will be increased every time the flag method is used.
void	restoreReadFlags() Restore the read flag value.
void	saveReadFlags() Save the current values of the read flags.
org.omg.CORBA.Object	servantToReference(org.omg.PortableServer.Servant servant) Convert a CORBA servant to a CORBA reference.
void	setContext(NameValue contextVariable) 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) Set/modify a known context variable or add a new context variable to the session.
void	setCurrentInitialRights(InitialRight[] irlEntries, boolean set) Every new created instance will set its initial rights to 'acl'.
static void	setDebugLevel(int level) Set the debug level.
void	setLockMode(short lockMode) Set the new lock mode.
void	setPassword(java.lang.String username, java.lang.String oldPassword, java.lang.String newPassword) Change the password for user defined by 'username' to 'newPassword'.
static void	setSessionNotificationEventManager(SessionNotificationEventManager sessionNotificationEventManager) Set the session notification event manager
void	setUserType(SessionUserType userType) Set/modify the user type of the session.
static void	setWorkerLogFileSuffix(java.lang.String workerLogFile)
void	startTransaction() Start a transaction on the physical storage system (e.g. database system).

Methods inherited from class org.asam.ods.AoSessionPOA

_all_interfaces, _invoke, _this, _this

Methods inherited from class org.omg.PortableServer.Servant

_default_POA, _get_delegate, _get_interface_def, _is_a, _non_existent, _object_id, _orb, _poa, _set_delegate, _this_object, _this_object

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.omg.CORBA.Object

_get_interface_def, _is_a, _non_existent

Field Detail

debugLevel

protected static int debugLevel

workerModeActive

protected static boolean workerModeActive

workerName

protected static java.lang.String workerName

newLogfileName

protected static java.lang.String newLogfileName

refCache

protected static java.util.HashMap<java.lang.Long,org.omg.CORBA.Object> refCache

cObjPtr

protected long cObjPtr

openReads

protected java.util.Vector<ODSReadTransfer> openReads

openWrites

protected java.util.Vector<ODSWriteTransfer> openWrites

openTransactions

protected java.util.Vector<FileTransactionEntry> openTransactions

sessionNumber

protected int sessionNumber

sessionCreatedTime

protected java.lang.String sessionCreatedTime

poa

protected org.omg.PortableServer.POA poa

The POA of the session, the POA will be destroyed after the session is close.

DBG_CALL_LEVEL

public static final int DBG_CALL_LEVEL

Method calls will be reported with a DEBUGLEVEL above this value.

See Also:

Constant Field Values

DBG_RETURN_LEVEL

public static final int DBG_RETURN_LEVEL

Method return will be reported with a DEBUGLEVEL above this value.

See Also:

Constant Field Values

DBG_ARG_LEVEL

public static final int DBG_ARG_LEVEL

Method calls arguments will be reported with a DEBUGLEVEL above this value.

See Also:

Constant Field Values

userName

protected java.lang.String userName

sessionCloseThread

protected long sessionCloseThread

sessionWillCloseThread

protected long sessionWillCloseThread

Constructor Detail

AoSession

public AoSession()

Constructors.

AoSession

public AoSession(long cObjPtr)

The constructor

Parameters:

cObjPtr - the C-Object pointer.

Method Detail

getTypeFlags

public int getTypeFlags()

getSessionRef

public org.omg.CORBA.Object getSessionRef()

Get the CORBA session reference.

Returns:

the CORBA session reference

getSessionCloseCount

public static int getSessionCloseCount()

Get the session close count.

setDebugLevel

public static void setDebugLevel(int level)

Set the debug level.

Parameters:

level - the new DEBUGLEVEL.

getDebugLevel

public static int getDebugLevel()

Get the debug level.

Returns:

level the current DEBUGLEVEL.

getWorkerLogFileSuffix

public static java.lang.String getWorkerLogFileSuffix()

Returns:

Get the name of the Avalon Worker

setWorkerLogFileSuffix

public static void setWorkerLogFileSuffix(java.lang.String workerLogFile)

Parameters:

Set - the name of the Avalon Worker

isWorkerMode

public static boolean isWorkerMode()

Returns:

Is Avalon running in worker mode?

aktivateWorkerMode

public static void aktivateWorkerMode()

Parameters:

Set - Avalon worker mode to true

setSessionNotificationEventManager

public static void setSessionNotificationEventManager(SessionNotificationEventManager sessionNotificationEventManager)

Set the session notification event manager

servantToReference

public org.omg.CORBA.Object servantToReference(org.omg.PortableServer.Servant servant)

Convert a CORBA servant to a CORBA reference. The servant object will be added to the list of used objects.

Parameters:

servant - The servant to be converted to a reference.

Returns:

The reference of the servant.

referenceToServant

public org.omg.PortableServer.Servant referenceToServant(org.omg.CORBA.Object reference)

Convert a CORBA reference to a CORBA servant.

Parameters:

reference - The reference to be converted to a servant.

Returns:

The servant of the reference.

deactivateFromPOA

public void deactivateFromPOA(org.omg.PortableServer.Servant servant)

Deactivate a CORBA servant from the POA.

Parameters:

servant - The servant to be converted to a reference.

getInstance

public static org.omg.CORBA.Object getInstance(long cObjPtr,
                               int typeFlags)

This method is only called from native code. Never call it from Java!

Parameters:

cObjPtr - the C-Object pointer.

typeFlags - The flags that are used to serialize the newly created object.

Returns:

the new created object ready for CORBA transport.

getInstance

public static org.omg.CORBA.Object getInstance(long cObjPtr)

This method is only called from native code. Never call it from Java!

Parameters:

cObjPtr - the C-Object pointer.

Returns:

the new created object ready for CORBA transport.

getCreateDateTime

public java.lang.String getCreateDateTime()

Get the date / time the session is created.

Returns:

The date time the session is created

getNumberOfUsedObjects

public int getNumberOfUsedObjects()

Get the number of used objects.

Returns:

the number of used objects.

getUseInstanceRefCache

public int getUseInstanceRefCache()

Get flag use instance reference cache.

Returns:

The use instance reference cache

getNotUsedFlag

public int getNotUsedFlag()

Get the not used flag, the flag will be increased every time the method is used.

Also every not-used flag of any AvalonDestroyable descendent of this session will incremented.

Returns:

The not used flag value, before the flag is incremented.

listDestroyableObjects

public java.util.Collection<AvalonDestroyable> listDestroyableObjects()

Returns all the destroyable objects which belongs to this session sorted ascending based on last modification date.

Returns:

a set of destroyable objects.

readNotUsedFlag

public int readNotUsedFlag()

Read the not used flag, the flag will be increased every time the method is used.

Returns:

The not used flag value, before the flag is incremented.

readNoAccess

public int readNoAccess()

Read the not used flag, the flag will be increased every time the method is used.

Returns:

The not used flag value, before the flag is incremented.

saveReadFlags

public void saveReadFlags()

Save the current values of the read flags.

restoreReadFlags

public void restoreReadFlags()

Restore the read flag value.

getSessionNumber

public int getSessionNumber()

Get the number or id of the session. This method is only used for internal perposes. For external usage with reset of the watch dog counter and the number of access use getId().

Returns:

The session number

See Also:

getId()

getUserName

public java.lang.String getUserName()
                             throws AoException

Get the name of the user logged on to the session

Returns:

the name of the user.

Throws:

AoException - any occurring ASAM ODS exception.

resetNotUsedFlag

public void resetNotUsedFlag()
                      throws AoException

Reset the not used flag, the flag will be increased every time the flag method is used. Check if the thread is the will close plugin or the close plugin these thread will not reset the not used flag and are allowed when the session is closed.

Throws:

AoException

abortTransaction

public void abortTransaction()
                      throws AoException

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

Specified by:

abortTransaction in interface AoSessionOperations

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

checkWrite

public boolean checkWrite(java.lang.String filename)

Check if the file use used by this session for write transfer.

Parameters:

filename - the filename

Returns:

true when the file is used by this session.

close

public void close()
           throws AoException

Close session to an ASAM-ODS server. Active transactions are committed.

Specified by:

close in interface AoSessionOperations

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

public void commitTransaction()
                       throws AoException

Commit a transaction. The changes made in the transaction become permanent.

Specified by:

commitTransaction in interface AoSessionOperations

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

public ApplicationStructure getApplicationStructure()
                                             throws AoException

Get the application structure from the current session.

Specified by:

getApplicationStructure in interface AoSessionOperations

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

createCoSession

public AoSession createCoSession()
                          throws AoException

Create a co-session. A 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, and the component can start its 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 at the interface AoFactory, a new session will be created when calling createSession, otherwise the exception AO_ACCESS_DENIED is thrown.

Specified by:

createCoSession in interface AoSessionOperations

Returns:

The application structure.

Throws:

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

getApplicationStructureValue

public ApplicationStructureValue getApplicationStructureValue()
                                                       throws AoException

Get the application structure as values from the current session.

Specified by:

getApplicationStructureValue in interface AoSessionOperations

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

public BaseStructure getBaseStructure()
                               throws AoException

Get the base structure from the current session.

Specified by:

getBaseStructure in interface AoSessionOperations

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

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

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

Specified by:

getContext in interface AoSessionOperations

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

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

Get a context variable by its name from the session.

Specified by:

getContextByName in interface AoSessionOperations

Parameters:

varName - The name of the requested context variable.

Returns:

The requested context variable. Special context variable is defined which will return information from the server. These variables are not listed at listContext or getContext.

Property Keyword	Datatype	Default	Description
Avalon.NumberOfSession	Integer	no	The current number of open sessions.
Avalon.MaxNumberOfSession	Integer	no	The maximum number of concurrent sessions.

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

getUser

public InstanceElement getUser()
                        throws AoException

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 s 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 methods helps the client to get his settings.

Specified by:

getUser in interface AoSessionOperations

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

listContext

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

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

Specified by:

listContext in interface AoSessionOperations

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

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

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

Specified by:

removeContext in interface AoSessionOperations

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

public void setContext(NameValue contextVariable)
                throws AoException

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

Specified by:

setContext in interface AoSessionOperations

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

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

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

Specified by:

setContextString in interface AoSessionOperations

Parameters:

varName - The name of the context variable.

value - The value of the context variable.

Property Keyword	Datatype	Default	Description
Avalon.StopServer	String	no	This is a special context variable for the Avalon server, to stop the server at the next session checkout, when no session are active anymore.

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

log

public void log(java.lang.String msg)

Log the message in the athos log file.

Parameters:

msg - the message.

addFileTransactionEntry

public boolean addFileTransactionEntry(FileTransactionEntry ft)

Add a file transaction to the list of transactions.

Parameters:

ft - the file transaction.

Returns:

true when the file is added which also means the transation is active.

startTransaction

public void startTransaction()
                      throws AoException

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 get 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 commited automatically. If a transaction is already active an exception is thrown.

Specified by:

startTransaction in interface AoSessionOperations

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

public void flush()
           throws AoException

Make the changes permanent.

Specified by:

flush in interface AoSessionOperations

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

setCurrentInitialRights

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

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

Specified by:

setCurrentInitialRights in interface AoSessionOperations

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

public short getLockMode()
                  throws AoException

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.

Specified by:

getLockMode in interface AoSessionOperations

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 AO_TRANSACTION_NOT_ACTIVE

setLockMode

public void setLockMode(short lockMode)
                 throws AoException

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.

Specified by:

setLockMode in interface AoSessionOperations

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

public ApplElemAccess getApplElemAccess()
                                 throws AoException

Get the application element access object from the current session.

Specified by:

getApplElemAccess in interface AoSessionOperations

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

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

Change the password for user defined by 'username' to 'newPassword'. A normal user must supply his current password 'oldPassword'. The superuser can change the password without supplying the current password 'oldPassword'. If no username is given the password of the user of te current session will be changed.

Specified by:

setPassword in interface AoSessionOperations

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 superuser.

oldPassword - The current password of the user. A normal user must supply his current password. The superuser 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

public java.lang.String getDescription()
                                throws AoException

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.

Specified by:

getDescription in interface AoSessionOperations

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

public java.lang.String getName()
                         throws AoException

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.

Specified by:

getName in interface AoSessionOperations

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

public java.lang.String getType()
                         throws AoException

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.

Specified by:

getType in interface AoSessionOperations

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

getId

public int getId()
          throws AoException

Get the id of the ASAM-ODS session. The id of the session is identical with the sessionnumber.

Specified by:

getId in interface AoSessionOperations

Returns:

The Id 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

public QueryEvaluator createQueryEvaluator()
                                    throws AoException

Create a QueryEvaluator object.

Specified by:

createQueryEvaluator in interface AoSessionOperations

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

public Blob createBlob()
                throws AoException

Create a new object with the Interface Blob on the server. This object can be used to create an attribute value of the datatype DT_BLOB.

Specified by:

createBlob in interface AoSessionOperations

Returns:

The reference of the blob object whgich 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

checkLicense

public void checkLicense()
                  throws AoException

Check if the license of the session is still active. This notify also RLM the license is still in use.

Throws:

AoException

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

listUsedObjects

public UsedObject[] listUsedObjects()

Get the list of used objects from the POA map.

Returns:

listUsedValueMatrixes

public java.util.List<ValueMatrix> listUsedValueMatrixes()

Get the list of used ValueMatrix objects from the POA map.

getInfoList

public java.lang.String[] getInfoList(java.lang.String varName)
                               throws AoException

Get the value of a context variable. This function is used to get the information from the CImplemetation for the variables of the ServiceControl interface

Parameters:

varName - The name of the context variable.

Returns:

The list with values.

Throws:

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

_create_request

public org.omg.CORBA.Request _create_request(org.omg.CORBA.Context ctx,
                                    java.lang.String operation,
                                    org.omg.CORBA.NVList arg_list,
                                    org.omg.CORBA.NamedValue result)

Specified by:

_create_request in interface org.omg.CORBA.Object

_create_request

public org.omg.CORBA.Request _create_request(org.omg.CORBA.Context ctx,
                                    java.lang.String operation,
                                    org.omg.CORBA.NVList arg_list,
                                    org.omg.CORBA.NamedValue result,
                                    org.omg.CORBA.ExceptionList exclist,
                                    org.omg.CORBA.ContextList ctxlist)

Specified by:

_create_request in interface org.omg.CORBA.Object

_duplicate

public org.omg.CORBA.Object _duplicate()

Specified by:

_duplicate in interface org.omg.CORBA.Object

_get_domain_managers

public org.omg.CORBA.DomainManager[] _get_domain_managers()

Specified by:

_get_domain_managers in interface org.omg.CORBA.Object

_get_policy

public org.omg.CORBA.Policy _get_policy(int policy_type)

Specified by:

_get_policy in interface org.omg.CORBA.Object

_hash

public int _hash(int maximum)

Specified by:

_hash in interface org.omg.CORBA.Object

_is_equivalent

public boolean _is_equivalent(org.omg.CORBA.Object other)

Specified by:

_is_equivalent in interface org.omg.CORBA.Object

_release

public void _release()

Specified by:

_release in interface org.omg.CORBA.Object

_request

public org.omg.CORBA.Request _request(java.lang.String operation)

Specified by:

_request in interface org.omg.CORBA.Object

_set_policy_override

public org.omg.CORBA.Object _set_policy_override(org.omg.CORBA.Policy[] policies,
                                        org.omg.CORBA.SetOverrideType set_add)

Specified by:

_set_policy_override in interface org.omg.CORBA.Object

getEnumerationAttributes

public EnumerationAttributeStructure[] getEnumerationAttributes()
                                                         throws AoException

Get the list with the attributes of all elements and the enumeration name which has an enumeration.

Specified by:

getEnumerationAttributes in interface AoSessionOperations

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

getEnumerationStructure

public EnumerationStructure[] getEnumerationStructure()
                                               throws AoException

Get all enumerations used in the application model. The enumerations and all items of the enumerations are returned to the client.

Specified by:

getEnumerationStructure in interface AoSessionOperations

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

addReadTransfer

public void addReadTransfer(ODSReadTransfer odsReadTransfer)

Add the read transfer to the list of open read transfer for this session.

Parameters:

odsReadTransfer - the read transfer

removeReadTransfer

public void removeReadTransfer(ODSReadTransfer odsReadTransfer)

Remove the read transfer from the list of open read transfers.

Parameters:

odsReadTransfer - teh read transfer.

addWriteTransfer

public void addWriteTransfer(ODSWriteTransfer odsWriteTransfer)

Add the write transfer to the list of open write transfer for this session.

Parameters:

odsWriteTransfer - the write transfer

removeWriteTransfer

public void removeWriteTransfer(ODSWriteTransfer odsWriteTransfer)

Remove the write transfer from the list of write read transfers.

Parameters:

odsWriteTransfer - teh write transfer.

setUserType

public void setUserType(SessionUserType userType)
                 throws AoException

Set/modify the user type of the session.

Parameters:

userType - The user type for the session.

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