java.lang.Object
- org.apache.manifoldcf.meridio.MeridioWrapper

public class MeridioWrapper
extends java.lang.Object

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`protected static class`	`MeridioWrapper.ResourceProvider`	Implementation of EngineConfiguration that we'll use to get the wsdd file from a local resource.

Field Summary

Fields
Modifier and Type	Field	Description
`protected java.lang.String`	`clientWorkstation`
`protected org.apache.http.conn.HttpClientConnectionManager`	`dmwsConnectionManager`
`protected org.apache.http.client.HttpClient`	`dmwsHttpClient`
`protected org.apache.axis.EngineConfiguration`	`engineConfiguration`
`static java.lang.String`	`HTTPCLIENT_PROPERTY`
`protected java.lang.String`	`loginToken_`
`protected org.apache.http.conn.HttpClientConnectionManager`	`mcwsConnectionManager`
`protected org.apache.http.client.HttpClient`	`mcwsHttpClient`
`protected org.apache.manifoldcf.crawler.connectors.meridio.DMDataSet.DMDataSet`	`meridioCategories_`
`protected static long`	`meridioCategoriesExpire`
`protected long`	`meridioCategoriesTime`
`protected com.meridio.www.MeridioDMWS.MeridioDMSoapStub`	`meridioDMWebService_`
`protected org.tempuri.MetaCartaSoapStub`	`meridioMCWS_`
`protected com.meridio.www.MeridioRMWS.MeridioRMSoapStub`	`meridioRMWebService_`
`protected org.apache.manifoldcf.crawler.connectors.meridio.DMDataSet.DMDataSet`	`meridioStaticData_`
`protected static long`	`meridioStaticDataExpire`
`protected long`	`meridioStaticDataTime`
`protected org.apache.log4j.Logger`	`oLog`
`protected org.apache.http.conn.HttpClientConnectionManager`	`rmwsConnectionManager`
`protected org.apache.http.client.HttpClient`	`rmwsHttpClient`

Constructor Summary

