public abstract class DfService extends java.lang.Object implements IDfService
Constructor and Description |
---|
DfService() |
Modifier and Type | Method and Description |
---|---|
void |
cleanupResources()
Deprecated.
|
java.lang.String |
getName()
Returns the fully qualified logical name of the service interface.
|
IDfSession |
getSession(java.lang.String docbaseName)
Obtains a handle to a Docbase session.
|
IDfSessionManager |
getSessionManager()
Gets the session manager.
|
java.lang.String |
getVendorString()
Gets the Copyright statement string.
|
java.lang.String |
getVersion()
Gets the current version of the service as a string.
|
boolean |
isCompatible(java.lang.String version)
Checks if this object is compatible with the specified version.
|
void |
releaseSession(IDfSession session)
Releases a handle to a Docbase session.
|
void |
setSessionManager(IDfSessionManager sessionManager)
Called by the runtime environment during service creation to
associate a session manager with this service instance.
|
boolean |
supportsFeature(java.lang.String feature)
Checks if the specified feature is supported by the implementation.
|
public java.lang.String getName()
This is a default implementation that may work in many cases. Most services will choose to override this method with a more accurate implementation.
getName
in interface IDfService
public java.lang.String getVersion()
This is a default implementation that returns a sample version. Most services will choose to override this method with a more meaningful implementation.
getVersion
in interface IDfService
IDfService.isCompatible(java.lang.String)
,
IDfService.supportsFeature(java.lang.String)
public java.lang.String getVendorString()
This is a default implementation that returns an empty string. Many services will choose to override this method with a more meaningful implementation.
getVendorString
in interface IDfService
public boolean isCompatible(java.lang.String version)
This is a default implementation that returns true if the version is an exact match. Many services will choose to override this method with a more meaningful implementation.
isCompatible
in interface IDfService
version
- version string of format: <major
version>.<minor version>
. Example:
"1.0"
true
if service is compatible with the version
(false
if incompatible)public boolean supportsFeature(java.lang.String feature)
This is a default implementation that returns false. Many services will choose to override this method with a more meaningful implementation.
supportsFeature
in interface IDfService
feature
- feature stringfalse
if the
feature is not supported)public void cleanupResources() throws DfServiceException
This method should not be used. Letting the client control cleanup can interfere with container life-cycle management.
cleanupResources
in interface IDfService
DfServiceException
- Internal errorpublic void setSessionManager(IDfSessionManager sessionManager)
This implementation is typically sufficient and doesn't need to be overridden.
public IDfSessionManager getSessionManager()
getSessionManager
in interface IDfService
IDfSessionManager
public IDfSession getSession(java.lang.String docbaseName) throws DfServiceException
Each time this method is called a corresponding call to
releaseSession(com.documentum.fc.client.IDfSession)
must be made once you are through
using the session.
getSession
in interface IDfService
docbaseName
- name of the DocbaseDfServiceException
public void releaseSession(IDfSession session) throws DfServiceException
This method must be called for each call to getSession(java.lang.String)
after you are through using the session.
releaseSession
in interface IDfService
session
- a session that was obtained from getSession(java.lang.String)
.DfServiceException
- Internal errorCopyright 1994-2023 OpenText Corporation. All rights reserved.