Package com.dassault_systemes.enovaultclientjava.vdk0vaultclient

   
Interface ENOVIVaultSession

 
Class Hierarchy
com.dassault_systemes.enovaultclientjava.vdk0vaultclient.ENOVIVaultSession
Class Location

Framework : ENOVaultClientJAVA

Module : VDK0VaultClient

Class Description

public interface ENOVIVaultSession

This class supplies methods to bind existing documents by URL
and to get VaultUserSession Object.

Version:
V5R11
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

abort

    public void abort()

Aborts all the work done in the current UserSession (database rollback). The Vault User Session is reinitialized after that.

Throws:
ENOVIVaultError -
Since:
V5R7

abort

    public void abort(byte[] ibvContextOId)

Aborts all the work done in the current UserSession (database rollback). The Vault User Session is reinitialized after that.

Parameters:
ibvContextOId
[in] - CATlet context OId.
Throws:
ENOVIVaultError -
Since:
V5R11

abort

    public void abort(ServerTokenProvider iIServerTokenProvider)

Aborts all the work done in the current UserSession (database rollback). The Vault User Session is reinitialized after that.

Parameters:
iIServerTokenProvider
[in] - ServerTokenProvider interface.
Throws:
ENOVIVaultError -
Since:
V5R11

bindDocument

    public ENOVIVaultDocument bindDocument(byte[] iURL)

Supplies the IVaultDocument object pertainning to the iUUD parameter.

Deprecated. V5R11

Parameters:
iURL
IVaultDocument URL.
Return:
IVaultDocument object.
Throws:
ENOVIVaultError -
Since:
V5R7

bindDocument

    public ENOVIVaultDocument bindDocument(byte[] iURL, byte[] ibvContextOId)

Supplies the IVaultDocument object pertainning to the iUUD parameter.

Parameters:
iURL
IVaultDocument URL.
ibvContextOId
[in] - CATlet context OId.
Return:
IVaultDocument object.
Throws:
ENOVIVaultError -
Since:
V5R11

bindDocument

    public ENOVIVaultDocument bindDocument(byte[] iURL, ServerTokenProvider iIServerTokenProvider)

Supplies the IVaultDocument object pertainning to the iUUD parameter.

Parameters:
iURL
IVaultDocument URL.
iIServerTokenProvider
[in] - ServerTokenProvider interface.
Return:
IVaultDocument object.
Throws:
ENOVIVaultError -
Since:
V5R11

bindDocuments

    public ENOVIVaultReadIterator bindDocuments(Vector iURLs)

Supplies a collection of IVaultDocument objects each pertainning to the iURL collection parameter.

Deprecated. V5R11

Parameters:
iURLs
Vector Of URL.
Return:
IVaultReadIterator of IVaultDocument.
Throws:
ENOVIVaultError -
Since:
V5R7

bindDocuments

    public ENOVIVaultReadIterator bindDocuments(Vector iURLs, byte[] ibvContextOId)

Supplies a collection of IVaultDocument objects each pertainning to the iURL collection parameter.

Parameters:
iURLs
Vector Of URL.
ibvContextOId
[in] - CATlet context OId.
Return:
IVaultReadIterator of IVaultDocument.
Throws:
ENOVIVaultError -
Since:
V5R11

bindDocuments

    public ENOVIVaultReadIterator bindDocuments(Vector iURLs, ServerTokenProvider iIServerTokenProvider)

Supplies a collection of IVaultDocument objects each pertainning to the iURL collection parameter.

Parameters:
iURLs
Vector Of URL.
iIServerTokenProvider
[in] - ServerTokenProvider interface.
Return:
IVaultReadIterator of IVaultDocument.
Throws:
ENOVIVaultError -
Since:
V5R11

close

    public void close()

Close the Vault Session.

Throws:
ENOVIVaultError -
Since:
V5R7

close

    public void close(byte[] ibvContextOId)

Close the Vault User Session pertaining to the given CATlet context OId.

Parameters:
ibvContextOId
[in] - CATlet context OId.
Throws:
ENOVIVaultError -
Since:
V5R11

close

    public void close(ServerTokenProvider iIServerTokenProvider)

Close the Vault User Session pertaining to the given ServerTokenProvider.

Parameters:
iIServerTokenProvider
[in] - ServerTokenProvider interface.
Throws:
ENOVIVaultError -
Since:
V5R11

closeProxy

    public void closeProxy()

Close the Vault Session.

Throws:
ENOVIVaultError -
Since:
V5R11

closeProxy

    public void closeProxy(byte[] ibvContextOId)

Close the Vault User Session proxy pertaining to the given CATlet context OId.

