com.ibm.ecm.extension

Class CMPluginServiceCallbacks

java.lang.Object

com.ibm.ecm.extension.CMPluginServiceCallbacks

public class CMPluginServiceCallbacks
extends java.lang.Object

Provides a plug-in service with access to the application programming interface (API) of the underlying server and the location of the configuration information for the plug-in.

Method Summary

Modifier and Type	Method and Description
boolean	CMApiAndServerVersionAtOrNewer(com.ibm.mm.sdk.server.DKDatastoreICM datastore, int version, int release, int csd, int fixpack) Determines if the CM API and CM server versions are at or newer than the specified level.
int	getBaseContentPartNumber(java.lang.String repositoryId, com.ibm.mm.sdk.common.DKDDO dkDdo) Get the base content part number for the retrieved CM Document.
com.ibm.ecm.beans.cm.CMObject	getCMAnnotations(com.ibm.ecm.beans.cm.CMItem item, java.lang.String repositoryId) Deprecated. As of version 2.0.2. This method is being removed because it has a dependency on the internal ICN CMObject class. Use getCMAnnotationsXDO, which returns an instance of dkXDO instead.
com.ibm.ecm.beans.cm.CMObject	getCMAnnotations(com.ibm.ecm.beans.cm.CMItem item, java.lang.String repositoryId, int partNum) Deprecated. As of version 2.0.2. This method is being removed because it has a dependency on the internal ICN CMObject class. Use getCMAnnotationsXDO, which returns an instance of dkXDO instead.
com.ibm.mm.sdk.common.dkXDO	getCMAnnotations(java.lang.String repositoryId, java.lang.String documentId) Deprecated. As of version 2.0.2.1. This method is being removed because it has an indirect dependency on the internal ICN CMObject class. Use getCMAnnotationsXDO, which returns an instance of dkXDO instead.
com.ibm.mm.sdk.common.dkXDO	getCMAnnotations(java.lang.String repositoryId, java.lang.String documentId, int partNum) Deprecated. As of version 2.0.2.1. This method is being removed because it has an indirect dependency on the internal ICN CMObject class. Use getCMAnnotationsXDO, which returns an instance of dkXDO instead.
com.ibm.mm.sdk.common.dkXDO	getCMAnnotationsXDO(java.lang.String repositoryId, java.lang.String documentId, int partNum) Retrieves annotations stored in the item's specified part number.
com.ibm.ecm.beans.cm.CMObject	getCMBookmarks(com.ibm.ecm.beans.cm.CMItem item, java.lang.String repositoryId) Deprecated. As of version 2.0.2. This method is being removed because it has a dependency on the internal ICN CMObject class. Use getCMBookmarksXDO, which returns an instance of dkXDO instead.
com.ibm.mm.sdk.common.dkXDO	getCMBookmarks(java.lang.String repositoryId, java.lang.String documentId) Deprecated. As of version 2.0.2.1. This method is being removed because it has an indirect dependency on the internal ICN CMObject class. Use getCMBookmarksXDO, which returns an instance of dkXDO instead.
com.ibm.mm.sdk.server.DKDatastoreICM	getCMDatastore(java.lang.String repositoryId) Returns a connection to the IBM Content Manager server for the given repository. The returned connection should only be used within a synchronized block using the object returned by: getSynchObject(String repositoryId, String repositoryType)
com.ibm.mm.sdk.common.DKDDO	getCMDocument(java.lang.String repositoryId, java.lang.String documentId, boolean baseAttributes, boolean partsList, boolean partsAttributes) Deprecated. As of version 2.0.2.1. This method is being removed because it has an indirect dependency on the internal ICN CMItem class. Use getCMDocumentDDO instead.
com.ibm.ecm.beans.cm.CMItem	getCMDocument(java.lang.String repositoryId, java.lang.String documentId, com.ibm.mm.sdk.common.DKRetrieveOptionsICM dkRetrieveOptions) Deprecated. As of version 2.0.2. This method is being removed because it has a dependency on the internal ICN CMItem class. Use getCMDocumentDDO, which returns an instance of DKDDO instead.
PluginDocumentContent	getCMDocumentContent(java.lang.String repositoryId, com.ibm.mm.sdk.common.DKDDO dkDdo, int partNum, boolean usePartFileName) Get the document content for the specified part in the retrieved CM Document.
com.ibm.mm.sdk.common.DKDDO	getCMDocumentDDO(java.lang.String repositoryId, java.lang.String documentId, boolean baseAttributes, boolean partsList, boolean partsAttributes) Retrieves a Content Manager document.
java.util.HashMap<com.ibm.mm.sdk.common.DKDDO,java.lang.Long>	getCMPrivilegeMasks(java.lang.String repositoryId, java.util.List<com.ibm.mm.sdk.common.DKDDO> items) Returns the privilege masks for the given CM items.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getCMDatastore

