com.filenet.rm.api

Interface RMConnector


  1. public interface RMConnector
Represents a connection to an external document repositories, such as Image Services, Content Services, and Content Engine. The RMConnector interface defines methods that you can use to query these repositories.

You can instantiate an RMConnector object by calling the getConnector method on an RMDriverManager object. This method validates the registration ID and returns the corresponding RMConnector object.

ATTENTION The methods in this interface might be deprecated in a future release. Do not use these methods.

Specifying a URL

To communicate with a document repository and locate a document stored in the repository, the Records Manager API provides the URL of a required document to the RMConnector object. The URL is a String that contains the information required to locate the document including the repository type, repository name, server name, and document ID. The URL is stored as a property of the RecordInfo object during the declaration process. The URL can then be retrieved from the RecordInfo object and parsed for any record-related operations.

The following example illustrates a URL that can be used for all methods except search-related methods on an RMConnector object:

<RMCONNECTOR_URL> <REPOSITORY_TYPE>CE</REPOSITORY_TYPE> <SERVER_NAME>http://fn-atlantic:8008/ApplicationEngine/xcmisasoap.dll</SERVER_NAME> <REPOSITORY_NAME>FPOS</REPOSITORY_NAME> <DOCUMENT_ID>C4A973F9-4F6B-4FCB-BE59-B1697497EC9C</DOCUMENT_ID> <USER_ID>somals</USER_ID> <PASSWORD>sood</PASSWORD> </RMCONNECTOR_URL>

The following example illustrates a URL that can be used for search-related methods on an RMConnector object:

<RMCONNECTOR_SEARCH_URL> <RMCONNECTOR_URL> <REPOSITORY_TYPE>CE</REPOSITORY_TYPE> <SERVER_NAME>http://fn-atlantic:8008/ApplicationEngine/xcmisasoap.dll</SERVER_NAME> <REPOSITORY_NAME>FPOS</REPOSITORY_NAME> <USER_ID>somals</USER_ID> <PASSWORD>sood</PASSWORD> </RMCONNECTOR_URL> <RMCONNECTOR_URL> <REPOSITORY_TYPE>CE</REPOSITORY_TYPE> <SERVER_NAME>http://fn-pacific:8008/ApplicationEngine/xcmisasoap.dll</SERVER_NAME> <REPOSITORY_NAME>PROTest</REPOSITORY_NAME> <USER_ID>somals</USER_ID> <PASSWORD>sood</PASSWORD> </RMCONNECTOR_URL> </RMCONNECTOR_SEARCH_URL>


Method Summary

Modifier and Type Method and Description
  1. boolean
canDeclare(java.lang.String asURL,java.lang.String[] asArrVersion)
Validates the eligibility of a document for the declaration operation.
  1. java.lang.String
copyDocument(java.lang.String asURL,java.lang.String asName,com.filenet.wcm.api.Properties aoProps,com.filenet.wcm.api.Permissions aoACLs)
Creates a copy of a specified document with the specified property and permission values.
  1. void
declareDocument(java.lang.String asURLDocument,RecordInfo aoRecordInfo,java.lang.String[] asArrVersion,com.filenet.wcm.api.Properties aoProps,com.filenet.wcm.api.Permissions aoACLs)
Sets the required properties to the document, which are related to the declaration and finally updates the permission of the document to that of the record as supplied.
  1. void
declareDocument(java.lang.String asURLDocument,java.lang.String asURLRecord,java.lang.String[] asArrVersion,com.filenet.wcm.api.Properties aoProps,com.filenet.wcm.api.Permissions aoACLs)
Sets the required properties to the document, which are related to the declaration and finally updates the permission of the document to that of the record as supplied.
  1. void
declareDocument(java.lang.String asURLDocument,java.lang.String asURLRecord,java.lang.String[] asArrVersion,com.filenet.wcm.api.Properties aoProps,com.filenet.wcm.api.Permissions aoACLs,DocumentStore aoDocStore)
Sets the isRecord and RecordLink properties to the document, which are related to the declaration and finally updates the permission of the document to that of the record as supplied.
  1. void
