|
|
|||||
| 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 |
| public void | abort()
Aborts all the work done in the current UserSession (database rollback). |
| public void | abort(byte[] ibvContextOId)
Aborts all the work done in the current UserSession (database rollback). |
| public void | abort(ServerTokenProvider iIServerTokenProvider)
Aborts all the work done in the current UserSession (database rollback). |
| public ENOVIVaultDocument | bindDocument(byte[] iURL)
Supplies the IVaultDocument object pertainning to the iUUD parameter.
Deprecated. V5R11 |
| public ENOVIVaultDocument | bindDocument(byte[] iURL, byte[] ibvContextOId)
Supplies the IVaultDocument object pertainning to the iUUD parameter. |
| public ENOVIVaultDocument | bindDocument(byte[] iURL, ServerTokenProvider iIServerTokenProvider)
Supplies the IVaultDocument object pertainning to the iUUD parameter. |
| public ENOVIVaultReadIterator | bindDocuments(Vector iURLs)
Supplies a collection of IVaultDocument objects each pertainning to the iURL
collection parameter.
Deprecated. V5R11 |
| public ENOVIVaultReadIterator | bindDocuments(Vector iURLs, byte[] ibvContextOId)
Supplies a collection of IVaultDocument objects each pertainning to the iURL
collection parameter. |
| public ENOVIVaultReadIterator | bindDocuments(Vector iURLs, ServerTokenProvider iIServerTokenProvider)
Supplies a collection of IVaultDocument objects each pertainning to the iURL
collection parameter. |
| public void | close()
Close the Vault Session. |
| public void | close(byte[] ibvContextOId)
Close the Vault User Session pertaining to the given CATlet context OId. |
| public void | close(ServerTokenProvider iIServerTokenProvider)
Close the Vault User Session pertaining to the given ServerTokenProvider. |
| public void | closeProxy()
Close the Vault Session. |
| public void | closeProxy(byte[] ibvContextOId)
Close the Vault User Session proxy pertaining to the given CATlet context OId. |
| public void | closeProxy(ServerTokenProvider iIServerTokenProvider)
Close the Vault User Session proxy pertaining to the given ServerTokenProvider. |
| public void | commit()
Commit all the work done during the UserSession (database commit). |
| public void | commit(byte[] ibvContextOId)
Commit all the work done during the UserSession (database commit). |
| public void | commit(ServerTokenProvider iIServerTokenProvider)
Commit all the work done during the UserSession (database commit). |
| public ENOVIVaultUserSession | createUserSession(byte[] ibvVaultUserSessionOId, byte[] ibvContextOId, String isvVaultAliasName, ServerTokenProvider iIServerTokenProvider, String isvIsMultiUser, String isvReadSrvName, String isvReadHostName, int invReadListenPort, String isvWriteSrvName, String isvWriteHostPort, int invWriteListenPort)
|
| public void | endUserSession(ENOVIVaultUserSession ipIVaultUserSession)
Ends the corresponding IVaultUserSession . |
| public void | endUserSession(ENOVIVaultUserSession ipIVaultUserSession, boolean ibvIsTransPropagate)
|
| public 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. |
| public Vector | getDocsCacheInfo(Vector iURLs, ServerTokenProvider iIServerTokenProvider, Vector oVaultCacheInfoColl)
Supplies a collection of IVaultDocument objects each pertainning to the iURL
collection parameter. |
| public String | getName()
Supplies the Vault Session Name. |
| public byte[] | getOId()
Supplies the Vault Session Object Identifier. |
| public String | getProperty(String iPropertyName)
Supplies the property value pertainning to the input property name. |
| public ENOVIVaultUserSession | getUserSession(byte[] iOId, String iVaultAliasName)
|
| public ENOVIVaultUserSession | getUserSession(byte[] iOId, String iVaultAliasName, byte[] ibvContextOId, ServerTokenProvider iIServerTokenProvider)
|
| public ENOVIVaultUserSession | getUserSession(byte[] iOId, String iVaultAliasName, byte[] ibvContextOId, ServerTokenProvider iIServerTokenProvider, String isvIsMultiUser)
|
| public ENOVIVaultUserSession | getUserSession(byte[] iOId, String iVaultAliasName, byte[] ibvContextOId, ServerTokenProvider iIServerTokenProvider, String isvIsMultiUser, String isvServiceName, String isvHostName, int invListenPort)
|
| public ENOVIVaultUserSession | getUserSession(String iIVaultAliasName)
Supplies a IVaultUserSession object pertainning to the requested Vault Server. If the IVaultUserSession object doesn't exist yet, it will be created. If you are not the transaction master, it will be called in order to manage transaction properly on the newly created IVaultUserSession object. Deprecated. V5R11 |
| public ENOVIVaultUserSession | getUserSession(String iIVaultAliasName, byte[] ibvContextOId)
Supplies a IVaultUserSession object pertainning to the requested Vault Server. If the IVaultUserSession object doesn't exist yet, it will be created. If you are not the transaction master, it will be called in order to manage transaction properly on the newly created IVaultUserSession object. |
| public ENOVIVaultUserSession | getUserSession(String isvVaultAliasName, ServerTokenProvider iIServerTokenProvider)
Supplies a IVaultUserSession object pertainning to the requested Vault Server. If the IVaultUserSession object doesn't exist yet, it will be created. If you are not the transaction master, it will be called in order to manage transaction properly on the newly created IVaultUserSession object. |
| public boolean | isAliasCached(String iAliasName)
Specifies if a given alias is cached or not. |
| public boolean | isCacheUsed()
Specifies if one of the Vault Alias Name defined in Vault Client properties is cached. |
| public boolean | IsContextOIdFlag()
|
| public boolean | isDocumentCached(byte[] iURL)
Specifies if a given document is cached or not. |
| public void | prepare()
Prepare all the work done during the UserSession. |
| public void | prepare(byte[] ibvContextOId)
Prepare all the work done during the UserSession. |
| public void | prepare(ServerTokenProvider iIServerTokenProvider)
Prepare all the work done during the UserSession. |
| public void | reloadProperties(String iVaultServerAliasName)
Reload the whole set of properties on the related Vault Server. |
| public void | reloadProperties(String iVaultServerName, String iVaultServerHost, int iVaultServerPort)
Reload whole set of properties on the related Vault Server. |
| public void | removeDocument(ENOVIVaultDocument ipDocument)
Remove (delete) the supplied IVaultDocument. |
| public void | setIsContextOIdFlag(boolean iIsContextOId)
|
| public void | setName(String iName)
Sets the Vault Session Name. |
| public void | shutdown(String iVaultServerAliasName, int iShutdownMode)
Shutdown the related Vault Server. |
| public void | shutdown(String iVaultServerName, String iVaultServerHost, int iVaultServerPort, int iShutdownMode)
Shutdown the related Vault Server. |
| public void | unBindDocument(ENOVIVaultDocument doc)
unBinds the IVaultDocument object form client side |
| public void | unPrepare()
unPrepare all the work done during the UserSession (database rollback). |
| public void | unPrepare(byte[] ibvContextOId)
unPrepare all the work done during the UserSession (database rollback). |
| public void | unPrepare(ServerTokenProvider iIServerTokenProvider)
unPrepare all the work done during the UserSession (database rollback). |
| Field Detail |
| Constructor Detail |
| Method Detail |
public void abort()
Aborts all the work done in the current UserSession (database rollback).
The Vault User Session is reinitialized after that.
public void abort(byte[] ibvContextOId)
Aborts all the work done in the current UserSession (database rollback).
The Vault User Session is reinitialized after that.
ibvContextOId
public void abort(ServerTokenProvider iIServerTokenProvider)
Aborts all the work done in the current UserSession (database rollback).
The Vault User Session is reinitialized after that.
iIServerTokenProvider
public ENOVIVaultDocument bindDocument(byte[] iURL)
Supplies the IVaultDocument object pertainning to the iUUD parameter.
Deprecated. V5R11
iURL
public ENOVIVaultDocument bindDocument(byte[] iURL, byte[] ibvContextOId)
Supplies the IVaultDocument object pertainning to the iUUD parameter.
iURLibvContextOId
public ENOVIVaultDocument bindDocument(byte[] iURL, ServerTokenProvider iIServerTokenProvider)
Supplies the IVaultDocument object pertainning to the iUUD parameter.
iURLiIServerTokenProvider
public ENOVIVaultReadIterator bindDocuments(Vector iURLs)
Supplies a collection of IVaultDocument objects each pertainning to the iURL
collection parameter.
Deprecated. V5R11
iURLs
public ENOVIVaultReadIterator bindDocuments(Vector iURLs, byte[] ibvContextOId)
Supplies a collection of IVaultDocument objects each pertainning to the iURL
collection parameter.
iURLsibvContextOId
public ENOVIVaultReadIterator bindDocuments(Vector iURLs, ServerTokenProvider iIServerTokenProvider)
Supplies a collection of IVaultDocument objects each pertainning to the iURL
collection parameter.
iURLsiIServerTokenProvider
public void close()
Close the Vault Session.
public void close(byte[] ibvContextOId)
Close the Vault User Session pertaining to the given CATlet context OId.
ibvContextOId
public void close(ServerTokenProvider iIServerTokenProvider)
Close the Vault User Session pertaining to the given ServerTokenProvider.
iIServerTokenProvider
public void closeProxy()
Close the Vault Session.
public void closeProxy(byte[] ibvContextOId)
Close the Vault User Session proxy pertaining to the given CATlet context OId.
ibvContextOId
public void closeProxy(ServerTokenProvider iIServerTokenProvider)
Close the Vault User Session proxy pertaining to the given ServerTokenProvider.
iIServerTokenProvider
public void commit()
Commit all the work done during the UserSession (database commit).
public void commit(byte[] ibvContextOId)
Commit all the work done during the UserSession (database commit).
ibvContextOId
public void commit(ServerTokenProvider iIServerTokenProvider)
Commit all the work done during the UserSession (database commit).
iIServerTokenProvider
public ENOVIVaultUserSession createUserSession(byte[] ibvVaultUserSessionOId, byte[] ibvContextOId, String isvVaultAliasName, ServerTokenProvider iIServerTokenProvider, String isvIsMultiUser, String isvReadSrvName, String isvReadHostName, int invReadListenPort, String isvWriteSrvName, String isvWriteHostPort, int invWriteListenPort)
public void endUserSession(ENOVIVaultUserSession ipIVaultUserSession)
Ends the corresponding IVaultUserSession .
ipIVaultUserSession
public void endUserSession(ENOVIVaultUserSession ipIVaultUserSession, boolean ibvIsTransPropagate)
public 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.
iURLsibvContextOIdoVaultCacheInfoColl
public Vector getDocsCacheInfo(Vector iURLs, ServerTokenProvider iIServerTokenProvider, Vector oVaultCacheInfoColl)
Supplies a collection of IVaultDocument objects each pertainning to the iURL
collection parameter.
iURLsiIServerTokenProvideroVaultCacheInfoColl
public String getName()
Supplies the Vault Session Name.
public byte[] getOId()
Supplies the Vault Session Object Identifier.
public String getProperty(String iPropertyName)
Supplies the property value pertainning to the input property name.
iPropertyName
public ENOVIVaultUserSession getUserSession(byte[] iOId, String iVaultAliasName)
public ENOVIVaultUserSession getUserSession(byte[] iOId, String iVaultAliasName, byte[] ibvContextOId, ServerTokenProvider iIServerTokenProvider)
public ENOVIVaultUserSession getUserSession(byte[] iOId, String iVaultAliasName, byte[] ibvContextOId, ServerTokenProvider iIServerTokenProvider, String isvIsMultiUser)
public ENOVIVaultUserSession getUserSession(byte[] iOId, String iVaultAliasName, byte[] ibvContextOId, ServerTokenProvider iIServerTokenProvider, String isvIsMultiUser, String isvServiceName, String isvHostName, int invListenPort)
public ENOVIVaultUserSession getUserSession(String iIVaultAliasName)
Supplies a IVaultUserSession object pertainning to the requested Vault Server.
Deprecated. V5R11
iIVaultAliasName
public ENOVIVaultUserSession getUserSession(String iIVaultAliasName, byte[] ibvContextOId)
Supplies a IVaultUserSession object pertainning to the requested Vault Server.
iIVaultAliasNameibvContextOId
public ENOVIVaultUserSession getUserSession(String isvVaultAliasName, ServerTokenProvider iIServerTokenProvider)
Supplies a IVaultUserSession object pertainning to the requested Vault Server.
iIVaultAliasNameiIServerTokenProvider
public boolean isAliasCached(String iAliasName)
Specifies if a given alias is cached or not.
iAliasName
public boolean isCacheUsed()
Specifies if one of the Vault Alias Name defined in Vault Client properties is cached.
public boolean IsContextOIdFlag()
public boolean isDocumentCached(byte[] iURL)
Specifies if a given document is cached or not.
iURL
public void prepare()
Prepare all the work done during the UserSession.
Execute orders on database but no commit.
public void prepare(byte[] ibvContextOId)
Prepare all the work done during the UserSession.
Execute orders on database but no commit.
ibvContextOId
public void prepare(ServerTokenProvider iIServerTokenProvider)
Prepare all the work done during the UserSession.
Execute orders on database but no commit.
iIServerTokenProvider
public void reloadProperties(String iVaultServerAliasName)
Reload the whole set of properties on the related Vault Server.
iVaultServerAliasName
public void reloadProperties(String iVaultServerName, String iVaultServerHost, int iVaultServerPort)
Reload whole set of properties on the related Vault Server.
iVaultServerNameiVaultServerHostiVaultServerPort
public void removeDocument(ENOVIVaultDocument ipDocument)
Remove (delete) the supplied IVaultDocument.
ipDocument
public void setIsContextOIdFlag(boolean iIsContextOId)
iIsContextOId
public void setName(String iName)
Sets the Vault Session Name.
iSessionName
public void shutdown(String iVaultServerAliasName, int iShutdownMode)
Shutdown the related Vault Server.
iVaultServerAliasNameiShutdownMode
public void shutdown(String iVaultServerName, String iVaultServerHost, int iVaultServerPort, int iShutdownMode)
Shutdown the related Vault Server.
iVaultServerNameiVaultServerHostiVaultServerPortiShutdownMode
public void unBindDocument(ENOVIVaultDocument doc)
unBinds the IVaultDocument object form client side
IVaultDocument
public void unPrepare()
unPrepare all the work done during the UserSession (database rollback).
public void unPrepare(byte[] ibvContextOId)
unPrepare all the work done during the UserSession (database rollback).
ibvContextOId
public void unPrepare(ServerTokenProvider iIServerTokenProvider)
unPrepare all the work done during the UserSession (database rollback).
iIServerTokenProvider