public com.ibm.mm.sdk.server.DKDatastoreICM getCMDatastore(java.lang.String repositoryId)

Returns a connection to the IBM Content Manager server for the given repository.
The returned connection should only be used within a synchronized block using the object returned by:
getSynchObject(String repositoryId, String repositoryType)

Parameters:

repositoryId - The repository identifier, as defined in IBM Content Navigator.

Returns:

An com.ibm.mm.sdk.server.DKDatastoreICM object that provides a connection to the IBM Content Manager server. If the server is not found, this method returns null.

getCMDocument

public com.ibm.ecm.beans.cm.CMItem getCMDocument(java.lang.String repositoryId,
                                                 java.lang.String documentId,
                                                 com.ibm.mm.sdk.common.DKRetrieveOptionsICM dkRetrieveOptions)
                                          throws java.lang.Exception

Deprecated. As of version 2.0.2. This method is being removed because it has a dependency on the internal ICN CMItem class. Use getCMDocumentDDO, which returns an instance of DKDDO instead.

Throws:

java.lang.Exception

getCMDocument

public com.ibm.mm.sdk.common.DKDDO getCMDocument(java.lang.String repositoryId,
                                                 java.lang.String documentId,
                                                 boolean baseAttributes,
                                                 boolean partsList,
                                                 boolean partsAttributes)
                                          throws java.lang.Exception

Deprecated. As of version 2.0.2.1. This method is being removed because it has an indirect dependency on the internal ICN CMItem class. Use getCMDocumentDDO instead.

Throws:

java.lang.Exception

getCMDocumentDDO

public com.ibm.mm.sdk.common.DKDDO getCMDocumentDDO(java.lang.String repositoryId,
                                                    java.lang.String documentId,
                                                    boolean baseAttributes,
                                                    boolean partsList,
                                                    boolean partsAttributes)
                                             throws java.lang.Exception

Retrieves a Content Manager document.

Access and use of this function and returned object must be placed with in a synchronized block, if getSynchObject returns non-null. Content can be retrieved from Content Manager, FileNet P8, Content Manager OnDemand, and CMIS repositories.

Parameters:

repositoryId - The repository identifier, as defined in IBM Content Navigator.

documentId - The document ID.

baseAttributes - Retrieve all base attributes of the document.

partsList - Retrieve the parts list for the document.

partsAttributes - Retrieve the parts attributes for the parts contained in the document.

Returns:

Throws:

java.lang.Exception

getBaseContentPartNumber

public int getBaseContentPartNumber(java.lang.String repositoryId,
                                    com.ibm.mm.sdk.common.DKDDO dkDdo)

Get the base content part number for the retrieved CM Document. This is the first BASE content part that appears in the document, and is most commonly part 0. If there are any problems determining the base content part number, 0 is returned, and if debug logging is enabled, an exception will be logged.

Parameters:

repositoryId -

dkDdo -

Returns:

Since:

2.0.3.7

getCMDocumentContent

public PluginDocumentContent getCMDocumentContent(java.lang.String repositoryId,
                                                  com.ibm.mm.sdk.common.DKDDO dkDdo,
                                                  int partNum,
                                                  boolean usePartFileName)
                                           throws java.lang.Exception

Get the document content for the specified part in the retrieved CM Document.

Parameters:

repositoryId -

dkDdo -

partNum -

usePartFileName -

Returns:

Throws:

java.lang.Exception

Since:

2.0.3.7

CMApiAndServerVersionAtOrNewer

public boolean CMApiAndServerVersionAtOrNewer(com.ibm.mm.sdk.server.DKDatastoreICM datastore,
                                              int version,
                                              int release,
                                              int csd,
                                              int fixpack)