deleteDocument(java.lang.String asURL)
Deletes the specified document from the records object store (ROS).
  1. java.lang.String
exportDocument(java.lang.String asArrURI,java.lang.String asParentXML)
Exports the documents identified by the URL in XML string format.
  1. java.lang.String[]
getAllVersions(java.lang.String asURL)
Retrieves all version numbers of the document specified by the URL.
  1. java.lang.String
getCurrentVersion(java.lang.String asURL)
Retrieves the current or latest version of the document that is specified by the URL.
  1. java.util.List
getDeclareDocuments(java.lang.String asURL,java.lang.String[] asArrVersion)
Retrieves the documents that correspond to the documentID provided in the URL and the version supplied.
  1. com.filenet.wcm.api.TransportInputStream
getDocumentContent(java.lang.String asURL)
Constructs a TransportInputStream that represents the content of this Document.
  1. int[]
getDocumentContentElements(java.lang.String asURL)
Returns an array that contains the object types for the content elements associated with this Document object.
  1. java.lang.String
getDocumentID(java.lang.String asURL,java.lang.String asVersion)
Retrieves the DocumentID of the specific version of the given document.
  1. com.filenet.wcm.api.Properties
getDocumentProperties(java.lang.String asURL,java.lang.String[] asArrProps)
Returns property values for the specified document.
  1. java.util.List
getRendition(java.lang.String asURL)
Retrieves a collection of documents (along with all the properties) that are published from this Document object version.
  1. java.lang.String
getRepositoryType(java.lang.String asURI)
Returns the Repository type where this instance of Connector points.
  1. java.lang.String
getSearchSQL(java.lang.String asContentSearchWhereClause)
Returns an XML document that represents the content query to be executed on the ROS.
  1. java.lang.String
search(java.lang.String asURL,java.lang.String asContentSearchRequestXML)
Performs the content-based search in the records object store (ROS) as identified by the URL parameters.
  1. java.util.List
searchDocument(java.lang.String asURL,java.lang.String asSearchCriteriaVerity,java.lang.String asExecuteDataXML)
This method does the content-based search in the records object store (ROS) as identified by the URL parameters.
  1. java.lang.String
searchDocumentXML(java.lang.String asURL,java.lang.String asSearchCriteriaVerity,java.lang.String asExecuteDataXML)
Performs a content-based search in the records object store (ROS) as identified by the URL parameters.
  1. void
synchronizeDocument(java.lang.String asURL,com.filenet.wcm.api.Properties asProps)
Synchronizes the document with the properties and the permissions provided by a user.

Method Detail

getDocumentProperties

  1. com.filenet.wcm.api.Properties getDocumentProperties( java.lang.String asURL,
  2. java.lang.String[] asArrProps)
  3. throws RMException
Returns property values for the specified document.
Parameters:
asURL - A String specifying the URL of the document for which property values are to be returned. For more information, see Specifying a URL. The String cannot be null or empty.
asArrProps - A String array specifying the names of the properties for which values are to be returned. Set to null to return values for all the properties of the document.
Returns:
A Properties collection containing the property values for the document.
Throws:
RMException - If a Records Manager error occurs.

copyDocument

  1. java.lang.String copyDocument(java.lang.String asURL,
  2. java.lang.String asName,
  3. com.filenet.wcm.api.Properties aoProps,
  4. com.filenet.wcm.api.Permissions aoACLs)
Creates a copy of a specified document with the specified property and permission values.
Parameters:
asURL - A String specifying the URL of the document to be copied. The String cannot be null or empty. For more information, see Specifying a URL.
asName - A String specifying the name for the new Document object.
aoProps - A Properties collection containing any property values that are to be overridden in the new Document object.
aoACLs - A Permissions collection containing the permission values for the new Document object.
Returns:
A String containing the ID of the new Document object.

deleteDocument

  1. void deleteDocument(java.lang.String asURL)