Constructors
Constructor	Description
MeridioWrapper(org.apache.log4j.Logger log, java.net.URL meridioDmwsUrl, java.net.URL meridioRmwsUrl, java.net.URL meridioManifoldCFWSUrl, java.lang.String dmwsProxyHost, java.lang.String dmwsProxyPort, java.lang.String rmwsProxyHost, java.lang.String rmwsProxyPort, java.lang.String mcwsProxyHost, java.lang.String mcwsProxyPort, java.lang.String userName, java.lang.String password, java.lang.String clientWorkstation, javax.net.ssl.SSLSocketFactory mySSLFactory, java.lang.Class resourceClass, java.lang.String engineConfigurationFile)	The Meridio Wrapper constructor that calls the Meridio login method

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`clearCache()`
`int`	`findClassOrFolder(java.lang.String classOrFolder)`	Given a string representing the path to a class or folder within the FilePlan, this method returns the identifier of the matching class (if any).
`int`	`findClassOrFolder(java.lang.String classOrFolder, int startClassOrFolder)`	Given a string representing the path to a class or folder within the FilePlan, this method returns the identifier of the matching class (if any).
`org.apache.manifoldcf.crawler.connectors.meridio.DMDataSet.DMDataSet`	`getCategories()`	This method is a wrapper around the Meridio "GetCategories" Web Service Method The following is the text from the Meridio Web Services Programming Guide Retrieves all categories accessible by the user.
`org.apache.manifoldcf.crawler.connectors.meridio.RMDataSet.RMDataSet`	`getClassContents(int classOrFolderId, boolean getPropDefs, boolean getActivities, boolean getCustomProperties)`	Returns a dataset containing information about the classes or folders within the class specified by the "classOrFolderId" parameter
`org.apache.manifoldcf.crawler.connectors.meridio.RMDataSet.RMDataSet`	`getConfiguration()`	This method is a wrapper around the Meridio "GetConfiguration" RM Web Service Method The following is the text from the Meridio Web Services Programming Guide Returns a DataSet containing information about all system configuration settings.
`org.apache.manifoldcf.crawler.connectors.meridio.DMDataSet.DMDataSet`	`getContainerData(int containerId, boolean getPropList, boolean getAcl, boolean getCanDo, boolean getChildContainers, boolean getContainerRefs, boolean getDocumentRefs, boolean getStoredSearchRefs, boolean getKeywords, boolean getReferencingContainers)`	This method is a wrapper around the Meridio "GetContainerData" Web Service Method Retrieves data relating to a specified container.
`protected org.apache.manifoldcf.crawler.connectors.meridio.DMDataSet.DMDataSet`	`getDMDataSet(org.apache.axis.message.MessageElement[] messageElement)`	Given the SOAP response received by AXIS on the successful call to a Meridio Web Service, this helper method returns a castor DMDataSet object which represents the XML This makes it much easier to subsequently manipulate the data that has been returned from the web service, and ensures that the Meridio wrapper implementation is as close to native .NET code as we can get.
`com.meridio.www.MeridioDMWS.MeridioDMSoapStub`	`getDMWebService()`
`org.apache.manifoldcf.crawler.connectors.meridio.DMDataSet.DMDataSet`	`getDocumentData(int docId, boolean getPropList, boolean getAcl, boolean getCanDo, boolean getPolicy, com.meridio.www.MeridioDMWS.DmVersionInfo getVersions, boolean getKeywords, boolean getReferencingContainers, boolean getLockInfo)`	This method is a wrapper around the Meridio "GetDocumentData" Web Service Method Retrieves data relating to a specified document.
`org.apache.manifoldcf.crawler.connectors.meridio.RMDataSet.RMDataSet`	`getDocumentPartList(int documentId)`
`org.apache.manifoldcf.crawler.connectors.meridio.RMDataSet.RMDataSet`	`getFolder(int folderId, boolean getPropDefs, boolean getActivities, boolean getContents, boolean getCustomProperties)`
`org.apache.axis.attachments.AttachmentPart`	`getLatestVersionFile(int docId)`	This method is a wrapper around the Meridio "GetLatestVersionFile" Web Service Method These methods retrieve a copy of a the latest version of a file that is stored in Meridio.
`java.lang.String`	`getLoginToken()`
`org.tempuri.MetaCartaSoapStub`	`getMCWSWebService()`
`org.apache.manifoldcf.crawler.connectors.meridio.RMDataSet.RMDataSet`	`getPropertyDefs()`	This method is a wrapper around the Meridio "GetPropertyDefs" RM Web Service Method The following is the text from the Meridio Web Services Programming Guide Returns a DataSet containing information about all fixed property definitions for objects in the RM Web Service.
`org.apache.manifoldcf.crawler.connectors.meridio.RMDataSet.RMDataSet`	`getProtectiveMarkingList(int id, int objectType)`
`org.apache.manifoldcf.crawler.connectors.meridio.RMDataSet.RMDataSet`	`getRecord(int recordId, boolean getPropDefs, boolean getActivities, boolean getCustomProperties)`
`org.apache.manifoldcf.crawler.connectors.meridio.RMDataSet.RMDataSet`	`getRecordPartList(int recordId, boolean getPropDefs, boolean getActivities)`
`protected org.apache.manifoldcf.crawler.connectors.meridio.RMDataSet.RMDataSet`	`getRMDataSet(org.apache.axis.message.MessageElement[] messageElement)`	Given the SOAP response received by AXIS on the successful call to a Meridio Web Service, this helper method returns a castor RMDataSet object which represents the XML This makes it much easier to subsequently manipulate the data that has been returned from the web service, and ensures that the Meridio wrapper implementation is as close to native .NET code as we can get.
`com.meridio.www.MeridioRMWS.MeridioRMSoapStub`	`getRMWebService()`
`org.apache.manifoldcf.crawler.connectors.meridio.RMDataSet.RMDataSet`	`getRolesAndMembership()`
`protected org.apache.axis.message.MessageElement[]`	`getSOAPMessage(org.apache.manifoldcf.crawler.connectors.meridio.DMDataSet.DMDataSet dsDM)`	Given the castor object representing the Meridio DMDataSet XSD, this method generates the XML that must be passed over the wire to invoke the Meridio DM Web Service
`protected org.apache.axis.message.MessageElement[]`	`getSOAPMessage(org.apache.manifoldcf.crawler.connectors.meridio.RMDataSet.RMDataSet dsRM)`	Given the castor object representing the Meridio DMDataSet XSD, this method generates the XML that must be passed over the wire to invoke the Meridio DM Web Service
`org.apache.manifoldcf.crawler.connectors.meridio.DMDataSet.DMDataSet`	`getStaticData()`	This method is a wrapper around the Meridio "GetStaticData" Web Service Method The following is the text from the Meridio Web Services Programming Guide Returns data that may be considered as static in a typical Meridio system, and that is not subject to access control.
`org.apache.manifoldcf.crawler.connectors.meridio.DMDataSet.DMDataSet`	`getUserData(long userId, boolean getPropList, boolean getCanDo, boolean getGroups, boolean getSharedContainers, boolean getStoredSearches, boolean getLockedDocuments)`	This method is a wrapper around the Meridio "GetUsersData" Web Service Method The following table shows which results are populated in the return result if they are set to "true" ACCESSCONTROL getCanDo (also controls retrieval of activity information for requested groups, containers, stored searches and locked documents) CONTAINERS getSharedContainers DOCUMENT_CUSTOMPROPS getLockedDocuments GROUP_CUSTOMPROPS getGroupList USER_CUSTOMPROPS getPropList DOCUMENTS getLockedDocuments GROUPS getGroupList STOREDSEARCHES getStoredSearches USERS getPropList
`long`	`getUserIdFromName(java.lang.String userName)`
`org.apache.manifoldcf.crawler.connectors.meridio.RMDataSet.RMDataSet`	`getUserPrivilegeList(int userId)`
`org.tempuri.GroupResult[]`	`getUsersGroups(int userId)`	Given a user id, find all the groups that it belongs to (including parents of parents)
`void`	`loginUnified()`	Checks if login needed, and if so performs a login to Meridio, using integrated Windows NT authentication (NTLM)
`void`	`logout()`	Logs out from Meridio
`DMSearchResults`	`searchDocuments(org.apache.manifoldcf.crawler.connectors.meridio.DMDataSet.DMDataSet searchInfo, int maxHitsToReturn, int startPositionOfHits, com.meridio.www.MeridioDMWS.DmPermission permissionFilter, boolean searchAll, com.meridio.www.MeridioDMWS.DmSearchScope scope, boolean useThesaurus, boolean searchChildren, boolean searchKeywordHierarchy, com.meridio.www.MeridioDMWS.DmLogicalOp keywordOperator)`	This method is a wrapper around the Meridio "SearchDocuments" Web Service Method The following is the text is paraphrased from the Meridio Web Services Programming Guide
`DMSearchResults`	`searchRecords(org.apache.manifoldcf.crawler.connectors.meridio.DMDataSet.DMDataSet searchInfo, int maxHitsToReturn, int startPositionOfHits, com.meridio.www.MeridioDMWS.DmPermission permissionFilter, boolean searchAll, com.meridio.www.MeridioDMWS.DmSearchScope scope, boolean useThesaurus, boolean searchChildren, boolean searchKeywordHierarchy, com.meridio.www.MeridioDMWS.DmLogicalOp keywordOperator)`	This method is a wrapper around the Meridio "SearchRecords" Web Service Method
`DMSearchResults`	`searchUsers(org.apache.manifoldcf.crawler.connectors.meridio.DMDataSet.DMDataSet searchInfo, int maxHitsToReturn, int startPositionOfHits, boolean searchChildren)`	This method is a wrapper around the Meridio "SearchUsers" Web Service Method

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

