public class

DocumentumConnector

extends Object
java.lang.Object
   ↳ org.mule.module.documentum.DocumentumConnector
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

Documentum Cloud Connector. The Documentum Connector will allow to use the DFS SOAP API. Almost every operation that can be done via the API can be done thru this connector.

Summary

Constants
String APIURL The relative URL where all API calls are made.
Fields
private AccessControlClient accessControlClient Access Control Client
private ServiceContext context Service Context
private RepositoryIdentity identity Repository Identity
private ObjectClient objectClient Object Client
private QueryClient queryClient Query Client
private String server URL of the DFS server API
private VersionControlClient versionControlClient Version Control Client
Public Constructors
DocumentumConnector()
Public Methods
ObjectIdentity applyAcl(ObjectIdentity objectIdentity, AclIdentity aclIdentity)
Apply Acl
ObjectIdentity cancelCheckout(ObjectIdentity objIdentity)
Cancel Checkout
ObjectIdentity checkin(ObjectIdentity objIdentity, String newContentPath, VersionStrategy versionStrategy, List<String> labels, boolean isRetainLock, ContentTransferMode transferMode)
Checkin
ObjectIdentity checkout(ObjectIdentity objIdentity)
Checkout
void connect(String username, String password, String repository, String server)
Connect
String connectionId()
Connection Identifier
ObjectIdentity copyObject(ObjectIdentity objectIdentity, ObjectIdentity folderIdentity)
Copy Object
Acl createAcl(String aclName, String aclDescription, List<AclEntry> aclEntries, AclVisibility aclVisibility, AclType aclType)
Create Acl
ObjectIdentity createDocument(String filePath, String folderPath, ContentTransferMode transferMode)
Create Document
ObjectIdentity createFolder(String folderName, String folderPath)
Create Folder
ObjectIdentity createPath(String folderPath)
Create Path
List<String> deleteAcl(List<String> aclNames)
Delete Acl
ObjectIdentity deleteAllVersions(ObjectIdentity objIdentity)
Delete All Versions
ObjectIdentity deleteObject(ObjectIdentity objectIdentity)
Delete Object
ObjectIdentity deleteVersion(ObjectIdentity objIdentity)
Delete Version
void disconnect()
Disconnect
AccessControlClient getAccessControlClient()
AclPackage getAcl(List<String> aclNames)
Get Acl
AclPackage getAcls()
Get Acls
String getApiUrl()
CheckoutInfo getCheckoutInfo(ObjectIdentity objIdentity)
Get checkout info
ServiceContext getContext()
ObjectIdentity getCurrent(ObjectIdentity objIdentity)
Get Current
RepositoryIdentity getIdentity()
File getObject(ObjectIdentity objectIdentity, String outputPath, ContentTransferMode transferMode)
Get Object
ObjectClient getObjectClient()
QueryClient getQueryClient()
String getServer()
String getTarget()
VersionControlClient getVersionControlClient()
VersionInfo getVersionInfo(ObjectIdentity objIdentity)
Get Version Info
boolean isConnected()
Are we connected
ObjectIdentity moveObject(ObjectIdentity objectIdentity, ObjectIdentity toFolderIdentity, ObjectIdentity fromFolderIdentity)
Move Object
QueryResult query(String dqlStatement)
Query
void setContext(ServiceContext context)
void setIdentity(RepositoryIdentity identity)
void setServer(String server)
Acl updateAcl(String aclName, String aclDescription, List<AclEntry> aclEntries, AclVisibility aclVisibility, AclType aclType)
Update Acl
ObjectIdentity updateDocument(ObjectIdentity objectIdentity, String newContentFilePath, ContentTransferMode transferMode, Map<String, String> newProperties, ObjectIdentity oldParentFolder, ObjectIdentity newParentFolder)
Update Document
ObjectIdentity updateFolder(ObjectIdentity objectIdentity, Map<String, String> newProperties, ObjectIdentity oldParentFolder, ObjectIdentity newParentFolder)
Update Folder
[Expand]
Inherited Methods
From class java.lang.Object

Constants

private static final String APIURL

The relative URL where all API calls are made.

Constant Value: "/services/"

Fields

private AccessControlClient accessControlClient