Deletes the specified document from the records object store (ROS).
Parameters:
asURL - A String specifying the URL of the document to be deleted. The String cannot be null or empty.

searchDocumentXML

  1. java.lang.String searchDocumentXML( java.lang.String asURL,
  2. java.lang.String asSearchCriteriaVerity,
  3. java.lang.String asExecuteDataXML)
Performs a content-based search in the records object store (ROS) as identified by the URL parameters.

If the asExecuteDataXML parameter is non-null, the XML string is modified to support the runtime parameters that are in connection to the content-based search only. Similarly, the asSearchCriteriaVerity parameter is modified to add all the object stores provided in the given URL for a domain. Additionally, the asSearchCriteriaVerity parameter is modified to retrieve the documentID from the Document object (specified in the 'class' node of the 'from' tag of the supplied XML).

Parameters:
asURL - A String specifying the URL of the document for which property values are to be returned. For more information, see Specifying a URL. The String cannot be null or empty.
asSearchCriteriaVerity - An XML String that represents the stored search XML to be executed on the ROS. A NULL or an empty URL are not acceptable values.
asExecuteDataXML - An XML String representation of the values that a user provides at runtime prior to executing the search. A NULL or an empty URL are not acceptable values.
Returns:
A String containing the search result in XML format.

searchDocument

  1. java.util.List searchDocument(java.lang.String asURL,
  2. java.lang.String asSearchCriteriaVerity,
  3. java.lang.String asExecuteDataXML)
This method does the content-based search in the records object store (ROS) as identified by the URL parameters.

If the 'asExecuteDataXML' is non-null, the XML string is modified to support the runtime parameters that are in connection to the Content based search only. Similarly, the 'asSearchCriteriaVerity' XML is modified to add all the object stores supplied in the given URL for a domain. Also the 'asSearchCriteriaVerity' XML is modified to retrieve the documentID from the Object 'document' (specified in the 'class' node of the 'from' tag of the supplied XML) where the 'isRecord' metadata value of the document in ROS is set to true.

Parameters:
asURL - A String specifying the URL of the document for which property values are to be returned. For more information, see Specifying a URL. The String cannot be null or empty.
asSearchCriteriaVerity - An XML String that represents the Stored search XML to be executed on the ROS. A NULL or an empty URL are not acceptable values.
asExecuteDataXML - An XML String representation of the values that a user provides at runtime prior to executing the search. The value of the parameter can be empty or null
Returns:
The method returns the search result in the form of the list collection

search

  1. java.lang.String search(java.lang.String asURL,
  2. java.lang.String asContentSearchRequestXML)
Performs the content-based search in the records object store (ROS) as identified by the URL parameters.

The asContentSearchRequestXML parameter is modified to add all the object stores provided in the given URL for a domain.

Parameters:
asURL - A String specifying the URL of the document for which property values are to be returned. For more information, see Specifying a URL. The String cannot be null or empty.
asContentSearchRequestXML - An XML string that represents the search XML to be executed on the ROS for the content-based search. A NULL or an empty URL are not acceptable values.
Returns:
The method returns the search result in the form of an XML string.

synchronizeDocument

  1. void synchronizeDocument(java.lang.String asURL,
  2. com.filenet.wcm.api.Properties asProps)
  3. throws RMException
Synchronizes the document with the properties and the permissions provided by a user. This method also filters out the properties that are not required for the document synchronization. A NULL or an empty URL are not acceptable values.
Parameters:
asURL - A String specifying the URL of the document for which property values are to be returned. For more information, see Specifying a URL. The String cannot be null or empty.
asProps - The Properties that need to be synchronized.
Throws:
RMException - If a Records Manager error occurs.

declareDocument

  1. void declareDocument(java.lang.String asURLDocument,
  2. java.lang.String asURLRecord,
  3. java.lang.String[] asArrVersion,
  4. com.filenet.wcm.api.Properties aoProps,
  5. com.filenet.wcm.api.Permissions aoACLs)
  6. throws RMException