- Field Detail
  - HTTPCLIENT_PROPERTY
```
public static final java.lang.String HTTPCLIENT_PROPERTY
```
    See Also:
    
    Constant Field Values
  - meridioCategoriesTime
```
protected long meridioCategoriesTime
```
  - meridioCategories_
```
protected org.apache.manifoldcf.crawler.connectors.meridio.DMDataSet.DMDataSet meridioCategories_
```
  - meridioCategoriesExpire
```
protected static final long meridioCategoriesExpire
```
    See Also:
    
    Constant Field Values
  - meridioStaticDataTime
```
protected long meridioStaticDataTime
```
  - meridioStaticData_
```
protected org.apache.manifoldcf.crawler.connectors.meridio.DMDataSet.DMDataSet meridioStaticData_
```
  - meridioStaticDataExpire
```
protected static final long meridioStaticDataExpire
```
    See Also:
    
    Constant Field Values
  - engineConfiguration
```
protected org.apache.axis.EngineConfiguration engineConfiguration
```
  - oLog
```
protected org.apache.log4j.Logger oLog
```
  - clientWorkstation
```
protected java.lang.String clientWorkstation
```
  - dmwsConnectionManager
```
protected org.apache.http.conn.HttpClientConnectionManager dmwsConnectionManager
```
  - rmwsConnectionManager
```
protected org.apache.http.conn.HttpClientConnectionManager rmwsConnectionManager
```
  - mcwsConnectionManager
```
protected org.apache.http.conn.HttpClientConnectionManager mcwsConnectionManager
```
  - dmwsHttpClient
```
protected org.apache.http.client.HttpClient dmwsHttpClient
```
  - rmwsHttpClient
```
protected org.apache.http.client.HttpClient rmwsHttpClient
```
  - mcwsHttpClient
```
protected org.apache.http.client.HttpClient mcwsHttpClient
```
  - meridioDMWebService_
```
protected com.meridio.www.MeridioDMWS.MeridioDMSoapStub meridioDMWebService_
```
  - meridioRMWebService_
```
protected com.meridio.www.MeridioRMWS.MeridioRMSoapStub meridioRMWebService_
```
  - meridioMCWS_
```
protected org.tempuri.MetaCartaSoapStub meridioMCWS_
```
  - loginToken_
```
protected java.lang.String loginToken_
```
- Constructor Detail
  - MeridioWrapper
```
public MeridioWrapper(org.apache.log4j.Logger log,
                      java.net.URL meridioDmwsUrl,
                      java.net.URL meridioRmwsUrl,
                      java.net.URL meridioManifoldCFWSUrl,
                      java.lang.String dmwsProxyHost,
                      java.lang.String dmwsProxyPort,
                      java.lang.String rmwsProxyHost,
                      java.lang.String rmwsProxyPort,
                      java.lang.String mcwsProxyHost,
                      java.lang.String mcwsProxyPort,
                      java.lang.String userName,
                      java.lang.String password,
                      java.lang.String clientWorkstation,
                      javax.net.ssl.SSLSocketFactory mySSLFactory,
                      java.lang.Class resourceClass,
                      java.lang.String engineConfigurationFile)
               throws java.rmi.RemoteException,
                      java.lang.NumberFormatException
```
    The Meridio Wrapper constructor that calls the Meridio login method
    
    Parameters:
    
    log - a handle to a Log4j logger
    
    meridioDmwsUrl - the URL to the Meridio Document Management Web Service
    
    meridioRmwsUrl - the URL to the Meridio Records Management Web Service
    
    dmwsProxyHost - the proxy for DMWS, or null if none
    
    dmwsProxyPort - the proxy port for DMWS, or -1 if default
    
    rmwsProxyHost - the proxy for RMWS, or null if none
    
    rmwsProxyPort - the proxy port for RMWS, or -1 if default
    
    userName - the username of the user to log in as, must include the Windows, e.g. domain\\user
    
    password - the password of the user who is logging in
    
    clientWorkstation - an identifier for the client workstation, could be the IP address, for auditing purposes
    
    protocolFactory - the protocol factory object to use for https communication
    
    engineConfigurationFile - the engine configuration object to use to communicate with the web services
    
    Throws:
    
    java.rmi.RemoteException - if an error is encountered logging into Meridio
    
    java.lang.NumberFormatException
