All Frameworks Class Hierarchy This Framework Previous Next Indexes
ENOVaultClientCPP Class ENOVIVaultSessionFactory
ENOVIVaultSessionFactory
Usage: you must use this class as is. You should never derive it.
public class ENOVIVaultSessionFactory
Class to manage Vault sessions.
role: This class provides static methods enabling to get and release ENOVIVaultSession objects.
Method Index
- o
endVaultSession(ENOVIVaultSession*,ENOVIVaultError&)
- Terminates a Vault session.
- o
endVaultSessionProxy(ENOVIVaultSession*,ENOVIVaultError&)
- Terminates a Vault session proxy.
- o
getDefaultAliasName(CATUnicodeString&,ENOVIVaultError&)
- Retrieves the alias name of the default Vault session.
- o
getVaultAliasNames(CATListOfCATUnicodeString&,ENOVIVaultError&)
- Retrieves the alias names of all the known Vaults.
- o
getVaultSession(CATUnicodeString&,CATUnicodeString&,int&,CATBoolean&,ENOVIVaultSession**,ENOVIVaultError&)
- Retrieves the Vault session pertainning to the given parameters.
- o
getVaultSession(SEQUENCE_octet&,CATBoolean&,ENOVIVaultSession**,ENOVIVaultError&)
- Retrieves the Vault session pertainning to the given parameters.
Methods
o endVaultSession
-
Terminates a Vault session.
- Parameters:
-
- iENOVIVaultSession
- [in] - Vault session to end.
Lifecycle rules deviation: The iENOVIVaultSession parameter will be deallocated.
- oVaultError
- [out] - Details about the error.
- Returns:
- S_OK, E_FAIL
o endVaultSessionProxy
-
Terminates a Vault session proxy.
- Parameters:
-
- iENOVIVaultSession
- [in] - Vault session to end.
Lifecycle rules deviation: The iENOVIVaultSession parameter will be deallocated.
- oVaultError
- [out] - Details about the error.
- Returns:
- S_OK, E_FAIL
o getDefaultAliasName
-
Retrieves the alias name of the default Vault session.
- Parameters:
-
- oDefaultAliasName
- [out] - Alias name of the default Vault session.
- oVaultError
- [out] - Details about the error.
- Returns:
- S_OK, E_FAIL
o getVaultAliasNames
-
Retrieves the alias names of all the known Vaults.
- Parameters:
-
- oVaultAliasNamesliste
- [out] - Known Vaults alias names.
- oVaultError
- [out] - Details about the error.
- Returns:
- S_OK, E_FAIL
o getVaultSession
-
Retrieves the Vault session pertainning to the given parameters.
If the
ENOVIVaultSession Object doesn't exist yet, it will be created.
- Parameters:
-
- iTransactionMasterServerMarker
- [in] - Identifier of the server where the transaction manager is located.
Legal Values: iAction may be set to "" when the Vault session is transaction master
- iTransactionMasterHostName
- [in] - Hostname of the transaction manager process.
Legal Values: iAction may be set to "" when the Vault session is transaction master
- iTransactionMasterListenPort
- [in] - Listen port on which call the transaction manager
Legal Values: iAction may be set to 0 when the Vault session is transaction master.
- iIsTransactionMaster
- [in] - specifies if this process is transaction master.
Legal Values: iAction may be set to:
- CATTrue
- To indicate that the session will support all transaction related methods
- CATFalse
- To indicate that the session will not support all transaction related methods. Meaning that it is part of multi-process transaction whose master is another vault session. In this case, the iTransactionMasterHostName and iTransactionMasterListenPort parameters are mandatory.
- oppENOVIVaultSession
- [out] - Double pointer on ENOVIVaultSession Object.
Lifecycle rules deviation: oppENOVIVaultSession parameter must only be dealocated using the
endVaultSession method.
- oVaultError
- [out] - Details about the error.
- Returns:
- S_OK, VAULT_E_NOSESSION, E_FAIL
- Deprecated:
- V5R12
o getVaultSession
-
Retrieves the Vault session pertainning to the given parameters.
If the
ENOVIVaultSession Object doesn't exist yet, it will be created.
- Parameters:
-
- ibvVaultSessionOId
- [in] - the vault user session object identifier.
- iIsTransactionMaster
- [in] - specifies if this process is transaction master.
Legal Values: iAction may be set to:
- CATTrue
- To indicate that the session will support all transaction related methods
- CATFalse
- To indicate that the session will not support all transaction related methods. Meaning that it is part of multi-process transaction whose master is another vault session. In this case, the iTransactionMasterHostName and iTransactionMasterListenPort parameters are mandatory.
- oppENOVIVaultSession
- [out] - Double pointer on ENOVIVaultSession Object.
Lifecycle rules deviation: oppENOVIVaultSession parameter must only be dealocated using the
endVaultSession method.
- oVaultError
- [out] - Details about the error.
- Returns:
- S_OK, VAULT_E_NOSESSION, E_FAIL
This object is included in the file: ENOVIVaultSessionFactory.h
If needed, your Imakefile.mk should include the module: ENOVIVaultClientAPP