Datasets:

---

CM

/

codexglue_code2text_java

like 4

[ "public", "static", "Iterable", "<", "BoxRetentionPolicy", ".", "Info", ">", "getAll", "(", "final", "BoxAPIConnection", "api", ",", "String", "...", "fields", ")", "{", "return", "getAll", "(", "null", ",", "null", ",", "null", ",", "DEFAULT_LIMIT", ",", "api", ",", "fields", ")", ";", "}" ]

[ "Returns", "all", "the", "retention", "policies", "." ]

[ "public", "static", "Iterable", "<", "BoxRetentionPolicy", ".", "Info", ">", "getAll", "(", "String", "name", ",", "String", "type", ",", "String", "userID", ",", "int", "limit", ",", "final", "BoxAPIConnection", "api", ",", "String", "...", "fields", ")", "{", "QueryStringBuilder", "queryString", "=", "new", "QueryStringBuilder", "(", ")", ";", "if", "(", "name", "!=", "null", ")", "{", "queryString", ".", "appendParam", "(", "\"policy_name\"", ",", "name", ")", ";", "}", "if", "(", "type", "!=", "null", ")", "{", "queryString", ".", "appendParam", "(", "\"policy_type\"", ",", "type", ")", ";", "}", "if", "(", "userID", "!=", "null", ")", "{", "queryString", ".", "appendParam", "(", "\"created_by_user_id\"", ",", "userID", ")", ";", "}", "if", "(", "fields", ".", "length", ">", "0", ")", "{", "queryString", ".", "appendParam", "(", "\"fields\"", ",", "fields", ")", ";", "}", "URL", "url", "=", "RETENTION_POLICIES_URL_TEMPLATE", ".", "buildWithQuery", "(", "api", ".", "getBaseURL", "(", ")", ",", "queryString", ".", "toString", "(", ")", ")", ";", "return", "new", "BoxResourceIterable", "<", "BoxRetentionPolicy", ".", "Info", ">", "(", "api", ",", "url", ",", "limit", ")", "{", "@", "Override", "protected", "BoxRetentionPolicy", ".", "Info", "factory", "(", "JsonObject", "jsonObject", ")", "{", "BoxRetentionPolicy", "policy", "=", "new", "BoxRetentionPolicy", "(", "api", ",", "jsonObject", ".", "get", "(", "\"id\"", ")", ".", "asString", "(", ")", ")", ";", "return", "policy", ".", "new", "Info", "(", "jsonObject", ")", ";", "}", "}", ";", "}" ]

[ "Returns", "all", "the", "retention", "policies", "with", "specified", "filters", "." ]

[ "public", "void", "start", "(", ")", "{", "if", "(", "this", ".", "started", ")", "{", "throw", "new", "IllegalStateException", "(", "\"Cannot start the EventStream because it isn't stopped.\"", ")", ";", "}", "final", "long", "initialPosition", ";", "if", "(", "this", ".", "startingPosition", "==", "STREAM_POSITION_NOW", ")", "{", "BoxAPIRequest", "request", "=", "new", "BoxAPIRequest", "(", "this", ".", "api", ",", "EVENT_URL", ".", "build", "(", "this", ".", "api", ".", "getBaseURL", "(", ")", ",", "\"now\"", ")", ",", "\"GET\"", ")", ";", "BoxJSONResponse", "response", "=", "(", "BoxJSONResponse", ")", "request", ".", "send", "(", ")", ";", "JsonObject", "jsonObject", "=", "JsonObject", ".", "readFrom", "(", "response", ".", "getJSON", "(", ")", ")", ";", "initialPosition", "=", "jsonObject", ".", "get", "(", "\"next_stream_position\"", ")", ".", "asLong", "(", ")", ";", "}", "else", "{", "assert", "this", ".", "startingPosition", ">=", "0", ":", "\"Starting position must be non-negative\"", ";", "initialPosition", "=", "this", ".", "startingPosition", ";", "}", "this", ".", "poller", "=", "new", "Poller", "(", "initialPosition", ")", ";", "this", ".", "pollerThread", "=", "new", "Thread", "(", "this", ".", "poller", ")", ";", "this", ".", "pollerThread", ".", "setUncaughtExceptionHandler", "(", "new", "Thread", ".", "UncaughtExceptionHandler", "(", ")", "{", "public", "void", "uncaughtException", "(", "Thread", "t", ",", "Throwable", "e", ")", "{", "EventStream", ".", "this", ".", "notifyException", "(", "e", ")", ";", "}", "}", ")", ";", "this", ".", "pollerThread", ".", "start", "(", ")", ";", "this", ".", "started", "=", "true", ";", "}" ]

[ "Starts", "this", "EventStream", "and", "begins", "long", "polling", "the", "API", "." ]

[ "protected", "boolean", "isDuplicate", "(", "String", "eventID", ")", "{", "if", "(", "this", ".", "receivedEvents", "==", "null", ")", "{", "this", ".", "receivedEvents", "=", "new", "LRUCache", "<", "String", ">", "(", ")", ";", "}", "return", "!", "this", ".", "receivedEvents", ".", "add", "(", "eventID", ")", ";", "}" ]

[ "Indicates", "whether", "or", "not", "an", "event", "ID", "is", "a", "duplicate", "." ]

[ "public", "static", "BoxRetentionPolicyAssignment", ".", "Info", "createAssignmentToEnterprise", "(", "BoxAPIConnection", "api", ",", "String", "policyID", ")", "{", "return", "createAssignment", "(", "api", ",", "policyID", ",", "new", "JsonObject", "(", ")", ".", "add", "(", "\"type\"", ",", "TYPE_ENTERPRISE", ")", ",", "null", ")", ";", "}" ]

[ "Assigns", "retention", "policy", "with", "givenID", "to", "the", "enterprise", "." ]

[ "public", "static", "BoxRetentionPolicyAssignment", ".", "Info", "createAssignmentToFolder", "(", "BoxAPIConnection", "api", ",", "String", "policyID", ",", "String", "folderID", ")", "{", "return", "createAssignment", "(", "api", ",", "policyID", ",", "new", "JsonObject", "(", ")", ".", "add", "(", "\"type\"", ",", "TYPE_FOLDER", ")", ".", "add", "(", "\"id\"", ",", "folderID", ")", ",", "null", ")", ";", "}" ]

[ "Assigns", "retention", "policy", "with", "givenID", "to", "the", "folder", "." ]

[ "public", "static", "BoxRetentionPolicyAssignment", ".", "Info", "createAssignmentToMetadata", "(", "BoxAPIConnection", "api", ",", "String", "policyID", ",", "String", "templateID", ",", "MetadataFieldFilter", "...", "filter", ")", "{", "JsonObject", "assignTo", "=", "new", "JsonObject", "(", ")", ".", "add", "(", "\"type\"", ",", "TYPE_METADATA", ")", ".", "add", "(", "\"id\"", ",", "templateID", ")", ";", "JsonArray", "filters", "=", "null", ";", "if", "(", "filter", ".", "length", ">", "0", ")", "{", "filters", "=", "new", "JsonArray", "(", ")", ";", "for", "(", "MetadataFieldFilter", "f", ":", "filter", ")", "{", "filters", ".", "add", "(", "f", ".", "getJsonObject", "(", ")", ")", ";", "}", "}", "return", "createAssignment", "(", "api", ",", "policyID", ",", "assignTo", ",", "filters", ")", ";", "}" ]

[ "Assigns", "a", "retention", "policy", "to", "all", "items", "with", "a", "given", "metadata", "template", "optionally", "matching", "on", "fields", "." ]

[ "private", "static", "BoxRetentionPolicyAssignment", ".", "Info", "createAssignment", "(", "BoxAPIConnection", "api", ",", "String", "policyID", ",", "JsonObject", "assignTo", ",", "JsonArray", "filter", ")", "{", "URL", "url", "=", "ASSIGNMENTS_URL_TEMPLATE", ".", "build", "(", "api", ".", "getBaseURL", "(", ")", ")", ";", "BoxJSONRequest", "request", "=", "new", "BoxJSONRequest", "(", "api", ",", "url", ",", "\"POST\"", ")", ";", "JsonObject", "requestJSON", "=", "new", "JsonObject", "(", ")", ".", "add", "(", "\"policy_id\"", ",", "policyID", ")", ".", "add", "(", "\"assign_to\"", ",", "assignTo", ")", ";", "if", "(", "filter", "!=", "null", ")", "{", "requestJSON", ".", "add", "(", "\"filter_fields\"", ",", "filter", ")", ";", "}", "request", ".", "setBody", "(", "requestJSON", ".", "toString", "(", ")", ")", ";", "BoxJSONResponse", "response", "=", "(", "BoxJSONResponse", ")", "request", ".", "send", "(", ")", ";", "JsonObject", "responseJSON", "=", "JsonObject", ".", "readFrom", "(", "response", ".", "getJSON", "(", ")", ")", ";", "BoxRetentionPolicyAssignment", "createdAssignment", "=", "new", "BoxRetentionPolicyAssignment", "(", "api", ",", "responseJSON", ".", "get", "(", "\"id\"", ")", ".", "asString", "(", ")", ")", ";", "return", "createdAssignment", ".", "new", "Info", "(", "responseJSON", ")", ";", "}" ]

[ "Assigns", "retention", "policy", "with", "givenID", "to", "folder", "or", "enterprise", "." ]

[ "public", "static", "Iterable", "<", "Metadata", ">", "getAllMetadata", "(", "BoxItem", "item", ",", "String", "...", "fields", ")", "{", "QueryStringBuilder", "builder", "=", "new", "QueryStringBuilder", "(", ")", ";", "if", "(", "fields", ".", "length", ">", "0", ")", "{", "builder", ".", "appendParam", "(", "\"fields\"", ",", "fields", ")", ";", "}", "return", "new", "BoxResourceIterable", "<", "Metadata", ">", "(", "item", ".", "getAPI", "(", ")", ",", "GET_ALL_METADATA_URL_TEMPLATE", ".", "buildWithQuery", "(", "item", ".", "getItemURL", "(", ")", ".", "toString", "(", ")", ",", "builder", ".", "toString", "(", ")", ")", ",", "DEFAULT_LIMIT", ")", "{", "@", "Override", "protected", "Metadata", "factory", "(", "JsonObject", "jsonObject", ")", "{", "return", "new", "Metadata", "(", "jsonObject", ")", ";", "}", "}", ";", "}" ]

[ "Used", "to", "retrieve", "all", "metadata", "associated", "with", "the", "item", "." ]

[ "public", "Metadata", "add", "(", "String", "path", ",", "String", "value", ")", "{", "this", ".", "values", ".", "add", "(", "this", ".", "pathToProperty", "(", "path", ")", ",", "value", ")", ";", "this", ".", "addOp", "(", "\"add\"", ",", "path", ",", "value", ")", ";", "return", "this", ";", "}" ]

[ "Adds", "a", "new", "metadata", "value", "." ]

[ "public", "Metadata", "add", "(", "String", "path", ",", "List", "<", "String", ">", "values", ")", "{", "JsonArray", "arr", "=", "new", "JsonArray", "(", ")", ";", "for", "(", "String", "value", ":", "values", ")", "{", "arr", ".", "add", "(", "value", ")", ";", "}", "this", ".", "values", ".", "add", "(", "this", ".", "pathToProperty", "(", "path", ")", ",", "arr", ")", ";", "this", ".", "addOp", "(", "\"add\"", ",", "path", ",", "arr", ")", ";", "return", "this", ";", "}" ]

[ "Adds", "a", "new", "metadata", "value", "of", "array", "type", "." ]

[ "public", "Metadata", "replace", "(", "String", "path", ",", "String", "value", ")", "{", "this", ".", "values", ".", "set", "(", "this", ".", "pathToProperty", "(", "path", ")", ",", "value", ")", ";", "this", ".", "addOp", "(", "\"replace\"", ",", "path", ",", "value", ")", ";", "return", "this", ";", "}" ]

[ "Replaces", "an", "existing", "metadata", "value", "." ]

[ "public", "Metadata", "remove", "(", "String", "path", ")", "{", "this", ".", "values", ".", "remove", "(", "this", ".", "pathToProperty", "(", "path", ")", ")", ";", "this", ".", "addOp", "(", "\"remove\"", ",", "path", ",", "(", "String", ")", "null", ")", ";", "return", "this", ";", "}" ]

[ "Removes", "an", "existing", "metadata", "value", "." ]

[ "@", "Deprecated", "public", "String", "get", "(", "String", "path", ")", "{", "final", "JsonValue", "value", "=", "this", ".", "values", ".", "get", "(", "this", ".", "pathToProperty", "(", "path", ")", ")", ";", "if", "(", "value", "==", "null", ")", "{", "return", "null", ";", "}", "if", "(", "!", "value", ".", "isString", "(", ")", ")", "{", "return", "value", ".", "toString", "(", ")", ";", "}", "return", "value", ".", "asString", "(", ")", ";", "}" ]

[ "Returns", "a", "value", "." ]

[ "public", "Date", "getDate", "(", "String", "path", ")", "throws", "ParseException", "{", "return", "BoxDateFormat", ".", "parse", "(", "this", ".", "getValue", "(", "path", ")", ".", "asString", "(", ")", ")", ";", "}" ]

[ "Get", "a", "value", "from", "a", "date", "metadata", "field", "." ]

[ "public", "List", "<", "String", ">", "getMultiSelect", "(", "String", "path", ")", "{", "List", "<", "String", ">", "values", "=", "new", "ArrayList", "<", "String", ">", "(", ")", ";", "for", "(", "JsonValue", "val", ":", "this", ".", "getValue", "(", "path", ")", ".", "asArray", "(", ")", ")", "{", "values", ".", "add", "(", "val", ".", "asString", "(", ")", ")", ";", "}", "return", "values", ";", "}" ]

[ "Get", "a", "value", "from", "a", "multiselect", "metadata", "field", "." ]

[ "public", "List", "<", "String", ">", "getPropertyPaths", "(", ")", "{", "List", "<", "String", ">", "result", "=", "new", "ArrayList", "<", "String", ">", "(", ")", ";", "for", "(", "String", "property", ":", "this", ".", "values", ".", "names", "(", ")", ")", "{", "if", "(", "!", "property", ".", "startsWith", "(", "\"$\"", ")", ")", "{", "result", ".", "add", "(", "this", ".", "propertyToPath", "(", "property", ")", ")", ";", "}", "}", "return", "result", ";", "}" ]

[ "Returns", "a", "list", "of", "metadata", "property", "paths", "." ]

[ "private", "String", "pathToProperty", "(", "String", "path", ")", "{", "if", "(", "path", "==", "null", "||", "!", "path", ".", "startsWith", "(", "\"/\"", ")", ")", "{", "throw", "new", "IllegalArgumentException", "(", "\"Path must be prefixed with a \\\"/\\\".\"", ")", ";", "}", "return", "path", ".", "substring", "(", "1", ")", ";", "}" ]

[ "Converts", "a", "JSON", "patch", "path", "to", "a", "JSON", "property", "name", ".", "Currently", "the", "metadata", "API", "only", "supports", "flat", "maps", "." ]

[ "private", "void", "addOp", "(", "String", "op", ",", "String", "path", ",", "String", "value", ")", "{", "if", "(", "this", ".", "operations", "==", "null", ")", "{", "this", ".", "operations", "=", "new", "JsonArray", "(", ")", ";", "}", "this", ".", "operations", ".", "add", "(", "new", "JsonObject", "(", ")", ".", "add", "(", "\"op\"", ",", "op", ")", ".", "add", "(", "\"path\"", ",", "path", ")", ".", "add", "(", "\"value\"", ",", "value", ")", ")", ";", "}" ]

[ "Adds", "a", "patch", "operation", "." ]

[ "protected", "static", "BoxCollaboration", ".", "Info", "create", "(", "BoxAPIConnection", "api", ",", "JsonObject", "accessibleBy", ",", "JsonObject", "item", ",", "BoxCollaboration", ".", "Role", "role", ",", "Boolean", "notify", ",", "Boolean", "canViewPath", ")", "{", "String", "queryString", "=", "\"\"", ";", "if", "(", "notify", "!=", "null", ")", "{", "queryString", "=", "new", "QueryStringBuilder", "(", ")", ".", "appendParam", "(", "\"notify\"", ",", "notify", ".", "toString", "(", ")", ")", ".", "toString", "(", ")", ";", "}", "URL", "url", ";", "if", "(", "queryString", ".", "length", "(", ")", ">", "0", ")", "{", "url", "=", "COLLABORATIONS_URL_TEMPLATE", ".", "buildWithQuery", "(", "api", ".", "getBaseURL", "(", ")", ",", "queryString", ")", ";", "}", "else", "{", "url", "=", "COLLABORATIONS_URL_TEMPLATE", ".", "build", "(", "api", ".", "getBaseURL", "(", ")", ")", ";", "}", "JsonObject", "requestJSON", "=", "new", "JsonObject", "(", ")", ";", "requestJSON", ".", "add", "(", "\"item\"", ",", "item", ")", ";", "requestJSON", ".", "add", "(", "\"accessible_by\"", ",", "accessibleBy", ")", ";", "requestJSON", ".", "add", "(", "\"role\"", ",", "role", ".", "toJSONString", "(", ")", ")", ";", "if", "(", "canViewPath", "!=", "null", ")", "{", "requestJSON", ".", "add", "(", "\"can_view_path\"", ",", "canViewPath", ".", "booleanValue", "(", ")", ")", ";", "}", "BoxJSONRequest", "request", "=", "new", "BoxJSONRequest", "(", "api", ",", "url", ",", "\"POST\"", ")", ";", "request", ".", "setBody", "(", "requestJSON", ".", "toString", "(", ")", ")", ";", "BoxJSONResponse", "response", "=", "(", "BoxJSONResponse", ")", "request", ".", "send", "(", ")", ";", "JsonObject", "responseJSON", "=", "JsonObject", ".", "readFrom", "(", "response", ".", "getJSON", "(", ")", ")", ";", "BoxCollaboration", "newCollaboration", "=", "new", "BoxCollaboration", "(", "api", ",", "responseJSON", ".", "get", "(", "\"id\"", ")", ".", "asString", "(", ")", ")", ";", "return", "newCollaboration", ".", "new", "Info", "(", "responseJSON", ")", ";", "}" ]