Parameters:
ibvContextOId
[in] - CATlet context OId.
Throws:
ENOVIVaultError -
Since:
V5R11

closeProxy

    public void closeProxy(ServerTokenProvider iIServerTokenProvider)

Close the Vault User Session proxy pertaining to the given ServerTokenProvider.

Parameters:
iIServerTokenProvider
[in] - ServerTokenProvider interface.
Throws:
ENOVIVaultError -
Since:
V5R11

commit

    public void commit()

Commit all the work done during the UserSession (database commit).

Throws:
ENOVIVaultError -
Since:
V5R7

commit

    public void commit(byte[] ibvContextOId)

Commit all the work done during the UserSession (database commit).

Parameters:
ibvContextOId
[in] - CATlet context OId.
Throws:
ENOVIVaultError -
Since:
V5R11

commit

    public void commit(ServerTokenProvider iIServerTokenProvider)

Commit all the work done during the UserSession (database commit).

Parameters:
iIServerTokenProvider
[in] - ServerTokenProvider interface.
Throws:
ENOVIVaultError -
Since:
V5R11

createUserSession

    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)


endUserSession

    public void endUserSession(ENOVIVaultUserSession ipIVaultUserSession)

Ends the corresponding IVaultUserSession .

Parameters:
ipIVaultUserSession
pointer on the IVaultUserSession object to end.
Throws:
ENOVIVaultError -
Since:
V5R7

endUserSession

    public void endUserSession(ENOVIVaultUserSession ipIVaultUserSession, boolean ibvIsTransPropagate)


getDocsCacheInfo

    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.

Parameters:
iURLs
Vector Of URL.
ibvContextOId
[in] - CATlet context OId.
oVaultCacheInfoColl
[out] - collection of VaultCacheInfo objects.
Return:
collection of URLs to refresh.
Throws:
ENOVIVaultError -
Since:
V5R11

getDocsCacheInfo

    public Vector getDocsCacheInfo(Vector iURLs, ServerTokenProvider iIServerTokenProvider, Vector oVaultCacheInfoColl)

Supplies a collection of IVaultDocument objects each pertainning to the iURL collection parameter.

Parameters:
iURLs
Vector Of URL.
iIServerTokenProvider
[in] - ServerTokenProvider interface.
oVaultCacheInfoColl
[out] - collection of VaultCacheInfo objects.
Return:
collection of URLs to refresh.
Throws:
ENOVIVaultError -
Since:
V5R11

getName

    public String getName()

Supplies the Vault Session Name.

Return:
Vault Session Name.
Since:
V5R9

getOId

    public byte[] getOId()

Supplies the Vault Session Object Identifier.

Return:
Vault Session Object Identifier.
Throws:
ENOVIVaultError -
Since:
V5R7

getProperty

    public String getProperty(String iPropertyName)

Supplies the property value pertainning to the input property name.

Parameters:
iPropertyName
property name.
Return:
property value. BlockSize DataTransferMode (NFS CORBA)
Throws:
ENOVIVaultError -
Since:
V5R7

getUserSession

    public ENOVIVaultUserSession getUserSession(byte[] iOId, String iVaultAliasName)


getUserSession

    public ENOVIVaultUserSession getUserSession(byte[] iOId, String iVaultAliasName, byte[] ibvContextOId, ServerTokenProvider iIServerTokenProvider)


getUserSession

    public ENOVIVaultUserSession getUserSession(byte[] iOId, String iVaultAliasName, byte[] ibvContextOId, ServerTokenProvider iIServerTokenProvider, String isvIsMultiUser)


getUserSession

    public ENOVIVaultUserSession getUserSession(byte[] iOId, String iVaultAliasName, byte[] ibvContextOId, ServerTokenProvider iIServerTokenProvider, String isvIsMultiUser, String isvServiceName, String isvHostName, int invListenPort)


getUserSession

    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

Parameters:
iIVaultAliasName
Vault Server alias name.
Return:
IVaultUserSession object.
Throws:
ENOVIVaultError -
Since:
V5R7

getUserSession

    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.

Parameters:
iIVaultAliasName
Vault Server alias name.
ibvContextOId
CATlet context OId.
Return:
IVaultUserSession object.
Throws:
ENOVIVaultError -
Since:
V5R11

getUserSession

    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.

Parameters:
iIVaultAliasName
Vault Server alias name.
iIServerTokenProvider
interface server token provider.
Return:
IVaultUserSession object.
Throws:
ENOVIVaultError -
Since:
V5R11

isAliasCached

    public boolean isAliasCached(String iAliasName)

Specifies if a given alias is cached or not.

