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.

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

getOId

    byte[] getOId()

Supplies the Vault Session Object Identifier.

Returns:
Vault Session Object Identifier.

setName

    void setName(String iName)

Sets the Vault Session Name.

Parameters:
iSessionName
Vault Session Name.

getName

    String getName()

Supplies the Vault Session Name.

Returns:
Vault Session Name.

setIsContextOIdFlag

    void setIsContextOIdFlag(boolean iIsContextOId)

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

IsContextOIdFlag

    boolean IsContextOIdFlag()

Returns:
IsContextOId Vault Session flag.

bindDocument

    ENOVIVaultDocument bindDocument(byte[] iURL, ServerTokenProvider iIServerTokenProvider)

Supplies the IVaultDocument object pertainning to the iUUD parameter.

Parameters:
iURL
IVaultDocument URL.
iIServerTokenProvider
[in] - ServerTokenProvider interface.
Returns:
IVaultDocument object.

bindDocument

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

Supplies the IVaultDocument object pertainning to the iUUD parameter.

Parameters:
iURL
IVaultDocument URL.
ibvContextOId
[in] - CATlet context OId.
Returns:
IVaultDocument object.

bindDocument

    ENOVIVaultDocument bindDocument(byte[] iURL)

Supplies the IVaultDocument object pertainning to the iUUD parameter.

Deprecated. V5R11

Parameters:
iURL
IVaultDocument URL.
Returns:
IVaultDocument object.

unBindDocument

    void unBindDocument(ENOVIVaultDocument doc)

unBinds the IVaultDocument object form client side

Parameters:
IVaultDocument
to unBind.

removeDocument

    void removeDocument(ENOVIVaultDocument ipDocument)

Remove (delete) the supplied IVaultDocument.

Parameters:
ipDocument
IVaultDocument to remove.

bindDocuments

    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.
Returns:
IVaultReadIterator of IVaultDocument.

bindDocuments

    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.
Returns:
IVaultReadIterator of IVaultDocument.

bindDocuments

    ENOVIVaultReadIterator bindDocuments(Vector iURLs)

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

Deprecated. V5R11

Parameters:
iURLs
Vector Of URL.
Returns:
IVaultReadIterator of IVaultDocument.

isDocumentCached

    boolean isDocumentCached(byte[] iURL)

Specifies if a given document is cached or not.

Parameters:
iURL
IVaultDocument URL.
Returns:
true if the document is cached, false otherwise.

isAliasCached

    boolean isAliasCached(String iAliasName)

Specifies if a given alias is cached or not.

Parameters:
iAliasName
Vault Alias Name.
Returns:
true if the Vault Alias Name is cached, false otherwise.

isCacheUsed

    boolean isCacheUsed()

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

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

getUserSession

    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.
Returns:
IVaultUserSession object.

getUserSession

    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.
Returns:
IVaultUserSession object.

getUserSession

    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.
Returns:
IVaultUserSession object.

getUserSession

    ENOVIVaultUserSession getUserSession(byte[] iOId, String iVaultAliasName)


getUserSession

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


getUserSession

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


getUserSession

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


createUserSession

    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

    void endUserSession(ENOVIVaultUserSession ipIVaultUserSession)

Ends the corresponding IVaultUserSession .

Parameters:
ipIVaultUserSession
pointer on the IVaultUserSession object to end.

endUserSession

    void endUserSession(ENOVIVaultUserSession ipIVaultUserSession, boolean ibvIsTransPropagate)


getProperty

    String getProperty(String iPropertyName)

Supplies the property value pertainning to the input property name.

Parameters:
iPropertyName
property name.
Returns:
property value. BlockSize DataTransferMode (NFS CORBA)

abort

    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.

abort

    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.

abort

    void abort()

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


closeProxy

    void closeProxy(ServerTokenProvider iIServerTokenProvider)

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

Parameters:
iIServerTokenProvider
[in] - ServerTokenProvider interface.

closeProxy

    void closeProxy(byte[] ibvContextOId)

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

Parameters:
ibvContextOId
[in] - CATlet context OId.

closeProxy

    void closeProxy()

Close the Vault Session.


close

    void close(ServerTokenProvider iIServerTokenProvider)

Close the Vault User Session pertaining to the given ServerTokenProvider.

Parameters:
iIServerTokenProvider
[in] - ServerTokenProvider interface.

close

    void close(byte[] ibvContextOId)

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

Parameters:
ibvContextOId
[in] - CATlet context OId.

close

    void close()

Close the Vault Session.


prepare

    void prepare(ServerTokenProvider iIServerTokenProvider)

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

Parameters:
iIServerTokenProvider
[in] - ServerTokenProvider interface.

prepare

    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.

prepare

    void prepare()

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


unPrepare

    void unPrepare(ServerTokenProvider iIServerTokenProvider)

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

Parameters:
iIServerTokenProvider
[in] - ServerTokenProvider interface.

unPrepare

    void unPrepare(byte[] ibvContextOId)

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

Parameters:
ibvContextOId
[in] - CATlet context OId.

unPrepare

    void unPrepare()

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


commit

    void commit(ServerTokenProvider iIServerTokenProvider)

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

Parameters:
iIServerTokenProvider
[in] - ServerTokenProvider interface.

commit

    void commit(byte[] ibvContextOId)

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

Parameters:
ibvContextOId
[in] - CATlet context OId.

commit

    void commit()

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


reloadProperties

    void reloadProperties(String iVaultServerAliasName)

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

Parameters:
iVaultServerAliasName
[in] - Vault Server Alias Name.

reloadProperties

    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).

shutdown

    void shutdown(String iVaultServerAliasName, int iShutdownMode)

Shutdown the related Vault Server.

Parameters:
iVaultServerAliasName
[in] - Vault Server Alias Name.
iShutdownMode
[in] - shutdown mode.

shutdown

    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.

getDocsCacheInfo

    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.
Returns:
collection of URLs to refresh.

getDocsCacheInfo

    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.
Returns:
collection of URLs to refresh.


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