org.apache.manifoldcf.csws

Class CswsSession

java.lang.Object

org.apache.manifoldcf.csws.CswsSession

public class CswsSession
extends java.lang.Object

This class describes a livelink csws session. It manages OAuth authentication and provides logged-in access to csws services via methods provided within.

Constructor Summary

Constructors

Constructor and Description
CswsSession(java.lang.String userName, java.lang.String password, org.apache.manifoldcf.connectorcommon.interfaces.IKeystoreManager keystore, long sessionExpirationInterval, java.lang.String authenticationServiceURL, java.lang.String documentManagementServiceURL, java.lang.String contentServiceServiceURL, java.lang.String memberServiceServiceURL, java.lang.String searchServiceServiceURL)

Method Summary

Modifier and Type	Method and Description
com.opentext.livelink.service.core.PageHandle	getAllUsers()
com.opentext.livelink.service.docman.AttributeGroupDefinition	getCategoryDefinition(long catId)
java.util.List<? extends com.opentext.livelink.service.docman.AttributeGroupDefinition>	getCategoryDefinitions(java.util.List<java.lang.Long> categoryIDs)
java.util.List<? extends com.opentext.livelink.service.docman.CategoryInheritance>	getCategoryInheritance(long parentId)
java.util.List<? extends com.opentext.livelink.service.docman.Node>	getChildren(long nodeId)
com.opentext.livelink.service.core.ContentService	getContentServiceHandle() Fetch initialized ContentService handle.
com.opentext.livelink.service.docman.DocumentManagement	getDocumentManagementHandle() Fetch initialized DocumentManagement handle.
com.opentext.livelink.service.memberservice.Member	getMember(long memberId)
com.opentext.livelink.service.memberservice.Member	getMemberByLoginName(java.lang.String memberName)
com.opentext.livelink.service.memberservice.MemberService	getMemberServiceHandle() Fetch initialized MemberService handle.
java.util.List<? extends com.opentext.livelink.service.memberservice.Member>	getNextUserSearchResults(com.opentext.livelink.service.core.PageHandle pgHandle)
com.opentext.livelink.service.docman.Node	getNode(long nodeId)
com.opentext.livelink.service.docman.Node	getNodeByPath(long rootNode, java.util.List<java.lang.String> colonSeparatedPath)
com.opentext.livelink.service.docman.NodeRights	getNodeRights(long nodeId)
javax.xml.ws.Holder<com.opentext.ecm.api.OTAuthentication>	getOTAuthentication() Construct OTAuthentication structure (to be passed as an argument)
com.opentext.livelink.service.docman.Node	getRootNode(java.lang.String nodeType) Fetch root node given type.
java.util.List<? extends java.lang.String>	getRootNodeTypes() Fetch root node types.
com.opentext.livelink.service.searchservices.SearchService	getSearchServiceHandle() Fetch initialized SearchService handle.
com.opentext.livelink.service.memberservice.User	getUserByLoginName(java.lang.String userName)
com.opentext.livelink.service.docman.Version	getVersion(long nodeId, long version)
void	getVersionContents(long nodeId, long version, java.io.OutputStream os)
java.util.List<? extends com.opentext.livelink.service.docman.Node>	listNodes(long nodeId)
java.util.List<? extends com.opentext.livelink.service.memberservice.MemberRight>	listRightsByMemberId(long memberId)
java.util.List<? extends com.opentext.livelink.service.searchservices.SGraph>	searchFor(long parentID, java.lang.String[] returnColumns, java.lang.String dataCollection, java.lang.String searchSpec, java.lang.String orderingColumn, int start, int count) Return a set of IDs matching the specification.

Methods inherited from class java.lang.Object

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

Constructor Detail

CswsSession

public CswsSession(java.lang.String userName,
                   java.lang.String password,
                   org.apache.manifoldcf.connectorcommon.interfaces.IKeystoreManager keystore,
                   long sessionExpirationInterval,
                   java.lang.String authenticationServiceURL,
                   java.lang.String documentManagementServiceURL,
                   java.lang.String contentServiceServiceURL,
                   java.lang.String memberServiceServiceURL,
                   java.lang.String searchServiceServiceURL)
            throws org.apache.manifoldcf.core.interfaces.ManifoldCFException

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

Method Detail

getDocumentManagementHandle

public com.opentext.livelink.service.docman.DocumentManagement getDocumentManagementHandle()

Fetch initialized DocumentManagement handle.

getContentServiceHandle

public com.opentext.livelink.service.core.ContentService getContentServiceHandle()

Fetch initialized ContentService handle.