Access Control Client

private ServiceContext context

Service Context

private RepositoryIdentity identity

Repository Identity

private ObjectClient objectClient

Object Client

private QueryClient queryClient

Query Client

private String server

URL of the DFS server API

private VersionControlClient versionControlClient

Version Control Client

Public Constructors

public DocumentumConnector ()

Public Methods

public ObjectIdentity applyAcl (ObjectIdentity objectIdentity, AclIdentity aclIdentity)

Apply Acl

Parameters
objectIdentity The object identity to receive the Acl.
aclIdentity The acl identity to apply to the object identity.
Returns
  • the ObjectIdentity.
Throws
SerializableException .
ServiceException .

public ObjectIdentity cancelCheckout (ObjectIdentity objIdentity)

Cancel Checkout

Parameters
objIdentity Identify the object to cancel the checkout.
Returns
  • ObjectIdentity if the cancellation was successful.
Throws
SerializableException .

public ObjectIdentity checkin (ObjectIdentity objIdentity, String newContentPath, VersionStrategy versionStrategy, List<String> labels, boolean isRetainLock, ContentTransferMode transferMode)

Checkin

Parameters
objIdentity Identify the object to checkin.
newContentPath The path to the file with the new content.
versionStrategy The strategy to do the checkin.
labels The labels of this checkin.
isRetainLock Specifies whether the object is to remain checked out and locked by the user after the new version is saved.
transferMode The transfer mode.
Returns
  • the ObjectIdentity.
Throws
IOException .
SerializableException .

public ObjectIdentity checkout (ObjectIdentity objIdentity)

Checkout

Parameters
objIdentity Identify the object to checkout.
Returns
  • the ObjectIdentity.
Throws
SerializableException .

public void connect (String username, String password, String repository, String server)

Connect

Parameters
username A username
password A password
repository A repository
server A server
Throws
ConnectionException

public String connectionId ()

Connection Identifier

public ObjectIdentity copyObject (ObjectIdentity objectIdentity, ObjectIdentity folderIdentity)

Copy Object

Parameters
objectIdentity Identify the object to copy.
folderIdentity Identify the folder to copy to.
Returns
  • the ObjectIdentity.
Throws
SerializableException .

public Acl createAcl (String aclName, String aclDescription, List<AclEntry> aclEntries, AclVisibility aclVisibility, AclType aclType)

Create Acl

Parameters
aclName The name of the acl.
aclDescription The description of the acl.
aclEntries The entries of the acl.
aclVisibility The visibility of the acl.
aclType The type of the acl.
Returns
  • the Acl.
Throws
CoreServiceException_Exception .
ServiceException .

public ObjectIdentity createDocument (String filePath, String folderPath, ContentTransferMode transferMode)

Create Document

Parameters
filePath Path to an existing file in the local system.
folderPath Path to an existing folder in the content server.
transferMode The transfer mode.
Returns
  • the ObjectIdentity.
Throws
SerializableException .
IOException .

public ObjectIdentity createFolder (String folderName, String folderPath)

Create Folder

Parameters
folderName Of the folder to create.
folderPath Path to an existing folder in the content server.
Returns
  • the ObjectIdentity.
Throws
SerializableException .
IOException .

public ObjectIdentity createPath (String folderPath)

Create Path

Parameters
folderPath Path to create in the content server.
Returns
  • the ObjectIdentity.
Throws
SerializableException .

public List<String> deleteAcl (List<String> aclNames)

Delete Acl

Parameters
aclNames The names of the acls.
Returns
  • a list with names of the deleted acls.
Throws
CoreServiceException_Exception .
ServiceException .

public ObjectIdentity deleteAllVersions (ObjectIdentity objIdentity)

Delete All Versions

Parameters
objIdentity Identify the object to delete.
Returns
  • ObjectIdentity if the deletion was successful.
Throws
SerializableException .

public ObjectIdentity deleteObject (ObjectIdentity objectIdentity)

Delete Object

Parameters
objectIdentity The ObjectIdentity of the object to delete.
Returns
  • ObjectIdentity if the deletion was successful.
Throws
SerializableException .

public ObjectIdentity deleteVersion (ObjectIdentity objIdentity)

