org.mule.module.sharepoint.common.service.rest

Class OnpremiseSharepointService

java.lang.Object

org.mule.module.sharepoint.common.service.rest.OnpremiseSharepointService

All Implemented Interfaces:

Closeable, AutoCloseable, SharepointService

Direct Known Subclasses:

OnlineSharepointService

public class OnpremiseSharepointService
extends Object
implements SharepointService

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.http.impl.client.CloseableHttpClient	httpClient
protected org.apache.http.protocol.HttpContext	httpContext

Constructor Summary

Constructors

Constructor and Description
OnpremiseSharepointService(org.apache.http.impl.client.CloseableHttpClient httpClient, org.apache.http.protocol.HttpContext httpContext, URL siteUrl, IMapper objectMapper)

Method Summary

Modifier and Type	Method and Description
<T> T	addBlob(String url, org.apache.http.HttpEntity entity, Class<T> clazz, boolean unwrapConfig)
SharepointFile	addFile(String filename, String folderPath, org.apache.http.HttpEntity entity, Boolean overwrite)
void	approveFile(String filename, String folderPath, String comment)
SharePointAttachResult	attachFile(String filename, String listTitle, String itemId, org.apache.http.HttpEntity entity)
void	checkInFile(String filename, String folderPath, String checkInType, String comment)
void	checkoutFile(String filename, String folderPath)
void	close()
void	copyFileTo(String filename, String folderPath, String newFilePath, Boolean overwrite)
SharepointFolder	createFolder(SharepointFolder folder)
SharepointList	createList(SharepointList list)
Map<String,Object>	createListItem(String id, SharepointListItem item)
protected void	delete(String path)
void	deleteFile(String filename, String folderPath)
void	deleteFolder(String serverRelativeUrl)
void	deleteList(String id)
void	deleteListItem(String listId, String itemId)
void	denyFile(String filename, String folderPath, String comment)
protected <T> T	exchangeForObject(String path, org.springframework.http.HttpMethod method, org.springframework.http.HttpEntity<?> requestEntity, Class<T> clazz)
protected URI	getAbsoluteUri(String path)
SharepointListItem	getAllItemFields(String fileServerRelativeUrl, Map<String,Object> updatedProperties)
byte[]	getFileContent(String filename, String folderPath)
SharepointFile	getFileMetadata(String filename, String folderPath)
SharepointFile	getFileMetadata(String filename, String folderPath, String query)
SharepointFolder	getFolder(String serverRelativeUrl)
String	getFormDigestValue()
<T> T	getForObject(String path, Class<T> clazz)
SharepointList	getList(String id, String query)
List<SharepointListField>	getListFields(String id, String query)
Map<String,Object>	getListItemById(String listId, Integer id)
SharepointListItemResults	getListItems(String id, String query)
SharepointListItemResults	getListItems(String id, String query, Boolean queryEncoded)
List<SharepointList>	getLists(String query)
SharepointListItemResults	getPage(String pageUrl)
protected String	getServerRelativeUrlFromMetadata(Map<String,Object> folder)
String	getWebId()
void	init(org.apache.http.impl.client.CloseableHttpClient httpClient, org.apache.http.protocol.HttpContext httpContext, URL siteUrl)
SharepointListItem	listItemAllFields(String fileRelativeUrl)
protected <T> T	postForObject(String path, Object object, Class<T> clazz)
protected <T> T	postForObject(String path, Object object, Class<T> clazz, Boolean withFormDigest)
void	publishFile(String filename, String folderPath, String comment)
List<Map<String,Object>>	queryFile(String query, String parsedFolderPath, Boolean recursive)
List<Map<String,Object>>	queryFolders(String query, String folderPath, Boolean recursive)
String	recycleFile(String filename, String folderPath)
List<Map<String,Object>>	resolveCollection(String url)
Map<String,Object>	resolveCreate(String url, Object body)
void	resolveDelete(String url)
SharepointMapResult	resolveMapResult(String url, org.apache.http.HttpEntity entity, boolean unwrapConfig)
Map<String,Object>	resolveObject(String url)
<T> T	resolvePost(String url, Object body, Class<T> clazz)
void	resolveUpdate(String url, Object body)
void	undoCheckOut(String filename, String folderPath)
void	unpublishFile(String filename, String folderPath, String comment)
protected <T> T	update(String path, Object updatedFields, Class<T> clazz)
void	updateFileMetadata(SharepointListItem file, Map<String,Object> updatedProperties)
void	updateFolder(String serverRelativeUrl, Map<String,Object> updatedFields)
void	updateList(String listId, SharepointList list)
void	updateListItem(String listId, String itemId, Map<String,Object> updatedFields)