getMemberServiceHandle

public com.opentext.livelink.service.memberservice.MemberService getMemberServiceHandle()

Fetch initialized MemberService handle.

getSearchServiceHandle

public com.opentext.livelink.service.searchservices.SearchService getSearchServiceHandle()

Fetch initialized SearchService handle.

getRootNodeTypes

public java.util.List<? extends java.lang.String> getRootNodeTypes()
                                                            throws org.apache.manifoldcf.core.interfaces.ManifoldCFException,
                                                                   org.apache.manifoldcf.agents.interfaces.ServiceInterruption

Fetch root node types. These will be cached so we only need to do it once.

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

org.apache.manifoldcf.agents.interfaces.ServiceInterruption

getRootNode

public com.opentext.livelink.service.docman.Node getRootNode(java.lang.String nodeType)
                                                      throws org.apache.manifoldcf.core.interfaces.ManifoldCFException,
                                                             org.apache.manifoldcf.agents.interfaces.ServiceInterruption

Fetch root node given type.

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

org.apache.manifoldcf.agents.interfaces.ServiceInterruption

listNodes

public java.util.List<? extends com.opentext.livelink.service.docman.Node> listNodes(long nodeId)
                                                                              throws org.apache.manifoldcf.core.interfaces.ManifoldCFException,
                                                                                     org.apache.manifoldcf.agents.interfaces.ServiceInterruption

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

org.apache.manifoldcf.agents.interfaces.ServiceInterruption

getChildren

public java.util.List<? extends com.opentext.livelink.service.docman.Node> getChildren(long nodeId)
                                                                                throws org.apache.manifoldcf.core.interfaces.ManifoldCFException,
                                                                                       org.apache.manifoldcf.agents.interfaces.ServiceInterruption

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

org.apache.manifoldcf.agents.interfaces.ServiceInterruption

getCategoryInheritance

public java.util.List<? extends com.opentext.livelink.service.docman.CategoryInheritance> getCategoryInheritance(long parentId)
                                                                                                          throws org.apache.manifoldcf.core.interfaces.ManifoldCFException,
                                                                                                                 org.apache.manifoldcf.agents.interfaces.ServiceInterruption

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

org.apache.manifoldcf.agents.interfaces.ServiceInterruption

getCategoryDefinitions

public java.util.List<? extends com.opentext.livelink.service.docman.AttributeGroupDefinition> getCategoryDefinitions(java.util.List<java.lang.Long> categoryIDs)
                                                                                                               throws org.apache.manifoldcf.core.interfaces.ManifoldCFException,
                                                                                                                      org.apache.manifoldcf.agents.interfaces.ServiceInterruption

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

org.apache.manifoldcf.agents.interfaces.ServiceInterruption

getNode

public com.opentext.livelink.service.docman.Node getNode(long nodeId)
                                                  throws org.apache.manifoldcf.core.interfaces.ManifoldCFException,
                                                         org.apache.manifoldcf.agents.interfaces.ServiceInterruption

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

org.apache.manifoldcf.agents.interfaces.ServiceInterruption

getNodeByPath

public com.opentext.livelink.service.docman.Node getNodeByPath(long rootNode,
                                                               java.util.List<java.lang.String> colonSeparatedPath)
                                                        throws org.apache.manifoldcf.core.interfaces.ManifoldCFException,
                                                               org.apache.manifoldcf.agents.interfaces.ServiceInterruption

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

org.apache.manifoldcf.agents.interfaces.ServiceInterruption

getNodeRights

public com.opentext.livelink.service.docman.NodeRights getNodeRights(long nodeId)
                                                              throws org.apache.manifoldcf.core.interfaces.ManifoldCFException,
                                                                     org.apache.manifoldcf.agents.interfaces.ServiceInterruption

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

org.apache.manifoldcf.agents.interfaces.ServiceInterruption

getVersion

public com.opentext.livelink.service.docman.Version getVersion(long nodeId,
                                                               long version)
                                                        throws org.apache.manifoldcf.core.interfaces.ManifoldCFException,
                                                               org.apache.manifoldcf.agents.interfaces.ServiceInterruption

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

org.apache.manifoldcf.agents.interfaces.ServiceInterruption

getCategoryDefinition

public com.opentext.livelink.service.docman.AttributeGroupDefinition getCategoryDefinition(long catId)
                                                                                    throws org.apache.manifoldcf.core.interfaces.ManifoldCFException,
                                                                                           org.apache.manifoldcf.agents.interfaces.ServiceInterruption

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

org.apache.manifoldcf.agents.interfaces.ServiceInterruption