Sets the required properties to the document, which are related to the declaration and finally updates the permission of the document to that of the record as supplied.
Parameters:
asURLDocument - The URL that specifies the document ID and other parameters such as the repository and server name to identify a document. A NULL or an empty URL are not acceptable values.
asURLRecord - The URL that specifies the record ID and other parameters such as repository and server name to identify a record.
asArrVersion - The versions that needs to be declared as a single record.
aoProps - The properties that need to be synchronized
aoACLs - A Permissions collection specifying the security for the document.
Throws:
RMException - If a Records Manager error occurs.

declareDocument

  1. void declareDocument(java.lang.String asURLDocument,
  2. RecordInfo aoRecordInfo,
  3. java.lang.String[] asArrVersion,
  4. com.filenet.wcm.api.Properties aoProps,
  5. com.filenet.wcm.api.Permissions aoACLs)
  6. throws RMException
Sets the required properties to the document, which are related to the declaration and finally updates the permission of the document to that of the record as supplied.
Parameters:
asURLDocument - The URL that specifies the document ID and other parameters such as the repository and server name to identify a document. A NULL or an empty URL are not acceptable values.
aoRecordInfo - RecordInfo Object
asArrVersion - The versions that needs to be declared as a single record.
aoProps - The properties that need to be synchronized
aoACLs - A Permissions collection specifying the security for the document.
Throws:
RMException - If a Records Manager error occurs.

declareDocument

  1. void declareDocument(java.lang.String asURLDocument,
  2. java.lang.String asURLRecord,
  3. java.lang.String[] asArrVersion,
  4. com.filenet.wcm.api.Properties aoProps,
  5. com.filenet.wcm.api.Permissions aoACLs,
  6. DocumentStore aoDocStore)
  7. throws RMException
Sets the isRecord and RecordLink properties to the document, which are related to the declaration and finally updates the permission of the document to that of the record as supplied. The RM API calls this method during the declaration operation. The URl may contain multiple document Ids. In such a situation, the versions array passed should be empty or null. In case the versions are specified in the array and multiple document IDs exists in the URL, an RMException will be thrown.
Parameters:
asURLDocument - The URL that specifies the documentID and the other parameters like Repository Name, Server Name to identify the document. A NULL or an empty URL are not acceptable values.
asURLRecord - The URL that specifies the record ID and other parameters such as the repository and server name to identify the Record
asArrVersion - The versions that need to be declared as a single record. The URL must contain a single document ID in the URL, otherwise an RMException will be thrown.
aoProps - The properties that need to be synchronized.
aoACLs - A Permissions collection specifying the security for the document.
aoDocStore - The Wrapper on the DocumentStore Library .The DocumentStore represents a document repository, where documents are stored.
Throws:
RMException - If a Records Manager error occurs.

getDocumentContentElements

  1. int[] getDocumentContentElements( java.lang.String asURL)
Returns an array that contains the object types for the content elements associated with this Document object.
Parameters:
asURL - The URL that specifies the document ID and other parameters such as the repository and server name to identify a document. A NULL or an empty URL are not acceptable values.
Returns:
An int array, where each element in the array is the object type of a content element associated with this Document object.

getAllVersions

  1. java.lang.String[] getAllVersions( java.lang.String asURL)
  2. throws RMException
Retrieves all version numbers of the document specified by the URL.
Parameters:
asURL - A URL that specifies the document ID and other parameters such as the repository and server name to identify a document. A NULL or an empty URL are not acceptable values.
Returns:
A string array containing all version numbers of the document specified by the URL.
Throws:
RMException - If a Records Manager error occurs.

getCurrentVersion

  1. java.lang.String getCurrentVersion( java.lang.String asURL)
  2. throws RMException
Retrieves the current or latest version of the document that is specified by the URL. The version is a combination of a major version number and a minor version number. For example, 3.2 means the document major version is 3 and minor version is 2.
Parameters:
asURL - A URL that specifies the document ID and other parameters such as the repository and server name to identify a document. A NULL or an empty URL are not acceptable values.
Returns:
A String representing the current or latest version of the document.
Throws:
RMException - If a Records Manager error occurs.

