org.aarboard.nextcloud.api.filesharing.FilesharingConnector Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of nextcloud-api Show documentation
Show all versions of nextcloud-api Show documentation
Java api library to access nextcloud features from java applications
The newest version!
/*
* Copyright (C) 2017 a.schild
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see getShares()
{
return getShares(null, false, false);
}
/**
* Get all shares of this user asynchronously
*
* @return a CompletableFuture containing the result of the operation
*/
public CompletableFuture getSharesAsync()
{
return getSharesAsync(null, false, false);
}
/**
* Gets all shares from a given file/folder
*
* @param path path to file/folder
* @param reShares returns not only the shares from the current user but all shares from the given file
* @param subShares returns all shares within a folder, given that path defines a folder
* @return matching shares
*/
public List getShares(String path, boolean reShares, boolean subShares)
{
return NextcloudResponseHelper.getAndCheckStatus(getSharesAsync(path,reShares,subShares)).getShares();
}
/**
* Gets all shares from a given file/folder asynchronously
*
* @param path path to file/folder
* @param reShares returns not only the shares from the current user but all shares from the given file
* @param subShares returns all shares within a folder, given that path defines a folder
* @return a CompletableFuture containing the result of the operation
*/
public CompletableFuture getSharesAsync(String path, boolean reShares, boolean subShares)
{
List queryParams= new LinkedList<>();
if (path != null)
{
queryParams.add(new BasicNameValuePair("path", path));
}
if (reShares)
{
queryParams.add(new BasicNameValuePair("reshares", "true"));
}
if (subShares)
{
queryParams.add(new BasicNameValuePair("subfiles", "true"));
}
return connectorCommon.executeGet(SHARES_PART, queryParams, XMLAnswerParser.getInstance(SharesXMLAnswer.class));
}
/**
* Get share info for a single share
*
* @param shareId id of share (Not path of share)
* @return the share if it has been found, otherwise null
*/
public Share getShareInfo(int shareId)
{
SharesXMLAnswer xa= NextcloudResponseHelper.getAndCheckStatus(getShareInfoAsync(shareId));
if (xa.getShares() == null)
{
return null;
}
else if (xa.getShares().size() == 1)
{
return xa.getShares().get(0);
}
throw new MoreThanOneShareFoundException(shareId);
}
/**
* Get share info for a single share asynchronously
*
* @param shareId id of share (Not path of share)
* @return a CompletableFuture containing the result of the operation
*/
public CompletableFuture getShareInfoAsync(int shareId)
{
return connectorCommon.executeGet(SHARES_PART+"/"+Integer.toString(shareId), null, XMLAnswerParser.getInstance(SharesXMLAnswer.class));
}
/**
* Shares the specified path with the provided parameters
*
* @param path path to the file/folder which should be shared
* @param shareType 0 = user; 1 = group; 3 = public link; 4 = email; 6 = federated cloud share
* @param shareWithUserOrGroupIdOrEmail user / group id / email with which the file should be shared
* @param publicUpload allow public upload to a public shared folder (true/false)
* @param password password to protect public link Share with
* @param permissions 1 = read; 2 = update; 4 = create; 8 = delete; 16 = share; 31 = all (default: 31, for public shares: 1)
* @return created share on success
*/
public Share doShare(
String path,
ShareType shareType,
String shareWithUserOrGroupIdOrEmail,
Boolean publicUpload,
String password,
SharePermissions permissions)
{
return NextcloudResponseHelper.getAndCheckStatus(doShareAsync(path, shareType, shareWithUserOrGroupIdOrEmail, publicUpload, password, permissions)).getShare();
}
/**
* Shares the specified path with the provided parameters asynchronously
*
* @param path path to the file/folder which should be shared
* @param shareType 0 = user; 1 = group; 3 = public link; 4 = email; 6 = federated cloud share
* @param shareWithUserOrGroupIdOrEmail user / group id / email with which the file should be shared
* @param publicUpload allow public upload to a public shared folder (true/false)
* @param password password to protect public link Share with
* @param permissions 1 = read; 2 = update; 4 = create; 8 = delete; 16 = share; 31 = all (default: 31, for public shares: 1)
* @return a CompletableFuture containing the result of the operation
*/
public CompletableFuture doShareAsync(
String path,
ShareType shareType,
String shareWithUserOrGroupIdOrEmail,
Boolean publicUpload,
String password,
SharePermissions permissions)
{
List postParams= new LinkedList<>();
postParams.add(new BasicNameValuePair("path", path));
postParams.add(new BasicNameValuePair("shareType", Integer.toString(shareType.getIntValue())));
postParams.add(new BasicNameValuePair("shareWith", shareWithUserOrGroupIdOrEmail));
if (publicUpload != null)
{
postParams.add(new BasicNameValuePair("publicUpload", publicUpload ? "true" : "false"));
}
if (password != null)
{
postParams.add(new BasicNameValuePair("password", password));
}
if (permissions != null)
{
postParams.add(new BasicNameValuePair("permissions", Integer.toString(permissions.getCurrentPermission())));
}
return connectorCommon.executePost(SHARES_PART, postParams, XMLAnswerParser.getInstance(SingleShareXMLAnswer.class));
}
/**
* Changes a single attribute of a share
*
* @param shareId unique identifier of the share
* @param key the attribute to change
* @param value the value to set
* @return true if the operation succeeded
*/
public boolean editShare(int shareId, ShareData key, String value)
{
return NextcloudResponseHelper.isStatusCodeOkay(editShareAsync(shareId, key, value));
}
/**
* Changes a single attribute of a share asynchronously
*
* @param shareId unique identifier of the share
* @param key the attribute to change
* @param value the value to set
* @return a CompletableFuture containing the result of the operation
*/
public CompletableFuture editShareAsync(int shareId, ShareData key, String value)
{
List queryParams= Collections.singletonList(new BasicNameValuePair(key.parameterName, value));
return connectorCommon.executePut(SHARES_PART, Integer.toString(shareId), queryParams, XMLAnswerParser.getInstance(XMLAnswer.class));
}
/**
* Changes multiple attributes of a share at once
*
* @param shareId unique identifier of the share
* @param values a Map containing the attributes to set
* @return true if the operation succeeded
*/
public boolean editShare(int shareId, Map values)
{
return NextcloudResponseHelper.isStatusCodeOkay(editShareAsync(shareId, values));
}
/**
* Changes multiple attributes of a share at once asynchronously
*
* @param shareId unique identifier of the share
* @param values a Map containing the attributes to set
* @return a CompletableFuture containing the result of the operation
*/
public CompletableFuture editShareAsync(int shareId, Map values) {
List queryParams = values.entrySet().stream()
.map(e -> new BasicNameValuePair(e.getKey().parameterName, e.getValue())).collect(Collectors.toList());
return connectorCommon.executePut(SHARES_PART, Integer.toString(shareId), queryParams, XMLAnswerParser.getInstance(XMLAnswer.class));
}
/**
* Deletes a share
*
* @param shareId unique identifier of the share
* @return true if the operation succeeded
*/
public boolean deleteShare(int shareId)
{
return NextcloudResponseHelper.isStatusCodeOkay(deleteShareAsync(shareId));
}
/**
* Deletes a share asynchronously
*
* @param shareId unique identifier of the share
* @return a CompletableFuture containing the result of the operation
*/
public CompletableFuture deleteShareAsync(int shareId)
{
return connectorCommon.executeDelete(SHARES_PART, Integer.toString(shareId), null, XMLAnswerParser.getInstance(XMLAnswer.class));
}
}