com.files.models.History Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of files-sdk Show documentation
Show all versions of files-sdk Show documentation
The Files.com Java client library provides convenient access to the Files.com API from JVM based applications.
package com.files.models;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.MapperFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.ObjectReader;
import com.fasterxml.jackson.databind.json.JsonMapper;
import com.files.FilesClient;
import com.files.FilesConfig;
import com.files.net.HttpMethods.RequestMethods;
import com.files.util.FilesInputStream;
import com.files.util.ModelUtils;
import java.io.BufferedInputStream;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.URI;
import java.net.URISyntaxException;
import java.util.Date;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import lombok.Getter;
import lombok.Setter;
@JsonIgnoreProperties(ignoreUnknown = true)
public class History {
private HashMap options;
private ObjectMapper objectMapper = JsonMapper
.builder()
.disable(MapperFeature.CAN_OVERRIDE_ACCESS_MODIFIERS)
.build();
public History() {
this(null, null);
}
public History(HashMap parameters) {
this(parameters, null);
}
public History(HashMap parameters, HashMap options) {
this.options = options;
try {
ObjectReader objectReader = objectMapper.readerForUpdating(this);
objectReader.readValue(objectMapper.writeValueAsString(parameters));
} catch (JsonProcessingException e) {
// TODO: error generation on constructor
}
}
/**
* Action ID
*/
@Getter
@JsonProperty("id")
public Long id;
/**
* Path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
*/
@Getter
@JsonProperty("path")
public String path;
/**
* Action occurrence date/time
*/
@Getter
@JsonProperty("when")
public Date when;
/**
* The destination path for this action, if applicable
*/
@Getter
@JsonProperty("destination")
public String destination;
/**
* Friendly displayed output
*/
@Getter
@JsonProperty("display")
public String display;
/**
* IP Address that performed this action
*/
@Getter
@JsonProperty("ip")
public String ip;
/**
* The source path for this action, if applicable
*/
@Getter
@JsonProperty("source")
public String source;
/**
* Targets
*/
@Getter
@JsonProperty("targets")
public Object[] targets;
/**
* User ID
*/
@Getter
@JsonProperty("user_id")
public Long userId;
/**
* Username
*/
@Getter
@JsonProperty("username")
public String username;
/**
* Type of action
*/
@Getter
@JsonProperty("action")
public String action;
/**
* Failure type. If action was a user login or session failure, why did it fail?
*/
@Getter
@JsonProperty("failure_type")
public String failureType;
/**
* Interface on which this action occurred.
*/
@Getter
@JsonProperty("interface")
public String interfaceName;
/**
* Parameters:
* start_at - string - Leave blank or set to a date/time to filter earlier entries.
* end_at - string - Leave blank or set to a date/time to filter later entries.
* display - string - Display format. Leave blank or set to `full` or `parent`.
* cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
* per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
* sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[user_id]=desc`). Valid fields are `user_id` and `created_at`.
* path (required) - string - Path to operate on.
*/
public static List listForFile() throws IOException {
return listForFile(null, null, null);
}
public static List listForFile(String path, HashMap parameters) throws IOException {
return listForFile(path, parameters, null);
}
public static List listForFile(HashMap parameters, HashMap options) throws IOException {
return listForFile(null, parameters, options);
}
public static List listForFile(String path, HashMap parameters, HashMap options) throws IOException {
parameters = parameters != null ? parameters : new HashMap();
options = options != null ? options : new HashMap();
if (path == null && parameters.containsKey("path") && parameters.get("path") != null) {
path = (String) parameters.get("path");
}
if (parameters.containsKey("start_at") && !(parameters.get("start_at") instanceof String)) {
throw new IllegalArgumentException("Bad parameter: start_at must be of type String parameters[\"start_at\"]");
}
if (parameters.containsKey("end_at") && !(parameters.get("end_at") instanceof String)) {
throw new IllegalArgumentException("Bad parameter: end_at must be of type String parameters[\"end_at\"]");
}
if (parameters.containsKey("display") && !(parameters.get("display") instanceof String)) {
throw new IllegalArgumentException("Bad parameter: display must be of type String parameters[\"display\"]");
}
if (parameters.containsKey("cursor") && !(parameters.get("cursor") instanceof String)) {
throw new IllegalArgumentException("Bad parameter: cursor must be of type String parameters[\"cursor\"]");
}
if (parameters.containsKey("per_page") && !(parameters.get("per_page") instanceof Long)) {
throw new IllegalArgumentException("Bad parameter: per_page must be of type Long parameters[\"per_page\"]");
}
if (parameters.containsKey("sort_by") && !(parameters.get("sort_by") instanceof Map)) {
throw new IllegalArgumentException("Bad parameter: sort_by must be of type Map parameters[\"sort_by\"]");
}
if (!(path instanceof String)) {
throw new IllegalArgumentException("Bad parameter: path must be of type String parameters[\"path\"]");
}
if (path == null) {
throw new NullPointerException("Argument or Parameter missing: path parameters[\"path\"]");
}
String urlParts[] = {FilesConfig.getInstance().getApiRoot(), FilesConfig.getInstance().getApiBase(), path};
for (int i = 2; i < urlParts.length; i++) {
try {
urlParts[i] = new URI(null, null, urlParts[i], null).getRawPath();
} catch (URISyntaxException ex) {
// NOOP
}
}
String url = String.format("%s%s/history/files/%s", urlParts);
TypeReference> typeReference = new TypeReference>() {};
return FilesClient.requestList(url, RequestMethods.GET, typeReference, parameters, options);
}
/**
* Parameters:
* start_at - string - Leave blank or set to a date/time to filter earlier entries.
* end_at - string - Leave blank or set to a date/time to filter later entries.
* display - string - Display format. Leave blank or set to `full` or `parent`.
* cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
* per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
* sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[user_id]=desc`). Valid fields are `user_id` and `created_at`.
* path (required) - string - Path to operate on.
*/
public static List listForFolder() throws IOException {
return listForFolder(null, null, null);
}
public static List listForFolder(String path, HashMap parameters) throws IOException {
return listForFolder(path, parameters, null);
}
public static List listForFolder(HashMap parameters, HashMap options) throws IOException {
return listForFolder(null, parameters, options);
}
public static List listForFolder(String path, HashMap parameters, HashMap options) throws IOException {
parameters = parameters != null ? parameters : new HashMap();
options = options != null ? options : new HashMap();
if (path == null && parameters.containsKey("path") && parameters.get("path") != null) {
path = (String) parameters.get("path");
}
if (parameters.containsKey("start_at") && !(parameters.get("start_at") instanceof String)) {
throw new IllegalArgumentException("Bad parameter: start_at must be of type String parameters[\"start_at\"]");
}
if (parameters.containsKey("end_at") && !(parameters.get("end_at") instanceof String)) {
throw new IllegalArgumentException("Bad parameter: end_at must be of type String parameters[\"end_at\"]");
}
if (parameters.containsKey("display") && !(parameters.get("display") instanceof String)) {
throw new IllegalArgumentException("Bad parameter: display must be of type String parameters[\"display\"]");
}
if (parameters.containsKey("cursor") && !(parameters.get("cursor") instanceof String)) {
throw new IllegalArgumentException("Bad parameter: cursor must be of type String parameters[\"cursor\"]");
}
if (parameters.containsKey("per_page") && !(parameters.get("per_page") instanceof Long)) {
throw new IllegalArgumentException("Bad parameter: per_page must be of type Long parameters[\"per_page\"]");
}
if (parameters.containsKey("sort_by") && !(parameters.get("sort_by") instanceof Map)) {
throw new IllegalArgumentException("Bad parameter: sort_by must be of type Map parameters[\"sort_by\"]");
}
if (!(path instanceof String)) {
throw new IllegalArgumentException("Bad parameter: path must be of type String parameters[\"path\"]");
}
if (path == null) {
throw new NullPointerException("Argument or Parameter missing: path parameters[\"path\"]");
}
String urlParts[] = {FilesConfig.getInstance().getApiRoot(), FilesConfig.getInstance().getApiBase(), path};
for (int i = 2; i < urlParts.length; i++) {
try {
urlParts[i] = new URI(null, null, urlParts[i], null).getRawPath();
} catch (URISyntaxException ex) {
// NOOP
}
}
String url = String.format("%s%s/history/folders/%s", urlParts);
TypeReference> typeReference = new TypeReference>() {};
return FilesClient.requestList(url, RequestMethods.GET, typeReference, parameters, options);
}
/**
* Parameters:
* start_at - string - Leave blank or set to a date/time to filter earlier entries.
* end_at - string - Leave blank or set to a date/time to filter later entries.
* display - string - Display format. Leave blank or set to `full` or `parent`.
* cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
* per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
* sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[user_id]=desc`). Valid fields are `user_id` and `created_at`.
* user_id (required) - int64 - User ID.
*/
public static List listForUser() throws IOException {
return listForUser(null, null, null);
}
public static List listForUser(Long user_id, HashMap parameters) throws IOException {
return listForUser(user_id, parameters, null);
}
public static List listForUser(HashMap parameters, HashMap options) throws IOException {
return listForUser(null, parameters, options);
}
public static List listForUser(Long user_id, HashMap parameters, HashMap options) throws IOException {
parameters = parameters != null ? parameters : new HashMap();
options = options != null ? options : new HashMap();
if (user_id == null && parameters.containsKey("user_id") && parameters.get("user_id") != null) {
user_id = (Long) parameters.get("user_id");
}
if (parameters.containsKey("start_at") && !(parameters.get("start_at") instanceof String)) {
throw new IllegalArgumentException("Bad parameter: start_at must be of type String parameters[\"start_at\"]");
}
if (parameters.containsKey("end_at") && !(parameters.get("end_at") instanceof String)) {
throw new IllegalArgumentException("Bad parameter: end_at must be of type String parameters[\"end_at\"]");
}
if (parameters.containsKey("display") && !(parameters.get("display") instanceof String)) {
throw new IllegalArgumentException("Bad parameter: display must be of type String parameters[\"display\"]");
}
if (parameters.containsKey("cursor") && !(parameters.get("cursor") instanceof String)) {
throw new IllegalArgumentException("Bad parameter: cursor must be of type String parameters[\"cursor\"]");
}
if (parameters.containsKey("per_page") && !(parameters.get("per_page") instanceof Long)) {
throw new IllegalArgumentException("Bad parameter: per_page must be of type Long parameters[\"per_page\"]");
}
if (parameters.containsKey("sort_by") && !(parameters.get("sort_by") instanceof Map)) {
throw new IllegalArgumentException("Bad parameter: sort_by must be of type Map parameters[\"sort_by\"]");
}
if (!(user_id instanceof Long)) {
throw new IllegalArgumentException("Bad parameter: user_id must be of type Long parameters[\"user_id\"]");
}
if (user_id == null) {
throw new NullPointerException("Argument or Parameter missing: user_id parameters[\"user_id\"]");
}
String urlParts[] = {FilesConfig.getInstance().getApiRoot(), FilesConfig.getInstance().getApiBase(), String.valueOf(user_id)};
for (int i = 2; i < urlParts.length; i++) {
try {
urlParts[i] = new URI(null, null, urlParts[i], null).getRawPath();
} catch (URISyntaxException ex) {
// NOOP
}
}
String url = String.format("%s%s/history/users/%s", urlParts);
TypeReference> typeReference = new TypeReference>() {};
return FilesClient.requestList(url, RequestMethods.GET, typeReference, parameters, options);
}
/**
* Parameters:
* start_at - string - Leave blank or set to a date/time to filter earlier entries.
* end_at - string - Leave blank or set to a date/time to filter later entries.
* display - string - Display format. Leave blank or set to `full` or `parent`.
* cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
* per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
* sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[user_id]=desc`). Valid fields are `user_id` and `created_at`.
*/
public static List listLogins() throws IOException {
return listLogins(null, null);
}
public static List listLogins(HashMap parameters) throws IOException {
return listLogins(parameters, null);
}
public static List listLogins(HashMap parameters, HashMap options) throws IOException {
parameters = parameters != null ? parameters : new HashMap();
options = options != null ? options : new HashMap();
if (parameters.containsKey("start_at") && !(parameters.get("start_at") instanceof String)) {
throw new IllegalArgumentException("Bad parameter: start_at must be of type String parameters[\"start_at\"]");
}
if (parameters.containsKey("end_at") && !(parameters.get("end_at") instanceof String)) {
throw new IllegalArgumentException("Bad parameter: end_at must be of type String parameters[\"end_at\"]");
}
if (parameters.containsKey("display") && !(parameters.get("display") instanceof String)) {
throw new IllegalArgumentException("Bad parameter: display must be of type String parameters[\"display\"]");
}
if (parameters.containsKey("cursor") && !(parameters.get("cursor") instanceof String)) {
throw new IllegalArgumentException("Bad parameter: cursor must be of type String parameters[\"cursor\"]");
}
if (parameters.containsKey("per_page") && !(parameters.get("per_page") instanceof Long)) {
throw new IllegalArgumentException("Bad parameter: per_page must be of type Long parameters[\"per_page\"]");
}
if (parameters.containsKey("sort_by") && !(parameters.get("sort_by") instanceof Map)) {
throw new IllegalArgumentException("Bad parameter: sort_by must be of type Map parameters[\"sort_by\"]");
}
String url = String.format("%s%s/history/login", FilesConfig.getInstance().getApiRoot(), FilesConfig.getInstance().getApiBase());
TypeReference> typeReference = new TypeReference>() {};
return FilesClient.requestList(url, RequestMethods.GET, typeReference, parameters, options);
}
/**
* Parameters:
* start_at - string - Leave blank or set to a date/time to filter earlier entries.
* end_at - string - Leave blank or set to a date/time to filter later entries.
* display - string - Display format. Leave blank or set to `full` or `parent`.
* cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
* per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
* sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[path]=desc`). Valid fields are `path`, `folder`, `user_id` or `created_at`.
* filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `user_id`, `folder` or `path`.
* filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `path`.
*/
public static List list() throws IOException {
return list(null, null);
}
public static List list(HashMap parameters) throws IOException {
return list(parameters, null);
}
public static List list(HashMap parameters, HashMap options) throws IOException {
parameters = parameters != null ? parameters : new HashMap();
options = options != null ? options : new HashMap();
if (parameters.containsKey("start_at") && !(parameters.get("start_at") instanceof String)) {
throw new IllegalArgumentException("Bad parameter: start_at must be of type String parameters[\"start_at\"]");
}
if (parameters.containsKey("end_at") && !(parameters.get("end_at") instanceof String)) {
throw new IllegalArgumentException("Bad parameter: end_at must be of type String parameters[\"end_at\"]");
}
if (parameters.containsKey("display") && !(parameters.get("display") instanceof String)) {
throw new IllegalArgumentException("Bad parameter: display must be of type String parameters[\"display\"]");
}
if (parameters.containsKey("cursor") && !(parameters.get("cursor") instanceof String)) {
throw new IllegalArgumentException("Bad parameter: cursor must be of type String parameters[\"cursor\"]");
}
if (parameters.containsKey("per_page") && !(parameters.get("per_page") instanceof Long)) {
throw new IllegalArgumentException("Bad parameter: per_page must be of type Long parameters[\"per_page\"]");
}
if (parameters.containsKey("sort_by") && !(parameters.get("sort_by") instanceof Map)) {
throw new IllegalArgumentException("Bad parameter: sort_by must be of type Map parameters[\"sort_by\"]");
}
if (parameters.containsKey("filter") && !(parameters.get("filter") instanceof Map)) {
throw new IllegalArgumentException("Bad parameter: filter must be of type Map parameters[\"filter\"]");
}
if (parameters.containsKey("filter_prefix") && !(parameters.get("filter_prefix") instanceof Map)) {
throw new IllegalArgumentException("Bad parameter: filter_prefix must be of type Map parameters[\"filter_prefix\"]");
}
String url = String.format("%s%s/history", FilesConfig.getInstance().getApiRoot(), FilesConfig.getInstance().getApiBase());
TypeReference> typeReference = new TypeReference>() {};
return FilesClient.requestList(url, RequestMethods.GET, typeReference, parameters, options);
}
public static List all() throws IOException {
return all(null, null);
}
public static List all(HashMap parameters, HashMap options) throws IOException {
return list(parameters, options);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy