com.box.sdk.BoxSharedLink Maven / Gradle / Ivy
package com.box.sdk;
import com.eclipsesource.json.JsonObject;
import com.eclipsesource.json.JsonValue;
import java.util.Date;
/**
* Represents a link to a file or folder on Box.
*/
public class BoxSharedLink extends BoxJSONObject {
private String url;
private String downloadUrl;
private String vanityUrl;
private String vanityName;
private boolean isPasswordEnabled;
private String password;
private Date unsharedAt;
private long downloadCount;
private long previewCount;
private Access access;
private Access effectiveAccess;
private Permissions permissions;
/**
* Constructs a BoxSharedLink with default settings.
*/
public BoxSharedLink() {
}
/**
* Constructs a BoxSharedLink from a JSON string.
*
* @param json the JSON encoded shared link.
*/
public BoxSharedLink(String json) {
super(json);
}
BoxSharedLink(JsonObject jsonObject) {
super(jsonObject);
}
BoxSharedLink(BoxSharedLink.Access access, Date unshareDate, BoxSharedLink.Permissions permissions) {
this.setAccess(access);
this.setPermissions(permissions);
if (unshareDate != null) {
this.setUnsharedDate(unshareDate);
}
}
BoxSharedLink(BoxSharedLink.Access access, Date unshareDate, BoxSharedLink.Permissions permissions,
String password) {
this.setAccess(access);
this.setPermissions(permissions);
this.setPassword(password);
if (unshareDate != null) {
this.setUnsharedDate(unshareDate);
}
}
/**
* Get the URL of this shared link.
*
* @return the URL of this shared link.
*/
public String getURL() {
return this.url;
}
/**
* Gets the direct download URL of this shared link.
*
* @return the direct download URL of this shared link.
*/
public String getDownloadURL() {
return this.downloadUrl;
}
/**
* Gets the vanity URL of this shared link.
*
* @return the vanity URL of this shared link.
*/
public String getVanityURL() {
return this.vanityUrl;
}
/**
* Returns vanity name used to create vanity URL.
*
* @return Vanity name
*/
public String getVanityName() {
return vanityName;
}
/**
* Sets vanity name used to create vanity URL.
* For example:
* vanityName = myCustomName
* will produce vanityUrl as:
* https://app.box.com/v/myCustomName
* Custom URLs should not be used when sharing sensitive content
* as vanity URLs are a lot easier to guess than regular shared links.
*
* @param vanityName Vanity name. Vanity name must be at least 12 characters long.
*/
public void setVanityName(String vanityName) {
if (vanityName != null && vanityName.length() < 12) {
throw new IllegalArgumentException("The vanityName has to be at least 12 characters long.");
}
this.vanityName = vanityName;
this.addPendingChange("vanity_name", vanityName);
}
/**
* Gets whether or not a password is enabled on this shared link.
*
* @return true if there's a password enabled on this shared link; otherwise false.
*/
public boolean getIsPasswordEnabled() {
return this.isPasswordEnabled;
}
/**
* Gets the time that this shared link will be deactivated.
*
* @return the time that this shared link will be deactivated.
*/
public Date getUnsharedDate() {
return this.unsharedAt;
}
/**
* Sets the time that this shared link will be deactivated.
*
* @param unsharedDate the time that this shared link will be deactivated.
*/
public void setUnsharedDate(Date unsharedDate) {
this.unsharedAt = unsharedDate;
this.addPendingChange("unshared_at", BoxDateFormat.format(unsharedDate));
}
/**
* Gets the number of times that this shared link has been downloaded.
*
* @return the number of times that this link has been downloaded.
*/
public long getDownloadCount() {
return this.downloadCount;
}
/**
* Gets the number of times that this shared link has been previewed.
*
* @return the number of times that this link has been previewed.
*/
public long getPreviewCount() {
return this.previewCount;
}
/**
* Gets the access level of this shared link.
*
* @return the access level of this shared link.
*/
public Access getAccess() {
return this.access;
}
/**
* Sets the access level of this shared link.
*
* @param access the new access level of this shared link.
*/
public void setAccess(Access access) {
this.access = access;
this.addPendingChange("access", access.toJSONValue());
}
/**
* Sets the password of this shared link.
*
* @param password the password of this shared link.
*/
public void setPassword(String password) {
this.password = password;
this.addPendingChange("password", password);
}
/**
* Gets the effective access level of this shared link.
*
* @return the effective access level of this shared link.
*
* Note there is no setEffectiveAccess metho becaused this
* cannot be changed via the API
*/
public Access getEffectiveAccess() {
return this.effectiveAccess;
}
/**
* Gets the permissions associated with this shared link.
*
* @return the permissions associated with this shared link.
*/
public Permissions getPermissions() {
return this.permissions;
}
/**
* Sets the permissions associated with this shared link.
*
* @param permissions the new permissions for this shared link.
*/
public void setPermissions(Permissions permissions) {
if (this.permissions != null && this.permissions.equals(permissions)) {
return;
}
this.removeChildObject("permissions");
this.permissions = permissions;
this.addChildObject("permissions", permissions);
}
private Access parseAccessValue(JsonValue value) {
String accessString = value.asString().toUpperCase();
return Access.valueOf(accessString);
}
@Override
void parseJSONMember(JsonObject.Member member) {
JsonValue value = member.getValue();
String memberName = member.getName();
try {
if (memberName.equals("url")) {
this.url = value.asString();
} else if (memberName.equals("download_url")) {
this.downloadUrl = value.asString();
} else if (memberName.equals("vanity_url")) {
this.vanityUrl = value.asString();
} else if (memberName.equals("vanity_name")) {
this.vanityName = value.asString();
} else if (memberName.equals("is_password_enabled")) {
this.isPasswordEnabled = value.asBoolean();
} else if (memberName.equals("unshared_at")) {
this.unsharedAt = BoxDateFormat.parse(value.asString());
} else if (memberName.equals("download_count")) {
this.downloadCount = Double.valueOf(value.toString()).longValue();
} else if (memberName.equals("preview_count")) {
this.previewCount = Double.valueOf(value.toString()).longValue();
} else if (memberName.equals("access")) {
this.access = this.parseAccessValue(value);
} else if (memberName.equals("effective_access")) {
this.effectiveAccess = this.parseAccessValue(value);
} else if (memberName.equals("permissions")) {
if (this.permissions == null) {
this.setPermissions(new Permissions(value.asObject()));
} else {
this.permissions.update(value.asObject());
}
}
} catch (Exception e) {
throw new BoxDeserializationException(memberName, value.toString(), e);
}
}
/**
* Enumerates the possible access levels that can be set on a shared link.
*/
public enum Access {
/**
* The default access level for the user or enterprise.
*/
DEFAULT(null),
/**
* The link can be accessed by anyone.
*/
OPEN("open"),
/**
* The link can be accessed by other users within the company.
*/
COMPANY("company"),
/**
* The link can be accessed by other collaborators.
*/
COLLABORATORS("collaborators");
private final String jsonValue;
Access(String jsonValue) {
this.jsonValue = jsonValue;
}
String toJSONValue() {
return this.jsonValue;
}
}
/**
* Contains permissions fields that can be set on a shared link.
*/
public static class Permissions extends BoxJSONObject {
private boolean canDownload;
private boolean canPreview;
private boolean canEdit;
/**
* Constructs a Permissions object with all permissions disabled.
*/
public Permissions() {
}
Permissions(boolean canPreview, boolean canDownload, boolean canEdit) {
this.setCanPreview(canPreview);
this.setCanDownload(canDownload);
this.setCanEdit(canEdit);
}
/**
* Constructs a Permissions object from a JSON string.
*
* @param json the JSON encoded shared link permissions.
*/
public Permissions(String json) {
super(json);
}
Permissions(JsonObject jsonObject) {
super(jsonObject);
}
/**
* Gets whether the shared link can be downloaded.
*
* @return true if the shared link can be downloaded; otherwise false.
*/
public boolean getCanDownload() {
return this.canDownload;
}
/**
* Sets whether or not the shared link can be downloaded.
*
* @param enabled true if the shared link can be downloaded; otherwise false.
*/
public void setCanDownload(boolean enabled) {
this.canDownload = enabled;
this.addPendingChange("can_download", enabled);
}
/**
* Gets whether the shared link can be previewed.
*
* @return true if the shared link can be previewed; otherwise false.
*/
public boolean getCanPreview() {
return this.canPreview;
}
/**
* Sets whether the shared link can be previewed.
*
* @param enabled true if the shared link can be previewed; otherwise false.
*/
public void setCanPreview(boolean enabled) {
this.canPreview = enabled;
this.addPendingChange("can_preview", enabled);
}
/**
* Gets whether the shared link allows for editing of files.
*
* @return true if the shared link allows for editing of files; otherwise false.
*/
public boolean getCanEdit() {
return canEdit;
}
/**
* Sets whether the shared link allows for editing of files.
* For folders this value will always be set to false.
*
* @param enabled true if the shared link allows for editing of files; otherwise false.
*/
public void setCanEdit(boolean enabled) {
this.canEdit = enabled;
this.addPendingChange("can_edit", enabled);
}
@Override
void parseJSONMember(JsonObject.Member member) {
JsonValue value = member.getValue();
String memberName = member.getName();
if (memberName.equals("can_download")) {
this.canDownload = value.asBoolean();
}
if (memberName.equals("can_preview")) {
this.canPreview = value.asBoolean();
}
if (memberName.equals("can_edit")) {
this.canEdit = value.asBoolean();
}
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || this.getClass() != o.getClass()) {
return false;
}
Permissions that = (Permissions) o;
return this.canDownload == that.canDownload
&& this.canPreview == that.canPreview
&& this.canEdit == that.canEdit;
}
@Override
public int hashCode() {
int result = (this.canDownload ? 1 : 0);
result = 31 * result + (this.canPreview ? 1 : 0);
result = 31 * result + (this.canEdit ? 1 : 0);
return result;
}
@Override
public String toString() {
return "Permissions{canDownload=" + this.canDownload
+ ", canPreview=" + this.canPreview
+ ", canEdit=" + this.canEdit
+ '}';
}
}
}