- Method Detail
  - getDMWebService
```
public com.meridio.www.MeridioDMWS.MeridioDMSoapStub getDMWebService()
```
  - getRMWebService
```
public com.meridio.www.MeridioRMWS.MeridioRMSoapStub getRMWebService()
```
  - getMCWSWebService
```
public org.tempuri.MetaCartaSoapStub getMCWSWebService()
```
  - getLoginToken
```
public java.lang.String getLoginToken()
```
  - clearCache
```
public void clearCache()
```
  - loginUnified
```
public void loginUnified()
                  throws java.rmi.RemoteException
```
    Checks if login needed, and if so performs a login to Meridio, using integrated Windows NT authentication (NTLM)
    
    Throws:
    
    java.rmi.RemoteException - if an error is encountered locating the web services, or logging in
  - logout
```
public void logout()
            throws java.rmi.RemoteException
```
    Logs out from Meridio
    
    Throws:
    
    java.rmi.RemoteException - if an error is encountered calling the Meridio Web Service logout method
  - getUsersGroups
```
public org.tempuri.GroupResult[] getUsersGroups(int userId)
                                         throws java.rmi.RemoteException
```
    Given a user id, find all the groups that it belongs to (including parents of parents)
    
    Throws:
    
    java.rmi.RemoteException
  - getStaticData
```
public org.apache.manifoldcf.crawler.connectors.meridio.DMDataSet.DMDataSet getStaticData()
                                                                                   throws java.rmi.RemoteException,
                                                                                          MeridioDataSetException
```
    This method is a wrapper around the Meridio "GetStaticData" Web Service Method The following is the text from the Meridio Web Services Programming Guide Returns data that may be considered as static in a typical Meridio system, and that is not subject to access control. Such data is therefore amenable to caching at Application scope. The method can be used to retrieve all property definitions (fixed and custom) in the Meridio system, for all Meridio object types supported via the Meridio SOAP API, independently of the permissions of the session user on the categories holding the property definitions. Lookups, policies, rendition definitions and system information (e.g. the name of the target Meridio system) can also be retrieved, depending on the value of the relevant Boolean input argument. The DataTables returned (in the DataSet) are as follows: PROPERTYDEFS LOOKUPS LOOKUP_VALUES POLICIES RENDITIONDEFS SYSTEMINFO
    
    Returns:
    
    the DM DataSet with the appropriate elements (see above) populated
    
    Throws:
    
    java.rmi.RemoteException - if an error is encountered call the Meridio web service method(s)
    
    MeridioDataSetException - if an error is encountered manipulating the Meridio DataSet
  - getConfiguration
```
public org.apache.manifoldcf.crawler.connectors.meridio.RMDataSet.RMDataSet getConfiguration()
                                                                                      throws java.rmi.RemoteException,
                                                                                             MeridioDataSetException
```
    This method is a wrapper around the Meridio "GetConfiguration" RM Web Service Method The following is the text from the Meridio Web Services Programming Guide Returns a DataSet containing information about all system configuration settings. The DataTables returned are as follows: Table Comment rm2Config Contains a row for each system configuration setting.
    
    Throws:
    
    java.rmi.RemoteException - if an error is encountered call the Meridio web service method(s)
    
    MeridioDataSetException - if an error is encountered manipulating the Meridio DataSet
  - getPropertyDefs
```
public org.apache.manifoldcf.crawler.connectors.meridio.RMDataSet.RMDataSet getPropertyDefs()
                                                                                     throws java.rmi.RemoteException,
                                                                                            MeridioDataSetException
```
    This method is a wrapper around the Meridio "GetPropertyDefs" RM Web Service Method The following is the text from the Meridio Web Services Programming Guide Returns a DataSet containing information about all fixed property definitions for objects in the RM Web Service. The DataTables returned are as follows: Table Comment rm2PropertyDef Contains a row for each fixed property definition for each object in the RM Web Service.
    
    Throws:
    
    java.rmi.RemoteException - if an error is encountered call the Meridio web service method(s)
    
    MeridioDataSetException - if an error is encountered manipulating the Meridio DataSet
  - getCategories
```
public org.apache.manifoldcf.crawler.connectors.meridio.DMDataSet.DMDataSet getCategories()
                                                                                   throws java.rmi.RemoteException,
                                                                                          MeridioDataSetException
```
    This method is a wrapper around the Meridio "GetCategories" Web Service Method The following is the text from the Meridio Web Services Programming Guide Retrieves all categories accessible by the user. The DataTables returned are as described in the following table. DataTable Comments CATEGORIES contains a row for each category in the system, subject to access control. CATEGORIES_EXTRA contains a row for each category in the system, subject to access control.
    
    Throws:
    
    java.rmi.RemoteException - if an error is encountered call the Meridio web service method(s)
    
    MeridioDataSetException - if an error is encountered manipulating the Meridio DataSet
  - getClassContents
