public class

DocumentServiceClient

extends AbstractServiceClient
implements DocumentService
java.lang.Object
   ↳ org.mule.LiquidPlanner.client.services.impl.AbstractServiceClient
     ↳ org.mule.LiquidPlanner.client.services.impl.DocumentServiceClient

Class Overview

Provide access to all the document's related operations in LiquidPlanner.

Summary

Constants
String API_DOCUMENT_DOWNLOAD_PATH
String API_DOCUMENT_THUMBNAIL_PATH
[Expand]
Inherited Constants
From class org.mule.LiquidPlanner.client.services.impl.AbstractServiceClient
[Expand]
Inherited Fields
From class org.mule.LiquidPlanner.client.services.impl.AbstractServiceClient
Public Constructors
DocumentServiceClient(String user, String password)
Public Methods
String createDocument(String workSpaceId, ServiceEntity entity, String entityId, String fileName, String fileDescription, InputStream fileInputStream)
Document deleteDocument(String workSpaceId, String id)
InputStream downloadDocument(String workSpaceId, String documentId)
Document getDocument(String workSpaceId, String documentId)
List<Document> getDocuments(String workSpaceId)
Document updateDocument(String workSpaceId, Document document)
Protected Methods
String extendGetBaseUrl(String baseUrl)
This method is called by getBaseURL for the user to extend the base URL of its ServiceClient implementation.
ClientConfig getJerseyClientConfiguration()
This method is called by getBuilder before the creation of the Client.
List<ClientFilter> getJerseyClientFilters()
This method is called by getBuilder before the creation of the Client.
[Expand]
Inherited Methods
From class org.mule.LiquidPlanner.client.services.impl.AbstractServiceClient
From class java.lang.Object
From interface org.mule.LiquidPlanner.client.services.DocumentService

Constants

private static final String API_DOCUMENT_DOWNLOAD_PATH

Constant Value: "/download"

private static final String API_DOCUMENT_THUMBNAIL_PATH

Constant Value: "/thumbnail"

Public Constructors

public DocumentServiceClient (String user, String password)

Parameters
user
password

Public Methods

public String createDocument (String workSpaceId, ServiceEntity entity, String entityId, String fileName, String fileDescription, InputStream fileInputStream)

Parameters
workSpaceId
entity
entityId
fileName
fileDescription
fileInputStream

public Document deleteDocument (String workSpaceId, String id)

Parameters
workSpaceId
id

public InputStream downloadDocument (String workSpaceId, String documentId)

Parameters
workSpaceId
documentId

public Document getDocument (String workSpaceId, String documentId)

Parameters
workSpaceId
documentId

public List<Document> getDocuments (String workSpaceId)

Parameters
workSpaceId

public Document updateDocument (String workSpaceId, Document document)

Parameters
workSpaceId
document

Protected Methods

protected String extendGetBaseUrl (String baseUrl)

This method is called by getBaseURL for the user to extend the base URL of its ServiceClient implementation.

Parameters
baseUrl The URL created by getBaseURL
Returns
  • the enhanced base URL

protected ClientConfig getJerseyClientConfiguration ()

This method is called by getBuilder before the creation of the Client. The ClientConfig is used to create the Client.

Returns
  • null if there are ClientConfig to be added.

protected List<ClientFilter> getJerseyClientFilters ()

This method is called by getBuilder before the creation of the Client. The ClientFilter is used to create the Client. If there are no ClientFilter to be added just return null.

Returns
  • null if there are no ClientFilter to be added.