com.microsoft.services.sharepoint

Class DocLibClient

java.lang.Object

com.microsoft.services.sharepoint.OfficeClient

com.microsoft.services.sharepoint.SharePointClient

com.microsoft.services.sharepoint.DocLibClient

public class DocLibClient
extends SharePointClient

The Class DocLibClient.

Constructor Summary

Constructors

Constructor and Description
DocLibClient(java.lang.String serverUrl, java.lang.String siteRelativeUrl, Credentials credentials) Instantiates a new file API client.
DocLibClient(java.lang.String serverUrl, java.lang.String siteRelativeUrl, Credentials credentials, Logger logger) Instantiates a new file client.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.common.util.concurrent.ListenableFuture<java.lang.Void>	copy(java.lang.String sourcePath, java.lang.String destinationPath, boolean overwrite) Copies an item from the given sourcePath to the given destinationPath.
com.google.common.util.concurrent.ListenableFuture<java.lang.Void>	copy(java.lang.String sourcePath, java.lang.String destinationPath, boolean overwrite, java.lang.String library) Copies an item from the given sourcePath to the given destinationPath.
com.google.common.util.concurrent.ListenableFuture<FileSystemItem>	createFile(java.lang.String fileName) Creates an empty file.
com.google.common.util.concurrent.ListenableFuture<FileSystemItem>	createFile(java.lang.String fileName, boolean overwrite, byte[] content) Creates the file with a given file name and content
com.google.common.util.concurrent.ListenableFuture<FileSystemItem>	createFile(java.lang.String fileName, java.lang.String library) Creates an empty file.
com.google.common.util.concurrent.ListenableFuture<FileSystemItem>	createFile(java.lang.String fileName, java.lang.String library, boolean overwrite, byte[] content) Creates a file with a given path inside a given library
com.google.common.util.concurrent.ListenableFuture<FileSystemItem>	createFolder(java.lang.String path) Creates the folder with a given path
com.google.common.util.concurrent.ListenableFuture<FileSystemItem>	createFolder(java.lang.String path, java.lang.String library) Creates a folder with a given path and library
com.google.common.util.concurrent.ListenableFuture<java.lang.Void>	delete(java.lang.String path) Delete a file/folder with a given path
com.google.common.util.concurrent.ListenableFuture<java.lang.Void>	delete(java.lang.String path, java.lang.String library) Deletes a file/folder with a given path and library
com.google.common.util.concurrent.ListenableFuture<byte[]>	getFile(java.lang.String path) Gets the file.
com.google.common.util.concurrent.ListenableFuture<byte[]>	getFile(java.lang.String path, java.lang.String library) Gets the file.
com.google.common.util.concurrent.ListenableFuture<FileSystemItem>	getFileSystemItem(java.lang.String path)
com.google.common.util.concurrent.ListenableFuture<FileSystemItem>	getFileSystemItem(java.lang.String path, java.lang.String library) Get a FileSystemItem from a path in a document library
com.google.common.util.concurrent.ListenableFuture<java.util.List<FileSystemItem>>	getFileSystemItems() Gets a list of FileSystemItem from the default Document Library
com.google.common.util.concurrent.ListenableFuture<java.util.List<FileSystemItem>>	getFileSystemItems(java.lang.String path, java.lang.String library) Gets children folder with a given path
com.google.common.util.concurrent.ListenableFuture<java.lang.Object>	getProperty(java.lang.String property, java.lang.String path) Gets the value of a given property with a given path
com.google.common.util.concurrent.ListenableFuture<java.lang.Object>	getProperty(java.lang.String property, java.lang.String path, java.lang.String library) Retrieves the value of property with a given path and library
com.google.common.util.concurrent.ListenableFuture<java.lang.Void>	move(java.lang.String sourcePath, java.lang.String destinationPath, boolean overwrite) Moves an item from the given sourcePath to the given destinationPath.
com.google.common.util.concurrent.ListenableFuture<java.lang.Void>	move(java.lang.String sourcePath, java.lang.String destinationPath, boolean overwrite, java.lang.String library) Moves an item from the given sourcePath to the given destinationPath.

Methods inherited from class com.microsoft.services.sharepoint.SharePointClient

executeRequestJsonWithDigest, getFormDigest, getServerUrl, getSiteRelativeUrl, getSiteUrl, getUserByID, getWebTitle

Methods inherited from class com.microsoft.services.sharepoint.OfficeClient

executeRequest, executeRequest, executeRequestJson, executeRequestJson, generateODataQueryString, getCredentials, getDiscoveryInfo, getDiscoveryInfo, getLogger, isValidStatus, log, log, prepareRequest, queryEncode, urlEncode, UUIDtoString

Methods inherited from class java.lang.Object

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

Constructor Detail

DocLibClient

public DocLibClient(java.lang.String serverUrl,
            java.lang.String siteRelativeUrl,
            Credentials credentials)

Instantiates a new file API client.

Parameters:

serverUrl -

credentials -

DocLibClient

public DocLibClient(java.lang.String serverUrl,
            java.lang.String siteRelativeUrl,
            Credentials credentials,
            Logger logger)

Instantiates a new file client.

Parameters:

serverUrl -

siteRelativeUrl -

credentials -

logger -

Method Detail

getFileSystemItems

public com.google.common.util.concurrent.ListenableFuture<java.util.List<FileSystemItem>> getFileSystemItems()

Gets a list of FileSystemItem from the default Document Library

Returns:

OfficeFuture>

getFileSystemItems

public com.google.common.util.concurrent.ListenableFuture<java.util.List<FileSystemItem>> getFileSystemItems(java.lang.String path,
                                                                                                    java.lang.String library)

Gets children folder with a given path

Parameters:

path -

Returns:

OfficeFuture

getFileSystemItem

public com.google.common.util.concurrent.ListenableFuture<FileSystemItem> getFileSystemItem(java.lang.String path)

getFileSystemItem

public com.google.common.util.concurrent.ListenableFuture<FileSystemItem> getFileSystemItem(java.lang.String path,
                                                                                   java.lang.String library)

Get a FileSystemItem from a path in a document library

Parameters:

library - the document library

path - the path

Returns:

OfficeFuture>

getProperty

public com.google.common.util.concurrent.ListenableFuture<java.lang.Object> getProperty(java.lang.String property,
                                                                               java.lang.String path,
                                                                               java.lang.String library)

Retrieves the value of property with a given path and library

Parameters:

property -

path -

library -

Returns:

getProperty

public com.google.common.util.concurrent.ListenableFuture<java.lang.Object> getProperty(java.lang.String property,
                                                                               java.lang.String path)

Gets the value of a given property with a given path

Parameters:

path -

property -

Returns:

OfficeFuture