```
public org.apache.manifoldcf.crawler.connectors.meridio.RMDataSet.RMDataSet getClassContents(int classOrFolderId,
                                                                                             boolean getPropDefs,
                                                                                             boolean getActivities,
                                                                                             boolean getCustomProperties)
                                                                                      throws java.rmi.RemoteException,
                                                                                             MeridioDataSetException
```
    Returns a dataset containing information about the classes or folders within the class specified by the "classOrFolderId" parameter
    
    Parameters:
    
    classOrFolderId - the Identifier of the class or folder for which the contents are required. 0 indicated the root of the FilePlan
    
    getPropDefs -
    
    getActivities -
    
    getCustomProperties -
    
    Throws:
    
    java.rmi.RemoteException - if an error is encountered call the Meridio web service method(s)
    
    MeridioDataSetException - if an error is encountered manipulating the Meridio DataSet
  - findClassOrFolder
```
public int findClassOrFolder(java.lang.String classOrFolder)
                      throws java.rmi.RemoteException,
                             MeridioDataSetException
```
    Given a string representing the path to a class or folder within the FilePlan, this method returns the identifier of the matching class (if any). This method matches a path from the root of the FilePlan
    
    Parameters:
    
    classOrFolder - is the path to the class or folder to be matched, for example /Finances/Audit, Finances/Audit/, or //Finances///Audit// will all match the class or folder "Audit" that exists in the "Finances" class which is located directly under the root of the FilePlan. The forward-slash "/" must be used.
    
    Returns:
    
    an integer representing the class or folder id, or zero if not found
    
    Throws:
    
    java.rmi.RemoteException - if an error is encountered call the Meridio web service method(s)
    
    MeridioDataSetException - if an error is encountered manipulating the Meridio DataSet
  - findClassOrFolder
```
public int findClassOrFolder(java.lang.String classOrFolder,
                             int startClassOrFolder)
                      throws java.rmi.RemoteException,
                             MeridioDataSetException
```
    Given a string representing the path to a class or folder within the FilePlan, this method returns the identifier of the matching class (if any). This method matches a path from the root of the FilePlan
    
    Parameters:
    
    classOrFolder - is the path to the class or folder to be matched, for example /Finances/Audit, Finances/Audit/, or //Finances///Audit//
    
    startClassOrFolder - the id of the class of folder to start searching at (zero for root)
    
    Returns:
    
    an integer representing the class or folder id, or zero if not found
    
    Throws:
    
    java.rmi.RemoteException - if an error is encountered call the Meridio web service method(s)
    
    MeridioDataSetException - if an error is encountered manipulating the Meridio DataSet
  - searchDocuments
```
public DMSearchResults searchDocuments(org.apache.manifoldcf.crawler.connectors.meridio.DMDataSet.DMDataSet searchInfo,
                                       int maxHitsToReturn,
                                       int startPositionOfHits,
                                       com.meridio.www.MeridioDMWS.DmPermission permissionFilter,
                                       boolean searchAll,
                                       com.meridio.www.MeridioDMWS.DmSearchScope scope,
                                       boolean useThesaurus,
                                       boolean searchChildren,
                                       boolean searchKeywordHierarchy,
                                       com.meridio.www.MeridioDMWS.DmLogicalOp keywordOperator)
                                throws java.rmi.RemoteException,
                                       MeridioDataSetException
```
    This method is a wrapper around the Meridio "SearchDocuments" Web Service Method The following is the text is paraphrased from the Meridio Web Services Programming Guide
    
    Parameters:
    
    searchInfo - contains the search definition and may also specify rendition types, containers, keywords and result definitions Tables that may be included in searchInfo are: CONTENT_OPS CONTENT_TERMS PROPERTY_OPS PROPERTY_TERMS RESULTDEFS SEARCH_CONTAINERS SEARCH_KEYWORDS SEARCH_RENDITIONDEFS
    
    maxHitsToReturn - controls the maximum number of hits to return on this call
    
    startPositionOfHits - controls what position to start from, 1 is the first result
    
    permissionFilter - documents for which the current user's permission is lower than permissionFilter will be excluded from the search results
    
    searchAll - indicates whether the search should return hits on all versions of documents or on the latest versions only. If searchAll is true then hits on all versions will be returned; if false then hits on the latest versions only will be returned
    
    scope - enditions of the specified type(s) will be included in the search, as long as renditions are included in the search scope
    
    useThesaurus - controls use of word synonyms in content searches
    
    searchChildren - specifies whether subcontainers are searched within any containers specified in searchInfo. This argument is ignored if the search is not restricted to specific containers.
    
    searchKeywordHierarchy - Only documents associated with the specified keywords will be returned, depending on the operator used to logically combine them (keywordOperator) and whether all keywords under the specified keywords are to be considered (searchKeywordHierarchy). However, if no keywords are specified in searchInfo then searching will ignore keyword associations.
    
    keywordOperator - see searchKeywordHierarchy
    
    Returns:
    
    object containing the eturns the total number of hits found in Meridio for the search, the actual number of hits returned by the current search call, and the results of the search. Search results are returned in the SEARCHRESULTS_DOCUMENTS DataTable.
    
    Throws:
    
    java.rmi.RemoteException - if an error is encountered call the Meridio web service method(s)
    
    MeridioDataSetException - if an error is encountered manipulating the Meridio DataSet
  - searchRecords