Delete Version

Parameters
objIdentity Identify the object to delete.
Returns
  • ObjectIdentity if the deletion was successful.
Throws
SerializableException .

public void disconnect ()

Disconnect

public AccessControlClient getAccessControlClient ()

public AclPackage getAcl (List<String> aclNames)

Get Acl

Parameters
aclNames The names of the acls.
Returns
  • the AclPackage.
Throws
CoreServiceException_Exception .
ServiceException .

public AclPackage getAcls ()

Get Acls

Returns
  • the AclPackage.
Throws
CoreServiceException_Exception .
SerializableException .
ServiceException .

public String getApiUrl ()

public CheckoutInfo getCheckoutInfo (ObjectIdentity objIdentity)

Get checkout info

Parameters
objIdentity Identify the object to get the checkout info.
Returns
  • the CheckoutInfo.
Throws
SerializableException .

public ServiceContext getContext ()

public ObjectIdentity getCurrent (ObjectIdentity objIdentity)

Get Current

Parameters
objIdentity Identify the object to get the current version.
Returns
  • the ObjectIdentity.
Throws
SerializableException .

public RepositoryIdentity getIdentity ()

public File getObject (ObjectIdentity objectIdentity, String outputPath, ContentTransferMode transferMode)

Get Object

Parameters
objectIdentity The ObjectIdentity of the object to download.
outputPath Download path plus the fileName.
transferMode The transfer mode.
Returns
  • the File.
Throws
SerializableException .
IOException .

public ObjectClient getObjectClient ()

public QueryClient getQueryClient ()

public String getServer ()

public String getTarget ()

public VersionControlClient getVersionControlClient ()

public VersionInfo getVersionInfo (ObjectIdentity objIdentity)

Get Version Info

Parameters
objIdentity Identify the object to get the version info.
Returns
  • the VersionInfo.
Throws
SerializableException .

public boolean isConnected ()

Are we connected

public ObjectIdentity moveObject (ObjectIdentity objectIdentity, ObjectIdentity toFolderIdentity, ObjectIdentity fromFolderIdentity)

Move Object

Parameters
objectIdentity Identify the object to move.
toFolderIdentity Identify the folder to move from.
fromFolderIdentity Identify the folder to move to.
Returns
  • the ObjectIdentity.
Throws
SerializableException .

public QueryResult query (String dqlStatement)

Query

Parameters
dqlStatement A DQL query.
Returns
  • the QueryResult.
Throws
SerializableException .

public void setContext (ServiceContext context)

Parameters
context

public void setIdentity (RepositoryIdentity identity)

Parameters
identity

public void setServer (String server)

Parameters
server

public Acl updateAcl (String aclName, String aclDescription, List<AclEntry> aclEntries, AclVisibility aclVisibility, AclType aclType)

Update Acl

Parameters
aclName The name of the acl.
aclDescription The description of the acl.
aclEntries The entries of the acl.
aclVisibility The visibility of the acl.
aclType The type of the acl.
Returns
  • the Acl.
Throws
CoreServiceException_Exception .
ServiceException .

public ObjectIdentity updateDocument (ObjectIdentity objectIdentity, String newContentFilePath, ContentTransferMode transferMode, Map<String, String> newProperties, ObjectIdentity oldParentFolder, ObjectIdentity newParentFolder)

Update Document

Parameters
objectIdentity The ObjectIdentity of the object to update.
newContentFilePath The path to file with the new content.
transferMode The transfer mode.
newProperties A map with the new properties.
oldParentFolder The old parent folder ObjectIdentity.
newParentFolder The new parent folder ObjectIdentity.
Returns
  • the ObjectIdentity.
Throws
IOException .
SerializableException .

public ObjectIdentity updateFolder (ObjectIdentity objectIdentity, Map<String, String> newProperties, ObjectIdentity oldParentFolder, ObjectIdentity newParentFolder)

Update Folder

Parameters
objectIdentity The ObjectIdentity of the object to update.
newProperties A map with the new properties.
oldParentFolder The old parent folder ObjectIdentity.
newParentFolder The new parent folder ObjectIdentity.
Returns
  • the ObjectIdentity.
Throws
IOException .
SerializableException .