com.ibm.ecm.extension

Class PluginServiceCallbacks

java.lang.Object
com.ibm.ecm.extension.PluginServiceCallbacks

public class PluginServiceCallbacks
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.

Constructor Summary

Constructor and Description
`PluginServiceCallbacks(javax.servlet.http.HttpServletRequest request,Plugin plugin)` For Internal Use Only.

Method Summary

Modifier and Type	Method and Description
ODAnnotationMediator	`addODNote(java.lang.String repositoryId,java.lang.String documentId,java.lang.String templateName,java.lang.String noteGroupName,java.lang.String noteText,boolean noteIsOKToCopy,boolean noteIsPublic)` Adds a note for a document in a Content Manager OnDemand repository.
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.
java.lang.Object	`executePluginAPI(java.lang.String pluginId,java.lang.String apiId,java.lang.Object[] arguments)` Invokes a plug-in API.
CMObject	`getCMAnnotations(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.
CMObject	`getCMAnnotations(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	`getCMAnnotationsXDO(java.lang.String repositoryId,java.lang.String documentId)` Retrieves Applet viewer annotations (partNum = 0).
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.
CMObject	`getCMBookmarks(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	`getCMBookmarksXDO(java.lang.String repositoryId,java.lang.String documentId)` Retrieves Applet viewer bookmarks (partNum = 1).
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.
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.
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.
org.apache.chemistry.opencmis.client.api.Document	`getCMISDocument(java.lang.String repositoryId,java.lang.String documentId)` Retrieves a CMIS 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.
java.lang.String[]	`getConfigurationKeys()` Returns an array of key for the plug-in configurations.
java.util.Locale	`getLocale()` Returns the locale that is currently in use for this user session.
PluginLogger	`getLogger()`
com.ibm.ecm.serviceability.MonitoringCounter	`getMonitoringCounter(java.lang.String eventName)`
com.ibm.ecm.serviceability.MonitoringCounter	`getMonitoringCounter(java.lang.String eventName,java.lang.String subEventName)`
java.net.URL	`getNavigatorBaseUrl()` Returns the base URL for IBM Content Navigator.
com.ibm.edms.od.ODHit	`getODDocument(java.lang.String repositoryId,java.lang.String documentId,java.lang.String templateName)` Retrieves a Content Manager OnDemand document.
java.util.Vector[]	`getODNotes(java.lang.String repositoryId,java.lang.String documentId,java.lang.String templateName)` Retrieves Notes for an OD document.
java.util.HashMap<com.ibm.edms.od.ODHit,java.lang.Long>	`getODPrivilegeMasks(java.lang.String repositoryId,com.ibm.edms.od.ODFolder folder,java.util.List<com.ibm.edms.od.ODHit> items)` Returns the privilege masks for the given OD Objects.
com.ibm.edms.od.ODServer	`getODServer(java.lang.String repositoryId)` Returns a connection to the IBM Content Manager OnDemand 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)
javax.servlet.http.HttpServletRequest	`getOriginalRequest(javax.servlet.http.HttpServletRequest request)`
com.filenet.api.collection.AnnotationSet	`getP8Annotations(com.filenet.api.core.Document document,java.lang.String repositoryId,java.lang.String[] properties)` Gets the native AnnotationSet object representing the annotations of a FileNet P8 document.
java.lang.String	`getP8AnnotationsXML(com.filenet.api.core.Document document,java.lang.String repositoryId)` Gets the annotations XML representing the annotations of a FileNet P8 document.
com.filenet.api.core.Connection	`getP8Connection(java.lang.String repositoryId)` Returns a connection to the IBM FileNet P8 domain 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)
P8Connection	`getP8ConnectionObject(java.lang.String repositoryId)` Deprecated. This method is deprecated because it uses internal class P8Connection. Use getP8Connection instead.
com.filenet.api.core.Document	`getP8Document(java.lang.String repositoryId,java.lang.String documentId,java.lang.String vsId,java.lang.String version)` Retrieves a FileNet P8 document.
com.filenet.api.property.PropertyFilter	`getP8DocumentResultsPropertyFilter()` Retrieves the P8 property filter for document results.
com.filenet.api.core.Domain	`getP8Domain(java.lang.String repositoryId)` Deprecated. Retrieves the FileNet P8 domain for the given repository. This method retrieves all properties of the domain which could have an performance impact. Use getP8Domain(String repositoryId, PropertyFilter propertyFilter) for better performance.
com.filenet.api.core.Domain	`getP8Domain(java.lang.String repositoryId,com.filenet.api.property.PropertyFilter propertyFilter)` Retrieves the FileNet P8 domain for the given repository.
com.filenet.api.property.PropertyFilter	`getP8FolderResultsPropertyFilter()` Retrieves the P8 property filter for folder results.
com.filenet.api.core.ObjectStore	`getP8ObjectStore(java.lang.String repositoryId)` Retrieves the IBM FileNet P8 object store for the given repository.
java.util.HashMap<java.lang.Object,java.lang.Long>	`getP8PrivilegeMasks(java.lang.String repositoryId,java.util.List<java.lang.Object> items)` Returns the privilege masks for the given P8 Objects.
javax.security.auth.Subject	`getP8Subject(java.lang.String repositoryId)` Retrieves the IBM FileNet P8 `Subject` object for the given repository.
PluginRepositoryConnection	`getPluginRepositoryConnection(java.lang.String repositoryId)` Retrieves the PluginRepositoryConnection representing a plug-in provided repository.
org.apache.struts.util.MessageResources	`getPluginResources()` Returns the plug-in message resource bundle.
java.lang.String	`getRepositoryId()` Returns the identifier for the repository, such as the server name or object store identifier.
org.apache.struts.action.ActionForm	`getRequestActionForm()`
org.apache.struts.upload.FormFile	`getRequestUploadFile()`
org.apache.struts.util.MessageResources	`getResources()` Returns the Navigator message resource bundle.
org.apache.struts.util.MessageResources	`getResources(java.lang.String resources)` Returns the specified message resource bundle.
java.net.URL	`getServerBaseUrl()` Returns the URL to address the application server that is running IBM Content Navigator services.
java.lang.Object	`getSynchObject(java.lang.String repositoryId,java.lang.String repositoryType)` Returns a synchronization object for the specified repository.
java.lang.String	`getSystemPropertyLabel(java.lang.String repositoryType,java.lang.String id,java.util.Locale locale)` Retrieves the label to use for a system property.
java.lang.String[]	`getUserConfigurationKeys()` Returns the configuration keys per-user configuration of the plug-in
java.lang.String	`getUserId()` Returns the user identifier for the current repository.
filenet.vw.api.VWSession	`getVWSession(java.lang.String repositoryId,java.lang.String connectionPoint)` Retrieves a VWSession object for a given repository FileNet P8 domain.
java.lang.String	`loadConfiguration()` Returns the configuration for the plug-in.
java.lang.String[]	`loadConfigurations(java.lang.String[] keys)` Return an array of configuration in the same order denoted by keys
java.lang.String	`loadFeatureConfiguration(java.lang.String featureId)` Returns the feature's configuration for the plug-in.
java.lang.String	`loadUserConfiguration(java.lang.String key)` Returns the per-user configuration for the plug-in for the given key.
java.lang.String[]	`loadUserConfiguration(java.lang.String[] keys)` Returns the per-user multiple configuration for the plug-in for the given key.
boolean	`pluginAPIExists(java.lang.String pluginId,java.lang.String apiId)` Returns true if the plug-in specified is loaded and has a plug-in API of the specified id.
JSONRequest	`readJSONRequest(javax.servlet.http.HttpServletRequest request,javax.servlet.http.HttpServletResponse response,java.lang.Class jsonRequestClass)` Reads the parameters of an HttpServletRequest, populating a JSONRequest (an extension of JSONObject) with the parameters.
java.lang.String	`refreshSecurityToken(java.lang.String url)` If the url contains a security token, and it is stale, replace it with the current security token.
com.ibm.ecm.mediator.BaseMediator	`retrieveAnnotations(java.lang.String repositoryId,java.lang.String repositoryType,java.lang.String documentId,java.lang.String p8VsId,java.lang.String p8Version,java.lang.String odFolderName,boolean cmBookmarks,java.lang.Integer cmAnnotationPosition)` Deprecated. As of version 2.0.2. This method is being deprecated because it has a dependency on the ICN internal class BaseMediator. Use `retrieveJSONAnnotations` instead.
com.ibm.ecm.util.DocumentContent	`retrieveContent(java.lang.String repositoryId,java.lang.String repositoryType,java.lang.String documentId,int partNum,java.lang.String p8VsId,java.lang.String p8Version,java.lang.String odFolderName,int odSegmentNum,boolean odAsciiTransform)` Deprecated. As of Version 2.0.2. The returned DocumentContent class has been refactored into the extension package. Use retrieveDocumentContent.
PluginDocumentContent	`retrieveDocumentContent(java.lang.String repositoryId,java.lang.String repositoryType,java.lang.String documentId,int partNum,java.lang.String p8VsId,java.lang.String p8Version,java.lang.String odFolderName,int odSegmentNum,boolean odAsciiTransform)` Retrieves document content.
PluginDocumentContent	`retrieveDocumentContent(java.lang.String repositoryId,java.lang.String repositoryType,java.lang.String documentId,int partNum,java.lang.String p8VsId,java.lang.String p8Version,java.lang.String odFolderName,int odSegmentNum,java.lang.String odTransform)` Retrieves document content.
JSONObject	`retrieveJSONAnnotations(java.lang.String repositoryId,java.lang.String repositoryType,java.lang.String documentId,java.lang.String p8VsId,java.lang.String p8Version,java.lang.String odFolderName,boolean cmBookmarks,java.lang.Integer cmAnnotationPosition)` Retrieves annotations for a document.
void	`saveConfiguration(java.util.Hashtable<java.lang.String,java.lang.String> configs)` Saves configurations of a plug-in.
void	`saveConfiguration(java.lang.String config)` Saves the configuration of the plug-in.
void	`saveFeatureConfiguration(java.lang.String featureId,java.lang.String config)` Saves the feature's configuration for the plug-in.
void	`saveUserConfiguration(java.util.Hashtable<java.lang.String,java.lang.String> configs)` Saves the per-user configuration of the plug-in for the given keys.
void	`saveUserConfiguration(java.lang.String key,java.lang.String config)` Saves the per-user configuration of the plug-in for the given key.
void	`writeJSONResponse(JSONResponse jsonResponse,javax.servlet.http.HttpServletResponse response)` Writes a JSON response to the HttpServletResponse provided.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

PluginServiceCallbacks

public PluginServiceCallbacks(javax.servlet.http.HttpServletRequest request,
Plugin plugin)

For Internal Use Only. Constructs the callbacks.

Method Detail

getLogger

public PluginLogger getLogger()

Returns:

PluginLogger

Since:

2.0.2 PluginLogger is instantiated per plug-in service.

getMonitoringCounter

public com.ibm.ecm.serviceability.MonitoringCounter getMonitoringCounter( java.lang.String eventName)

Parameters:

eventName - The name of the event to monitor.

Returns:

MonitoringCounter

Since:

2.0.3.2 Returns a monitoring counter for accumulating events and their duration. To begin monitoring the duration of a particular event, call the start() method on the counter. To end monitoring, call the stop() method. The frequency and duration of monitored events are visible in the System Dashboard.

getMonitoringCounter

public com.ibm.ecm.serviceability.MonitoringCounter getMonitoringCounter( java.lang.String eventName,
java.lang.String subEventName)

Parameters:

eventName - The name of the parent event of the event to monitor.

subEventName - The name of the sub-event to monitor.

Returns:

MonitoringCounter

Since:

getOriginalRequest

public javax.servlet.http.HttpServletRequest getOriginalRequest( javax.servlet.http.HttpServletRequest request)

Returns:

PluginLogger

Since:

2.0.3 If the provided request is a proxy request object, this method will return the original request. Some application server APIs expect the original request and will fail when passed a proxy request object. If the provided request is not a proxy request object it is returned as is.

loadConfiguration

public java.lang.String loadConfiguration( )
throws java.lang.Exception

Returns the configuration for the plug-in.

Returns:

A String that contains the configuration for the plug-in.

Throws:

java.lang.Exception

saveConfiguration

public void saveConfiguration(java.lang.String config)
throws java.lang.Exception

Saves the configuration of the plug-in.

Throws:

java.lang.Exception

loadConfigurations

public java.lang.String[] loadConfigurations( java.lang.String[] keys)
throws java.lang.Exception

Return an array of configuration in the same order denoted by keys

Parameters:

keys - An array of key store the configuration information. Different keys can be used to store as much information as necessary.

Returns:

A String[] of configuration for a plug-in.

Throws:

java.lang.Exception

saveConfiguration

public void saveConfiguration(java.util.Hashtable<java.lang.String,java.lang.String> configs)
throws java.lang.Exception

Saves configurations of a plug-in.

Parameters:

configs - An hashed table of String and String of configuration for a plug-in.

Throws:

java.lang.Exception

getConfigurationKeys

public java.lang.String[] getConfigurationKeys( )
throws java.lang.Exception

Returns an array of key for the plug-in configurations.

Returns:

A String[] of key for the plug-in configurations.

Throws:

java.lang.Exception

loadFeatureConfiguration

public java.lang.String loadFeatureConfiguration( java.lang.String featureId)
throws java.lang.Exception

Returns the feature's configuration for the plug-in.

Parameters:

featureId - The id of the feature's configuration to return.

Returns:

A String of the feature's configuration.

Throws:

java.lang.Exception

saveFeatureConfiguration

public void saveFeatureConfiguration( java.lang.String featureId,
java.lang.String config)
throws java.lang.Exception

Saves the feature's configuration for the plug-in.

config - The configuration string to save for the provided feature.

Throws:

java.lang.Exception

loadUserConfiguration

public java.lang.String loadUserConfiguration( java.lang.String key)
throws java.lang.Exception

Returns the per-user configuration for the plug-in for the given key.

Parameters:

key - The key that is used to store the user configuration.

Returns:

A String that contains the user configuration for the plug-in.

Throws:

java.lang.Exception

saveUserConfiguration

public void saveUserConfiguration( java.lang.String key,
java.lang.String config)
throws java.lang.Exception

Saves the per-user configuration of the plug-in for the given key. This configuration information is stored differently for each user and key for the plug-in.

Parameters:

key - A key store the configuration information. Different keys can be used to store as much information as is necessary.

config - A string containing the user configuration for the plug-in.

Throws:

java.lang.Exception

loadUserConfiguration

public java.lang.String[] loadUserConfiguration( java.lang.String[] keys)
throws java.lang.Exception

Returns the per-user multiple configuration for the plug-in for the given key.

Parameters:

keys - A array of key store the configuration information.

Returns:

A String that contains the user configuration for the plug-in.

Throws:

java.lang.Exception

getUserConfigurationKeys

public java.lang.String[] getUserConfigurationKeys( )
throws java.lang.Exception

Returns the configuration keys per-user configuration of the plug-in

Returns:

A String array that contains the configuration key for the user.

Throws:

java.lang.Exception

saveUserConfiguration

public void saveUserConfiguration( java.util.Hashtable<java.lang.String,java.lang.String> configs)
throws java.lang.Exception

Saves the per-user configuration of the plug-in for the given keys.

Parameters:

configs - An hashed table of String and String of user configuration for a plug-in.

Throws:

java.lang.Exception

getRepositoryId

public java.lang.String getRepositoryId( )

Returns the identifier for the repository, such as the server name or object store identifier.

Returns:

A String that contains the repository ID.

getUserId

public java.lang.String getUserId( )

Returns the user identifier for the current repository.

Returns:

A String that contains the user ID.

getLocale

public java.util.Locale getLocale( )

Returns the locale that is currently in use for this user session.

getServerBaseUrl

public java.net.URL getServerBaseUrl( )

Returns the URL to address the application server that is running IBM Content Navigator services. This method is useful when the plug-in needs to communicate with another web application that is running on the same application server.

getNavigatorBaseUrl

public java.net.URL getNavigatorBaseUrl( )

Returns the base URL for IBM Content Navigator.

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.

getODServer

public com.ibm.edms.od.ODServer getODServer( java.lang.String repositoryId)

Returns a connection to the IBM Content Manager OnDemand 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.edms.od.ODServer object that provides a connection to the IBM Content Manager OnDemand server. If the server is not found, this method returns null.

getP8Connection

public com.filenet.api.core.Connection getP8Connection( java.lang.String repositoryId)

Returns a connection to the IBM FileNet P8 domain 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:

A com.filenet.api.core.Connection object that provides a connection to the IBM Filenet P8 domain. If the server is not found, this method returns null.

getP8ConnectionObject

public P8Connection getP8ConnectionObject( java.lang.String repositoryId)

Deprecated. This method is deprecated because it uses internal class P8Connection. Use getP8Connection instead.

Retrieves a P8Connection object for a given repository FileNet P8 domain.

Parameters:

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

Returns:

A com.ibm.ecm.util.p8.P8Connection object that provides a connection to the IBM FileNet P8 domain. If the server is not found, this method returns null.

getVWSession

public filenet.vw.api.VWSession getVWSession( java.lang.String repositoryId,
java.lang.String connectionPoint)
throws java.lang.Exception

Retrieves a VWSession object for a given repository FileNet P8 domain.

Parameters:

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

connectionPoint - (Optional) A string holding the connection point to use when establishing a connection to the Process Server. If not passed in, will use the connection point registered to the repository in the administration tool.

Returns:

A filenet.vw.api.VWSession object that provides a session to the IBM FileNet P8 process server. If a connection to a FileNet P8 repository is not found, this method returns null.

Throws:

java.lang.Exception

Since:

2.0.2

getP8ObjectStore

public com.filenet.api.core.ObjectStore getP8ObjectStore( java.lang.String repositoryId)

Retrieves the IBM FileNet P8 object store for the given repository. The object store represents a location in which folders, documents, and custom objects are stored, accessed, and managed on the IBM Content Engine server.

Parameters:

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

Returns:

A com.filenet.api.core.ObjectStore object for the object store represented by the repository identifier, or null.

getP8Domain

public com.filenet.api.core.Domain getP8Domain( java.lang.String repositoryId)

Deprecated. Retrieves the FileNet P8 domain for the given repository. This method retrieves all properties of the domain which could have an performance impact. Use getP8Domain(String repositoryId, PropertyFilter propertyFilter) for better performance.

Parameters:

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

Returns:

A com.filenet.api.core.Domain domain that contains the object store represented by the repository identifier, or null.

getP8Domain

public com.filenet.api.core.Domain getP8Domain( java.lang.String repositoryId,
com.filenet.api.property.PropertyFilter propertyFilter)

Retrieves the FileNet P8 domain for the given repository.

Parameters:

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

propertyFilter - The PropertyFilter to use to fetch the domain object. The filter must contain the Id property.

Returns:

A com.filenet.api.core.Domain domain that contains the object store represented by the repository identifier, or null.

Since:

2.0.1

getP8Subject

public javax.security.auth.Subject getP8Subject( java.lang.String repositoryId)

Retrieves the IBM FileNet P8 Subject object for the given repository. A Subject represents a grouping of related information for a single entity, such as a person. Such information includes the Subject's identities as well as its security-related attributes (for example, passwords and cryptographic keys).

Parameters:

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

Returns:

The javax.security.auth.Subject object for the subject used to authenticate against the object store represented by the repository identifier, or null.

getResources

public org.apache.struts.util.MessageResources getResources( )

Returns the Navigator message resource bundle.

Returns:

Returns the Navigator MessageResources object.

getPluginResources

public org.apache.struts.util.MessageResources getPluginResources( )

Returns the plug-in message resource bundle.

Returns:

Returns the plug-in MessageResources object.

getResources

public org.apache.struts.util.MessageResources getResources( java.lang.String resources)

Returns the specified message resource bundle.

Returns:

Returns the MessageResources object.

Since:

2.0.3.2

getSynchObject

public java.lang.Object getSynchObject( java.lang.String repositoryId,
java.lang.String repositoryType)

Returns a synchronization object for the specified repository.

For IBM Content Manager, IBM Content Manager OnDemand, and FileNet P8 repositories, this call will return a non-null object which must be used to set up a synchronized block when calling any of the content/annotation retrieval/update calls below or when using the repository API objects returned by getCMDatastore(), getP8Connection(), and getODServer().

Parameters:

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

repositoryType - The repository type, as defined in IBM Content Navigator.

Returns:

synchronization object, if synchronization is required, otherwise null

retrieveDocumentContent

public PluginDocumentContent retrieveDocumentContent( java.lang.String repositoryId,
java.lang.String repositoryType,
java.lang.String documentId,
int partNum,
java.lang.String p8VsId,
java.lang.String p8Version,
java.lang.String odFolderName,
int odSegmentNum,
boolean odAsciiTransform)
throws java.lang.Exception

Retrieves document content.

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.

repositoryType - The repository type, as defined in IBM Content Navigator.

documentId - The document ID.

partNum - Either the part number for a Content Manager multi-part document, or the element id for a FileNet P8 multi-element document.

p8VsId - For FileNet P8, the version series ID.

p8Version - For FileNet P8, specify either "current" to get the latest major/minor version, or "released" to get the latest major version.

odFolderName - For Content Manager OnDemand, the folder name.

odSegmentNum - For Content Manager OnDemand, the segment number, or specify 0 to retrieve all segments.

odAsciiTransform - For Content Manager OnDemand, set to true to receive ASCII, or false to receive the content in its native format.

Returns:

A PluginDocumentContent object, representing the document content

Throws:

java.lang.Exception

retrieveDocumentContent

public PluginDocumentContent retrieveDocumentContent( java.lang.String repositoryId,
java.lang.String repositoryType,
java.lang.String documentId,
int partNum,
java.lang.String p8VsId,
java.lang.String p8Version,
java.lang.String odFolderName,
int odSegmentNum,
java.lang.String odTransform)
throws java.lang.Exception

Retrieves document content.

Parameters:

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

repositoryType - The repository type, as defined in IBM Content Navigator.

documentId - The document ID.

partNum - Either the part number for a Content Manager multi-part document, or the element id for a FileNet P8 multi-element document.

p8VsId - For FileNet P8, the version series ID.

p8Version - For FileNet P8, specify either "current" to get the latest major/minor version, or "released" to get the latest major version.

odFolderName - For Content Manager OnDemand, the folder name.

odSegmentNum - For Content Manager OnDemand, the segment number, or specify 0 to retrieve all segments.

odTransform - For Content Manager OnDemand, specify to request a transformation type.

Returns:

A PluginDocumentContent object, representing the document content.

Throws:

java.lang.Exception

Since:

2.0.3

retrieveContent

public com.ibm.ecm.util.DocumentContent retrieveContent( java.lang.String repositoryId,
java.lang.String repositoryType,
java.lang.String documentId,
int partNum,
java.lang.String p8VsId,
java.lang.String p8Version,
java.lang.String odFolderName,
int odSegmentNum,
boolean odAsciiTransform)
throws java.lang.Exception

Deprecated. As of Version 2.0.2. The returned DocumentContent class has been refactored into the extension package. Use retrieveDocumentContent.

Throws:

java.lang.Exception

retrieveAnnotations

public com.ibm.ecm.mediator.BaseMediator retrieveAnnotations( java.lang.String repositoryId,
java.lang.String repositoryType,
java.lang.String documentId,
java.lang.String p8VsId,
java.lang.String p8Version,
java.lang.String odFolderName,
boolean cmBookmarks,
java.lang.Integer cmAnnotationPosition)

Deprecated. As of version 2.0.2. This method is being deprecated because it has a dependency on the ICN internal class BaseMediator. Use retrieveJSONAnnotations instead.

retrieveJSONAnnotations

public JSONObject retrieveJSONAnnotations( java.lang.String repositoryId,
java.lang.String repositoryType,
java.lang.String documentId,
java.lang.String p8VsId,
java.lang.String p8Version,
java.lang.String odFolderName,
boolean cmBookmarks,
java.lang.Integer cmAnnotationPosition)

Retrieves annotations for a document.

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

Parameters:

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

repositoryType - The repository type, as defined in IBM Content Navigator.

documentId - The document ID.

p8VsId - For FileNet P8, the version series ID.

p8Version - For FileNet P8, specify either "current" to get the latest major/minor version, or "released" to get the latest major version.

odFolderName - For Content Manager OnDemand, the folder name.

cmBookmarks - For Content Manager, specify true to receive bookmarks, and false to receive regular annotations.

cmAnnotationPosition - For Content Manager annotations (not bookmarks), specify the annotationPosition value. This effects adjustment of placement of annotations in the returned JSON. If this is not specified, a default value of 1400 will be used. (optional)

Returns:

getP8Document

public com.filenet.api.core.Document getP8Document( java.lang.String repositoryId,
java.lang.String documentId,
java.lang.String vsId,
java.lang.String version)

Retrieves a FileNet P8 document.

Parameters:

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

documentId - The document ID.

vsId - The version series ID.

version -

Returns:

getP8DocumentResultsPropertyFilter

public com.filenet.api.property.PropertyFilter getP8DocumentResultsPropertyFilter( )

Retrieves the P8 property filter for document results.

Returns:

Returns the com.filenet.api.property.PropertyFilter for document results.

Since:

2.0.2

getP8FolderResultsPropertyFilter

public com.filenet.api.property.PropertyFilter getP8FolderResultsPropertyFilter( )

Retrieves the P8 property filter for folder results.

Returns:

Returns the com.filenet.api.property.PropertyFilter for folder results.

Since:

2.0.2

getP8PrivilegeMasks

public java.util.HashMap<java.lang.Object,java.lang.Long> getP8PrivilegeMasks( java.lang.String repositoryId,
java.util.List<java.lang.Object> items)
throws java.lang.Exception

Returns the privilege masks for the given P8 Objects.

Parameters:

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

items - The java.util.List of Object items.

Returns:

Returns a java.util.HashMap that maps each Object to the associated privilege mask.

Throws:

java.lang.Exception

Since:

2.0.2

getCMDocument

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

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

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.

items - The java.util.List of DKDDO items.

Returns:

Returns a java.util.HashMap that maps each DKDDO item to the associated privilege mask.

Throws:

java.lang.Exception

Since:

2.0.2

getODDocument

public com.ibm.edms.od.ODHit getODDocument( java.lang.String repositoryId,
java.lang.String documentId,
java.lang.String templateName)
throws java.lang.Exception

Retrieves a Content Manager OnDemand 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.

templateName -

Returns:

Throws:

java.lang.Exception

getODPrivilegeMasks

public java.util.HashMap<com.ibm.edms.od.ODHit,java.lang.Long> getODPrivilegeMasks( java.lang.String repositoryId,
com.ibm.edms.od.ODFolder folder,
java.util.List<com.ibm.edms.od.ODHit> items)
throws java.lang.Exception

Returns the privilege masks for the given OD Objects.

Parameters:

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

folder - The ODFolder containing the ODHit items.

items - The java.util.List of ODHit items.

Returns:

Returns a java.util.HashMap that maps each ODHit to the associated privilege mask.

Throws:

java.lang.Exception

Since:

2.0.2.3

getCMISDocument

public org.apache.chemistry.opencmis.client.api.Document getCMISDocument( java.lang.String repositoryId,
java.lang.String documentId)

Retrieves a CMIS document.

Parameters:

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

documentId - The document ID.

Returns:

addODNote

public ODAnnotationMediator addODNote( java.lang.String repositoryId,
java.lang.String documentId,
java.lang.String templateName,
java.lang.String noteGroupName,
java.lang.String noteText,
boolean noteIsOKToCopy,
boolean noteIsPublic)

Adds a note for a document in a Content Manager OnDemand repository.

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.

templateName - The folder name.

noteGroupName -

noteText -

noteIsOKToCopy -

noteIsPublic -

Returns:

getP8Annotations

public com.filenet.api.collection.AnnotationSet getP8Annotations( com.filenet.api.core.Document document,
java.lang.String repositoryId,
java.lang.String[] properties)

Gets the native AnnotationSet object representing the annotations of a FileNet P8 document.

Parameters:

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

Returns:

getP8AnnotationsXML

public java.lang.String getP8AnnotationsXML( com.filenet.api.core.Document document,
java.lang.String repositoryId)
throws java.lang.Exception

Gets the annotations XML representing the annotations of a FileNet P8 document.

Parameters:

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

Returns:

Throws:

java.lang.Exception

getCMAnnotations

public CMObject getCMAnnotations( 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 CMObject getCMAnnotations( CMItem item,
java.lang.String repositoryId)
throws java.lang.Exception

Throws:

java.lang.Exception

getCMBookmarks

public CMObject getCMBookmarks( 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

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

getCMAnnotationsXDO

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

Retrieves Applet viewer annotations (partNum = 0).

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.

Returns:

Throws:

java.lang.Exception

getCMBookmarksXDO

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

Retrieves Applet viewer bookmarks (partNum = 1).

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.

Returns:

Throws:

java.lang.Exception

getODNotes

public java.util.Vector[] getODNotes( java.lang.String repositoryId,
java.lang.String documentId,
java.lang.String templateName)
throws java.lang.Exception

Retrieves Notes for an OD document.

The Vector array returned will contain two entries. The first (index 0) contains a Vector containing an ODHit object representing the document itself. The second (index 1) contains a Vector containing all of the ODNote objects for the document.

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.

templateName -

Returns:

Throws:

java.lang.Exception

getRequestUploadFile

public org.apache.struts.upload.FormFile getRequestUploadFile( )

Returns:

An org.apache.struts.upload.FormFile object for the file uploaded in the request. If no file was uploaded this method returns null.

Since:

2.0.2 Retrieves the upload file from the request.

getRequestActionForm

public org.apache.struts.action.ActionForm getRequestActionForm( )

Returns:

An org.apache.struts.action.ActionForm object from the request. If no action form is present this method returns null.

Since:

2.0.2 Retrieves the action form from the request.

getSystemPropertyLabel

public java.lang.String getSystemPropertyLabel( java.lang.String repositoryType,
java.lang.String id,
java.util.Locale locale)

Retrieves the label to use for a system property. This allows a plug-in to match its terminology for similar properties with that defined using IBM Content Navigator's administration.

Parameters:

repositoryType - the type of repository ("p8", "cm", "od", "cmis")

id - the internal identifier for the system property.

Returns:

Since:

2.0.2

getPluginRepositoryConnection

public PluginRepositoryConnection getPluginRepositoryConnection( java.lang.String repositoryId)

Retrieves the PluginRepositoryConnection representing a plug-in provided repository. Note that the support for this repository can be provided by a different plug-in than the invoker of this method. ha

Parameters:

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

Returns:

an instance of PluginRepositoryConnection or null if the repository does not exist.

readJSONRequest

public JSONRequest readJSONRequest( javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
java.lang.Class jsonRequestClass)
throws java.lang.Exception

Reads the parameters of an HttpServletRequest, populating a JSONRequest (an extension of JSONObject) with the parameters. This utility should be used when it is desirable to allow other plug-ins, such as the EDSPlugin, to process the request with its request filters.

Note: This should never be used within a PluginRequestFilter as it would cause an infinite loop.

Parameters:

request - The instance of HttpServletRequest to read the parameters.

response - The instance of HttpServletResponse for the request. Although this isn't needed in order to convert the request parameters to JSON, it is passed to any plug-in request filters so that they can override behavior and write an alternate response.

jsonRequestClass - The class for a JSONRequest or subclass. An instance of this class is created and the parameters of the HttpServletRequest are populated as fields into this object.

Returns:

an instance of the JSONRequest class specified or null if a plug-in request filter has overridden the behavior. In the case of null, the plug-in service should simply return without performing any actions.

Throws:

java.lang.Exception

Since:

2.0.3

writeJSONResponse

public void writeJSONResponse(JSONResponse jsonResponse,
javax.servlet.http.HttpServletResponse response)
throws java.lang.Exception

Writes a JSON response to the HttpServletResponse provided. This utility should be used when it is desirable to allow other plug-ins, such as the EDSPlugin, to process the response with its response filters.

Note: This should never be used within a PluginResponseFilter as it would cause an infinite loop.

Parameters:

jsonResponse - The JSON response to write.

response - The instance of HttpServletResponse in which to write the response.

Throws:

java.lang.Exception - an exception raised during the writing of the response

Since:

2.0.3

pluginAPIExists

public boolean pluginAPIExists( java.lang.String pluginId,
java.lang.String apiId)

Returns true if the plug-in specified is loaded and has a plug-in API of the specified id.

Parameters:

pluginId - the identifier of the plug-in containing the API.

apiId - the identifier of the plug-in API

Returns:

true if the plug-in is loaded and the plug-in API exists

Since:

2.0.3

executePluginAPI

public java.lang.Object executePluginAPI( java.lang.String pluginId,
java.lang.String apiId,
java.lang.Object[] arguments)
throws java.lang.Exception

Invokes a plug-in API. A plug-in API is provided by a plug-in for use by other plug-ins.

Parameters:

pluginId - the identifier of the plug-in containing the API.

apiId - the identifier of the plug-in API

arguments - an object array containing arguments to the plug-in API. The structure of this objects are defined by the plug-in containing the API.

Returns:

an object containing any return information from the plug-in API. The structure of this object is defined by the plug-in containing the API.

Throws:

java.lang.Exception - an exception either from IBM Content Navigator or the plug-in API. Unless otherwise defined by the plug-in API, the exception should not be caught and allowed to terminate the invoking plug-in service.

Since:

2.0.3

refreshSecurityToken

public java.lang.String refreshSecurityToken( java.lang.String url)

If the url contains a security token, and it is stale, replace it with the current security token. If the url does not contain the security token, or it does contain the security token but it is not stale, this function returns the same url as it is passed.

Parameters:

url -

Returns:

Since:

2.0.3