```
public DMSearchResults searchRecords(org.apache.manifoldcf.crawler.connectors.meridio.DMDataSet.DMDataSet searchInfo,
                                     int maxHitsToReturn,
                                     int startPositionOfHits,
                                     com.meridio.www.MeridioDMWS.DmPermission permissionFilter,
                                     boolean searchAll,
                                     com.meridio.www.MeridioDMWS.DmSearchScope scope,
                                     boolean useThesaurus,
                                     boolean searchChildren,
                                     boolean searchKeywordHierarchy,
                                     com.meridio.www.MeridioDMWS.DmLogicalOp keywordOperator)
                              throws java.rmi.RemoteException,
                                     MeridioDataSetException
```
    This method is a wrapper around the Meridio "SearchRecords" Web Service Method
    
    Throws:
    
    java.rmi.RemoteException
    
    MeridioDataSetException
    
    See Also:
    
    DMDataSet searchInfo, int maxHitsToReturn, int startPositionOfHits, DmPermission permissionFilter, boolean searchAll, DmSearchScope scope, boolean useThesaurus, boolean searchChildren, boolean searchKeywordHierarchy, DmLogicalOp keywordOperator
  - searchUsers
```
public DMSearchResults searchUsers(org.apache.manifoldcf.crawler.connectors.meridio.DMDataSet.DMDataSet searchInfo,
                                   int maxHitsToReturn,
                                   int startPositionOfHits,
                                   boolean searchChildren)
                            throws java.rmi.RemoteException,
                                   MeridioDataSetException
```
    This method is a wrapper around the Meridio "SearchUsers" Web Service Method
    
    Parameters:
    
    searchInfo - contains the search definition and may also specify groups and result definitions. See "Search Expressions" on page 23 for an overview of how a search expression can be recorded in searchInfo. Only groups that belong to the groups specified in searchInfo will be included in the search results. However, if no groups are specified in searchInfo then searching will not be restricted to any specific groups, and will instead take place across all groups in the Meridio system. The result definitions specified by searchInfo will be applied when returning property search results.
    
    maxHitsToReturn - maxHitsToReturn may be NULL in which case the default limit is 100 hits.
    
    startPositionOfHits - may be NULL in which case the default start position is 1.
    
    searchChildren - specifies whether subgroups are searched within any groups specified in searchInfo. This argument is ignored if the search is not restricted to specific groups.
    
    Throws:
    
    java.rmi.RemoteException - if an error is encountered call the Meridio web service method(s)
    
    MeridioDataSetException - if an error is encountered manipulating the Meridio DataSet
  - getUserIdFromName
```
public long getUserIdFromName(java.lang.String userName)
                       throws java.rmi.RemoteException,
                              MeridioDataSetException
```
    Throws:
    
    java.rmi.RemoteException
    
    MeridioDataSetException
  - getRolesAndMembership
```
public org.apache.manifoldcf.crawler.connectors.meridio.RMDataSet.RMDataSet getRolesAndMembership()
                                                                                           throws java.rmi.RemoteException,
                                                                                                  MeridioDataSetException
```
    Throws:
    
    java.rmi.RemoteException
    
    MeridioDataSetException
  - getProtectiveMarkingList
```
public org.apache.manifoldcf.crawler.connectors.meridio.RMDataSet.RMDataSet getProtectiveMarkingList(int id,
                                                                                                     int objectType)
                                                                                              throws java.rmi.RemoteException,
                                                                                                     MeridioDataSetException
```
    Throws:
    
    java.rmi.RemoteException
    
    MeridioDataSetException
  - getUserPrivilegeList
```
public org.apache.manifoldcf.crawler.connectors.meridio.RMDataSet.RMDataSet getUserPrivilegeList(int userId)
                                                                                          throws java.rmi.RemoteException,
                                                                                                 MeridioDataSetException
```
    Throws:
    
    java.rmi.RemoteException
    
    MeridioDataSetException
  - getRecord
```
public org.apache.manifoldcf.crawler.connectors.meridio.RMDataSet.RMDataSet getRecord(int recordId,
                                                                                      boolean getPropDefs,
                                                                                      boolean getActivities,
                                                                                      boolean getCustomProperties)
                                                                               throws java.rmi.RemoteException,
                                                                                      MeridioDataSetException
```
    Throws:
    
    java.rmi.RemoteException
    
    MeridioDataSetException
  - getFolder
```
public org.apache.manifoldcf.crawler.connectors.meridio.RMDataSet.RMDataSet getFolder(int folderId,
                                                                                      boolean getPropDefs,
                                                                                      boolean getActivities,
                                                                                      boolean getContents,
                                                                                      boolean getCustomProperties)
                                                                               throws java.rmi.RemoteException,
                                                                                      MeridioDataSetException
```
    Throws:
    
    java.rmi.RemoteException
    
    MeridioDataSetException
  - getUserData
