|
|
Package com.dassault_systemes.enovaultclientjava.vdk0vaultclient |
Interface ENOVIVaultSession
|
Class Hierarchy |
com.dassault_systemes.enovaultclientjava.vdk0vaultclient.ENOVIVaultSession
Class Location |
Class Description |
public interface ENOVIVaultSession
This class supplies methods to bind existing documents by URL
and to get VaultUserSession Object.
Field Summary |
Constructor Summary |
Method Summary |
byte[] | getOId() |
void | setName(String iName) |
String | getName() |
void | setIsContextOIdFlag(boolean iIsContextOId) |
boolean | IsContextOIdFlag() |
ENOVIVaultDocument | bindDocument(byte[] iURL, ServerTokenProvider iIServerTokenProvider) |
ENOVIVaultDocument | bindDocument(byte[] iURL, byte[] ibvContextOId) |
ENOVIVaultDocument | bindDocument(byte[] iURL) |
void | unBindDocument(ENOVIVaultDocument doc) |
void | removeDocument(ENOVIVaultDocument ipDocument) |
ENOVIVaultReadIterator | bindDocuments(Vector iURLs, ServerTokenProvider iIServerTokenProvider) |
ENOVIVaultReadIterator | bindDocuments(Vector iURLs, byte[] ibvContextOId) |
ENOVIVaultReadIterator | bindDocuments(Vector iURLs) |
boolean | isDocumentCached(byte[] iURL) |
boolean | isAliasCached(String iAliasName) |
boolean | isCacheUsed() |
ENOVIVaultUserSession | getUserSession(String isvVaultAliasName, ServerTokenProvider iIServerTokenProvider) |
ENOVIVaultUserSession | getUserSession(String iIVaultAliasName, byte[] ibvContextOId) |
ENOVIVaultUserSession | getUserSession(String iIVaultAliasName) |
ENOVIVaultUserSession | getUserSession(byte[] iOId, String iVaultAliasName) |
ENOVIVaultUserSession | getUserSession(byte[] iOId, String iVaultAliasName, byte[] ibvContextOId, ServerTokenProvider iIServerTokenProvider) |
ENOVIVaultUserSession | getUserSession(byte[] iOId, String iVaultAliasName, byte[] ibvContextOId, ServerTokenProvider iIServerTokenProvider, String isvIsMultiUser) |
ENOVIVaultUserSession | getUserSession(byte[] iOId, String iVaultAliasName, byte[] ibvContextOId, ServerTokenProvider iIServerTokenProvider, String isvIsMultiUser, String isvServiceName, String isvHostName, int invListenPort) |
ENOVIVaultUserSession | createUserSession(byte[] ibvVaultUserSessionOId, byte[] ibvContextOId, String isvVaultAliasName, ServerTokenProvider iIServerTokenProvider, String isvIsMultiUser, String isvReadSrvName, String isvReadHostName, int invReadListenPort, String isvWriteSrvName, String isvWriteHostPort, int invWriteListenPort) |
void | endUserSession(ENOVIVaultUserSession ipIVaultUserSession) |
void | endUserSession(ENOVIVaultUserSession ipIVaultUserSession, boolean ibvIsTransPropagate) |
String | getProperty(String iPropertyName) |
void | abort(ServerTokenProvider iIServerTokenProvider) |
void | abort(byte[] ibvContextOId) |
void | abort() |
void | closeProxy(ServerTokenProvider iIServerTokenProvider) |
void | closeProxy(byte[] ibvContextOId) |
void | closeProxy() |
void | close(ServerTokenProvider iIServerTokenProvider) |
void | close(byte[] ibvContextOId) |
void | close() |
void | prepare(ServerTokenProvider iIServerTokenProvider) |
void | prepare(byte[] ibvContextOId) |
void | prepare() |
void | unPrepare(ServerTokenProvider iIServerTokenProvider) |
void | unPrepare(byte[] ibvContextOId) |
void | unPrepare() |
void | commit(ServerTokenProvider iIServerTokenProvider) |
void | commit(byte[] ibvContextOId) |
void | commit() |
void | reloadProperties(String iVaultServerAliasName) |
void | reloadProperties(String iVaultServerName, String iVaultServerHost, int iVaultServerPort) |
void | shutdown(String iVaultServerAliasName, int iShutdownMode) |
void | shutdown(String iVaultServerName, String iVaultServerHost, int iVaultServerPort, int iShutdownMode) |
Vector | getDocsCacheInfo(Vector iURLs, ServerTokenProvider iIServerTokenProvider, Vector oVaultCacheInfoColl) |
Vector | getDocsCacheInfo(Vector iURLs, byte[] ibvContextOId, Vector oVaultCacheInfoColl) |
Field Detail |
Constructor Detail |
Method Detail |
byte[] getOId()Supplies the Vault Session Object Identifier.
void setName(String iName)Sets the Vault Session Name.
iSessionName
String getName()Supplies the Vault Session Name.
void setIsContextOIdFlag(boolean iIsContextOId)
iIsContextOId
boolean IsContextOIdFlag()
ENOVIVaultDocument bindDocument(byte[] iURL, ServerTokenProvider iIServerTokenProvider)Supplies the IVaultDocument object pertainning to the
iUUD
parameter.
iURL
iIServerTokenProvider
ENOVIVaultDocument bindDocument(byte[] iURL, byte[] ibvContextOId)Supplies the IVaultDocument object pertainning to the
iUUD
parameter.
iURL
ibvContextOId
ENOVIVaultDocument bindDocument(byte[] iURL)Supplies the IVaultDocument object pertainning to the
iUUD
parameter.
Deprecated. V5R11
iURL
void unBindDocument(ENOVIVaultDocument doc)unBinds the IVaultDocument object form client side
IVaultDocument
void removeDocument(ENOVIVaultDocument ipDocument)Remove (delete) the supplied IVaultDocument.
ipDocument
ENOVIVaultReadIterator bindDocuments(Vector iURLs, ServerTokenProvider iIServerTokenProvider)Supplies a collection of IVaultDocument objects each pertainning to the
iURL
collection parameter.
iURLs
iIServerTokenProvider
ENOVIVaultReadIterator bindDocuments(Vector iURLs, byte[] ibvContextOId)Supplies a collection of IVaultDocument objects each pertainning to the
iURL
collection parameter.
iURLs
ibvContextOId
ENOVIVaultReadIterator bindDocuments(Vector iURLs)Supplies a collection of IVaultDocument objects each pertainning to the
iURL
collection parameter.
Deprecated. V5R11
iURLs
boolean isDocumentCached(byte[] iURL)Specifies if a given document is cached or not.
iURL
boolean isAliasCached(String iAliasName)Specifies if a given alias is cached or not.
iAliasName
boolean isCacheUsed()Specifies if one of the Vault Alias Name defined in Vault Client properties is cached.
ENOVIVaultUserSession getUserSession(String isvVaultAliasName, ServerTokenProvider iIServerTokenProvider)Supplies a IVaultUserSession object pertainning to the requested Vault Server.
iIVaultAliasName
iIServerTokenProvider
ENOVIVaultUserSession getUserSession(String iIVaultAliasName, byte[] ibvContextOId)Supplies a IVaultUserSession object pertainning to the requested Vault Server.
iIVaultAliasName
ibvContextOId
ENOVIVaultUserSession getUserSession(String iIVaultAliasName)Supplies a IVaultUserSession object pertainning to the requested Vault Server.
Deprecated. V5R11
iIVaultAliasName
ENOVIVaultUserSession getUserSession(byte[] iOId, String iVaultAliasName)
ENOVIVaultUserSession getUserSession(byte[] iOId, String iVaultAliasName, byte[] ibvContextOId, ServerTokenProvider iIServerTokenProvider)
ENOVIVaultUserSession getUserSession(byte[] iOId, String iVaultAliasName, byte[] ibvContextOId, ServerTokenProvider iIServerTokenProvider, String isvIsMultiUser)
ENOVIVaultUserSession getUserSession(byte[] iOId, String iVaultAliasName, byte[] ibvContextOId, ServerTokenProvider iIServerTokenProvider, String isvIsMultiUser, String isvServiceName, String isvHostName, int invListenPort)
ENOVIVaultUserSession createUserSession(byte[] ibvVaultUserSessionOId, byte[] ibvContextOId, String isvVaultAliasName, ServerTokenProvider iIServerTokenProvider, String isvIsMultiUser, String isvReadSrvName, String isvReadHostName, int invReadListenPort, String isvWriteSrvName, String isvWriteHostPort, int invWriteListenPort)
void endUserSession(ENOVIVaultUserSession ipIVaultUserSession)Ends the corresponding IVaultUserSession .
ipIVaultUserSession
void endUserSession(ENOVIVaultUserSession ipIVaultUserSession, boolean ibvIsTransPropagate)
String getProperty(String iPropertyName)Supplies the property value pertainning to the input property name.
iPropertyName
void abort(ServerTokenProvider iIServerTokenProvider)Aborts all the work done in the current UserSession (database rollback). The Vault User Session is reinitialized after that.
iIServerTokenProvider
void abort(byte[] ibvContextOId)Aborts all the work done in the current UserSession (database rollback). The Vault User Session is reinitialized after that.
ibvContextOId
void abort()Aborts all the work done in the current UserSession (database rollback). The Vault User Session is reinitialized after that.
void closeProxy(ServerTokenProvider iIServerTokenProvider)Close the Vault User Session proxy pertaining to the given ServerTokenProvider.
iIServerTokenProvider
void closeProxy(byte[] ibvContextOId)Close the Vault User Session proxy pertaining to the given CATlet context OId.
ibvContextOId
void closeProxy()Close the Vault Session.
void close(ServerTokenProvider iIServerTokenProvider)Close the Vault User Session pertaining to the given ServerTokenProvider.
iIServerTokenProvider
void close(byte[] ibvContextOId)Close the Vault User Session pertaining to the given CATlet context OId.
ibvContextOId
void close()Close the Vault Session.
void prepare(ServerTokenProvider iIServerTokenProvider)Prepare all the work done during the UserSession. Execute orders on database but no commit.
iIServerTokenProvider
void prepare(byte[] ibvContextOId)Prepare all the work done during the UserSession. Execute orders on database but no commit.
ibvContextOId
void prepare()Prepare all the work done during the UserSession. Execute orders on database but no commit.
void unPrepare(ServerTokenProvider iIServerTokenProvider)unPrepare all the work done during the UserSession (database rollback).
iIServerTokenProvider
void unPrepare(byte[] ibvContextOId)unPrepare all the work done during the UserSession (database rollback).
ibvContextOId
void unPrepare()unPrepare all the work done during the UserSession (database rollback).
void commit(ServerTokenProvider iIServerTokenProvider)Commit all the work done during the UserSession (database commit).
iIServerTokenProvider
void commit(byte[] ibvContextOId)Commit all the work done during the UserSession (database commit).
ibvContextOId
void commit()Commit all the work done during the UserSession (database commit).
void reloadProperties(String iVaultServerAliasName)Reload the whole set of properties on the related Vault Server.
iVaultServerAliasName
void reloadProperties(String iVaultServerName, String iVaultServerHost, int iVaultServerPort)Reload whole set of properties on the related Vault Server.
iVaultServerName
iVaultServerHost
iVaultServerPort
void shutdown(String iVaultServerAliasName, int iShutdownMode)Shutdown the related Vault Server.
iVaultServerAliasName
iShutdownMode
void shutdown(String iVaultServerName, String iVaultServerHost, int iVaultServerPort, int iShutdownMode)Shutdown the related Vault Server.
iVaultServerName
iVaultServerHost
iVaultServerPort
iShutdownMode
Vector getDocsCacheInfo(Vector iURLs, ServerTokenProvider iIServerTokenProvider, Vector oVaultCacheInfoColl)Supplies a collection of IVaultDocument objects each pertainning to the
iURL
collection parameter.
iURLs
iIServerTokenProvider
oVaultCacheInfoColl
Vector getDocsCacheInfo(Vector iURLs, byte[] ibvContextOId, Vector oVaultCacheInfoColl)Supplies a collection of VaultCacheInfo objects each pertainning to the
iURL
collection parameter and a returns a collection of URLs to refresh.
iURLs
ibvContextOId
oVaultCacheInfoColl