Methods inherited from class java.lang.Object

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

Field Detail

httpClient

protected org.apache.http.impl.client.CloseableHttpClient httpClient

httpContext

protected org.apache.http.protocol.HttpContext httpContext

Constructor Detail

OnpremiseSharepointService

public OnpremiseSharepointService(org.apache.http.impl.client.CloseableHttpClient httpClient,
                                  org.apache.http.protocol.HttpContext httpContext,
                                  URL siteUrl,
                                  IMapper objectMapper)

Method Detail

getWebId

public String getWebId()
                throws SharepointException

Specified by:

getWebId in interface SharepointService

Throws:

SharepointException

getFormDigestValue

public String getFormDigestValue()
                          throws SharepointException

Specified by:

getFormDigestValue in interface SharepointService

Throws:

SharepointException

getList

public SharepointList getList(String id,
                              String query)
                       throws SharepointException

Specified by:

getList in interface SharepointService

Throws:

SharepointException

getListItems

public SharepointListItemResults getListItems(String id,
                                              String query)
                                       throws SharepointException

Specified by:

getListItems in interface SharepointService

Throws:

SharepointException

getListItemById

public Map<String,Object> getListItemById(String listId,
                                          Integer id)
                                   throws SharepointException

Specified by:

getListItemById in interface SharepointService

Throws:

SharepointException

getListItems

public SharepointListItemResults getListItems(String id,
                                              String query,
                                              Boolean queryEncoded)
                                       throws SharepointException

Specified by:

getListItems in interface SharepointService

Throws:

SharepointException

getLists

public List<SharepointList> getLists(String query)
                              throws SharepointException

Specified by:

getLists in interface SharepointService

Throws:

SharepointException

getListFields

public List<SharepointListField> getListFields(String id,
                                               String query)
                                        throws SharepointException

Specified by:

getListFields in interface SharepointService

Throws:

SharepointException

deleteList

public void deleteList(String id)
                throws SharepointException

Specified by:

deleteList in interface SharepointService

Throws:

SharepointException

createList

public SharepointList createList(SharepointList list)
                          throws SharepointException

Specified by:

createList in interface SharepointService

Throws:

SharepointException

updateList

public void updateList(String listId,
                       SharepointList list)
                throws SharepointException

Specified by:

updateList in interface SharepointService

Throws:

SharepointException

createListItem

public Map<String,Object> createListItem(String id,
                                         SharepointListItem item)
                                  throws SharepointException

Specified by:

createListItem in interface SharepointService

Throws:

SharepointException

deleteListItem

public void deleteListItem(String listId,
                           String itemId)
                    throws SharepointException

Specified by:

deleteListItem in interface SharepointService

Throws:

SharepointException

attachFile

public SharePointAttachResult attachFile(String filename,
                                         String listTitle,
                                         String itemId,
                                         org.apache.http.HttpEntity entity)
                                  throws SharepointException

Specified by:

attachFile in interface SharepointService

Throws:

SharepointException

updateListItem

public void updateListItem(String listId,
                           String itemId,
                           Map<String,Object> updatedFields)
                    throws SharepointException

Specified by:

updateListItem in interface SharepointService

Throws:

SharepointException

createFolder

