org.mule.module.sharepoint.common.service

Interface SharepointService

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

OnlineSharepointService, OnpremiseSharepointService

public interface SharepointService
extends Closeable

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	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)
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)
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)
String	getWebId()
void	init(org.apache.http.impl.client.CloseableHttpClient client, org.apache.http.protocol.HttpContext context, URL siteUrl)
SharepointListItem	listItemAllFields(String fileRelativeUrl)
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)
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 interface java.io.Closeable

close

Method Detail

getWebId

String getWebId()
         throws SharepointException

Throws:

SharepointException

getFormDigestValue

String getFormDigestValue()
                   throws SharepointException

Throws:

SharepointException

getList

SharepointList getList(String id,
                       String query)
                throws SharepointException

Throws:

SharepointException

getListItems

SharepointListItemResults getListItems(String id,
                                       String query)
                                throws SharepointException

Throws:

SharepointException

getListItemById

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

Throws:

SharepointException

getListItems

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

Throws:

SharepointException

getLists

List<SharepointList> getLists(String query)
                       throws SharepointException

Throws:

SharepointException

getListFields

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

Throws:

SharepointException

deleteList

void deleteList(String id)
         throws SharepointException

Throws:

SharepointException

createList

SharepointList createList(SharepointList list)
                   throws SharepointException

Throws:

SharepointException

updateList

void updateList(String listId,
                SharepointList list)
         throws SharepointException

Throws:

SharepointException

createListItem

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

Throws:

SharepointException

deleteListItem

void deleteListItem(String listId,
                    String itemId)
             throws SharepointException

Throws:

SharepointException

attachFile

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

Throws:

SharepointException

updateListItem

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

Throws:

SharepointException

createFolder

SharepointFolder createFolder(SharepointFolder folder)
                       throws SharepointException

Throws:

SharepointException

getFolder

SharepointFolder getFolder(String serverRelativeUrl)
                    throws SharepointException

Throws:

SharepointException

listItemAllFields

SharepointListItem listItemAllFields(String fileRelativeUrl)
                              throws SharepointException

Throws:

SharepointException

deleteFolder

void deleteFolder(String serverRelativeUrl)
           throws SharepointException

Throws:

SharepointException

updateFolder

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

Throws:

SharepointException

queryFolders

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

Throws:

SharepointException

addBlob

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

Throws:

SharepointException

resolveMapResult

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

Throws:

SharepointException

getPage

SharepointListItemResults getPage(String pageUrl)
                           throws SharepointException

Throws:

SharepointException

addFile

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

Throws:

SharepointException

getFileMetadata

SharepointFile getFileMetadata(String filename,
                               String folderPath)
                        throws SharepointException

Throws:

SharepointException

getFileMetadata

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

Throws:

SharepointException

deleteFile

void deleteFile(String filename,
                String folderPath)
         throws SharepointException

Throws:

SharepointException

getFileContent

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

Throws:

SharepointException

checkoutFile

void checkoutFile(String filename,
                  String folderPath)
           throws SharepointException

Throws:

SharepointException

checkInFile

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

Throws:

SharepointException

undoCheckOut

void undoCheckOut(String filename,
                  String folderPath)
           throws SharepointException

Throws:

SharepointException

publishFile

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

Throws:

SharepointException

unpublishFile

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

Throws:

SharepointException

approveFile

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

Throws:

SharepointException

denyFile

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

Throws:

SharepointException

queryFile

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

Throws:

SharepointException

copyFileTo

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

Throws:

SharepointException

recycleFile

String recycleFile(String filename,
                   String folderPath)
            throws SharepointException

Throws:

SharepointException

resolveObject

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

Throws:

SharepointException

resolveCollection

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

Throws:

SharepointException

resolveCreate

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

Throws:

SharepointException

resolveUpdate

void resolveUpdate(String url,
                   Object body)
            throws SharepointException

Throws:

SharepointException

resolveDelete

void resolveDelete(String url)
            throws SharepointException

Throws:

SharepointException

resolvePost

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

Throws:

SharepointException

getAllItemFields

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

Throws:

SharepointException

updateFileMetadata

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

Throws:

SharepointException

init

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

getForObject

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

Throws:

SharepointException