```
public org.apache.manifoldcf.crawler.connectors.meridio.DMDataSet.DMDataSet getUserData(long userId,
                                                                                        boolean getPropList,
                                                                                        boolean getCanDo,
                                                                                        boolean getGroups,
                                                                                        boolean getSharedContainers,
                                                                                        boolean getStoredSearches,
                                                                                        boolean getLockedDocuments)
                                                                                 throws java.rmi.RemoteException,
                                                                                        MeridioDataSetException
```
    This method is a wrapper around the Meridio "GetUsersData" Web Service Method The following table shows which results are populated in the return result if they are set to "true" ACCESSCONTROL getCanDo (also controls retrieval of activity information for requested groups, containers, stored searches and locked documents) CONTAINERS getSharedContainers DOCUMENT_CUSTOMPROPS getLockedDocuments GROUP_CUSTOMPROPS getGroupList USER_CUSTOMPROPS getPropList DOCUMENTS getLockedDocuments GROUPS getGroupList STOREDSEARCHES getStoredSearches USERS getPropList
    
    Parameters:
    
    userId - Retrieves data relating to the user specified by the userId argument. The data retrieved can be selected by supplying a true value for those Boolean arguments in which the caller is interested
    
    getPropList -
    
    getCanDo -
    
    getGroups - if true then the returned groups are only those of which the specified user is a direct member, i.e. they do not include groups of which the user is indirectly a member by virtue of the user's membership of an intermediate subgroup
    
    getSharedContainers - returns the user's shared containers (if any)
    
    getStoredSearches - getLockedDocuments and getStoredSearches arguments control retrieval of the specified user's (userId) locked documents and stored searches. Only documents or stored searches to which the current session user has access are returned when the getLockedDocuments or getStoredSearches arguments are true.
    
    getLockedDocuments - see getStoredSearches
    
    Throws:
    
    java.rmi.RemoteException - if an error is encountered call the Meridio web service method(s)
    
    MeridioDataSetException - if an error is encountered manipulating the Meridio DataSet
  - getDocumentData
```
public org.apache.manifoldcf.crawler.connectors.meridio.DMDataSet.DMDataSet getDocumentData(int docId,
                                                                                            boolean getPropList,
                                                                                            boolean getAcl,
                                                                                            boolean getCanDo,
                                                                                            boolean getPolicy,
                                                                                            com.meridio.www.MeridioDMWS.DmVersionInfo getVersions,
                                                                                            boolean getKeywords,
                                                                                            boolean getReferencingContainers,
                                                                                            boolean getLockInfo)
                                                                                     throws java.rmi.RemoteException,
                                                                                            MeridioDataSetException
```
    This method is a wrapper around the Meridio "GetDocumentData" Web Service Method Retrieves data relating to a specified document. The data retrieved can be selected by supplying a true value for those Boolean arguments in which the caller is interested. Similarly, if getVersions is ALL then all versions of the specified document will be DataTable Controlling flag ACCESSCONTROL getAcl (ACL of document docId only) ACTIVITIES getCanDo (also controls retrieval of activity information for requested policy, lock, keywords and referencing containers) CONTAINERS getReferencingContainers CONTAINER_DOCUMENTREFS getReferencingContainers CONTAINER_CUSTOMPROPS getReferencingContainers DOCUMENT_CUSTOMPROPS getPropList DOCUMENT_POLICIES getPolicy DOCUMENT_REFERENCEPATHS getReferencePaths LOCK_CUSTOMPROPS getLockInfo VERSION_CUSTOMPROPS getVersions DOCUMENTS getPropList DOCUMENT_KEYWORDS getKeywords GROUPS getAcl KEYWORDS getKeywords LOCKS getLockInfo USERS getAcl VERSIONS getVersions
    
    Returns:
    
    Meridio DMDataSet with elements populated as per controlling flags
    
    Throws:
    
    java.rmi.RemoteException - if an error is encountered call the Meridio web service method(s)
    
    MeridioDataSetException - if an error is encountered manipulating the Meridio DataSet
  - getContainerData