public SharepointFolder createFolder(SharepointFolder folder)
                              throws SharepointException

Specified by:

createFolder in interface SharepointService

Throws:

SharepointException

getFolder

public SharepointFolder getFolder(String serverRelativeUrl)
                           throws SharepointException

Specified by:

getFolder in interface SharepointService

Throws:

SharepointException

listItemAllFields

public SharepointListItem listItemAllFields(String fileRelativeUrl)
                                     throws SharepointException

Specified by:

listItemAllFields in interface SharepointService

Throws:

SharepointException

deleteFolder

public void deleteFolder(String serverRelativeUrl)
                  throws SharepointException

Specified by:

deleteFolder in interface SharepointService

Throws:

SharepointException

updateFolder

public void updateFolder(String serverRelativeUrl,
                         Map<String,Object> updatedFields)
                  throws SharepointException

Specified by:

updateFolder in interface SharepointService

Throws:

SharepointException

queryFolders

public List<Map<String,Object>> queryFolders(String query,
                                             String folderPath,
                                             Boolean recursive)
                                      throws SharepointException

Specified by:

queryFolders in interface SharepointService

Throws:

SharepointException

addBlob

public <T> T addBlob(String url,
                     org.apache.http.HttpEntity entity,
                     Class<T> clazz,
                     boolean unwrapConfig)
              throws SharepointException

Specified by:

addBlob in interface SharepointService

Throws:

SharepointException

addFile

public SharepointFile addFile(String filename,
                              String folderPath,
                              org.apache.http.HttpEntity entity,
                              Boolean overwrite)
                       throws SharepointException

Specified by:

addFile in interface SharepointService

Throws:

SharepointException

getFileMetadata

public SharepointFile getFileMetadata(String filename,
                                      String folderPath)
                               throws SharepointException

Specified by:

getFileMetadata in interface SharepointService

Throws:

SharepointException

getFileMetadata

public SharepointFile getFileMetadata(String filename,
                                      String folderPath,
                                      String query)
                               throws SharepointException

Specified by:

getFileMetadata in interface SharepointService

Throws:

SharepointException

deleteFile

public void deleteFile(String filename,
                       String folderPath)
                throws SharepointException

Specified by:

deleteFile in interface SharepointService

Throws:

SharepointException

getFileContent

public byte[] getFileContent(String filename,
                             String folderPath)
                      throws SharepointException

Specified by:

getFileContent in interface SharepointService

Throws:

SharepointException

checkoutFile

public void checkoutFile(String filename,
                         String folderPath)
                  throws SharepointException

Specified by:

checkoutFile in interface SharepointService

Throws:

SharepointException

checkInFile

public void checkInFile(String filename,
                        String folderPath,
                        String checkInType,
                        String comment)
                 throws SharepointException

Specified by:

checkInFile in interface SharepointService

Throws:

SharepointException

undoCheckOut

public void undoCheckOut(String filename,
                         String folderPath)
                  throws SharepointException

Specified by:

undoCheckOut in interface SharepointService

Throws:

SharepointException

publishFile

public void publishFile(String filename,
                        String folderPath,
                        String comment)
                 throws SharepointException

Specified by:

publishFile in interface SharepointService

Throws:

SharepointException

unpublishFile

public void unpublishFile(String filename,
                          String folderPath,
                          String comment)
                   throws SharepointException

Specified by:

unpublishFile in interface SharepointService

Throws:

SharepointException

approveFile

public void approveFile(String filename,
                        String folderPath,
                        String comment)
                 throws SharepointException

Specified by:

approveFile in interface SharepointService

Throws:

SharepointException

denyFile

public void denyFile(String filename,
                     String folderPath,
                     String comment)
              throws SharepointException

Specified by:

denyFile in interface SharepointService

Throws:

SharepointException

queryFile

public List<Map<String,Object>> queryFile(String query,
                                          String parsedFolderPath,
                                          Boolean recursive)
                                   throws SharepointException

Specified by:

queryFile in interface SharepointService

Throws:

SharepointException

copyFileTo

public void copyFileTo(String filename,
                       String folderPath,
                       String newFilePath,
                       Boolean overwrite)
                throws SharepointException

Specified by:

copyFileTo in interface SharepointService

Throws:

SharepointException

recycleFile

public String recycleFile(String filename,
                          String folderPath)
                   throws SharepointException

Specified by:

recycleFile in interface SharepointService

Throws:

SharepointException

resolveObject

public Map<String,Object> resolveObject(String url)
                                 throws SharepointException

Specified by:

resolveObject in interface SharepointService

Throws:

SharepointException

resolveCollection

public List<Map<String,Object>> resolveCollection(String url)
                                           throws SharepointException

Specified by:

resolveCollection in interface SharepointService

Throws:

SharepointException

resolveCreate

public Map<String,Object> resolveCreate(String url,
                                        Object body)
                                 throws SharepointException

Specified by:

resolveCreate in interface SharepointService

Throws:

SharepointException

resolveUpdate

public void resolveUpdate(String url,
                          Object body)
                   throws SharepointException

Specified by:

resolveUpdate in interface SharepointService

Throws:

SharepointException

resolveDelete

public void resolveDelete(String url)
                   throws SharepointException

Specified by:

resolveDelete in interface SharepointService

Throws:

SharepointException

resolvePost

public <T> T resolvePost(String url,
                         Object body,
                         Class<T> clazz)
                  throws SharepointException

Specified by:

resolvePost in interface SharepointService

Throws:

SharepointException

getServerRelativeUrlFromMetadata

protected String getServerRelativeUrlFromMetadata(Map<String,Object> folder)

getAllItemFields

public SharepointListItem getAllItemFields(String fileServerRelativeUrl,
                                           Map<String,Object> updatedProperties)
                                    throws SharepointException

Specified by:

getAllItemFields in interface SharepointService

Throws:

SharepointException

updateFileMetadata

public void updateFileMetadata(SharepointListItem file,
                               Map<String,Object> updatedProperties)
                        throws SharepointException

Specified by:

updateFileMetadata in interface SharepointService

Throws:

SharepointException

resolveMapResult

public SharepointMapResult resolveMapResult(String url,
                                            org.apache.http.HttpEntity entity,
                                            boolean unwrapConfig)
                                     throws SharepointException

Specified by:

resolveMapResult in interface SharepointService

Throws:

SharepointException

getPage

public SharepointListItemResults getPage(String pageUrl)
                                  throws SharepointException

Specified by:

getPage in interface SharepointService

Throws:

SharepointException

init

public void init(org.apache.http.impl.client.CloseableHttpClient httpClient,
                 org.apache.http.protocol.HttpContext httpContext,
                 URL siteUrl)

Specified by:

init in interface SharepointService

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

getForObject

public <T> T getForObject(String path,
                          Class<T> clazz)
                   throws SharepointException

Specified by:

getForObject in interface SharepointService

Throws:

SharepointException

postForObject

protected <T> T postForObject(String path,
                              Object object,
                              Class<T> clazz)
                       throws SharepointException

Throws:

SharepointException

postForObject

protected <T> T postForObject(String path,
                              Object object,
                              Class<T> clazz,
                              Boolean withFormDigest)
                       throws SharepointException

Throws:

SharepointException

delete

protected void delete(String path)
               throws SharepointException

Throws:

SharepointException

update

protected <T> T update(String path,
                       Object updatedFields,
                       Class<T> clazz)
                throws SharepointException

Throws:

SharepointException

exchangeForObject

protected <T> T exchangeForObject(String path,
                                  org.springframework.http.HttpMethod method,
                                  org.springframework.http.HttpEntity<?> requestEntity,
                                  Class<T> clazz)
                           throws SharepointException

Throws:

SharepointException

getAbsoluteUri

protected URI getAbsoluteUri(String path)
                      throws SharepointException

Throws:

SharepointException