getUserByLoginName

public com.opentext.livelink.service.memberservice.User getUserByLoginName(java.lang.String userName)
                                                                    throws org.apache.manifoldcf.core.interfaces.ManifoldCFException,
                                                                           org.apache.manifoldcf.agents.interfaces.ServiceInterruption

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

org.apache.manifoldcf.agents.interfaces.ServiceInterruption

getMemberByLoginName

public com.opentext.livelink.service.memberservice.Member getMemberByLoginName(java.lang.String memberName)
                                                                        throws org.apache.manifoldcf.core.interfaces.ManifoldCFException,
                                                                               org.apache.manifoldcf.agents.interfaces.ServiceInterruption

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

org.apache.manifoldcf.agents.interfaces.ServiceInterruption

listRightsByMemberId

public java.util.List<? extends com.opentext.livelink.service.memberservice.MemberRight> listRightsByMemberId(long memberId)
                                                                                                       throws org.apache.manifoldcf.core.interfaces.ManifoldCFException,
                                                                                                              org.apache.manifoldcf.agents.interfaces.ServiceInterruption

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

org.apache.manifoldcf.agents.interfaces.ServiceInterruption

getMember

public com.opentext.livelink.service.memberservice.Member getMember(long memberId)
                                                             throws org.apache.manifoldcf.core.interfaces.ManifoldCFException,
                                                                    org.apache.manifoldcf.agents.interfaces.ServiceInterruption

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

org.apache.manifoldcf.agents.interfaces.ServiceInterruption

getVersionContents

public void getVersionContents(long nodeId,
                               long version,
                               java.io.OutputStream os)
                        throws org.apache.manifoldcf.core.interfaces.ManifoldCFException,
                               org.apache.manifoldcf.agents.interfaces.ServiceInterruption

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

org.apache.manifoldcf.agents.interfaces.ServiceInterruption

getAllUsers

public com.opentext.livelink.service.core.PageHandle getAllUsers()
                                                          throws org.apache.manifoldcf.core.interfaces.ManifoldCFException,
                                                                 org.apache.manifoldcf.agents.interfaces.ServiceInterruption

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

org.apache.manifoldcf.agents.interfaces.ServiceInterruption

getNextUserSearchResults

public java.util.List<? extends com.opentext.livelink.service.memberservice.Member> getNextUserSearchResults(com.opentext.livelink.service.core.PageHandle pgHandle)
                                                                                                      throws org.apache.manifoldcf.core.interfaces.ManifoldCFException,
                                                                                                             org.apache.manifoldcf.agents.interfaces.ServiceInterruption

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

org.apache.manifoldcf.agents.interfaces.ServiceInterruption

searchFor

public java.util.List<? extends com.opentext.livelink.service.searchservices.SGraph> searchFor(long parentID,
                                                                                               java.lang.String[] returnColumns,
                                                                                               java.lang.String dataCollection,
                                                                                               java.lang.String searchSpec,
                                                                                               java.lang.String orderingColumn,
                                                                                               int start,
                                                                                               int count)
                                                                                        throws org.apache.manifoldcf.core.interfaces.ManifoldCFException,
                                                                                               org.apache.manifoldcf.agents.interfaces.ServiceInterruption

Return a set of IDs matching the specification.

Parameters:

parentID - is the parent ID.

returnColumns - is an array of return column names. For reference: OTDataID OTSubTypeName OTName

dataCollection - the data collection (i.e. the slice) to be queried

searchSpec - is the search specification, e.g. "\"OTSubType\":0 OR \"OTSubType\":1 OR \"OTSubType\":144) AND \"OTModifyDate\":<20190312" For reference: OTSubType Details 0 - Folder 1 - Alias [Shortcut] 131 - Category 136 - Compound Document 140 - URL 144 - Document 202 - Project 204 - Task List 207 - Channel 215 - Discussion 299 - LiveReport

orderingColumn - is the column name to order the result by

start - is the ID of the result to return (0-based)

count - is the maximum number of IDs to return

Returns:

an array of IDs corresponding to documents or categories requested

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

org.apache.manifoldcf.agents.interfaces.ServiceInterruption

getOTAuthentication

public javax.xml.ws.Holder<com.opentext.ecm.api.OTAuthentication> getOTAuthentication()
                                                                               throws org.apache.manifoldcf.core.interfaces.ManifoldCFException,
                                                                                      org.apache.manifoldcf.agents.interfaces.ServiceInterruption

Construct OTAuthentication structure (to be passed as an argument)

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

org.apache.manifoldcf.agents.interfaces.ServiceInterruption