```
public org.apache.manifoldcf.crawler.connectors.meridio.DMDataSet.DMDataSet getContainerData(int containerId,
                                                                                             boolean getPropList,
                                                                                             boolean getAcl,
                                                                                             boolean getCanDo,
                                                                                             boolean getChildContainers,
                                                                                             boolean getContainerRefs,
                                                                                             boolean getDocumentRefs,
                                                                                             boolean getStoredSearchRefs,
                                                                                             boolean getKeywords,
                                                                                             boolean getReferencingContainers)
                                                                                      throws java.rmi.RemoteException,
                                                                                             MeridioDataSetException
```
    This method is a wrapper around the Meridio "GetContainerData" Web Service Method Retrieves data relating to a specified container. The data retrieved can be selected by supplying a true value for those arguments in which the caller is interested. The DataTables returned are as described below. DataTable Controlling flag ACCESSCONTROL getAcl (ACL of container containerId only) ACTIVITIES getCanDo (also controls retrieval of activity information for requested references, child containers, keywords and referencing containers) CONTAINERS getPropList getContainerRefs getReferencingContainers CONTAINER_CHILDCONTAINERS getChildContainers (always includes specified container's parent) CONTAINER_CONTAINERREFS getContainerRefs (includes containers referenced by specified container) getReferencingContainers (includes containers that specified container is referenced by) CONTAINER_DOCUMENTREFS getDocumentRefs CONTAINER_STOREDSEARCHREFS getStoredSearchRefs CONTAINER_CUSTOMPROPS getPropList getChildContainers getContainerRefs getReferencingContainers CONTAINER_KEYWORDS getKeywords DOCUMENT_CUSTOMPROPS getDocumentRefs DOCUMENTS getDocumentRefs GROUPS getAcl KEYWORDS getKeywords STOREDSEARCHES getStoredSearchRefs USERS getAcl
    
    Returns:
    
    Meridio DMDataSet with elements populated as per controlling flags
    
    Throws:
    
    java.rmi.RemoteException - if an error is encountered call the Meridio web service method(s)
    
    MeridioDataSetException - if an error is encountered manipulating the Meridio DataSet
  - getLatestVersionFile
```
public org.apache.axis.attachments.AttachmentPart getLatestVersionFile(int docId)
                                                                throws java.rmi.RemoteException,
                                                                       MeridioDataSetException
```
    This method is a wrapper around the Meridio "GetLatestVersionFile" Web Service Method These methods retrieve a copy of a the latest version of a file that is stored in Meridio.
    
    Parameters:
    
    docId - the identifier of the document for the version file to return
    
    Returns:
    
    An attachment part object, containing the version file
    
    Throws:
    
    java.rmi.RemoteException - if an error is encountered call the Meridio web service method(s)
    
    MeridioDataSetException - if an error is encountered manipulating the Meridio DataSet
  - getRecordPartList
```
public org.apache.manifoldcf.crawler.connectors.meridio.RMDataSet.RMDataSet getRecordPartList(int recordId,
                                                                                              boolean getPropDefs,
                                                                                              boolean getActivities)
                                                                                       throws java.rmi.RemoteException,
                                                                                              MeridioDataSetException
```
    Throws:
    
    java.rmi.RemoteException
    
    MeridioDataSetException
  - getDocumentPartList
```
public org.apache.manifoldcf.crawler.connectors.meridio.RMDataSet.RMDataSet getDocumentPartList(int documentId)
                                                                                         throws java.rmi.RemoteException,
                                                                                                MeridioDataSetException
```
    Throws:
    
    java.rmi.RemoteException
    
    MeridioDataSetException
  - getDMDataSet
```
protected org.apache.manifoldcf.crawler.connectors.meridio.DMDataSet.DMDataSet getDMDataSet(org.apache.axis.message.MessageElement[] messageElement)
                                                                                     throws MeridioDataSetException
```
    Given the SOAP response received by AXIS on the successful call to a Meridio Web Service, this helper method returns a castor DMDataSet object which represents the XML This makes it much easier to subsequently manipulate the data that has been returned from the web service, and ensures that the Meridio wrapper implementation is as close to native .NET code as we can get.
    
    Throws:
    
    MeridioDataSetException
  - getRMDataSet
```
protected org.apache.manifoldcf.crawler.connectors.meridio.RMDataSet.RMDataSet getRMDataSet(org.apache.axis.message.MessageElement[] messageElement)
                                                                                     throws MeridioDataSetException
```
    Given the SOAP response received by AXIS on the successful call to a Meridio Web Service, this helper method returns a castor RMDataSet object which represents the XML This makes it much easier to subsequently manipulate the data that has been returned from the web service, and ensures that the Meridio wrapper implementation is as close to native .NET code as we can get.
    
    Throws:
    
    MeridioDataSetException
  - getSOAPMessage
```
protected org.apache.axis.message.MessageElement[] getSOAPMessage(org.apache.manifoldcf.crawler.connectors.meridio.DMDataSet.DMDataSet dsDM)
                                                           throws MeridioDataSetException
```
    Given the castor object representing the Meridio DMDataSet XSD, this method generates the XML that must be passed over the wire to invoke the Meridio DM Web Service
    
    Throws:
    
    MeridioDataSetException
  - getSOAPMessage
```
protected org.apache.axis.message.MessageElement[] getSOAPMessage(org.apache.manifoldcf.crawler.connectors.meridio.RMDataSet.RMDataSet dsRM)
                                                           throws MeridioDataSetException
```
    Given the castor object representing the Meridio DMDataSet XSD, this method generates the XML that must be passed over the wire to invoke the Meridio DM Web Service
    
    Throws:
    
    MeridioDataSetException

Class MeridioWrapper

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

HTTPCLIENT_PROPERTY

meridioCategoriesTime

meridioCategories_

meridioCategoriesExpire

meridioStaticDataTime

meridioStaticData_

meridioStaticDataExpire

engineConfiguration

oLog

clientWorkstation

dmwsConnectionManager

rmwsConnectionManager

mcwsConnectionManager

dmwsHttpClient

rmwsHttpClient

mcwsHttpClient

meridioDMWebService_

meridioRMWebService_

meridioMCWS_

loginToken_

Constructor Detail

MeridioWrapper

Method Detail

getDMWebService

getRMWebService

getMCWSWebService

getLoginToken

clearCache

loginUnified

logout

getUsersGroups

getStaticData

getConfiguration

getPropertyDefs

getCategories

getClassContents

findClassOrFolder

findClassOrFolder

searchDocuments

searchRecords

searchUsers

getUserIdFromName

getRolesAndMembership

getProtectiveMarkingList

getUserPrivilegeList

getRecord

getFolder

getUserData

getDocumentData

getContainerData

getLatestVersionFile

getRecordPartList

getDocumentPartList

getDMDataSet

getRMDataSet

getSOAPMessage

getSOAPMessage