[ "Create", "a", "new", "collaboration", "object", "." ]

[ "public", "static", "Collection", "<", "Info", ">", "getPendingCollaborations", "(", "BoxAPIConnection", "api", ")", "{", "URL", "url", "=", "PENDING_COLLABORATIONS_URL", ".", "build", "(", "api", ".", "getBaseURL", "(", ")", ")", ";", "BoxAPIRequest", "request", "=", "new", "BoxAPIRequest", "(", "api", ",", "url", ",", "\"GET\"", ")", ";", "BoxJSONResponse", "response", "=", "(", "BoxJSONResponse", ")", "request", ".", "send", "(", ")", ";", "JsonObject", "responseJSON", "=", "JsonObject", ".", "readFrom", "(", "response", ".", "getJSON", "(", ")", ")", ";", "int", "entriesCount", "=", "responseJSON", ".", "get", "(", "\"total_count\"", ")", ".", "asInt", "(", ")", ";", "Collection", "<", "BoxCollaboration", ".", "Info", ">", "collaborations", "=", "new", "ArrayList", "<", "BoxCollaboration", ".", "Info", ">", "(", "entriesCount", ")", ";", "JsonArray", "entries", "=", "responseJSON", ".", "get", "(", "\"entries\"", ")", ".", "asArray", "(", ")", ";", "for", "(", "JsonValue", "entry", ":", "entries", ")", "{", "JsonObject", "entryObject", "=", "entry", ".", "asObject", "(", ")", ";", "BoxCollaboration", "collaboration", "=", "new", "BoxCollaboration", "(", "api", ",", "entryObject", ".", "get", "(", "\"id\"", ")", ".", "asString", "(", ")", ")", ";", "BoxCollaboration", ".", "Info", "info", "=", "collaboration", ".", "new", "Info", "(", "entryObject", ")", ";", "collaborations", ".", "add", "(", "info", ")", ";", "}", "return", "collaborations", ";", "}" ]

[ "Gets", "all", "pending", "collaboration", "invites", "for", "the", "current", "user", "." ]

[ "public", "Info", "getInfo", "(", ")", "{", "BoxAPIConnection", "api", "=", "this", ".", "getAPI", "(", ")", ";", "URL", "url", "=", "COLLABORATION_URL_TEMPLATE", ".", "build", "(", "api", ".", "getBaseURL", "(", ")", ",", "this", ".", "getID", "(", ")", ")", ";", "BoxAPIRequest", "request", "=", "new", "BoxAPIRequest", "(", "api", ",", "url", ",", "\"GET\"", ")", ";", "BoxJSONResponse", "response", "=", "(", "BoxJSONResponse", ")", "request", ".", "send", "(", ")", ";", "JsonObject", "jsonObject", "=", "JsonObject", ".", "readFrom", "(", "response", ".", "getJSON", "(", ")", ")", ";", "return", "new", "Info", "(", "jsonObject", ")", ";", "}" ]

[ "Gets", "information", "about", "this", "collaboration", "." ]

[ "public", "void", "updateInfo", "(", "Info", "info", ")", "{", "BoxAPIConnection", "api", "=", "this", ".", "getAPI", "(", ")", ";", "URL", "url", "=", "COLLABORATION_URL_TEMPLATE", ".", "build", "(", "api", ".", "getBaseURL", "(", ")", ",", "this", ".", "getID", "(", ")", ")", ";", "BoxJSONRequest", "request", "=", "new", "BoxJSONRequest", "(", "api", ",", "url", ",", "\"PUT\"", ")", ";", "request", ".", "setBody", "(", "info", ".", "getPendingChanges", "(", ")", ")", ";", "BoxAPIResponse", "boxAPIResponse", "=", "request", ".", "send", "(", ")", ";", "if", "(", "boxAPIResponse", "instanceof", "BoxJSONResponse", ")", "{", "BoxJSONResponse", "response", "=", "(", "BoxJSONResponse", ")", "boxAPIResponse", ";", "JsonObject", "jsonObject", "=", "JsonObject", ".", "readFrom", "(", "response", ".", "getJSON", "(", ")", ")", ";", "info", ".", "update", "(", "jsonObject", ")", ";", "}", "}" ]

[ "Updates", "the", "information", "about", "this", "collaboration", "with", "any", "info", "fields", "that", "have", "been", "modified", "locally", "." ]

[ "public", "void", "delete", "(", ")", "{", "BoxAPIConnection", "api", "=", "this", ".", "getAPI", "(", ")", ";", "URL", "url", "=", "COLLABORATION_URL_TEMPLATE", ".", "build", "(", "api", ".", "getBaseURL", "(", ")", ",", "this", ".", "getID", "(", ")", ")", ";", "BoxAPIRequest", "request", "=", "new", "BoxAPIRequest", "(", "api", ",", "url", ",", "\"DELETE\"", ")", ";", "BoxAPIResponse", "response", "=", "request", ".", "send", "(", ")", ";", "response", ".", "disconnect", "(", ")", ";", "}" ]

[ "Deletes", "this", "collaboration", "." ]

[ "public", "static", "BoxLegalHoldAssignment", ".", "Info", "create", "(", "BoxAPIConnection", "api", ",", "String", "policyID", ",", "String", "resourceType", ",", "String", "resourceID", ")", "{", "URL", "url", "=", "ASSIGNMENTS_URL_TEMPLATE", ".", "build", "(", "api", ".", "getBaseURL", "(", ")", ")", ";", "BoxJSONRequest", "request", "=", "new", "BoxJSONRequest", "(", "api", ",", "url", ",", "\"POST\"", ")", ";", "JsonObject", "requestJSON", "=", "new", "JsonObject", "(", ")", ".", "add", "(", "\"policy_id\"", ",", "policyID", ")", ".", "add", "(", "\"assign_to\"", ",", "new", "JsonObject", "(", ")", ".", "add", "(", "\"type\"", ",", "resourceType", ")", ".", "add", "(", "\"id\"", ",", "resourceID", ")", ")", ";", "request", ".", "setBody", "(", "requestJSON", ".", "toString", "(", ")", ")", ";", "BoxJSONResponse", "response", "=", "(", "BoxJSONResponse", ")", "request", ".", "send", "(", ")", ";", "JsonObject", "responseJSON", "=", "JsonObject", ".", "readFrom", "(", "response", ".", "getJSON", "(", ")", ")", ";", "BoxLegalHoldAssignment", "createdAssignment", "=", "new", "BoxLegalHoldAssignment", "(", "api", ",", "responseJSON", ".", "get", "(", "\"id\"", ")", ".", "asString", "(", ")", ")", ";", "return", "createdAssignment", ".", "new", "Info", "(", "responseJSON", ")", ";", "}" ]

[ "Creates", "new", "legal", "hold", "policy", "assignment", "." ]

[ "public", "void", "addCustomNotificationRecipient", "(", "String", "userID", ")", "{", "BoxUser", "user", "=", "new", "BoxUser", "(", "null", ",", "userID", ")", ";", "this", ".", "customNotificationRecipients", ".", "add", "(", "user", ".", "new", "Info", "(", ")", ")", ";", "}" ]

[ "Add", "a", "user", "by", "ID", "to", "the", "list", "of", "people", "to", "notify", "when", "the", "retention", "period", "is", "ending", "." ]

[ "public", "static", "Iterable", "<", "BoxCollection", ".", "Info", ">", "getAllCollections", "(", "final", "BoxAPIConnection", "api", ")", "{", "return", "new", "Iterable", "<", "BoxCollection", ".", "Info", ">", "(", ")", "{", "public", "Iterator", "<", "BoxCollection", ".", "Info", ">", "iterator", "(", ")", "{", "URL", "url", "=", "GET_COLLECTIONS_URL_TEMPLATE", ".", "build", "(", "api", ".", "getBaseURL", "(", ")", ")", ";", "return", "new", "BoxCollectionIterator", "(", "api", ",", "url", ")", ";", "}", "}", ";", "}" ]

[ "Gets", "an", "iterable", "of", "all", "the", "collections", "for", "the", "given", "user", "." ]

[ "public", "PartialCollection", "<", "BoxItem", ".", "Info", ">", "getItemsRange", "(", "long", "offset", ",", "long", "limit", ",", "String", "...", "fields", ")", "{", "QueryStringBuilder", "builder", "=", "new", "QueryStringBuilder", "(", ")", ".", "appendParam", "(", "\"offset\"", ",", "offset", ")", ".", "appendParam", "(", "\"limit\"", ",", "limit", ")", ";", "if", "(", "fields", ".", "length", ">", "0", ")", "{", "builder", ".", "appendParam", "(", "\"fields\"", ",", "fields", ")", ".", "toString", "(", ")", ";", "}", "URL", "url", "=", "GET_COLLECTION_ITEMS_URL", ".", "buildWithQuery", "(", "getAPI", "(", ")", ".", "getBaseURL", "(", ")", ",", "builder", ".", "toString", "(", ")", ",", "getID", "(", ")", ")", ";", "BoxAPIRequest", "request", "=", "new", "BoxAPIRequest", "(", "this", ".", "getAPI", "(", ")", ",", "url", ",", "\"GET\"", ")", ";", "BoxJSONResponse", "response", "=", "(", "BoxJSONResponse", ")", "request", ".", "send", "(", ")", ";", "JsonObject", "responseJSON", "=", "JsonObject", ".", "readFrom", "(", "response", ".", "getJSON", "(", ")", ")", ";", "String", "totalCountString", "=", "responseJSON", ".", "get", "(", "\"total_count\"", ")", ".", "toString", "(", ")", ";", "long", "fullSize", "=", "Double", ".", "valueOf", "(", "totalCountString", ")", ".", "longValue", "(", ")", ";", "PartialCollection", "<", "BoxItem", ".", "Info", ">", "items", "=", "new", "PartialCollection", "<", "BoxItem", ".", "Info", ">", "(", "offset", ",", "limit", ",", "fullSize", ")", ";", "JsonArray", "entries", "=", "responseJSON", ".", "get", "(", "\"entries\"", ")", ".", "asArray", "(", ")", ";", "for", "(", "JsonValue", "entry", ":", "entries", ")", "{", "BoxItem", ".", "Info", "entryInfo", "=", "(", "BoxItem", ".", "Info", ")", "BoxResource", ".", "parseInfo", "(", "this", ".", "getAPI", "(", ")", ",", "entry", ".", "asObject", "(", ")", ")", ";", "if", "(", "entryInfo", "!=", "null", ")", "{", "items", ".", "add", "(", "entryInfo", ")", ";", "}", "}", "return", "items", ";", "}" ]

[ "Retrieves", "a", "specific", "range", "of", "items", "in", "this", "collection", "." ]

[ "@", "Override", "public", "Iterator", "<", "BoxItem", ".", "Info", ">", "iterator", "(", ")", "{", "URL", "url", "=", "GET_COLLECTION_ITEMS_URL", ".", "build", "(", "this", ".", "getAPI", "(", ")", ".", "getBaseURL", "(", ")", ",", "BoxCollection", ".", "this", ".", "getID", "(", ")", ")", ";", "return", "new", "BoxItemIterator", "(", "BoxCollection", ".", "this", ".", "getAPI", "(", ")", ",", "url", ")", ";", "}" ]

[ "Returns", "an", "iterator", "over", "the", "items", "in", "this", "collection", "." ]

[ "public", "static", "BoxCollaborationWhitelistExemptTarget", ".", "Info", "create", "(", "final", "BoxAPIConnection", "api", ",", "String", "userID", ")", "{", "URL", "url", "=", "COLLABORATION_WHITELIST_EXEMPT_TARGET_ENTRIES_URL_TEMPLATE", ".", "build", "(", "api", ".", "getBaseURL", "(", ")", ")", ";", "BoxJSONRequest", "request", "=", "new", "BoxJSONRequest", "(", "api", ",", "url", ",", "HttpMethod", ".", "POST", ")", ";", "JsonObject", "requestJSON", "=", "new", "JsonObject", "(", ")", ".", "add", "(", "\"user\"", ",", "new", "JsonObject", "(", ")", ".", "add", "(", "\"type\"", ",", "\"user\"", ")", ".", "add", "(", "\"id\"", ",", "userID", ")", ")", ";", "request", ".", "setBody", "(", "requestJSON", ".", "toString", "(", ")", ")", ";", "BoxJSONResponse", "response", "=", "(", "BoxJSONResponse", ")", "request", ".", "send", "(", ")", ";", "JsonObject", "responseJSON", "=", "JsonObject", ".", "readFrom", "(", "response", ".", "getJSON", "(", ")", ")", ";", "BoxCollaborationWhitelistExemptTarget", "userWhitelist", "=", "new", "BoxCollaborationWhitelistExemptTarget", "(", "api", ",", "responseJSON", ".", "get", "(", "\"id\"", ")", ".", "asString", "(", ")", ")", ";", "return", "userWhitelist", ".", "new", "Info", "(", "responseJSON", ")", ";", "}" ]

[ "Creates", "a", "collaboration", "whitelist", "for", "a", "Box", "User", "with", "a", "given", "ID", "." ]

[ "public", "BoxCollaborationWhitelistExemptTarget", ".", "Info", "getInfo", "(", ")", "{", "URL", "url", "=", "COLLABORATION_WHITELIST_EXEMPT_TARGET_ENTRY_URL_TEMPLATE", ".", "build", "(", "this", ".", "getAPI", "(", ")", ".", "getBaseURL", "(", ")", ",", "this", ".", "getID", "(", ")", ")", ";", "BoxAPIRequest", "request", "=", "new", "BoxAPIRequest", "(", "this", ".", "getAPI", "(", ")", ",", "url", ",", "HttpMethod", ".", "GET", ")", ";", "BoxJSONResponse", "response", "=", "(", "BoxJSONResponse", ")", "request", ".", "send", "(", ")", ";", "return", "new", "Info", "(", "JsonObject", ".", "readFrom", "(", "response", ".", "getJSON", "(", ")", ")", ")", ";", "}" ]

[ "Retrieves", "information", "for", "a", "collaboration", "whitelist", "for", "a", "given", "whitelist", "ID", "." ]

[ "public", "static", "BoxDeveloperEditionAPIConnection", "getAppEnterpriseConnection", "(", "String", "enterpriseId", ",", "String", "clientId", ",", "String", "clientSecret", ",", "JWTEncryptionPreferences", "encryptionPref", ",", "IAccessTokenCache", "accessTokenCache", ")", "{", "BoxDeveloperEditionAPIConnection", "connection", "=", "new", "BoxDeveloperEditionAPIConnection", "(", "enterpriseId", ",", "DeveloperEditionEntityType", ".", "ENTERPRISE", ",", "clientId", ",", "clientSecret", ",", "encryptionPref", ",", "accessTokenCache", ")", ";", "connection", ".", "tryRestoreUsingAccessTokenCache", "(", ")", ";", "return", "connection", ";", "}" ]

[ "Creates", "a", "new", "Box", "Developer", "Edition", "connection", "with", "enterprise", "token", "leveraging", "an", "access", "token", "cache", "." ]

[ "public", "static", "BoxDeveloperEditionAPIConnection", "getAppEnterpriseConnection", "(", "BoxConfig", "boxConfig", ")", "{", "BoxDeveloperEditionAPIConnection", "connection", "=", "getAppEnterpriseConnection", "(", "boxConfig", ".", "getEnterpriseId", "(", ")", ",", "boxConfig", ".", "getClientId", "(", ")", ",", "boxConfig", ".", "getClientSecret", "(", ")", ",", "boxConfig", ".", "getJWTEncryptionPreferences", "(", ")", ")", ";", "return", "connection", ";", "}" ]

[ "Creates", "a", "new", "Box", "Developer", "Edition", "connection", "with", "enterprise", "token", "leveraging", "BoxConfig", "." ]