Determines if the CM API and CM server versions are at or newer than the specified level.

Parameters:

datastore - The datastore connection

version - Version number

release - Release number

csd - CSD number

fixpack - Fixpack number

Returns:

Boolean true if the CM API and CM server are at or newer than the specified level.

Since:

2.0.2

getCMPrivilegeMasks

public java.util.HashMap<com.ibm.mm.sdk.common.DKDDO,java.lang.Long> getCMPrivilegeMasks(java.lang.String repositoryId,
                                                                                         java.util.List<com.ibm.mm.sdk.common.DKDDO> items)
                                                                                  throws java.lang.Exception

Returns the privilege masks for the given CM items.

Parameters:

repositoryId - The datastore connection

items - The list of items.

Returns:

Returns a map of each DKDDO item to the associated privilege mask.

Throws:

java.lang.Exception

Since:

2.0.2

getCMAnnotations

public com.ibm.ecm.beans.cm.CMObject getCMAnnotations(com.ibm.ecm.beans.cm.CMItem item,
                                                      java.lang.String repositoryId,
                                                      int partNum)
                                               throws java.lang.Exception

Deprecated. As of version 2.0.2. This method is being removed because it has a dependency on the internal ICN CMObject class. Use getCMAnnotationsXDO, which returns an instance of dkXDO instead.

Throws:

java.lang.Exception

getCMAnnotations

public com.ibm.ecm.beans.cm.CMObject getCMAnnotations(com.ibm.ecm.beans.cm.CMItem item,
                                                      java.lang.String repositoryId)
                                               throws java.lang.Exception

Deprecated. As of version 2.0.2. This method is being removed because it has a dependency on the internal ICN CMObject class. Use getCMAnnotationsXDO, which returns an instance of dkXDO instead.

Throws:

java.lang.Exception

getCMBookmarks

public com.ibm.ecm.beans.cm.CMObject getCMBookmarks(com.ibm.ecm.beans.cm.CMItem item,
                                                    java.lang.String repositoryId)
                                             throws java.lang.Exception

Deprecated. As of version 2.0.2. This method is being removed because it has a dependency on the internal ICN CMObject class. Use getCMBookmarksXDO, which returns an instance of dkXDO instead.

Throws:

java.lang.Exception

getCMAnnotations

public com.ibm.mm.sdk.common.dkXDO getCMAnnotations(java.lang.String repositoryId,
                                                    java.lang.String documentId,
                                                    int partNum)
                                             throws java.lang.Exception

Deprecated. As of version 2.0.2.1. This method is being removed because it has an indirect dependency on the internal ICN CMObject class. Use getCMAnnotationsXDO, which returns an instance of dkXDO instead.

Throws:

java.lang.Exception

getCMAnnotations

public com.ibm.mm.sdk.common.dkXDO getCMAnnotations(java.lang.String repositoryId,
                                                    java.lang.String documentId)
                                             throws java.lang.Exception

Deprecated. As of version 2.0.2.1. This method is being removed because it has an indirect dependency on the internal ICN CMObject class. Use getCMAnnotationsXDO, which returns an instance of dkXDO instead.

Throws:

java.lang.Exception

getCMBookmarks

public com.ibm.mm.sdk.common.dkXDO getCMBookmarks(java.lang.String repositoryId,
                                                  java.lang.String documentId)
                                           throws java.lang.Exception

Deprecated. As of version 2.0.2.1. This method is being removed because it has an indirect dependency on the internal ICN CMObject class. Use getCMBookmarksXDO, which returns an instance of dkXDO instead.

Throws:

java.lang.Exception

getCMAnnotationsXDO

public com.ibm.mm.sdk.common.dkXDO getCMAnnotationsXDO(java.lang.String repositoryId,
                                                       java.lang.String documentId,
                                                       int partNum)
                                                throws java.lang.Exception

Retrieves annotations stored in the item's specified part number. The first two parts, 0 and 1, are reserved for Applet viewer annotations and bookmarks respectively.

Access and use of this function and returned object must be placed with in a synchronized block, if getSynchObject returns non-null.

Parameters:

repositoryId - The repository identifier, as defined in IBM Content Navigator.

documentId - The document ID.

partNum - The part number to retrieve.

Returns:

Throws:

java.lang.Exception