org.asam.ods

Interface AoFactoryOperations

All Known Subinterfaces:

AoFactory, AoFactoryIF

All Known Implementing Classes:

_AoFactoryStub, AoFactory, AoFactory, AoFactoryPOA, DistributorAoFactory

public interface AoFactoryOperations

The ASAM factory interface.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDescription() (2001) Get the description of the ASAM ODS factory.
java.lang.String	getInterfaceVersion() (2002) Get the interface version of the ASAM ODS factory.
java.lang.String	getName() (2003) Get the name of the ASAM ODS factory.
java.lang.String	getType() (2004) Get the type of the ASAM ODS factory.
AoSession	newSession(java.lang.String auth) (2005) Establish a new session to an ASAM ODS server.
AoSession	newSessionNameValue(NameValue[] auth) (2006) Establish a new session to an ASAM ODS server, using an authentication string as set of name-value-pairs.

Method Detail

getDescription

java.lang.String getDescription()
                                throws AoException

(2001) Get the 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 factory.

Throws:

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

getInterfaceVersion

java.lang.String getInterfaceVersion()
                                     throws AoException

(2002) Get the interface version of the ASAM ODS factory. The interface version is for each ODS version a fixed string. The string is the version of the interface implemented at the server. The format of the string is: V.. - Major Version Nr (numeric: [0-9]+) - Minor Version Nr (numeric: [0-9]+) - Revision Nr (numeric: [0-9]+) Example of the version specification is 'V5.1.0'.

Returns:

The interface version of the ASAM ODS factory.

Throws:

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

getName

java.lang.String getName()
                         throws AoException

(2003) Get the name of the ASAM ODS factory. If the name is not available an empty string is returned and no exception is thrown.

Returns:

The name of the ASAM ODS factory.

Throws:

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

getType

java.lang.String getType()
                         throws AoException

(2004) Get 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 factory.

Throws:

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

newSession

AoSession newSession(java.lang.String auth)
                     throws AoException

(2005) Establish a new session to an ASAM ODS server. The server normally checks the activity of the session and will close the session after a time period of inactivity.

Parameters:

auth - A string containing the authentication information. The following values are currently supported: USER PASSWORD CREATE_COSESSION_ALLOWED FOR_USER The values may be specified in any order and have to be separated by comma. The variable CREATE_COSESSION_ALLOWED Value (DT_STRING) TRUE or FALSE Default for CREATE_COSESSION_ALLOWED = FALSE. The variable CREATE_COSESSION_ALLOWED is a read-only variable in the session. The variable FOR_USER is the name of the user for which this session shall be created. If this value is given, USER must be a superuser. Otherwise the exception AO_CONNECT_REFUSED will be thrown. Example: "USER=hans, PASSWORD=secret, CREATE_COSESSION_ALLOWED = TRUE"

Returns:

The new created ASAM ODS session.

Throws:

AoException - with the following possible error codes: AO_CONNECT_FAILED AO_CONNECT_REFUSED AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_OPEN_MODE_NOT_SUPPORTED AO_SESSION_LIMIT_REACHED

newSessionNameValue

AoSession newSessionNameValue(NameValue[] auth)
                              throws AoException

(2006) Establish a new session to an ASAM ODS server, using an authentication string as set of name-value-pairs. The server normally checks the activity of the session and will close the session after a time period of inactivity. The authentication is a list of NameValue which is an argument of the method.

Parameters:

auth - The authentication string as set of pairs (NameValue) consisting of a name and a value each. The name may be the name of any context valiable, the value may be any allowed value for that context variable. With this argument the values of NameValue can contain also comma because these are not used as separator.

Returns:

The new created ASAM ODS session.

Throws:

AoException - with the following possible error codes: AO_CONNECT_FAILED AO_CONNECT_REFUSED AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_OPEN_MODE_NOT_SUPPORTED AO_SESSION_LIMIT_REACHED