getRendition

  1. java.util.List getRendition(java.lang.String asURL)
Retrieves a collection of documents (along with all the properties) that are published from this Document object version.
Parameters:
asURL - The URL that specifies the document ID and other parameters such as the repository and server name to identify a document. A NULL or an empty URL are not acceptable values.
Returns:
A collection of Documents that are published from this Document object

exportDocument

  1. java.lang.String exportDocument( java.lang.String asArrURI,
  2. java.lang.String asParentXML)
  3. throws RMException
Exports the documents identified by the URL in XML string format.
Parameters:
asArrURI - The URL that specifies the document ID and other parameters such as the repository and server name to identify a document.
Returns:
The export documents in the form of an XML string.
Throws:

canDeclare

  1. boolean canDeclare(java.lang.String asURL,
  2. java.lang.String[] asArrVersion)
  3. throws RMException
Validates the eligibility of a document for the declaration operation. If a version list is provided, the eligibility of each version will be validated. If the list of versions contains any invalid versions, that version will be ignored. If the list contains no valid versions, an RMException will be raised.
Parameters:
asArrVersion - The version numbers whose eligibility for declaration needs to be checked.
asURL - The URL that specifies the document ID and other parameters such as the repository and server name to identify a document. A NULL or an empty URL are not acceptable values.
Returns:
Boolean true is returned, if a document is eligible for the declaration process. Else, an RMException will be thrown stating the reason for the disqualification of the document to be declared. If the version(s) information is provided, Boolean true will be returned, if all the specified versions are eligible for the declaration process. If any one of the versions is not eligible, an RMException will be raised.
Throws:
RMException - If a Records Manager error occurs.

getDocumentID

  1. java.lang.String getDocumentID( java.lang.String asURL,
  2. java.lang.String asVersion)
  3. throws RMException
Retrieves the DocumentID of the specific version of the given document.
Parameters:
asURL - The URL that specifies the document ID and other parameters such as the repository and server name to identify a document. A NULL or an empty URL are not acceptable values.
asVersion - The version whose document ID needs to be retrieved
Returns:
The Document ID as the String. If the version specified as a input parameter donot exists, empty string will be returned
Throws:
RMException - In case of any error an RMException will be thrown

getDeclareDocuments

  1. java.util.List getDeclareDocuments( java.lang.String asURL,
  2. java.lang.String[] asArrVersion)
  3. throws RMException
Retrieves the documents that correspond to the documentID provided in the URL and the version supplied.
Parameters:
asURL - The URL that specifies the document ID and other parameters such as the repository and server name to identify a document. A NULL or an empty URL are not acceptable values.
asArrVersion - The version whose document object needs to be retrieved.
Returns:
A collection of documents as a Documents object.
Throws:
RMException - If a Records Manager error occurs.

getSearchSQL

  1. java.lang.String getSearchSQL(java.lang.String asContentSearchWhereClause)
Returns an XML document that represents the content query to be executed on the ROS.
Parameters:
asContentSearchWhereClause - The WHERE clause of the content-based query.
Returns:
A query that represents the content-based query to be executed on the ROS.

getDocumentContent

  1. com.filenet.wcm.api.TransportInputStream getDocumentContent( java.lang.String asURL)
  2. throws RMException
Constructs a TransportInputStream that represents the content of this Document. The content may be the actual document or some external URL.
Parameters:
asURL - A String to be used to locate the Document in the Document repository.
Returns:
Return the Document content as a TransportInputStream. The TransportInputStream will represent either a BaseObject.TYPE_CONTENT_TRANSFER or a BaseObject.TYPE_CONTENT_REFERENCE.
Throws:

getRepositoryType

  1. java.lang.String getRepositoryType( java.lang.String asURI)
  2. throws RMException
Returns the Repository type where this instance of Connector points.
Returns:
A String that represents the Repository type where the Document is stored. For e.g.CE represents Content Engine Repository.
Throws:
RMException - If a Records Manager error occurs.