com.ibm.ecm.extension

Class P8PluginServiceCallbacks

java.lang.Object

com.ibm.ecm.extension.P8PluginServiceCallbacks

public class P8PluginServiceCallbacks
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
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.
java.lang.String	getP8BurnInRedactionsXML(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)
com.ibm.ecm.util.p8.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.
filenet.vw.api.VWSession	getVWSession(java.lang.String repositoryId, java.lang.String connectionPoint) Retrieves a VWSession object for a given repository FileNet P8 domain.

Methods inherited from class java.lang.Object

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

Method Detail

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 com.ibm.ecm.util.p8.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). It is recommended that the subject is pushed to and popped from the IBM FileNet P8 UserContext object before and after any operations are performed against IBM FileNet P8 repositories. Calls to the UserContext.pushSubject and UserContext.popSubject methods must always be balanced. That is, a call to pushSubject must eventually be followed by a balancing call to popSubject. If the pushSubject and popSubject calls are not balanced, an incorrect Subject might be used by a component that is reusing the thread.

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.

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 list items.

Returns:

Returns a map of each Object to the associated privilege mask.

Throws:

java.lang.Exception

Since:

2.0.2

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:

document - The document.

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:

document - The document.

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

Returns:

Throws:

java.lang.Exception

getP8BurnInRedactionsXML

public java.lang.String getP8BurnInRedactionsXML(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:

document - The document.

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

Returns:

Throws:

java.lang.Exception

Since:

2.0.3.8