Parameters:
iAliasName
Vault Alias Name.
Return:
true if the Vault Alias Name is cached, false otherwise.
Since:
V5R10

isCacheUsed

    public boolean isCacheUsed()

Specifies if one of the Vault Alias Name defined in Vault Client properties is cached.

Return:
true if one of the Vault Alias Name defined in Vault Client properties is cached, false otherwise.
Since:
V5R10

IsContextOIdFlag

    public boolean IsContextOIdFlag()

Return:
IsContextOId Vault Session flag.
Since:
V5R11

isDocumentCached

    public boolean isDocumentCached(byte[] iURL)

Specifies if a given document is cached or not.

Parameters:
iURL
IVaultDocument URL.
Return:
true if the document is cached, false otherwise.
Since:
V5R10

prepare

    public void prepare()

Prepare all the work done during the UserSession. Execute orders on database but no commit.

Throws:
ENOVIVaultError -
Since:
V5R7

prepare

    public void prepare(byte[] ibvContextOId)

Prepare all the work done during the UserSession. Execute orders on database but no commit.

Parameters:
ibvContextOId
[in] - CATlet context OId.
Throws:
ENOVIVaultError -
Since:
V5R11

prepare

    public void prepare(ServerTokenProvider iIServerTokenProvider)

Prepare all the work done during the UserSession. Execute orders on database but no commit.

Parameters:
iIServerTokenProvider
[in] - ServerTokenProvider interface.
Throws:
ENOVIVaultError -
Since:
V5R11

reloadProperties

    public void reloadProperties(String iVaultServerAliasName)

Reload the whole set of properties on the related Vault Server.

Parameters:
iVaultServerAliasName
[in] - Vault Server Alias Name.
Throws:
ENOVIVaultError -
Since:
V5R7

reloadProperties

    public void reloadProperties(String iVaultServerName, String iVaultServerHost, int iVaultServerPort)

Reload whole set of properties on the related Vault Server.

Parameters:
iVaultServerName
[in] - Vault Server Name (server marker).
iVaultServerHost
[in] - Vault Server Host.
iVaultServerPort
[in] - Vault Server Port (Orbix daemon port).
Throws:
ENOVIVaultError -
Since:
V5R7

removeDocument

    public void removeDocument(ENOVIVaultDocument ipDocument)

Remove (delete) the supplied IVaultDocument.

Parameters:
ipDocument
IVaultDocument to remove.
Throws:
ENOVIVaultError -

setIsContextOIdFlag

    public void setIsContextOIdFlag(boolean iIsContextOId)

Parameters:
iIsContextOId
the new value of the IsContextOId Vault Session flag.
Since:
V5R11

setName

    public void setName(String iName)

Sets the Vault Session Name.

Parameters:
iSessionName
Vault Session Name.
Since:
V5R9

shutdown

    public void shutdown(String iVaultServerAliasName, int iShutdownMode)

Shutdown the related Vault Server.

Parameters:
iVaultServerAliasName
[in] - Vault Server Alias Name.
iShutdownMode
[in] - shutdown mode.
Throws:
ENOVIVaultError -
Since:
V5R7

shutdown

    public void shutdown(String iVaultServerName, String iVaultServerHost, int iVaultServerPort, int iShutdownMode)

Shutdown the related Vault Server.

Parameters:
iVaultServerName
[in] - Vault Server Name (server marker).
iVaultServerHost
[in] - Vault Server Host.
iVaultServerPort
[in] - Vault Server Port (Orbix daemon port).
iShutdownMode
[in] - shutdown mode.
Throws:
ENOVIVaultError -
Since:
V5R7

unBindDocument

    public void unBindDocument(ENOVIVaultDocument doc)

unBinds the IVaultDocument object form client side

Parameters:
IVaultDocument
to unBind.
Throws:
ENOVIVaultError -
Since:
V5R7

unPrepare

    public void unPrepare()

unPrepare all the work done during the UserSession (database rollback).

Throws:
ENOVIVaultError -
Since:
V5R7

unPrepare

    public void unPrepare(byte[] ibvContextOId)

unPrepare all the work done during the UserSession (database rollback).

Parameters:
ibvContextOId
[in] - CATlet context OId.
Throws:
ENOVIVaultError -
Since:
V5R11

unPrepare

    public void unPrepare(ServerTokenProvider iIServerTokenProvider)

unPrepare all the work done during the UserSession (database rollback).

Parameters:
iIServerTokenProvider
[in] - ServerTokenProvider interface.
Throws:
ENOVIVaultError -
Since:
V5R11


Copyright © 2000, Dassault Systèmes. All rights reserved