[ "public", "static", "BoxDeveloperEditionAPIConnection", "getAppUserConnection", "(", "String", "userId", ",", "String", "clientId", ",", "String", "clientSecret", ",", "JWTEncryptionPreferences", "encryptionPref", ",", "IAccessTokenCache", "accessTokenCache", ")", "{", "BoxDeveloperEditionAPIConnection", "connection", "=", "new", "BoxDeveloperEditionAPIConnection", "(", "userId", ",", "DeveloperEditionEntityType", ".", "USER", ",", "clientId", ",", "clientSecret", ",", "encryptionPref", ",", "accessTokenCache", ")", ";", "connection", ".", "tryRestoreUsingAccessTokenCache", "(", ")", ";", "return", "connection", ";", "}" ]

[ "Creates", "a", "new", "Box", "Developer", "Edition", "connection", "with", "App", "User", "token", "." ]

[ "public", "static", "BoxDeveloperEditionAPIConnection", "getAppUserConnection", "(", "String", "userId", ",", "BoxConfig", "boxConfig", ")", "{", "return", "getAppUserConnection", "(", "userId", ",", "boxConfig", ".", "getClientId", "(", ")", ",", "boxConfig", ".", "getClientSecret", "(", ")", ",", "boxConfig", ".", "getJWTEncryptionPreferences", "(", ")", ")", ";", "}" ]

[ "Creates", "a", "new", "Box", "Developer", "Edition", "connection", "with", "App", "User", "token", "levaraging", "BoxConfig", "." ]

[ "public", "void", "authenticate", "(", ")", "{", "URL", "url", ";", "try", "{", "url", "=", "new", "URL", "(", "this", ".", "getTokenURL", "(", ")", ")", ";", "}", "catch", "(", "MalformedURLException", "e", ")", "{", "assert", "false", ":", "\"An invalid token URL indicates a bug in the SDK.\"", ";", "throw", "new", "RuntimeException", "(", "\"An invalid token URL indicates a bug in the SDK.\"", ",", "e", ")", ";", "}", "String", "jwtAssertion", "=", "this", ".", "constructJWTAssertion", "(", ")", ";", "String", "urlParameters", "=", "String", ".", "format", "(", "JWT_GRANT_TYPE", ",", "this", ".", "getClientID", "(", ")", ",", "this", ".", "getClientSecret", "(", ")", ",", "jwtAssertion", ")", ";", "BoxAPIRequest", "request", "=", "new", "BoxAPIRequest", "(", "this", ",", "url", ",", "\"POST\"", ")", ";", "request", ".", "shouldAuthenticate", "(", "false", ")", ";", "request", ".", "setBody", "(", "urlParameters", ")", ";", "String", "json", ";", "try", "{", "BoxJSONResponse", "response", "=", "(", "BoxJSONResponse", ")", "request", ".", "send", "(", ")", ";", "json", "=", "response", ".", "getJSON", "(", ")", ";", "}", "catch", "(", "BoxAPIException", "ex", ")", "{", "// Use the Date advertised by the Box server as the current time to synchronize clocks", "List", "<", "String", ">", "responseDates", "=", "ex", ".", "getHeaders", "(", ")", ".", "get", "(", "\"Date\"", ")", ";", "NumericDate", "currentTime", ";", "if", "(", "responseDates", "!=", "null", ")", "{", "String", "responseDate", "=", "responseDates", ".", "get", "(", "0", ")", ";", "SimpleDateFormat", "dateFormat", "=", "new", "SimpleDateFormat", "(", "\"EEE, d MMM yyyy HH:mm:ss zzz\"", ")", ";", "try", "{", "Date", "date", "=", "dateFormat", ".", "parse", "(", "responseDate", ")", ";", "currentTime", "=", "NumericDate", ".", "fromMilliseconds", "(", "date", ".", "getTime", "(", ")", ")", ";", "}", "catch", "(", "ParseException", "e", ")", "{", "currentTime", "=", "NumericDate", ".", "now", "(", ")", ";", "}", "}", "else", "{", "currentTime", "=", "NumericDate", ".", "now", "(", ")", ";", "}", "// Reconstruct the JWT assertion, which regenerates the jti claim, with the new \"current\" time", "jwtAssertion", "=", "this", ".", "constructJWTAssertion", "(", "currentTime", ")", ";", "urlParameters", "=", "String", ".", "format", "(", "JWT_GRANT_TYPE", ",", "this", ".", "getClientID", "(", ")", ",", "this", ".", "getClientSecret", "(", ")", ",", "jwtAssertion", ")", ";", "// Re-send the updated request", "request", "=", "new", "BoxAPIRequest", "(", "this", ",", "url", ",", "\"POST\"", ")", ";", "request", ".", "shouldAuthenticate", "(", "false", ")", ";", "request", ".", "setBody", "(", "urlParameters", ")", ";", "BoxJSONResponse", "response", "=", "(", "BoxJSONResponse", ")", "request", ".", "send", "(", ")", ";", "json", "=", "response", ".", "getJSON", "(", ")", ";", "}", "JsonObject", "jsonObject", "=", "JsonObject", ".", "readFrom", "(", "json", ")", ";", "this", ".", "setAccessToken", "(", "jsonObject", ".", "get", "(", "\"access_token\"", ")", ".", "asString", "(", ")", ")", ";", "this", ".", "setLastRefresh", "(", "System", ".", "currentTimeMillis", "(", ")", ")", ";", "this", ".", "setExpires", "(", "jsonObject", ".", "get", "(", "\"expires_in\"", ")", ".", "asLong", "(", ")", "*", "1000", ")", ";", "//if token cache is specified, save to cache", "if", "(", "this", ".", "accessTokenCache", "!=", "null", ")", "{", "String", "key", "=", "this", ".", "getAccessTokenCacheKey", "(", ")", ";", "JsonObject", "accessTokenCacheInfo", "=", "new", "JsonObject", "(", ")", ".", "add", "(", "\"accessToken\"", ",", "this", ".", "getAccessToken", "(", ")", ")", ".", "add", "(", "\"lastRefresh\"", ",", "this", ".", "getLastRefresh", "(", ")", ")", ".", "add", "(", "\"expires\"", ",", "this", ".", "getExpires", "(", ")", ")", ";", "this", ".", "accessTokenCache", ".", "put", "(", "key", ",", "accessTokenCacheInfo", ".", "toString", "(", ")", ")", ";", "}", "}" ]

[ "Authenticates", "the", "API", "connection", "for", "Box", "Developer", "Edition", "." ]

[ "public", "void", "refresh", "(", ")", "{", "this", ".", "getRefreshLock", "(", ")", ".", "writeLock", "(", ")", ".", "lock", "(", ")", ";", "try", "{", "this", ".", "authenticate", "(", ")", ";", "}", "catch", "(", "BoxAPIException", "e", ")", "{", "this", ".", "notifyError", "(", "e", ")", ";", "this", ".", "getRefreshLock", "(", ")", ".", "writeLock", "(", ")", ".", "unlock", "(", ")", ";", "throw", "e", ";", "}", "this", ".", "notifyRefresh", "(", ")", ";", "this", ".", "getRefreshLock", "(", ")", ".", "writeLock", "(", ")", ".", "unlock", "(", ")", ";", "}" ]

[ "Refresh", "s", "this", "connection", "s", "access", "token", "using", "Box", "Developer", "Edition", "." ]

[ "public", "BoxTask", ".", "Info", "addTask", "(", "BoxTask", ".", "Action", "action", ",", "String", "message", ",", "Date", "dueAt", ")", "{", "JsonObject", "itemJSON", "=", "new", "JsonObject", "(", ")", ";", "itemJSON", ".", "add", "(", "\"type\"", ",", "\"file\"", ")", ";", "itemJSON", ".", "add", "(", "\"id\"", ",", "this", ".", "getID", "(", ")", ")", ";", "JsonObject", "requestJSON", "=", "new", "JsonObject", "(", ")", ";", "requestJSON", ".", "add", "(", "\"item\"", ",", "itemJSON", ")", ";", "requestJSON", ".", "add", "(", "\"action\"", ",", "action", ".", "toJSONString", "(", ")", ")", ";", "if", "(", "message", "!=", "null", "&&", "!", "message", ".", "isEmpty", "(", ")", ")", "{", "requestJSON", ".", "add", "(", "\"message\"", ",", "message", ")", ";", "}", "if", "(", "dueAt", "!=", "null", ")", "{", "requestJSON", ".", "add", "(", "\"due_at\"", ",", "BoxDateFormat", ".", "format", "(", "dueAt", ")", ")", ";", "}", "URL", "url", "=", "ADD_TASK_URL_TEMPLATE", ".", "build", "(", "this", ".", "getAPI", "(", ")", ".", "getBaseURL", "(", ")", ")", ";", "BoxJSONRequest", "request", "=", "new", "BoxJSONRequest", "(", "this", ".", "getAPI", "(", ")", ",", "url", ",", "\"POST\"", ")", ";", "request", ".", "setBody", "(", "requestJSON", ".", "toString", "(", ")", ")", ";", "BoxJSONResponse", "response", "=", "(", "BoxJSONResponse", ")", "request", ".", "send", "(", ")", ";", "JsonObject", "responseJSON", "=", "JsonObject", ".", "readFrom", "(", "response", ".", "getJSON", "(", ")", ")", ";", "BoxTask", "addedTask", "=", "new", "BoxTask", "(", "this", ".", "getAPI", "(", ")", ",", "responseJSON", ".", "get", "(", "\"id\"", ")", ".", "asString", "(", ")", ")", ";", "return", "addedTask", ".", "new", "Info", "(", "responseJSON", ")", ";", "}" ]

[ "Adds", "a", "new", "task", "to", "this", "file", ".", "The", "task", "can", "have", "an", "optional", "message", "to", "include", "and", "a", "due", "date", "." ]

[ "public", "URL", "getDownloadURL", "(", ")", "{", "URL", "url", "=", "CONTENT_URL_TEMPLATE", ".", "build", "(", "this", ".", "getAPI", "(", ")", ".", "getBaseURL", "(", ")", ",", "this", ".", "getID", "(", ")", ")", ";", "BoxAPIRequest", "request", "=", "new", "BoxAPIRequest", "(", "this", ".", "getAPI", "(", ")", ",", "url", ",", "\"GET\"", ")", ";", "request", ".", "setFollowRedirects", "(", "false", ")", ";", "BoxRedirectResponse", "response", "=", "(", "BoxRedirectResponse", ")", "request", ".", "send", "(", ")", ";", "return", "response", ".", "getRedirectURL", "(", ")", ";", "}" ]

[ "Gets", "an", "expiring", "URL", "for", "downloading", "a", "file", "directly", "from", "Box", ".", "This", "can", "be", "user", "for", "example", "for", "sending", "as", "a", "redirect", "to", "a", "browser", "to", "cause", "the", "browser", "to", "download", "the", "file", "directly", "from", "Box", "." ]

[ "public", "void", "downloadRange", "(", "OutputStream", "output", ",", "long", "rangeStart", ",", "long", "rangeEnd", ")", "{", "this", ".", "downloadRange", "(", "output", ",", "rangeStart", ",", "rangeEnd", ",", "null", ")", ";", "}" ]

[ "Downloads", "a", "part", "of", "this", "file", "s", "contents", "starting", "at", "rangeStart", "and", "stopping", "at", "rangeEnd", "." ]

[ "public", "void", "downloadRange", "(", "OutputStream", "output", ",", "long", "rangeStart", ",", "long", "rangeEnd", ",", "ProgressListener", "listener", ")", "{", "URL", "url", "=", "CONTENT_URL_TEMPLATE", ".", "build", "(", "this", ".", "getAPI", "(", ")", ".", "getBaseURL", "(", ")", ",", "this", ".", "getID", "(", ")", ")", ";", "BoxAPIRequest", "request", "=", "new", "BoxAPIRequest", "(", "this", ".", "getAPI", "(", ")", ",", "url", ",", "\"GET\"", ")", ";", "if", "(", "rangeEnd", ">", "0", ")", "{", "request", ".", "addHeader", "(", "\"Range\"", ",", "String", ".", "format", "(", "\"bytes=%s-%s\"", ",", "Long", ".", "toString", "(", "rangeStart", ")", ",", "Long", ".", "toString", "(", "rangeEnd", ")", ")", ")", ";", "}", "else", "{", "request", ".", "addHeader", "(", "\"Range\"", ",", "String", ".", "format", "(", "\"bytes=%s-\"", ",", "Long", ".", "toString", "(", "rangeStart", ")", ")", ")", ";", "}", "BoxAPIResponse", "response", "=", "request", ".", "send", "(", ")", ";", "InputStream", "input", "=", "response", ".", "getBody", "(", "listener", ")", ";", "byte", "[", "]", "buffer", "=", "new", "byte", "[", "BUFFER_SIZE", "]", ";", "try", "{", "int", "n", "=", "input", ".", "read", "(", "buffer", ")", ";", "while", "(", "n", "!=", "-", "1", ")", "{", "output", ".", "write", "(", "buffer", ",", "0", ",", "n", ")", ";", "n", "=", "input", ".", "read", "(", "buffer", ")", ";", "}", "}", "catch", "(", "IOException", "e", ")", "{", "throw", "new", "BoxAPIException", "(", "\"Couldn't connect to the Box API due to a network error.\"", ",", "e", ")", ";", "}", "finally", "{", "response", ".", "disconnect", "(", ")", ";", "}", "}" ]

[ "Downloads", "a", "part", "of", "this", "file", "s", "contents", "starting", "at", "rangeStart", "and", "stopping", "at", "rangeEnd", "while", "reporting", "the", "progress", "to", "a", "ProgressListener", "." ]

[ "public", "void", "rename", "(", "String", "newName", ")", "{", "URL", "url", "=", "FILE_URL_TEMPLATE", ".", "build", "(", "this", ".", "getAPI", "(", ")", ".", "getBaseURL", "(", ")", ",", "this", ".", "getID", "(", ")", ")", ";", "BoxJSONRequest", "request", "=", "new", "BoxJSONRequest", "(", "this", ".", "getAPI", "(", ")", ",", "url", ",", "\"PUT\"", ")", ";", "JsonObject", "updateInfo", "=", "new", "JsonObject", "(", ")", ";", "updateInfo", ".", "add", "(", "\"name\"", ",", "newName", ")", ";", "request", ".", "setBody", "(", "updateInfo", ".", "toString", "(", ")", ")", ";", "BoxAPIResponse", "response", "=", "request", ".", "send", "(", ")", ";", "response", ".", "disconnect", "(", ")", ";", "}" ]

[ "Renames", "this", "file", "." ]

[ "public", "void", "getRepresentationContent", "(", "String", "representationHint", ",", "String", "assetPath", ",", "OutputStream", "output", ")", "{", "List", "<", "Representation", ">", "reps", "=", "this", ".", "getInfoWithRepresentations", "(", "representationHint", ")", ".", "getRepresentations", "(", ")", ";", "if", "(", "reps", ".", "size", "(", ")", "<", "1", ")", "{", "throw", "new", "BoxAPIException", "(", "\"No matching representations found\"", ")", ";", "}", "Representation", "representation", "=", "reps", ".", "get", "(", "0", ")", ";", "String", "repState", "=", "representation", ".", "getStatus", "(", ")", ".", "getState", "(", ")", ";", "if", "(", "repState", ".", "equals", "(", "\"viewable\"", ")", "||", "repState", ".", "equals", "(", "\"success\"", ")", ")", "{", "this", ".", "makeRepresentationContentRequest", "(", "representation", ".", "getContent", "(", ")", ".", "getUrlTemplate", "(", ")", ",", "assetPath", ",", "output", ")", ";", "return", ";", "}", "else", "if", "(", "repState", ".", "equals", "(", "\"pending\"", ")", "||", "repState", ".", "equals", "(", "\"none\"", ")", ")", "{", "String", "repContentURLString", "=", "null", ";", "while", "(", "repContentURLString", "==", "null", ")", "{", "repContentURLString", "=", "this", ".", "pollRepInfo", "(", "representation", ".", "getInfo", "(", ")", ".", "getUrl", "(", ")", ")", ";", "}", "this", ".", "makeRepresentationContentRequest", "(", "repContentURLString", ",", "assetPath", ",", "output", ")", ";", "return", ";", "}", "else", "if", "(", "repState", ".", "equals", "(", "\"error\"", ")", ")", "{", "throw", "new", "BoxAPIException", "(", "\"Representation had error status\"", ")", ";", "}", "else", "{", "throw", "new", "BoxAPIException", "(", "\"Representation had unknown status\"", ")", ";", "}", "}" ]

[ "Fetches", "the", "contents", "of", "a", "file", "representation", "with", "asset", "path", "and", "writes", "them", "to", "the", "provided", "output", "stream", "." ]

