com.anrisoftware.simplerest.owncloudocs.OwncloudOcsCreateShare Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of simplerest-owncloud-ocs Show documentation
Show all versions of simplerest-owncloud-ocs Show documentation
Access Owncloud OCS via REST API.
/*
* Copyright 2016 Erwin Müller
*
* This file is part of simplerest-owncloud-ocs.
*
* simplerest-owncloud-ocs is free software: you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by the
* Free Software Foundation, either version 3 of the License, or (at your
* option) any later version.
*
* simplerest-owncloud-ocs 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 Lesser General Public License
* along with simplerest-owncloud-ocs. If not, see
* Creates a new share.
*
*
*
* Usage example
*
*
*
* DefaultOwncloudAccountFactory accountFactory;
* account = accountFactory.create(new URI(account))
* OwncloudOcsCreateShareFactory createShareFactory;
* String path = "Public/test.txt";
* ShareType type = ShareType.link;
* OwncloudOcsCreateShare share = createShareFactory.create(account, path, type, shareWith, publicUpload, password, permissions);
* ShareResultMessage message = share.call();
*
*
*
* Usage example using pooling HTTP client.
*
*
*
* DefaultOwncloudAccountFactory accountFactory;
* account = accountFactory.create(new URI(account))
* PoolingHttpClientConnectionManager cm = new PoolingHttpClientConnectionManager();
* CloseableHttpClient httpclient = HttpClients.custom().setConnectionManager(cm).build();
*
* public void run() {
* OwncloudOcsCreateShareFactory createShareFactory;
* String path = "Public/test.txt";
* ShareType type = ShareType.link;
* OwncloudOcsCreateShare share = createShareFactory.create(account, path, type, shareWith, publicUpload, password, permissions, httpclient);
* ShareResultMessage message = share.call();
* }
*
*
* @author Erwin Müller, [email protected]
* @since 0.1
*/
public class OwncloudOcsCreateShare implements OwncloudCreateShare {
public interface OwncloudOcsCreateShareFactory {
/**
* Creates the new share.
*/
OwncloudOcsCreateShare create(@Assisted OwncloudAccount account,
@Assisted("path") String path, @Assisted ShareType type,
@Nullable @Assisted("shareWith") String shareWith,
@Nullable Boolean publicUpload,
@Nullable @Assisted("password") String password,
@Nullable Integer permissions);
/**
* Creates the new share using the specified pooling HTTP client.
*/
OwncloudOcsCreateShare create(@Assisted OwncloudAccount account,
@Assisted("path") String path, @Assisted ShareType type,
@Nullable @Assisted("shareWith") String shareWith,
@Nullable Boolean publicUpload,
@Nullable @Assisted("password") String password,
@Nullable Integer permissions,
@Assisted @Nullable CloseableHttpClient httpClient);
}
private final OwncloudAccount account;
private final String path;
private final ShareType type;
private final String shareWith;
private final Boolean publicUpload;
private final String password;
private final Integer permissions;
@Inject
private OwncloudOcsPropertiesProvider propertiesProvider;
@Inject
private SimplePostWorkerFactory simpleWorkerFactory;
@Inject
private ShareResultParseJsonResponse parseResponse;
@Inject
private NopParseResponse nopParseResponse;
private CloseableHttpClient httpClient;
@AssistedInject
OwncloudOcsCreateShare(@Assisted OwncloudAccount account,
@Assisted("path") String path, @Assisted ShareType type,
@Assisted("shareWith") @Nullable String shareWith,
@Assisted @Nullable Boolean publicUpload,
@Assisted("password") @Nullable String password,
@Assisted @Nullable Integer permissions) {
this(account, path, type, shareWith, publicUpload, password,
permissions, null);
}
@AssistedInject
OwncloudOcsCreateShare(@Assisted OwncloudAccount account,
@Assisted("path") String path, @Assisted ShareType type,
@Assisted("shareWith") @Nullable String shareWith,
@Assisted @Nullable Boolean publicUpload,
@Assisted("password") @Nullable String password,
@Assisted @Nullable Integer permissions,
@Assisted @Nullable CloseableHttpClient httpClient) {
this.httpClient = httpClient;
this.account = account;
this.path = path;
this.type = type;
this.shareWith = shareWith;
this.publicUpload = publicUpload;
this.password = password;
this.permissions = permissions;
}
public void setHttpClient(CloseableHttpClient httpClient) {
this.httpClient = httpClient;
}
@Override
public OwncloudAccount getAccount() {
return account;
}
@Override
public String getPath() {
return path;
}
@Override
public ShareType getType() {
return type;
}
@Override
public String getShareWith() {
return shareWith;
}
@Override
public Boolean isPublicUpload() {
return publicUpload;
}
@Override
public String getPassword() {
return password;
}
@Override
public Integer getPermissions() {
return permissions;
}
@Override
public ShareResultMessage call() throws SimpleRestException {
return sendRequest();
}
private ShareResultMessage sendRequest() throws SimpleRestException {
URI requestUri = getRequestURI();
SimplePostWorker requestWorker = simpleWorkerFactory.create(this,
requestUri, getAccount(), httpClient, parseResponse,
nopParseResponse);
requestWorker.addHeader("OCS-APIREQUEST", "true");
List postParameters = createPostParameters();
@SuppressWarnings("unchecked")
HttpEntity postParametersEntry = requestWorker
.createPostParametersEntity(postParameters);
ShareResultMessage data = (ShareResultMessage) requestWorker
.sendData(postParametersEntry);
return data;
}
private List createPostParameters() {
List list = new ArrayList();
list.add(new BasicNameValuePair("path", path));
list.add(new BasicNameValuePair("shareType", getTypeInt()));
if (permissions != null) {
list.add(new BasicNameValuePair("permissions", Integer
.toString(permissions)));
}
switch (type) {
case user:
case group:
list.add(new BasicNameValuePair("shareWith", shareWith));
break;
case link:
if (publicUpload != null) {
list.add(new BasicNameValuePair("publicUpload", Boolean
.toString(publicUpload)));
}
if (password != null) {
list.add(new BasicNameValuePair("password", password));
}
break;
default:
break;
}
return list;
}
private String getTypeInt() {
switch (type) {
case user:
return "0";
case group:
return "1";
case link:
return "3";
case cloud:
return "6";
}
return null;
}
private URI getRequestURI() throws BadRequestURIException {
try {
return getRequestURI0();
} catch (URISyntaxException e) {
throw new BadRequestURIException(e);
}
}
private URI getRequestURI0() throws URISyntaxException {
URI baseUri = account.getBaseUri();
String extraPath = baseUri.getPath();
URIBuilder builder = new URIBuilder(baseUri);
builder.setUserInfo(account.getUser(), account.getPassword());
addParameters(builder);
String statusPath = String.format("%s%s", extraPath,
propertiesProvider.getOwncloudSharesPath());
builder.setPath(statusPath);
return builder.build();
}
private void addParameters(URIBuilder builder) {
builder.addParameter("format", "json");
}
}