[ "public", "Collection", "<", "BoxFileVersion", ">", "getVersions", "(", ")", "{", "URL", "url", "=", "VERSIONS_URL_TEMPLATE", ".", "build", "(", "this", ".", "getAPI", "(", ")", ".", "getBaseURL", "(", ")", ",", "this", ".", "getID", "(", ")", ")", ";", "BoxAPIRequest", "request", "=", "new", "BoxAPIRequest", "(", "this", ".", "getAPI", "(", ")", ",", "url", ",", "\"GET\"", ")", ";", "BoxJSONResponse", "response", "=", "(", "BoxJSONResponse", ")", "request", ".", "send", "(", ")", ";", "JsonObject", "jsonObject", "=", "JsonObject", ".", "readFrom", "(", "response", ".", "getJSON", "(", ")", ")", ";", "JsonArray", "entries", "=", "jsonObject", ".", "get", "(", "\"entries\"", ")", ".", "asArray", "(", ")", ";", "Collection", "<", "BoxFileVersion", ">", "versions", "=", "new", "ArrayList", "<", "BoxFileVersion", ">", "(", ")", ";", "for", "(", "JsonValue", "entry", ":", "entries", ")", "{", "versions", ".", "add", "(", "new", "BoxFileVersion", "(", "this", ".", "getAPI", "(", ")", ",", "entry", ".", "asObject", "(", ")", ",", "this", ".", "getID", "(", ")", ")", ")", ";", "}", "return", "versions", ";", "}" ]

[ "Gets", "any", "previous", "versions", "of", "this", "file", ".", "Note", "that", "only", "users", "with", "premium", "accounts", "will", "be", "able", "to", "retrieve", "previous", "versions", "of", "their", "files", "." ]

[ "public", "boolean", "canUploadVersion", "(", "String", "name", ",", "long", "fileSize", ")", "{", "URL", "url", "=", "CONTENT_URL_TEMPLATE", ".", "build", "(", "this", ".", "getAPI", "(", ")", ".", "getBaseURL", "(", ")", ",", "this", ".", "getID", "(", ")", ")", ";", "BoxJSONRequest", "request", "=", "new", "BoxJSONRequest", "(", "this", ".", "getAPI", "(", ")", ",", "url", ",", "\"OPTIONS\"", ")", ";", "JsonObject", "preflightInfo", "=", "new", "JsonObject", "(", ")", ";", "if", "(", "name", "!=", "null", ")", "{", "preflightInfo", ".", "add", "(", "\"name\"", ",", "name", ")", ";", "}", "preflightInfo", ".", "add", "(", "\"size\"", ",", "fileSize", ")", ";", "request", ".", "setBody", "(", "preflightInfo", ".", "toString", "(", ")", ")", ";", "try", "{", "BoxAPIResponse", "response", "=", "request", ".", "send", "(", ")", ";", "return", "response", ".", "getResponseCode", "(", ")", "==", "200", ";", "}", "catch", "(", "BoxAPIException", "ex", ")", "{", "if", "(", "ex", ".", "getResponseCode", "(", ")", ">=", "400", "&&", "ex", ".", "getResponseCode", "(", ")", "<", "500", ")", "{", "// This looks like an error response, menaing the upload would fail", "return", "false", ";", "}", "else", "{", "// This looks like a network error or server error, rethrow exception", "throw", "ex", ";", "}", "}", "}" ]

[ "Checks", "if", "a", "new", "version", "of", "the", "file", "can", "be", "uploaded", "with", "the", "specified", "name", "and", "size", "." ]

[ "public", "byte", "[", "]", "getThumbnail", "(", "ThumbnailFileType", "fileType", ",", "int", "minWidth", ",", "int", "minHeight", ",", "int", "maxWidth", ",", "int", "maxHeight", ")", "{", "QueryStringBuilder", "builder", "=", "new", "QueryStringBuilder", "(", ")", ";", "builder", ".", "appendParam", "(", "\"min_width\"", ",", "minWidth", ")", ";", "builder", ".", "appendParam", "(", "\"min_height\"", ",", "minHeight", ")", ";", "builder", ".", "appendParam", "(", "\"max_width\"", ",", "maxWidth", ")", ";", "builder", ".", "appendParam", "(", "\"max_height\"", ",", "maxHeight", ")", ";", "URLTemplate", "template", ";", "if", "(", "fileType", "==", "ThumbnailFileType", ".", "PNG", ")", "{", "template", "=", "GET_THUMBNAIL_PNG_TEMPLATE", ";", "}", "else", "if", "(", "fileType", "==", "ThumbnailFileType", ".", "JPG", ")", "{", "template", "=", "GET_THUMBNAIL_JPG_TEMPLATE", ";", "}", "else", "{", "throw", "new", "BoxAPIException", "(", "\"Unsupported thumbnail file type\"", ")", ";", "}", "URL", "url", "=", "template", ".", "buildWithQuery", "(", "this", ".", "getAPI", "(", ")", ".", "getBaseURL", "(", ")", ",", "builder", ".", "toString", "(", ")", ",", "this", ".", "getID", "(", ")", ")", ";", "BoxAPIRequest", "request", "=", "new", "BoxAPIRequest", "(", "this", ".", "getAPI", "(", ")", ",", "url", ",", "\"GET\"", ")", ";", "BoxAPIResponse", "response", "=", "request", ".", "send", "(", ")", ";", "ByteArrayOutputStream", "thumbOut", "=", "new", "ByteArrayOutputStream", "(", ")", ";", "InputStream", "body", "=", "response", ".", "getBody", "(", ")", ";", "byte", "[", "]", "buffer", "=", "new", "byte", "[", "BUFFER_SIZE", "]", ";", "try", "{", "int", "n", "=", "body", ".", "read", "(", "buffer", ")", ";", "while", "(", "n", "!=", "-", "1", ")", "{", "thumbOut", ".", "write", "(", "buffer", ",", "0", ",", "n", ")", ";", "n", "=", "body", ".", "read", "(", "buffer", ")", ";", "}", "}", "catch", "(", "IOException", "e", ")", "{", "throw", "new", "BoxAPIException", "(", "\"Error reading thumbnail bytes from response body\"", ",", "e", ")", ";", "}", "finally", "{", "response", ".", "disconnect", "(", ")", ";", "}", "return", "thumbOut", ".", "toByteArray", "(", ")", ";", "}" ]

[ "Retrieves", "a", "thumbnail", "or", "smaller", "image", "representation", "of", "this", "file", ".", "Sizes", "of", "32x32", "64x64", "128x128", "and", "256x256", "can", "be", "returned", "in", "the", ".", "png", "format", "and", "sizes", "of", "32x32", "94x94", "160x160", "and", "320x320", "can", "be", "returned", "in", "the", ".", "jpg", "format", "." ]

[ "public", "List", "<", "BoxComment", ".", "Info", ">", "getComments", "(", ")", "{", "URL", "url", "=", "GET_COMMENTS_URL_TEMPLATE", ".", "build", "(", "this", ".", "getAPI", "(", ")", ".", "getBaseURL", "(", ")", ",", "this", ".", "getID", "(", ")", ")", ";", "BoxAPIRequest", "request", "=", "new", "BoxAPIRequest", "(", "this", ".", "getAPI", "(", ")", ",", "url", ",", "\"GET\"", ")", ";", "BoxJSONResponse", "response", "=", "(", "BoxJSONResponse", ")", "request", ".", "send", "(", ")", ";", "JsonObject", "responseJSON", "=", "JsonObject", ".", "readFrom", "(", "response", ".", "getJSON", "(", ")", ")", ";", "int", "totalCount", "=", "responseJSON", ".", "get", "(", "\"total_count\"", ")", ".", "asInt", "(", ")", ";", "List", "<", "BoxComment", ".", "Info", ">", "comments", "=", "new", "ArrayList", "<", "BoxComment", ".", "Info", ">", "(", "totalCount", ")", ";", "JsonArray", "entries", "=", "responseJSON", ".", "get", "(", "\"entries\"", ")", ".", "asArray", "(", ")", ";", "for", "(", "JsonValue", "value", ":", "entries", ")", "{", "JsonObject", "commentJSON", "=", "value", ".", "asObject", "(", ")", ";", "BoxComment", "comment", "=", "new", "BoxComment", "(", "this", ".", "getAPI", "(", ")", ",", "commentJSON", ".", "get", "(", "\"id\"", ")", ".", "asString", "(", ")", ")", ";", "BoxComment", ".", "Info", "info", "=", "comment", ".", "new", "Info", "(", "commentJSON", ")", ";", "comments", ".", "add", "(", "info", ")", ";", "}", "return", "comments", ";", "}" ]

[ "Gets", "a", "list", "of", "any", "comments", "on", "this", "file", "." ]

[ "public", "List", "<", "BoxTask", ".", "Info", ">", "getTasks", "(", "String", "...", "fields", ")", "{", "QueryStringBuilder", "builder", "=", "new", "QueryStringBuilder", "(", ")", ";", "if", "(", "fields", ".", "length", ">", "0", ")", "{", "builder", ".", "appendParam", "(", "\"fields\"", ",", "fields", ")", ".", "toString", "(", ")", ";", "}", "URL", "url", "=", "GET_TASKS_URL_TEMPLATE", ".", "buildWithQuery", "(", "this", ".", "getAPI", "(", ")", ".", "getBaseURL", "(", ")", ",", "builder", ".", "toString", "(", ")", ",", "this", ".", "getID", "(", ")", ")", ";", "BoxAPIRequest", "request", "=", "new", "BoxAPIRequest", "(", "this", ".", "getAPI", "(", ")", ",", "url", ",", "\"GET\"", ")", ";", "BoxJSONResponse", "response", "=", "(", "BoxJSONResponse", ")", "request", ".", "send", "(", ")", ";", "JsonObject", "responseJSON", "=", "JsonObject", ".", "readFrom", "(", "response", ".", "getJSON", "(", ")", ")", ";", "int", "totalCount", "=", "responseJSON", ".", "get", "(", "\"total_count\"", ")", ".", "asInt", "(", ")", ";", "List", "<", "BoxTask", ".", "Info", ">", "tasks", "=", "new", "ArrayList", "<", "BoxTask", ".", "Info", ">", "(", "totalCount", ")", ";", "JsonArray", "entries", "=", "responseJSON", ".", "get", "(", "\"entries\"", ")", ".", "asArray", "(", ")", ";", "for", "(", "JsonValue", "value", ":", "entries", ")", "{", "JsonObject", "taskJSON", "=", "value", ".", "asObject", "(", ")", ";", "BoxTask", "task", "=", "new", "BoxTask", "(", "this", ".", "getAPI", "(", ")", ",", "taskJSON", ".", "get", "(", "\"id\"", ")", ".", "asString", "(", ")", ")", ";", "BoxTask", ".", "Info", "info", "=", "task", ".", "new", "Info", "(", "taskJSON", ")", ";", "tasks", ".", "add", "(", "info", ")", ";", "}", "return", "tasks", ";", "}" ]

[ "Gets", "a", "list", "of", "any", "tasks", "on", "this", "file", "with", "requested", "fields", "." ]

[ "public", "Metadata", "createMetadata", "(", "String", "typeName", ",", "Metadata", "metadata", ")", "{", "String", "scope", "=", "Metadata", ".", "scopeBasedOnType", "(", "typeName", ")", ";", "return", "this", ".", "createMetadata", "(", "typeName", ",", "scope", ",", "metadata", ")", ";", "}" ]

[ "Creates", "metadata", "on", "this", "file", "in", "the", "specified", "template", "type", "." ]

[ "public", "String", "updateClassification", "(", "String", "classificationType", ")", "{", "Metadata", "metadata", "=", "new", "Metadata", "(", "\"enterprise\"", ",", "Metadata", ".", "CLASSIFICATION_TEMPLATE_KEY", ")", ";", "metadata", ".", "add", "(", "\"/Box__Security__Classification__Key\"", ",", "classificationType", ")", ";", "Metadata", "classification", "=", "this", ".", "updateMetadata", "(", "metadata", ")", ";", "return", "classification", ".", "getString", "(", "Metadata", ".", "CLASSIFICATION_KEY", ")", ";", "}" ]

[ "Updates", "a", "metadata", "classification", "on", "the", "specified", "file", "." ]

[ "public", "String", "setClassification", "(", "String", "classificationType", ")", "{", "Metadata", "metadata", "=", "new", "Metadata", "(", ")", ".", "add", "(", "Metadata", ".", "CLASSIFICATION_KEY", ",", "classificationType", ")", ";", "Metadata", "classification", "=", "null", ";", "try", "{", "classification", "=", "this", ".", "createMetadata", "(", "Metadata", ".", "CLASSIFICATION_TEMPLATE_KEY", ",", "\"enterprise\"", ",", "metadata", ")", ";", "}", "catch", "(", "BoxAPIException", "e", ")", "{", "if", "(", "e", ".", "getResponseCode", "(", ")", "==", "409", ")", "{", "metadata", "=", "new", "Metadata", "(", "\"enterprise\"", ",", "Metadata", ".", "CLASSIFICATION_TEMPLATE_KEY", ")", ";", "metadata", ".", "replace", "(", "Metadata", ".", "CLASSIFICATION_KEY", ",", "classificationType", ")", ";", "classification", "=", "this", ".", "updateMetadata", "(", "metadata", ")", ";", "}", "else", "{", "throw", "e", ";", "}", "}", "return", "classification", ".", "getString", "(", "Metadata", ".", "CLASSIFICATION_KEY", ")", ";", "}" ]

[ "Attempts", "to", "add", "classification", "to", "a", "file", ".", "If", "classification", "already", "exists", "then", "do", "update", "." ]

[ "public", "BoxLock", "lock", "(", "Date", "expiresAt", ",", "boolean", "isDownloadPrevented", ")", "{", "String", "queryString", "=", "new", "QueryStringBuilder", "(", ")", ".", "appendParam", "(", "\"fields\"", ",", "\"lock\"", ")", ".", "toString", "(", ")", ";", "URL", "url", "=", "FILE_URL_TEMPLATE", ".", "buildWithQuery", "(", "this", ".", "getAPI", "(", ")", ".", "getBaseURL", "(", ")", ",", "queryString", ",", "this", ".", "getID", "(", ")", ")", ";", "BoxAPIRequest", "request", "=", "new", "BoxAPIRequest", "(", "this", ".", "getAPI", "(", ")", ",", "url", ",", "\"PUT\"", ")", ";", "JsonObject", "lockConfig", "=", "new", "JsonObject", "(", ")", ";", "lockConfig", ".", "add", "(", "\"type\"", ",", "\"lock\"", ")", ";", "if", "(", "expiresAt", "!=", "null", ")", "{", "lockConfig", ".", "add", "(", "\"expires_at\"", ",", "BoxDateFormat", ".", "format", "(", "expiresAt", ")", ")", ";", "}", "lockConfig", ".", "add", "(", "\"is_download_prevented\"", ",", "isDownloadPrevented", ")", ";", "JsonObject", "requestJSON", "=", "new", "JsonObject", "(", ")", ";", "requestJSON", ".", "add", "(", "\"lock\"", ",", "lockConfig", ")", ";", "request", ".", "setBody", "(", "requestJSON", ".", "toString", "(", ")", ")", ";", "BoxJSONResponse", "response", "=", "(", "BoxJSONResponse", ")", "request", ".", "send", "(", ")", ";", "JsonObject", "responseJSON", "=", "JsonObject", ".", "readFrom", "(", "response", ".", "getJSON", "(", ")", ")", ";", "JsonValue", "lockValue", "=", "responseJSON", ".", "get", "(", "\"lock\"", ")", ";", "JsonObject", "lockJSON", "=", "JsonObject", ".", "readFrom", "(", "lockValue", ".", "toString", "(", ")", ")", ";", "return", "new", "BoxLock", "(", "lockJSON", ",", "this", ".", "getAPI", "(", ")", ")", ";", "}" ]

[ "Locks", "a", "file", "." ]

[ "public", "void", "unlock", "(", ")", "{", "String", "queryString", "=", "new", "QueryStringBuilder", "(", ")", ".", "appendParam", "(", "\"fields\"", ",", "\"lock\"", ")", ".", "toString", "(", ")", ";", "URL", "url", "=", "FILE_URL_TEMPLATE", ".", "buildWithQuery", "(", "this", ".", "getAPI", "(", ")", ".", "getBaseURL", "(", ")", ",", "queryString", ",", "this", ".", "getID", "(", ")", ")", ";", "BoxAPIRequest", "request", "=", "new", "BoxAPIRequest", "(", "this", ".", "getAPI", "(", ")", ",", "url", ",", "\"PUT\"", ")", ";", "JsonObject", "lockObject", "=", "new", "JsonObject", "(", ")", ";", "lockObject", ".", "add", "(", "\"lock\"", ",", "JsonObject", ".", "NULL", ")", ";", "request", ".", "setBody", "(", "lockObject", ".", "toString", "(", ")", ")", ";", "request", ".", "send", "(", ")", ";", "}" ]

[ "Unlocks", "a", "file", "." ]

[ "public", "Metadata", "updateMetadata", "(", "Metadata", "metadata", ")", "{", "String", "scope", ";", "if", "(", "metadata", ".", "getScope", "(", ")", ".", "equals", "(", "Metadata", ".", "GLOBAL_METADATA_SCOPE", ")", ")", "{", "scope", "=", "Metadata", ".", "GLOBAL_METADATA_SCOPE", ";", "}", "else", "{", "scope", "=", "Metadata", ".", "ENTERPRISE_METADATA_SCOPE", ";", "}", "URL", "url", "=", "METADATA_URL_TEMPLATE", ".", "build", "(", "this", ".", "getAPI", "(", ")", ".", "getBaseURL", "(", ")", ",", "this", ".", "getID", "(", ")", ",", "scope", ",", "metadata", ".", "getTemplateName", "(", ")", ")", ";", "BoxAPIRequest", "request", "=", "new", "BoxAPIRequest", "(", "this", ".", "getAPI", "(", ")", ",", "url", ",", "\"PUT\"", ")", ";", "request", ".", "addHeader", "(", "\"Content-Type\"", ",", "\"application/json-patch+json\"", ")", ";", "request", ".", "setBody", "(", "metadata", ".", "getPatch", "(", ")", ")", ";", "BoxJSONResponse", "response", "=", "(", "BoxJSONResponse", ")", "request", ".", "send", "(", ")", ";", "return", "new", "Metadata", "(", "JsonObject", ".", "readFrom", "(", "response", ".", "getJSON", "(", ")", ")", ")", ";", "}" ]

[ "Updates", "the", "file", "metadata", "." ]

[ "public", "BoxFileUploadSession", ".", "Info", "createUploadSession", "(", "long", "fileSize", ")", "{", "URL", "url", "=", "UPLOAD_SESSION_URL_TEMPLATE", ".", "build", "(", "this", ".", "getAPI", "(", ")", ".", "getBaseUploadURL", "(", ")", ",", "this", ".", "getID", "(", ")", ")", ";", "BoxJSONRequest", "request", "=", "new", "BoxJSONRequest", "(", "this", ".", "getAPI", "(", ")", ",", "url", ",", "\"POST\"", ")", ";", "request", ".", "addHeader", "(", "\"Content-Type\"", ",", "\"application/json\"", ")", ";", "JsonObject", "body", "=", "new", "JsonObject", "(", ")", ";", "body", ".", "add", "(", "\"file_size\"", ",", "fileSize", ")", ";", "request", ".", "setBody", "(", "body", ".", "toString", "(", ")", ")", ";", "BoxJSONResponse", "response", "=", "(", "BoxJSONResponse", ")", "request", ".", "send", "(", ")", ";", "JsonObject", "jsonObject", "=", "JsonObject", ".", "readFrom", "(", "response", ".", "getJSON", "(", ")", ")", ";", "String", "sessionId", "=", "jsonObject", ".", "get", "(", "\"id\"", ")", ".", "asString", "(", ")", ";", "BoxFileUploadSession", "session", "=", "new", "BoxFileUploadSession", "(", "this", ".", "getAPI", "(", ")", ",", "sessionId", ")", ";", "return", "session", ".", "new", "Info", "(", "jsonObject", ")", ";", "}" ]

[ "Creates", "an", "upload", "session", "to", "create", "a", "new", "version", "of", "a", "file", "in", "chunks", ".", "This", "will", "first", "verify", "that", "the", "version", "can", "be", "created", "and", "then", "open", "a", "session", "for", "uploading", "pieces", "of", "the", "file", "." ]

[ "public", "static", "EventLog", "getEnterpriseEvents", "(", "BoxAPIConnection", "api", ",", "Date", "after", ",", "Date", "before", ",", "BoxEvent", ".", "Type", "...", "types", ")", "{", "return", "getEnterpriseEvents", "(", "api", ",", "null", ",", "after", ",", "before", ",", "ENTERPRISE_LIMIT", ",", "types", ")", ";", "}" ]

[ "Gets", "all", "the", "enterprise", "events", "that", "occurred", "within", "a", "specified", "date", "range", "." ]

[ "public", "BoxStoragePolicy", ".", "Info", "getInfo", "(", "String", "...", "fields", ")", "{", "QueryStringBuilder", "builder", "=", "new", "QueryStringBuilder", "(", ")", ";", "if", "(", "fields", ".", "length", ">", "0", ")", "{", "builder", ".", "appendParam", "(", "\"fields\"", ",", "fields", ")", ";", "}", "URL", "url", "=", "STORAGE_POLICY_WITH_ID_URL_TEMPLATE", ".", "buildWithQuery", "(", "this", ".", "getAPI", "(", ")", ".", "getBaseURL", "(", ")", ",", "builder", ".", "toString", "(", ")", ",", "this", ".", "getID", "(", ")", ")", ";", "BoxAPIRequest", "request", "=", "new", "BoxAPIRequest", "(", "this", ".", "getAPI", "(", ")", ",", "url", ",", "\"GET\"", ")", ";", "BoxJSONResponse", "response", "=", "(", "BoxJSONResponse", ")", "request", ".", "send", "(", ")", ";", "return", "new", "Info", "(", "response", ".", "getJSON", "(", ")", ")", ";", "}" ]

[ "Gets", "information", "for", "a", "Box", "Storage", "Policy", "with", "optional", "fields", "." ]

[ "public", "BoxFile", ".", "Info", "upload", "(", "BoxAPIConnection", "boxApi", ",", "String", "folderId", ",", "InputStream", "stream", ",", "URL", "url", ",", "String", "fileName", ",", "long", "fileSize", ")", "throws", "InterruptedException", ",", "IOException", "{", "//Create a upload session", "BoxFileUploadSession", ".", "Info", "session", "=", "this", ".", "createUploadSession", "(", "boxApi", ",", "folderId", ",", "url", ",", "fileName", ",", "fileSize", ")", ";", "return", "this", ".", "uploadHelper", "(", "session", ",", "stream", ",", "fileSize", ")", ";", "}" ]

[ "Uploads", "a", "new", "large", "file", "." ]

[ "public", "String", "generateDigest", "(", "InputStream", "stream", ")", "{", "MessageDigest", "digest", "=", "null", ";", "try", "{", "digest", "=", "MessageDigest", ".", "getInstance", "(", "DIGEST_ALGORITHM_SHA1", ")", ";", "}", "catch", "(", "NoSuchAlgorithmException", "ae", ")", "{", "throw", "new", "BoxAPIException", "(", "\"Digest algorithm not found\"", ",", "ae", ")", ";", "}", "//Calcuate the digest using the stream.", "DigestInputStream", "dis", "=", "new", "DigestInputStream", "(", "stream", ",", "digest", ")", ";", "try", "{", "int", "value", "=", "dis", ".", "read", "(", ")", ";", "while", "(", "value", "!=", "-", "1", ")", "{", "value", "=", "dis", ".", "read", "(", ")", ";", "}", "}", "catch", "(", "IOException", "ioe", ")", "{", "throw", "new", "BoxAPIException", "(", "\"Reading the stream failed.\"", ",", "ioe", ")", ";", "}", "//Get the calculated digest for the stream", "byte", "[", "]", "digestBytes", "=", "digest", ".", "digest", "(", ")", ";", "return", "Base64", ".", "encode", "(", "digestBytes", ")", ";", "}" ]

[ "Generates", "the", "Base64", "encoded", "SHA", "-", "1", "hash", "for", "content", "available", "in", "the", "stream", ".", "It", "can", "be", "used", "to", "calculate", "the", "hash", "of", "a", "file", "." ]

[ "public", "void", "setPermissions", "(", "Permissions", "permissions", ")", "{", "if", "(", "this", ".", "permissions", "==", "permissions", ")", "{", "return", ";", "}", "this", ".", "removeChildObject", "(", "\"permissions\"", ")", ";", "this", ".", "permissions", "=", "permissions", ";", "this", ".", "addChildObject", "(", "\"permissions\"", ",", "permissions", ")", ";", "}" ]

[ "Sets", "the", "permissions", "associated", "with", "this", "shared", "link", "." ]

[ "public", "void", "deleteFolder", "(", "String", "folderID", ")", "{", "URL", "url", "=", "FOLDER_INFO_URL_TEMPLATE", ".", "build", "(", "this", ".", "api", ".", "getBaseURL", "(", ")", ",", "folderID", ")", ";", "BoxAPIRequest", "request", "=", "new", "BoxAPIRequest", "(", "this", ".", "api", ",", "url", ",", "\"DELETE\"", ")", ";", "BoxAPIResponse", "response", "=", "request", ".", "send", "(", ")", ";", "response", ".", "disconnect", "(", ")", ";", "}" ]

[ "Permanently", "deletes", "a", "trashed", "folder", "." ]

[ "public", "BoxFolder", ".", "Info", "getFolderInfo", "(", "String", "folderID", ")", "{", "URL", "url", "=", "FOLDER_INFO_URL_TEMPLATE", ".", "build", "(", "this", ".", "api", ".", "getBaseURL", "(", ")", ",", "folderID", ")", ";", "BoxAPIRequest", "request", "=", "new", "BoxAPIRequest", "(", "this", ".", "api", ",", "url", ",", "\"GET\"", ")", ";", "BoxJSONResponse", "response", "=", "(", "BoxJSONResponse", ")", "request", ".", "send", "(", ")", ";", "JsonObject", "jsonObject", "=", "JsonObject", ".", "readFrom", "(", "response", ".", "getJSON", "(", ")", ")", ";", "BoxFolder", "folder", "=", "new", "BoxFolder", "(", "this", ".", "api", ",", "jsonObject", ".", "get", "(", "\"id\"", ")", ".", "asString", "(", ")", ")", ";", "return", "folder", ".", "new", "Info", "(", "response", ".", "getJSON", "(", ")", ")", ";", "}" ]

[ "Gets", "information", "about", "a", "trashed", "folder", "." ]

[ "public", "BoxFolder", ".", "Info", "getFolderInfo", "(", "String", "folderID", ",", "String", "...", "fields", ")", "{", "String", "queryString", "=", "new", "QueryStringBuilder", "(", ")", ".", "appendParam", "(", "\"fields\"", ",", "fields", ")", ".", "toString", "(", ")", ";", "URL", "url", "=", "FOLDER_INFO_URL_TEMPLATE", ".", "buildWithQuery", "(", "this", ".", "api", ".", "getBaseURL", "(", ")", ",", "queryString", ",", "folderID", ")", ";", "BoxAPIRequest", "request", "=", "new", "BoxAPIRequest", "(", "this", ".", "api", ",", "url", ",", "\"GET\"", ")", ";", "BoxJSONResponse", "response", "=", "(", "BoxJSONResponse", ")", "request", ".", "send", "(", ")", ";", "JsonObject", "jsonObject", "=", "JsonObject", ".", "readFrom", "(", "response", ".", "getJSON", "(", ")", ")", ";", "BoxFolder", "folder", "=", "new", "BoxFolder", "(", "this", ".", "api", ",", "jsonObject", ".", "get", "(", "\"id\"", ")", ".", "asString", "(", ")", ")", ";", "return", "folder", ".", "new", "Info", "(", "response", ".", "getJSON", "(", ")", ")", ";", "}" ]

[ "Gets", "information", "about", "a", "trashed", "folder", "that", "s", "limited", "to", "a", "list", "of", "specified", "fields", "." ]

[ "public", "BoxFolder", ".", "Info", "restoreFolder", "(", "String", "folderID", ")", "{", "URL", "url", "=", "RESTORE_FOLDER_URL_TEMPLATE", ".", "build", "(", "this", ".", "api", ".", "getBaseURL", "(", ")", ",", "folderID", ")", ";", "BoxAPIRequest", "request", "=", "new", "BoxAPIRequest", "(", "this", ".", "api", ",", "url", ",", "\"POST\"", ")", ";", "JsonObject", "requestJSON", "=", "new", "JsonObject", "(", ")", ".", "add", "(", "\"\"", ",", "\"\"", ")", ";", "request", ".", "setBody", "(", "requestJSON", ".", "toString", "(", ")", ")", ";", "BoxJSONResponse", "response", "=", "(", "BoxJSONResponse", ")", "request", ".", "send", "(", ")", ";", "JsonObject", "responseJSON", "=", "JsonObject", ".", "readFrom", "(", "response", ".", "getJSON", "(", ")", ")", ";", "BoxFolder", "restoredFolder", "=", "new", "BoxFolder", "(", "this", ".", "api", ",", "responseJSON", ".", "get", "(", "\"id\"", ")", ".", "asString", "(", ")", ")", ";", "return", "restoredFolder", ".", "new", "Info", "(", "responseJSON", ")", ";", "}" ]

[ "Restores", "a", "trashed", "folder", "back", "to", "its", "original", "location", "." ]

[ "public", "BoxFolder", ".", "Info", "restoreFolder", "(", "String", "folderID", ",", "String", "newName", ",", "String", "newParentID", ")", "{", "JsonObject", "requestJSON", "=", "new", "JsonObject", "(", ")", ";", "if", "(", "newName", "!=", "null", ")", "{", "requestJSON", ".", "add", "(", "\"name\"", ",", "newName", ")", ";", "}", "if", "(", "newParentID", "!=", "null", ")", "{", "JsonObject", "parent", "=", "new", "JsonObject", "(", ")", ";", "parent", ".", "add", "(", "\"id\"", ",", "newParentID", ")", ";", "requestJSON", ".", "add", "(", "\"parent\"", ",", "parent", ")", ";", "}", "URL", "url", "=", "RESTORE_FOLDER_URL_TEMPLATE", ".", "build", "(", "this", ".", "api", ".", "getBaseURL", "(", ")", ",", "folderID", ")", ";", "BoxJSONRequest", "request", "=", "new", "BoxJSONRequest", "(", "this", ".", "api", ",", "url", ",", "\"POST\"", ")", ";", "request", ".", "setBody", "(", "requestJSON", ".", "toString", "(", ")", ")", ";", "BoxJSONResponse", "response", "=", "(", "BoxJSONResponse", ")", "request", ".", "send", "(", ")", ";", "JsonObject", "responseJSON", "=", "JsonObject", ".", "readFrom", "(", "response", ".", "getJSON", "(", ")", ")", ";", "BoxFolder", "restoredFolder", "=", "new", "BoxFolder", "(", "this", ".", "api", ",", "responseJSON", ".", "get", "(", "\"id\"", ")", ".", "asString", "(", ")", ")", ";", "return", "restoredFolder", ".", "new", "Info", "(", "responseJSON", ")", ";", "}" ]

[ "Restores", "a", "trashed", "folder", "to", "a", "new", "location", "with", "a", "new", "name", "." ]

[ "public", "void", "deleteFile", "(", "String", "fileID", ")", "{", "URL", "url", "=", "FILE_INFO_URL_TEMPLATE", ".", "build", "(", "this", ".", "api", ".", "getBaseURL", "(", ")", ",", "fileID", ")", ";", "BoxAPIRequest", "request", "=", "new", "BoxAPIRequest", "(", "this", ".", "api", ",", "url", ",", "\"DELETE\"", ")", ";", "BoxAPIResponse", "response", "=", "request", ".", "send", "(", ")", ";", "response", ".", "disconnect", "(", ")", ";", "}" ]

[ "Permanently", "deletes", "a", "trashed", "file", "." ]

[ "public", "BoxFile", ".", "Info", "getFileInfo", "(", "String", "fileID", ")", "{", "URL", "url", "=", "FILE_INFO_URL_TEMPLATE", ".", "build", "(", "this", ".", "api", ".", "getBaseURL", "(", ")", ",", "fileID", ")", ";", "BoxAPIRequest", "request", "=", "new", "BoxAPIRequest", "(", "this", ".", "api", ",", "url", ",", "\"GET\"", ")", ";", "BoxJSONResponse", "response", "=", "(", "BoxJSONResponse", ")", "request", ".", "send", "(", ")", ";", "JsonObject", "jsonObject", "=", "JsonObject", ".", "readFrom", "(", "response", ".", "getJSON", "(", ")", ")", ";", "BoxFile", "file", "=", "new", "BoxFile", "(", "this", ".", "api", ",", "jsonObject", ".", "get", "(", "\"id\"", ")", ".", "asString", "(", ")", ")", ";", "return", "file", ".", "new", "Info", "(", "response", ".", "getJSON", "(", ")", ")", ";", "}" ]

[ "Gets", "information", "about", "a", "trashed", "file", "." ]

[ "public", "BoxFile", ".", "Info", "getFileInfo", "(", "String", "fileID", ",", "String", "...", "fields", ")", "{", "String", "queryString", "=", "new", "QueryStringBuilder", "(", ")", ".", "appendParam", "(", "\"fields\"", ",", "fields", ")", ".", "toString", "(", ")", ";", "URL", "url", "=", "FILE_INFO_URL_TEMPLATE", ".", "buildWithQuery", "(", "this", ".", "api", ".", "getBaseURL", "(", ")", ",", "queryString", ",", "fileID", ")", ";", "BoxAPIRequest", "request", "=", "new", "BoxAPIRequest", "(", "this", ".", "api", ",", "url", ",", "\"GET\"", ")", ";", "BoxJSONResponse", "response", "=", "(", "BoxJSONResponse", ")", "request", ".", "send", "(", ")", ";", "JsonObject", "jsonObject", "=", "JsonObject", ".", "readFrom", "(", "response", ".", "getJSON", "(", ")", ")", ";", "BoxFile", "file", "=", "new", "BoxFile", "(", "this", ".", "api", ",", "jsonObject", ".", "get", "(", "\"id\"", ")", ".", "asString", "(", ")", ")", ";", "return", "file", ".", "new", "Info", "(", "response", ".", "getJSON", "(", ")", ")", ";", "}" ]

[ "Gets", "information", "about", "a", "trashed", "file", "that", "s", "limited", "to", "a", "list", "of", "specified", "fields", "." ]

[ "public", "BoxFile", ".", "Info", "restoreFile", "(", "String", "fileID", ")", "{", "URL", "url", "=", "RESTORE_FILE_URL_TEMPLATE", ".", "build", "(", "this", ".", "api", ".", "getBaseURL", "(", ")", ",", "fileID", ")", ";", "BoxAPIRequest", "request", "=", "new", "BoxAPIRequest", "(", "this", ".", "api", ",", "url", ",", "\"POST\"", ")", ";", "JsonObject", "requestJSON", "=", "new", "JsonObject", "(", ")", ".", "add", "(", "\"\"", ",", "\"\"", ")", ";", "request", ".", "setBody", "(", "requestJSON", ".", "toString", "(", ")", ")", ";", "BoxJSONResponse", "response", "=", "(", "BoxJSONResponse", ")", "request", ".", "send", "(", ")", ";", "JsonObject", "responseJSON", "=", "JsonObject", ".", "readFrom", "(", "response", ".", "getJSON", "(", ")", ")", ";", "BoxFile", "restoredFile", "=", "new", "BoxFile", "(", "this", ".", "api", ",", "responseJSON", ".", "get", "(", "\"id\"", ")", ".", "asString", "(", ")", ")", ";", "return", "restoredFile", ".", "new", "Info", "(", "responseJSON", ")", ";", "}" ]

[ "Restores", "a", "trashed", "file", "back", "to", "its", "original", "location", "." ]

[ "public", "BoxFile", ".", "Info", "restoreFile", "(", "String", "fileID", ",", "String", "newName", ",", "String", "newParentID", ")", "{", "JsonObject", "requestJSON", "=", "new", "JsonObject", "(", ")", ";", "if", "(", "newName", "!=", "null", ")", "{", "requestJSON", ".", "add", "(", "\"name\"", ",", "newName", ")", ";", "}", "if", "(", "newParentID", "!=", "null", ")", "{", "JsonObject", "parent", "=", "new", "JsonObject", "(", ")", ";", "parent", ".", "add", "(", "\"id\"", ",", "newParentID", ")", ";", "requestJSON", ".", "add", "(", "\"parent\"", ",", "parent", ")", ";", "}", "URL", "url", "=", "RESTORE_FILE_URL_TEMPLATE", ".", "build", "(", "this", ".", "api", ".", "getBaseURL", "(", ")", ",", "fileID", ")", ";", "BoxJSONRequest", "request", "=", "new", "BoxJSONRequest", "(", "this", ".", "api", ",", "url", ",", "\"POST\"", ")", ";", "request", ".", "setBody", "(", "requestJSON", ".", "toString", "(", ")", ")", ";", "BoxJSONResponse", "response", "=", "(", "BoxJSONResponse", ")", "request", ".", "send", "(", ")", ";", "JsonObject", "responseJSON", "=", "JsonObject", ".", "readFrom", "(", "response", ".", "getJSON", "(", ")", ")", ";", "BoxFile", "restoredFile", "=", "new", "BoxFile", "(", "this", ".", "api", ",", "responseJSON", ".", "get", "(", "\"id\"", ")", ".", "asString", "(", ")", ")", ";", "return", "restoredFile", ".", "new", "Info", "(", "responseJSON", ")", ";", "}" ]

[ "Restores", "a", "trashed", "file", "to", "a", "new", "location", "with", "a", "new", "name", "." ]

[ "public", "Iterator", "<", "BoxItem", ".", "Info", ">", "iterator", "(", ")", "{", "URL", "url", "=", "GET_ITEMS_URL", ".", "build", "(", "this", ".", "api", ".", "getBaseURL", "(", ")", ")", ";", "return", "new", "BoxItemIterator", "(", "this", ".", "api", ",", "url", ")", ";", "}" ]

[ "Returns", "an", "iterator", "over", "the", "items", "in", "the", "trash", "." ]

[ "public", "static", "MetadataTemplate", "createMetadataTemplate", "(", "BoxAPIConnection", "api", ",", "String", "scope", ",", "String", "templateKey", ",", "String", "displayName", ",", "boolean", "hidden", ",", "List", "<", "Field", ">", "fields", ")", "{", "JsonObject", "jsonObject", "=", "new", "JsonObject", "(", ")", ";", "jsonObject", ".", "add", "(", "\"scope\"", ",", "scope", ")", ";", "jsonObject", ".", "add", "(", "\"displayName\"", ",", "displayName", ")", ";", "jsonObject", ".", "add", "(", "\"hidden\"", ",", "hidden", ")", ";", "if", "(", "templateKey", "!=", "null", ")", "{", "jsonObject", ".", "add", "(", "\"templateKey\"", ",", "templateKey", ")", ";", "}", "JsonArray", "fieldsArray", "=", "new", "JsonArray", "(", ")", ";", "if", "(", "fields", "!=", "null", "&&", "!", "fields", ".", "isEmpty", "(", ")", ")", "{", "for", "(", "Field", "field", ":", "fields", ")", "{", "JsonObject", "fieldObj", "=", "getFieldJsonObject", "(", "field", ")", ";", "fieldsArray", ".", "add", "(", "fieldObj", ")", ";", "}", "jsonObject", ".", "add", "(", "\"fields\"", ",", "fieldsArray", ")", ";", "}", "URL", "url", "=", "METADATA_TEMPLATE_SCHEMA_URL_TEMPLATE", ".", "build", "(", "api", ".", "getBaseURL", "(", ")", ")", ";", "BoxJSONRequest", "request", "=", "new", "BoxJSONRequest", "(", "api", ",", "url", ",", "\"POST\"", ")", ";", "request", ".", "setBody", "(", "jsonObject", ".", "toString", "(", ")", ")", ";", "BoxJSONResponse", "response", "=", "(", "BoxJSONResponse", ")", "request", ".", "send", "(", ")", ";", "JsonObject", "responseJSON", "=", "JsonObject", ".", "readFrom", "(", "response", ".", "getJSON", "(", ")", ")", ";", "return", "new", "MetadataTemplate", "(", "responseJSON", ")", ";", "}" ]

[ "Creates", "new", "metadata", "template", "." ]

[ "private", "static", "JsonObject", "getFieldJsonObject", "(", "Field", "field", ")", "{", "JsonObject", "fieldObj", "=", "new", "JsonObject", "(", ")", ";", "fieldObj", ".", "add", "(", "\"type\"", ",", "field", ".", "getType", "(", ")", ")", ";", "fieldObj", ".", "add", "(", "\"key\"", ",", "field", ".", "getKey", "(", ")", ")", ";", "fieldObj", ".", "add", "(", "\"displayName\"", ",", "field", ".", "getDisplayName", "(", ")", ")", ";", "String", "fieldDesc", "=", "field", ".", "getDescription", "(", ")", ";", "if", "(", "fieldDesc", "!=", "null", ")", "{", "fieldObj", ".", "add", "(", "\"description\"", ",", "field", ".", "getDescription", "(", ")", ")", ";", "}", "Boolean", "fieldIsHidden", "=", "field", ".", "getIsHidden", "(", ")", ";", "if", "(", "fieldIsHidden", "!=", "null", ")", "{", "fieldObj", ".", "add", "(", "\"hidden\"", ",", "field", ".", "getIsHidden", "(", ")", ")", ";", "}", "JsonArray", "array", "=", "new", "JsonArray", "(", ")", ";", "List", "<", "String", ">", "options", "=", "field", ".", "getOptions", "(", ")", ";", "if", "(", "options", "!=", "null", "&&", "!", "options", ".", "isEmpty", "(", ")", ")", "{", "for", "(", "String", "option", ":", "options", ")", "{", "JsonObject", "optionObj", "=", "new", "JsonObject", "(", ")", ";", "optionObj", ".", "add", "(", "\"key\"", ",", "option", ")", ";", "array", ".", "add", "(", "optionObj", ")", ";", "}", "fieldObj", ".", "add", "(", "\"options\"", ",", "array", ")", ";", "}", "return", "fieldObj", ";", "}" ]

[ "Gets", "the", "JsonObject", "representation", "of", "the", "given", "field", "object", "." ]

[ "public", "static", "MetadataTemplate", "updateMetadataTemplate", "(", "BoxAPIConnection", "api", ",", "String", "scope", ",", "String", "template", ",", "List", "<", "FieldOperation", ">", "fieldOperations", ")", "{", "JsonArray", "array", "=", "new", "JsonArray", "(", ")", ";", "for", "(", "FieldOperation", "fieldOperation", ":", "fieldOperations", ")", "{", "JsonObject", "jsonObject", "=", "getFieldOperationJsonObject", "(", "fieldOperation", ")", ";", "array", ".", "add", "(", "jsonObject", ")", ";", "}", "QueryStringBuilder", "builder", "=", "new", "QueryStringBuilder", "(", ")", ";", "URL", "url", "=", "METADATA_TEMPLATE_URL_TEMPLATE", ".", "build", "(", "api", ".", "getBaseURL", "(", ")", ",", "scope", ",", "template", ")", ";", "BoxJSONRequest", "request", "=", "new", "BoxJSONRequest", "(", "api", ",", "url", ",", "\"PUT\"", ")", ";", "request", ".", "setBody", "(", "array", ".", "toString", "(", ")", ")", ";", "BoxJSONResponse", "response", "=", "(", "BoxJSONResponse", ")", "request", ".", "send", "(", ")", ";", "JsonObject", "responseJson", "=", "JsonObject", ".", "readFrom", "(", "response", ".", "getJSON", "(", ")", ")", ";", "return", "new", "MetadataTemplate", "(", "responseJson", ")", ";", "}" ]

[ "Updates", "the", "schema", "of", "an", "existing", "metadata", "template", "." ]

[ "public", "static", "void", "deleteMetadataTemplate", "(", "BoxAPIConnection", "api", ",", "String", "scope", ",", "String", "template", ")", "{", "URL", "url", "=", "METADATA_TEMPLATE_URL_TEMPLATE", ".", "build", "(", "api", ".", "getBaseURL", "(", ")", ",", "scope", ",", "template", ")", ";", "BoxJSONRequest", "request", "=", "new", "BoxJSONRequest", "(", "api", ",", "url", ",", "\"DELETE\"", ")", ";", "request", ".", "send", "(", ")", ";", "}" ]

[ "Deletes", "the", "schema", "of", "an", "existing", "metadata", "template", "." ]

[ "private", "static", "JsonObject", "getFieldOperationJsonObject", "(", "FieldOperation", "fieldOperation", ")", "{", "JsonObject", "jsonObject", "=", "new", "JsonObject", "(", ")", ";", "jsonObject", ".", "add", "(", "\"op\"", ",", "fieldOperation", ".", "getOp", "(", ")", ".", "toString", "(", ")", ")", ";", "String", "fieldKey", "=", "fieldOperation", ".", "getFieldKey", "(", ")", ";", "if", "(", "fieldKey", "!=", "null", ")", "{", "jsonObject", ".", "add", "(", "\"fieldKey\"", ",", "fieldKey", ")", ";", "}", "Field", "field", "=", "fieldOperation", ".", "getData", "(", ")", ";", "if", "(", "field", "!=", "null", ")", "{", "JsonObject", "fieldObj", "=", "new", "JsonObject", "(", ")", ";", "String", "type", "=", "field", ".", "getType", "(", ")", ";", "if", "(", "type", "!=", "null", ")", "{", "fieldObj", ".", "add", "(", "\"type\"", ",", "type", ")", ";", "}", "String", "key", "=", "field", ".", "getKey", "(", ")", ";", "if", "(", "key", "!=", "null", ")", "{", "fieldObj", ".", "add", "(", "\"key\"", ",", "key", ")", ";", "}", "String", "displayName", "=", "field", ".", "getDisplayName", "(", ")", ";", "if", "(", "displayName", "!=", "null", ")", "{", "fieldObj", ".", "add", "(", "\"displayName\"", ",", "displayName", ")", ";", "}", "String", "description", "=", "field", ".", "getDescription", "(", ")", ";", "if", "(", "description", "!=", "null", ")", "{", "fieldObj", ".", "add", "(", "\"description\"", ",", "description", ")", ";", "}", "Boolean", "hidden", "=", "field", ".", "getIsHidden", "(", ")", ";", "if", "(", "hidden", "!=", "null", ")", "{", "fieldObj", ".", "add", "(", "\"hidden\"", ",", "hidden", ")", ";", "}", "List", "<", "String", ">", "options", "=", "field", ".", "getOptions", "(", ")", ";", "if", "(", "options", "!=", "null", ")", "{", "JsonArray", "array", "=", "new", "JsonArray", "(", ")", ";", "for", "(", "String", "option", ":", "options", ")", "{", "JsonObject", "optionObj", "=", "new", "JsonObject", "(", ")", ";", "optionObj", ".", "add", "(", "\"key\"", ",", "option", ")", ";", "array", ".", "add", "(", "optionObj", ")", ";", "}", "fieldObj", ".", "add", "(", "\"options\"", ",", "array", ")", ";", "}", "jsonObject", ".", "add", "(", "\"data\"", ",", "fieldObj", ")", ";", "}", "List", "<", "String", ">", "fieldKeys", "=", "fieldOperation", ".", "getFieldKeys", "(", ")", ";", "if", "(", "fieldKeys", "!=", "null", ")", "{", "jsonObject", ".", "add", "(", "\"fieldKeys\"", ",", "getJsonArray", "(", "fieldKeys", ")", ")", ";", "}", "List", "<", "String", ">", "enumOptionKeys", "=", "fieldOperation", ".", "getEnumOptionKeys", "(", ")", ";", "if", "(", "enumOptionKeys", "!=", "null", ")", "{", "jsonObject", ".", "add", "(", "\"enumOptionKeys\"", ",", "getJsonArray", "(", "enumOptionKeys", ")", ")", ";", "}", "String", "enumOptionKey", "=", "fieldOperation", ".", "getEnumOptionKey", "(", ")", ";", "if", "(", "enumOptionKey", "!=", "null", ")", "{", "jsonObject", ".", "add", "(", "\"enumOptionKey\"", ",", "enumOptionKey", ")", ";", "}", "String", "multiSelectOptionKey", "=", "fieldOperation", ".", "getMultiSelectOptionKey", "(", ")", ";", "if", "(", "multiSelectOptionKey", "!=", "null", ")", "{", "jsonObject", ".", "add", "(", "\"multiSelectOptionKey\"", ",", "multiSelectOptionKey", ")", ";", "}", "List", "<", "String", ">", "multiSelectOptionKeys", "=", "fieldOperation", ".", "getMultiSelectOptionKeys", "(", ")", ";", "if", "(", "multiSelectOptionKeys", "!=", "null", ")", "{", "jsonObject", ".", "add", "(", "\"multiSelectOptionKeys\"", ",", "getJsonArray", "(", "multiSelectOptionKeys", ")", ")", ";", "}", "return", "jsonObject", ";", "}" ]

[ "Gets", "the", "JsonObject", "representation", "of", "the", "Field", "Operation", "." ]

[ "private", "static", "JsonArray", "getJsonArray", "(", "List", "<", "String", ">", "keys", ")", "{", "JsonArray", "array", "=", "new", "JsonArray", "(", ")", ";", "for", "(", "String", "key", ":", "keys", ")", "{", "array", ".", "add", "(", "key", ")", ";", "}", "return", "array", ";", "}" ]

[ "Gets", "the", "Json", "Array", "representation", "of", "the", "given", "list", "of", "strings", "." ]

[ "public", "static", "MetadataTemplate", "getMetadataTemplateByID", "(", "BoxAPIConnection", "api", ",", "String", "templateID", ")", "{", "URL", "url", "=", "METADATA_TEMPLATE_BY_ID_URL_TEMPLATE", ".", "build", "(", "api", ".", "getBaseURL", "(", ")", ",", "templateID", ")", ";", "BoxAPIRequest", "request", "=", "new", "BoxAPIRequest", "(", "api", ",", "url", ",", "\"GET\"", ")", ";", "BoxJSONResponse", "response", "=", "(", "BoxJSONResponse", ")", "request", ".", "send", "(", ")", ";", "return", "new", "MetadataTemplate", "(", "response", ".", "getJSON", "(", ")", ")", ";", "}" ]

[ "Geta", "the", "specified", "metadata", "template", "by", "its", "ID", "." ]

[ "public", "boolean", "clearParameters", "(", ")", "{", "this", ".", "query", "=", "null", ";", "this", ".", "fields", "=", "null", ";", "this", ".", "scope", "=", "null", ";", "this", ".", "fileExtensions", "=", "null", ";", "this", ".", "createdRange", "=", "null", ";", "this", ".", "updatedRange", "=", "null", ";", "this", ".", "sizeRange", "=", "null", ";", "this", ".", "ownerUserIds", "=", "null", ";", "this", ".", "ancestorFolderIds", "=", "null", ";", "this", ".", "contentTypes", "=", "null", ";", "this", ".", "type", "=", "null", ";", "this", ".", "trashContent", "=", "null", ";", "this", ".", "metadataFilter", "=", "null", ";", "this", ".", "sort", "=", "null", ";", "this", ".", "direction", "=", "null", ";", "return", "true", ";", "}" ]

[ "Clears", "the", "Parameters", "before", "performing", "a", "new", "search", "." ]

[ "private", "boolean", "isNullOrEmpty", "(", "Object", "paramValue", ")", "{", "boolean", "isNullOrEmpty", "=", "false", ";", "if", "(", "paramValue", "==", "null", ")", "{", "isNullOrEmpty", "=", "true", ";", "}", "if", "(", "paramValue", "instanceof", "String", ")", "{", "if", "(", "(", "(", "String", ")", "paramValue", ")", ".", "trim", "(", ")", ".", "equalsIgnoreCase", "(", "\"\"", ")", ")", "{", "isNullOrEmpty", "=", "true", ";", "}", "}", "else", "if", "(", "paramValue", "instanceof", "List", ")", "{", "return", "(", "(", "List", ")", "paramValue", ")", ".", "isEmpty", "(", ")", ";", "}", "return", "isNullOrEmpty", ";", "}" ]

[ "Checks", "String", "to", "see", "if", "the", "parameter", "is", "null", "." ]

[ "private", "JsonArray", "formatBoxMetadataFilterRequest", "(", ")", "{", "JsonArray", "boxMetadataFilterRequestArray", "=", "new", "JsonArray", "(", ")", ";", "JsonObject", "boxMetadataFilter", "=", "new", "JsonObject", "(", ")", ".", "add", "(", "\"templateKey\"", ",", "this", ".", "metadataFilter", ".", "getTemplateKey", "(", ")", ")", ".", "add", "(", "\"scope\"", ",", "this", ".", "metadataFilter", ".", "getScope", "(", ")", ")", ".", "add", "(", "\"filters\"", ",", "this", ".", "metadataFilter", ".", "getFiltersList", "(", ")", ")", ";", "boxMetadataFilterRequestArray", ".", "add", "(", "boxMetadataFilter", ")", ";", "return", "boxMetadataFilterRequestArray", ";", "}" ]

[ "Add", "BoxMetaDataFilter", "to", "the", "JsonArray", "boxMetadataFilterRequestArray", "." ]

[ "private", "String", "listToCSV", "(", "List", "<", "String", ">", "list", ")", "{", "String", "csvStr", "=", "\"\"", ";", "for", "(", "String", "item", ":", "list", ")", "{", "csvStr", "+=", "\",\"", "+", "item", ";", "}", "return", "csvStr", ".", "length", "(", ")", ">", "1", "?", "csvStr", ".", "substring", "(", "1", ")", ":", "csvStr", ";", "}" ]

[ "Concat", "a", "List", "into", "a", "CSV", "String", "." ]

[ "public", "QueryStringBuilder", "getQueryParameters", "(", ")", "{", "QueryStringBuilder", "builder", "=", "new", "QueryStringBuilder", "(", ")", ";", "if", "(", "this", ".", "isNullOrEmpty", "(", "this", ".", "query", ")", "&&", "this", ".", "metadataFilter", "==", "null", ")", "{", "throw", "new", "BoxAPIException", "(", "\"BoxSearchParameters requires either a search query or Metadata filter to be set.\"", ")", ";", "}", "//Set the query of the search", "if", "(", "!", "this", ".", "isNullOrEmpty", "(", "this", ".", "query", ")", ")", "{", "builder", ".", "appendParam", "(", "\"query\"", ",", "this", ".", "query", ")", ";", "}", "//Set the scope of the search", "if", "(", "!", "this", ".", "isNullOrEmpty", "(", "this", ".", "scope", ")", ")", "{", "builder", ".", "appendParam", "(", "\"scope\"", ",", "this", ".", "scope", ")", ";", "}", "//Acceptable Value: \"jpg,png\"", "if", "(", "!", "this", ".", "isNullOrEmpty", "(", "this", ".", "fileExtensions", ")", ")", "{", "builder", ".", "appendParam", "(", "\"file_extensions\"", ",", "this", ".", "listToCSV", "(", "this", ".", "fileExtensions", ")", ")", ";", "}", "//Created Date Range: From Date - To Date", "if", "(", "(", "this", ".", "createdRange", "!=", "null", ")", ")", "{", "builder", ".", "appendParam", "(", "\"created_at_range\"", ",", "this", ".", "createdRange", ".", "buildRangeString", "(", ")", ")", ";", "}", "//Updated Date Range: From Date - To Date", "if", "(", "(", "this", ".", "updatedRange", "!=", "null", ")", ")", "{", "builder", ".", "appendParam", "(", "\"updated_at_range\"", ",", "this", ".", "updatedRange", ".", "buildRangeString", "(", ")", ")", ";", "}", "//Filesize Range", "if", "(", "(", "this", ".", "sizeRange", "!=", "null", ")", ")", "{", "builder", ".", "appendParam", "(", "\"size_range\"", ",", "this", ".", "sizeRange", ".", "buildRangeString", "(", ")", ")", ";", "}", "//Owner Id's", "if", "(", "!", "this", ".", "isNullOrEmpty", "(", "this", ".", "ownerUserIds", ")", ")", "{", "builder", ".", "appendParam", "(", "\"owner_user_ids\"", ",", "this", ".", "listToCSV", "(", "this", ".", "ownerUserIds", ")", ")", ";", "}", "//Ancestor ID's", "if", "(", "!", "this", ".", "isNullOrEmpty", "(", "this", ".", "ancestorFolderIds", ")", ")", "{", "builder", ".", "appendParam", "(", "\"ancestor_folder_ids\"", ",", "this", ".", "listToCSV", "(", "this", ".", "ancestorFolderIds", ")", ")", ";", "}", "//Content Types: \"name, description\"", "if", "(", "!", "this", ".", "isNullOrEmpty", "(", "this", ".", "contentTypes", ")", ")", "{", "builder", ".", "appendParam", "(", "\"content_types\"", ",", "this", ".", "listToCSV", "(", "this", ".", "contentTypes", ")", ")", ";", "}", "//Type of File: \"file,folder,web_link\"", "if", "(", "this", ".", "type", "!=", "null", ")", "{", "builder", ".", "appendParam", "(", "\"type\"", ",", "this", ".", "type", ")", ";", "}", "//Trash Content", "if", "(", "!", "this", ".", "isNullOrEmpty", "(", "this", ".", "trashContent", ")", ")", "{", "builder", ".", "appendParam", "(", "\"trash_content\"", ",", "this", ".", "trashContent", ")", ";", "}", "//Metadata filters", "if", "(", "this", ".", "metadataFilter", "!=", "null", ")", "{", "builder", ".", "appendParam", "(", "\"mdfilters\"", ",", "this", ".", "formatBoxMetadataFilterRequest", "(", ")", ".", "toString", "(", ")", ")", ";", "}", "//Fields", "if", "(", "!", "this", ".", "isNullOrEmpty", "(", "this", ".", "fields", ")", ")", "{", "builder", ".", "appendParam", "(", "\"fields\"", ",", "this", ".", "listToCSV", "(", "this", ".", "fields", ")", ")", ";", "}", "//Sort", "if", "(", "!", "this", ".", "isNullOrEmpty", "(", "this", ".", "sort", ")", ")", "{", "builder", ".", "appendParam", "(", "\"sort\"", ",", "this", ".", "sort", ")", ";", "}", "//Direction", "if", "(", "!", "this", ".", "isNullOrEmpty", "(", "this", ".", "direction", ")", ")", "{", "builder", ".", "appendParam", "(", "\"direction\"", ",", "this", ".", "direction", ")", ";", "}", "return", "builder", ";", "}" ]

[ "Get", "the", "Query", "Paramaters", "to", "be", "used", "for", "search", "request", "." ]

[ "public", "JsonObject", "getJsonObject", "(", ")", "{", "JsonObject", "obj", "=", "new", "JsonObject", "(", ")", ";", "obj", ".", "add", "(", "\"field\"", ",", "this", ".", "field", ")", ";", "obj", ".", "add", "(", "\"value\"", ",", "this", ".", "value", ")", ";", "return", "obj", ";", "}" ]

[ "Get", "the", "JSON", "representation", "of", "the", "metadata", "field", "filter", "." ]

[ "public", "static", "BoxAPIConnection", "restore", "(", "String", "clientID", ",", "String", "clientSecret", ",", "String", "state", ")", "{", "BoxAPIConnection", "api", "=", "new", "BoxAPIConnection", "(", "clientID", ",", "clientSecret", ")", ";", "api", ".", "restore", "(", "state", ")", ";", "return", "api", ";", "}" ]

[ "Restores", "a", "BoxAPIConnection", "from", "a", "saved", "state", "." ]

[ "public", "static", "URL", "getAuthorizationURL", "(", "String", "clientID", ",", "URI", "redirectUri", ",", "String", "state", ",", "List", "<", "String", ">", "scopes", ")", "{", "URLTemplate", "template", "=", "new", "URLTemplate", "(", "AUTHORIZATION_URL", ")", ";", "QueryStringBuilder", "queryBuilder", "=", "new", "QueryStringBuilder", "(", ")", ".", "appendParam", "(", "\"client_id\"", ",", "clientID", ")", ".", "appendParam", "(", "\"response_type\"", ",", "\"code\"", ")", ".", "appendParam", "(", "\"redirect_uri\"", ",", "redirectUri", ".", "toString", "(", ")", ")", ".", "appendParam", "(", "\"state\"", ",", "state", ")", ";", "if", "(", "scopes", "!=", "null", "&&", "!", "scopes", ".", "isEmpty", "(", ")", ")", "{", "StringBuilder", "builder", "=", "new", "StringBuilder", "(", ")", ";", "int", "size", "=", "scopes", ".", "size", "(", ")", "-", "1", ";", "int", "i", "=", "0", ";", "while", "(", "i", "<", "size", ")", "{", "builder", ".", "append", "(", "scopes", ".", "get", "(", "i", ")", ")", ";", "builder", ".", "append", "(", "\" \"", ")", ";", "i", "++", ";", "}", "builder", ".", "append", "(", "scopes", ".", "get", "(", "i", ")", ")", ";", "queryBuilder", ".", "appendParam", "(", "\"scope\"", ",", "builder", ".", "toString", "(", ")", ")", ";", "}", "return", "template", ".", "buildWithQuery", "(", "\"\"", ",", "queryBuilder", ".", "toString", "(", ")", ")", ";", "}" ]

[ "Return", "the", "authorization", "URL", "which", "is", "used", "to", "perform", "the", "authorization_code", "based", "OAuth2", "flow", "." ]

[ "public", "void", "authenticate", "(", "String", "authCode", ")", "{", "URL", "url", "=", "null", ";", "try", "{", "url", "=", "new", "URL", "(", "this", ".", "tokenURL", ")", ";", "}", "catch", "(", "MalformedURLException", "e", ")", "{", "assert", "false", ":", "\"An invalid token URL indicates a bug in the SDK.\"", ";", "throw", "new", "RuntimeException", "(", "\"An invalid token URL indicates a bug in the SDK.\"", ",", "e", ")", ";", "}", "String", "urlParameters", "=", "String", ".", "format", "(", "\"grant_type=authorization_code&code=%s&client_id=%s&client_secret=%s\"", ",", "authCode", ",", "this", ".", "clientID", ",", "this", ".", "clientSecret", ")", ";", "BoxAPIRequest", "request", "=", "new", "BoxAPIRequest", "(", "this", ",", "url", ",", "\"POST\"", ")", ";", "request", ".", "shouldAuthenticate", "(", "false", ")", ";", "request", ".", "setBody", "(", "urlParameters", ")", ";", "BoxJSONResponse", "response", "=", "(", "BoxJSONResponse", ")", "request", ".", "send", "(", ")", ";", "String", "json", "=", "response", ".", "getJSON", "(", ")", ";", "JsonObject", "jsonObject", "=", "JsonObject", ".", "readFrom", "(", "json", ")", ";", "this", ".", "accessToken", "=", "jsonObject", ".", "get", "(", "\"access_token\"", ")", ".", "asString", "(", ")", ";", "this", ".", "refreshToken", "=", "jsonObject", ".", "get", "(", "\"refresh_token\"", ")", ".", "asString", "(", ")", ";", "this", ".", "lastRefresh", "=", "System", ".", "currentTimeMillis", "(", ")", ";", "this", ".", "expires", "=", "jsonObject", ".", "get", "(", "\"expires_in\"", ")", ".", "asLong", "(", ")", "*", "1000", ";", "}" ]

[ "Authenticates", "the", "API", "connection", "by", "obtaining", "access", "and", "refresh", "tokens", "using", "the", "auth", "code", "that", "was", "obtained", "from", "the", "first", "half", "of", "OAuth", "." ]

[ "public", "boolean", "needsRefresh", "(", ")", "{", "boolean", "needsRefresh", ";", "this", ".", "refreshLock", ".", "readLock", "(", ")", ".", "lock", "(", ")", ";", "long", "now", "=", "System", ".", "currentTimeMillis", "(", ")", ";", "long", "tokenDuration", "=", "(", "now", "-", "this", ".", "lastRefresh", ")", ";", "needsRefresh", "=", "(", "tokenDuration", ">=", "this", ".", "expires", "-", "REFRESH_EPSILON", ")", ";", "this", ".", "refreshLock", ".", "readLock", "(", ")", ".", "unlock", "(", ")", ";", "return", "needsRefresh", ";", "}" ]

[ "Determines", "if", "this", "connection", "s", "access", "token", "has", "expired", "and", "needs", "to", "be", "refreshed", "." ]

[ "public", "void", "refresh", "(", ")", "{", "this", ".", "refreshLock", ".", "writeLock", "(", ")", ".", "lock", "(", ")", ";", "if", "(", "!", "this", ".", "canRefresh", "(", ")", ")", "{", "this", ".", "refreshLock", ".", "writeLock", "(", ")", ".", "unlock", "(", ")", ";", "throw", "new", "IllegalStateException", "(", "\"The BoxAPIConnection cannot be refreshed because it doesn't have a \"", "+", "\"refresh token.\"", ")", ";", "}", "URL", "url", "=", "null", ";", "try", "{", "url", "=", "new", "URL", "(", "this", ".", "tokenURL", ")", ";", "}", "catch", "(", "MalformedURLException", "e", ")", "{", "this", ".", "refreshLock", ".", "writeLock", "(", ")", ".", "unlock", "(", ")", ";", "assert", "false", ":", "\"An invalid refresh URL indicates a bug in the SDK.\"", ";", "throw", "new", "RuntimeException", "(", "\"An invalid refresh URL indicates a bug in the SDK.\"", ",", "e", ")", ";", "}", "String", "urlParameters", "=", "String", ".", "format", "(", "\"grant_type=refresh_token&refresh_token=%s&client_id=%s&client_secret=%s\"", ",", "this", ".", "refreshToken", ",", "this", ".", "clientID", ",", "this", ".", "clientSecret", ")", ";", "BoxAPIRequest", "request", "=", "new", "BoxAPIRequest", "(", "this", ",", "url", ",", "\"POST\"", ")", ";", "request", ".", "shouldAuthenticate", "(", "false", ")", ";", "request", ".", "setBody", "(", "urlParameters", ")", ";", "String", "json", ";", "try", "{", "BoxJSONResponse", "response", "=", "(", "BoxJSONResponse", ")", "request", ".", "send", "(", ")", ";", "json", "=", "response", ".", "getJSON", "(", ")", ";", "}", "catch", "(", "BoxAPIException", "e", ")", "{", "this", ".", "notifyError", "(", "e", ")", ";", "this", ".", "refreshLock", ".", "writeLock", "(", ")", ".", "unlock", "(", ")", ";", "throw", "e", ";", "}", "JsonObject", "jsonObject", "=", "JsonObject", ".", "readFrom", "(", "json", ")", ";", "this", ".", "accessToken", "=", "jsonObject", ".", "get", "(", "\"access_token\"", ")", ".", "asString", "(", ")", ";", "this", ".", "refreshToken", "=", "jsonObject", ".", "get", "(", "\"refresh_token\"", ")", ".", "asString", "(", ")", ";", "this", ".", "lastRefresh", "=", "System", ".", "currentTimeMillis", "(", ")", ";", "this", ".", "expires", "=", "jsonObject", ".", "get", "(", "\"expires_in\"", ")", ".", "asLong", "(", ")", "*", "1000", ";", "this", ".", "notifyRefresh", "(", ")", ";", "this", ".", "refreshLock", ".", "writeLock", "(", ")", ".", "unlock", "(", ")", ";", "}" ]

[ "Refresh", "s", "this", "connection", "s", "access", "token", "using", "its", "refresh", "token", "." ]

[ "public", "void", "restore", "(", "String", "state", ")", "{", "JsonObject", "json", "=", "JsonObject", ".", "readFrom", "(", "state", ")", ";", "String", "accessToken", "=", "json", ".", "get", "(", "\"accessToken\"", ")", ".", "asString", "(", ")", ";", "String", "refreshToken", "=", "json", ".", "get", "(", "\"refreshToken\"", ")", ".", "asString", "(", ")", ";", "long", "lastRefresh", "=", "json", ".", "get", "(", "\"lastRefresh\"", ")", ".", "asLong", "(", ")", ";", "long", "expires", "=", "json", ".", "get", "(", "\"expires\"", ")", ".", "asLong", "(", ")", ";", "String", "userAgent", "=", "json", ".", "get", "(", "\"userAgent\"", ")", ".", "asString", "(", ")", ";", "String", "tokenURL", "=", "json", ".", "get", "(", "\"tokenURL\"", ")", ".", "asString", "(", ")", ";", "String", "baseURL", "=", "json", ".", "get", "(", "\"baseURL\"", ")", ".", "asString", "(", ")", ";", "String", "baseUploadURL", "=", "json", ".", "get", "(", "\"baseUploadURL\"", ")", ".", "asString", "(", ")", ";", "boolean", "autoRefresh", "=", "json", ".", "get", "(", "\"autoRefresh\"", ")", ".", "asBoolean", "(", ")", ";", "int", "maxRequestAttempts", "=", "json", ".", "get", "(", "\"maxRequestAttempts\"", ")", ".", "asInt", "(", ")", ";", "this", ".", "accessToken", "=", "accessToken", ";", "this", ".", "refreshToken", "=", "refreshToken", ";", "this", ".", "lastRefresh", "=", "lastRefresh", ";", "this", ".", "expires", "=", "expires", ";", "this", ".", "userAgent", "=", "userAgent", ";", "this", ".", "tokenURL", "=", "tokenURL", ";", "this", ".", "baseURL", "=", "baseURL", ";", "this", ".", "baseUploadURL", "=", "baseUploadURL", ";", "this", ".", "autoRefresh", "=", "autoRefresh", ";", "this", ".", "maxRequestAttempts", "=", "maxRequestAttempts", ";", "}" ]

[ "Restores", "a", "saved", "connection", "state", "into", "this", "BoxAPIConnection", "." ]

[ "public", "ScopedToken", "getLowerScopedToken", "(", "List", "<", "String", ">", "scopes", ",", "String", "resource", ")", "{", "assert", "(", "scopes", "!=", "null", ")", ";", "assert", "(", "scopes", ".", "size", "(", ")", ">", "0", ")", ";", "URL", "url", "=", "null", ";", "try", "{", "url", "=", "new", "URL", "(", "this", ".", "getTokenURL", "(", ")", ")", ";", "}", "catch", "(", "MalformedURLException", "e", ")", "{", "assert", "false", ":", "\"An invalid refresh URL indicates a bug in the SDK.\"", ";", "throw", "new", "RuntimeException", "(", "\"An invalid refresh URL indicates a bug in the SDK.\"", ",", "e", ")", ";", "}", "StringBuilder", "spaceSeparatedScopes", "=", "new", "StringBuilder", "(", ")", ";", "for", "(", "int", "i", "=", "0", ";", "i", "<", "scopes", ".", "size", "(", ")", ";", "i", "++", ")", "{", "spaceSeparatedScopes", ".", "append", "(", "scopes", ".", "get", "(", "i", ")", ")", ";", "if", "(", "i", "<", "scopes", ".", "size", "(", ")", "-", "1", ")", "{", "spaceSeparatedScopes", ".", "append", "(", "\" \"", ")", ";", "}", "}", "String", "urlParameters", "=", "null", ";", "if", "(", "resource", "!=", "null", ")", "{", "//this.getAccessToken() ensures we have a valid access token", "urlParameters", "=", "String", ".", "format", "(", "\"grant_type=urn:ietf:params:oauth:grant-type:token-exchange\"", "+", "\"&subject_token_type=urn:ietf:params:oauth:token-type:access_token&subject_token=%s\"", "+", "\"&scope=%s&resource=%s\"", ",", "this", ".", "getAccessToken", "(", ")", ",", "spaceSeparatedScopes", ",", "resource", ")", ";", "}", "else", "{", "//this.getAccessToken() ensures we have a valid access token", "urlParameters", "=", "String", ".", "format", "(", "\"grant_type=urn:ietf:params:oauth:grant-type:token-exchange\"", "+", "\"&subject_token_type=urn:ietf:params:oauth:token-type:access_token&subject_token=%s\"", "+", "\"&scope=%s\"", ",", "this", ".", "getAccessToken", "(", ")", ",", "spaceSeparatedScopes", ")", ";", "}", "BoxAPIRequest", "request", "=", "new", "BoxAPIRequest", "(", "this", ",", "url", ",", "\"POST\"", ")", ";", "request", ".", "shouldAuthenticate", "(", "false", ")", ";", "request", ".", "setBody", "(", "urlParameters", ")", ";", "String", "json", ";", "try", "{", "BoxJSONResponse", "response", "=", "(", "BoxJSONResponse", ")", "request", ".", "send", "(", ")", ";", "json", "=", "response", ".", "getJSON", "(", ")", ";", "}", "catch", "(", "BoxAPIException", "e", ")", "{", "this", ".", "notifyError", "(", "e", ")", ";", "throw", "e", ";", "}", "JsonObject", "jsonObject", "=", "JsonObject", ".", "readFrom", "(", "json", ")", ";", "ScopedToken", "token", "=", "new", "ScopedToken", "(", "jsonObject", ")", ";", "token", ".", "setObtainedAt", "(", "System", ".", "currentTimeMillis", "(", ")", ")", ";", "token", ".", "setExpiresIn", "(", "jsonObject", ".", "get", "(", "\"expires_in\"", ")", ".", "asLong", "(", ")", "*", "1000", ")", ";", "return", "token", ";", "}" ]

[ "Get", "a", "lower", "-", "scoped", "token", "restricted", "to", "a", "resource", "for", "the", "list", "of", "scopes", "that", "are", "passed", "." ]

[ "public", "String", "save", "(", ")", "{", "JsonObject", "state", "=", "new", "JsonObject", "(", ")", ".", "add", "(", "\"accessToken\"", ",", "this", ".", "accessToken", ")", ".", "add", "(", "\"refreshToken\"", ",", "this", ".", "refreshToken", ")", ".", "add", "(", "\"lastRefresh\"", ",", "this", ".", "lastRefresh", ")", ".", "add", "(", "\"expires\"", ",", "this", ".", "expires", ")", ".", "add", "(", "\"userAgent\"", ",", "this", ".", "userAgent", ")", ".", "add", "(", "\"tokenURL\"", ",", "this", ".", "tokenURL", ")", ".", "add", "(", "\"baseURL\"", ",", "this", ".", "baseURL", ")", ".", "add", "(", "\"baseUploadURL\"", ",", "this", ".", "baseUploadURL", ")", ".", "add", "(", "\"autoRefresh\"", ",", "this", ".", "autoRefresh", ")", ".", "add", "(", "\"maxRequestAttempts\"", ",", "this", ".", "maxRequestAttempts", ")", ";", "return", "state", ".", "toString", "(", ")", ";", "}" ]

[ "Saves", "the", "state", "of", "this", "connection", "to", "a", "string", "so", "that", "it", "can", "be", "persisted", "and", "restored", "at", "a", "later", "time", "." ]

[ "public", "Info", "getInfo", "(", "String", "...", "fields", ")", "{", "QueryStringBuilder", "builder", "=", "new", "QueryStringBuilder", "(", ")", ";", "if", "(", "fields", ".", "length", ">", "0", ")", "{", "builder", ".", "appendParam", "(", "\"fields\"", ",", "fields", ")", ";", "}", "URL", "url", "=", "DEVICE_PIN_URL_TEMPLATE", ".", "buildWithQuery", "(", "this", ".", "getAPI", "(", ")", ".", "getBaseURL", "(", ")", ",", "builder", ".", "toString", "(", ")", ",", "this", ".", "getID", "(", ")", ")", ";", "BoxAPIRequest", "request", "=", "new", "BoxAPIRequest", "(", "this", ".", "getAPI", "(", ")", ",", "url", ",", "\"GET\"", ")", ";", "BoxJSONResponse", "response", "=", "(", "BoxJSONResponse", ")", "request", ".", "send", "(", ")", ";", "JsonObject", "responseJSON", "=", "JsonObject", ".", "readFrom", "(", "response", ".", "getJSON", "(", ")", ")", ";", "return", "new", "Info", "(", "responseJSON", ")", ";", "}" ]

[ "Gets", "information", "about", "the", "device", "pin", "." ]

[ "public", "void", "delete", "(", ")", "{", "URL", "url", "=", "DEVICE_PIN_URL_TEMPLATE", ".", "build", "(", "this", ".", "getAPI", "(", ")", ".", "getBaseURL", "(", ")", ",", "this", ".", "getID", "(", ")", ")", ";", "BoxAPIRequest", "request", "=", "new", "BoxAPIRequest", "(", "this", ".", "getAPI", "(", ")", ",", "url", ",", "\"DELETE\"", ")", ";", "BoxAPIResponse", "response", "=", "request", ".", "send", "(", ")", ";", "response", ".", "disconnect", "(", ")", ";", "}" ]

[ "Deletes", "the", "device", "pin", "." ]

[ "public", "void", "forceApply", "(", "String", "conflictResolution", ")", "{", "URL", "url", "=", "FORCE_METADATA_CASCADE_POLICIES_URL_TEMPLATE", ".", "build", "(", "this", ".", "getAPI", "(", ")", ".", "getBaseURL", "(", ")", ",", "this", ".", "getID", "(", ")", ")", ";", "BoxJSONRequest", "request", "=", "new", "BoxJSONRequest", "(", "this", ".", "getAPI", "(", ")", ",", "url", ",", "\"POST\"", ")", ";", "JsonObject", "requestJSON", "=", "new", "JsonObject", "(", ")", ".", "add", "(", "\"conflict_resolution\"", ",", "conflictResolution", ")", ";", "request", ".", "setBody", "(", "requestJSON", ".", "toString", "(", ")", ")", ";", "request", ".", "send", "(", ")", ";", "}" ]

[ "If", "a", "policy", "already", "exists", "on", "a", "folder", "this", "will", "apply", "that", "policy", "to", "all", "existing", "files", "and", "sub", "folders", "within", "the", "target", "folder", "." ]

[ "public", "BoxTaskAssignment", ".", "Info", "addAssignment", "(", "BoxUser", "assignTo", ")", "{", "JsonObject", "taskJSON", "=", "new", "JsonObject", "(", ")", ";", "taskJSON", ".", "add", "(", "\"type\"", ",", "\"task\"", ")", ";", "taskJSON", ".", "add", "(", "\"id\"", ",", "this", ".", "getID", "(", ")", ")", ";", "JsonObject", "assignToJSON", "=", "new", "JsonObject", "(", ")", ";", "assignToJSON", ".", "add", "(", "\"id\"", ",", "assignTo", ".", "getID", "(", ")", ")", ";", "JsonObject", "requestJSON", "=", "new", "JsonObject", "(", ")", ";", "requestJSON", ".", "add", "(", "\"task\"", ",", "taskJSON", ")", ";", "requestJSON", ".", "add", "(", "\"assign_to\"", ",", "assignToJSON", ")", ";", "URL", "url", "=", "ADD_TASK_ASSIGNMENT_URL_TEMPLATE", ".", "build", "(", "this", ".", "getAPI", "(", ")", ".", "getBaseURL", "(", ")", ")", ";", "BoxJSONRequest", "request", "=", "new", "BoxJSONRequest", "(", "this", ".", "getAPI", "(", ")", ",", "url", ",", "\"POST\"", ")", ";", "request", ".", "setBody", "(", "requestJSON", ".", "toString", "(", ")", ")", ";", "BoxJSONResponse", "response", "=", "(", "BoxJSONResponse", ")", "request", ".", "send", "(", ")", ";", "JsonObject", "responseJSON", "=", "JsonObject", ".", "readFrom", "(", "response", ".", "getJSON", "(", ")", ")", ";", "BoxTaskAssignment", "addedAssignment", "=", "new", "BoxTaskAssignment", "(", "this", ".", "getAPI", "(", ")", ",", "responseJSON", ".", "get", "(", "\"id\"", ")", ".", "asString", "(", ")", ")", ";", "return", "addedAssignment", ".", "new", "Info", "(", "responseJSON", ")", ";", "}" ]

[ "Adds", "a", "new", "assignment", "to", "this", "task", "." ]

[ "public", "List", "<", "BoxTaskAssignment", ".", "Info", ">", "getAssignments", "(", ")", "{", "URL", "url", "=", "GET_ASSIGNMENTS_URL_TEMPLATE", ".", "build", "(", "this", ".", "getAPI", "(", ")", ".", "getBaseURL", "(", ")", ",", "this", ".", "getID", "(", ")", ")", ";", "BoxAPIRequest", "request", "=", "new", "BoxAPIRequest", "(", "this", ".", "getAPI", "(", ")", ",", "url", ",", "\"GET\"", ")", ";", "BoxJSONResponse", "response", "=", "(", "BoxJSONResponse", ")", "request", ".", "send", "(", ")", ";", "JsonObject", "responseJSON", "=", "JsonObject", ".", "readFrom", "(", "response", ".", "getJSON", "(", ")", ")", ";", "int", "totalCount", "=", "responseJSON", ".", "get", "(", "\"total_count\"", ")", ".", "asInt", "(", ")", ";", "List", "<", "BoxTaskAssignment", ".", "Info", ">", "assignments", "=", "new", "ArrayList", "<", "BoxTaskAssignment", ".", "Info", ">", "(", "totalCount", ")", ";", "JsonArray", "entries", "=", "responseJSON", ".", "get", "(", "\"entries\"", ")", ".", "asArray", "(", ")", ";", "for", "(", "JsonValue", "value", ":", "entries", ")", "{", "JsonObject", "assignmentJSON", "=", "value", ".", "asObject", "(", ")", ";", "BoxTaskAssignment", "assignment", "=", "new", "BoxTaskAssignment", "(", "this", ".", "getAPI", "(", ")", ",", "assignmentJSON", ".", "get", "(", "\"id\"", ")", ".", "asString", "(", ")", ")", ";", "BoxTaskAssignment", ".", "Info", "info", "=", "assignment", ".", "new", "Info", "(", "assignmentJSON", ")", ";", "assignments", ".", "add", "(", "info", ")", ";", "}", "return", "assignments", ";", "}" ]

[ "Gets", "any", "assignments", "for", "this", "task", "." ]

[ "public", "Iterable", "<", "BoxTaskAssignment", ".", "Info", ">", "getAllAssignments", "(", "String", "...", "fields", ")", "{", "final", "QueryStringBuilder", "builder", "=", "new", "QueryStringBuilder", "(", ")", ";", "if", "(", "fields", ".", "length", ">", "0", ")", "{", "builder", ".", "appendParam", "(", "\"fields\"", ",", "fields", ")", ";", "}", "return", "new", "Iterable", "<", "BoxTaskAssignment", ".", "Info", ">", "(", ")", "{", "public", "Iterator", "<", "BoxTaskAssignment", ".", "Info", ">", "iterator", "(", ")", "{", "URL", "url", "=", "GET_ASSIGNMENTS_URL_TEMPLATE", ".", "buildWithQuery", "(", "BoxTask", ".", "this", ".", "getAPI", "(", ")", ".", "getBaseURL", "(", ")", ",", "builder", ".", "toString", "(", ")", ",", "BoxTask", ".", "this", ".", "getID", "(", ")", ")", ";", "return", "new", "BoxTaskAssignmentIterator", "(", "BoxTask", ".", "this", ".", "getAPI", "(", ")", ",", "url", ")", ";", "}", "}", ";", "}" ]

[ "Gets", "an", "iterable", "of", "all", "the", "assignments", "of", "this", "task", "." ]

[ "public", "String", "getPendingChanges", "(", ")", "{", "JsonObject", "jsonObject", "=", "this", ".", "getPendingJSONObject", "(", ")", ";", "if", "(", "jsonObject", "==", "null", ")", "{", "return", "null", ";", "}", "return", "jsonObject", ".", "toString", "(", ")", ";", "}" ]

[ "Gets", "a", "JSON", "string", "containing", "any", "pending", "changes", "to", "this", "object", "that", "can", "be", "sent", "back", "to", "the", "Box", "API", "." ]

[ "void", "update", "(", "JsonObject", "jsonObject", ")", "{", "for", "(", "JsonObject", ".", "Member", "member", ":", "jsonObject", ")", "{", "if", "(", "member", ".", "getValue", "(", ")", ".", "isNull", "(", ")", ")", "{", "continue", ";", "}", "this", ".", "parseJSONMember", "(", "member", ")", ";", "}", "this", ".", "clearPendingChanges", "(", ")", ";", "}" ]

[ "Updates", "this", "BoxJSONObject", "using", "the", "information", "in", "a", "JSON", "object", "." ]