com.box.sdk

Class BoxFolder

Object

BoxResource

BoxItem

BoxFolder

All Implemented Interfaces:

Iterable<BoxItem.Info>

@BoxResourceType(value="folder")
public class BoxFolder
extends BoxItem
implements Iterable<BoxItem.Info>

Represents a folder on Box. This class can be used to iterate through a folder's contents, collaborate a folder with another user or group, and perform other common folder operations (move, copy, delete, etc.).

Unless otherwise noted, the methods in this class can throw an unchecked BoxAPIException (unchecked meaning that the compiler won't force you to handle it) if an error occurs. If you wish to implement custom error handling for errors related to the Box REST API, you should capture this exception explicitly.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BoxFolder.Info Contains information about a BoxFolder.
static class	BoxFolder.Permission Enumerates the possible permissions that a user can have on a folder.
static class	BoxFolder.SortDirection Used to specify what direction to sort and display results.
static class	BoxFolder.SyncState Enumerates the possible sync states that a folder can have.

Field Summary

Fields

Modifier and Type	Field and Description
static URLTemplate	ADD_COLLABORATION_URL Add Collaboration URL Template.
static String[]	ALL_FIELDS An array of all possible folder fields that can be requested when calling getInfo(String...).
static URLTemplate	COPY_FOLDER_URL Copy Folder URL Template.
static URLTemplate	CREATE_FOLDER_URL Create Folder URL Template.
static URLTemplate	CREATE_WEB_LINK_URL Create Web Link URL Template.
static URLTemplate	DELETE_FOLDER_URL Delete Folder URL Template.
static URLTemplate	FOLDER_INFO_URL_TEMPLATE Folder Info URL Template.
static URLTemplate	FOLDER_LOCK_URL_TEMPLATE Folder Locks URL Template.
static URLTemplate	GET_COLLABORATIONS_URL Get Collaborations URL Template.
static URLTemplate	GET_ITEMS_URL Get Items URL Template.
static URLTemplate	METADATA_URL_TEMPLATE Metadata URL Template.
static URLTemplate	SEARCH_URL_TEMPLATE Search URL Template.
static URLTemplate	UPLOAD_FILE_URL Upload File URL Template.
static URLTemplate	UPLOAD_SESSION_URL_TEMPLATE Upload Session URL Template.

Fields inherited from class BoxItem

SHARED_ITEM_URL_TEMPLATE, WATERMARK_URL_TEMPLATE

Constructor Summary

Constructors

Constructor and Description
BoxFolder(BoxAPIConnection api, String id) Constructs a BoxFolder for a folder with a given ID.

Method Summary

Modifier and Type	Method and Description
String	addClassification(String classificationType) Adds a metadata classification to the specified file.
BoxMetadataCascadePolicy.Info	addMetadataCascadePolicy(String scope, String templateKey) Creates a new Metadata Cascade Policy on a folder.
BoxWebHook.Info	addWebHook(URL address, BoxWebHook.Trigger... triggers) Adds new BoxWebHook to this BoxFolder.
BoxWatermark	applyWatermark() Used to apply or update the watermark for the folder.
void	canUpload(String name, long fileSize) Checks if the file can be successfully uploaded by using the preflight check.
BoxCollaboration.Info	collaborate(BoxCollaborator collaborator, BoxCollaboration.Role role) Adds a collaborator to this folder.
BoxCollaboration.Info	collaborate(BoxCollaborator collaborator, BoxCollaboration.Role role, Boolean notify, Boolean canViewPath) Adds a collaborator to this folder.
BoxCollaboration.Info	collaborate(BoxCollaborator collaborator, BoxCollaboration.Role role, Boolean notify, Boolean canViewPath, Date expiresAt, Boolean isAccessOnly) Adds a collaborator to this folder.
BoxCollaboration.Info	collaborate(String email, BoxCollaboration.Role role) Adds a collaborator to this folder.
BoxCollaboration.Info	collaborate(String email, BoxCollaboration.Role role, Boolean notify, Boolean canViewPath) Adds a collaborator to this folder.
BoxCollaboration.Info	collaborate(String email, BoxCollaboration.Role role, Boolean notify, Boolean canViewPath, Date expiresAt, Boolean isAccessOnly) Adds a collaborator to this folder.
BoxFolder.Info	copy(BoxFolder destination) Copies this item to another folder.
BoxFolder.Info	copy(BoxFolder destination, String newName) Copies this item to another folder and gives it a new name.
BoxFolder.Info	createFolder(String name) Creates a new child folder inside this folder.
Metadata	createMetadata(Metadata metadata) Creates global property metadata on this folder.
Metadata	createMetadata(String templateName, Metadata metadata) Creates metadata on this folder using a specified template.
Metadata	createMetadata(String templateName, String scope, Metadata metadata) Creates metadata on this folder using a specified scope and template.
BoxSharedLink	createSharedLink(BoxSharedLinkRequest sharedLinkRequest) Creates a shared link.
BoxFileUploadSession.Info	createUploadSession(String fileName, long fileSize) Creates an upload session to create a new file in chunks.
BoxWebLink.Info	createWebLink(String name, URL linkURL) Uploads a new weblink to this folder.
BoxWebLink.Info	createWebLink(String name, URL linkURL, String description) Uploads a new weblink to this folder.
BoxWebLink.Info	createWebLink(URL linkURL) Uploads a new weblink to this folder.
BoxWebLink.Info	createWebLink(URL linkURL, String description) Uploads a new weblink to this folder.
void	delete(boolean recursive) Deletes this folder, optionally recursively deleting all of its contents.
void	deleteClassification() Deletes the classification on the file.
void	deleteMetadata() Deletes the global properties metadata on this folder.
void	deleteMetadata(String templateName) Deletes the metadata on this folder associated with a specified template.
void	deleteMetadata(String templateName, String scope) Deletes the metadata on this folder associated with a specified scope and template.
Iterable<Metadata>	getAllMetadata(String... fields) Used to retrieve all metadata associated with the folder.
Iterable<BoxItem.Info>	getChildren() Returns an iterable containing the items in this folder.
Iterable<BoxItem.Info>	getChildren(SortParameters sortParameters, PagingParameters pagingParameters, String... fields) Returns an iterable containing the items in this folder sorted by name and direction.
Iterable<BoxItem.Info>	getChildren(String... fields) Returns an iterable containing the items in this folder and specifies which child fields to retrieve from the API.
Iterable<BoxItem.Info>	getChildren(String sort, BoxFolder.SortDirection direction, long offset, long limit, String... fields) Returns an iterable containing the items in this folder sorted by name and direction.
Iterable<BoxItem.Info>	getChildren(String sort, BoxFolder.SortDirection direction, String... fields) Returns an iterable containing the items in this folder sorted by name and direction.
PartialCollection<BoxItem.Info>	getChildrenRange(long offset, long limit, String... fields) Retrieves a specific range of child items in this folder.
String	getClassification() Gets the classification type for the specified file.
Collection<BoxCollaboration.Info>	getCollaborations(String... fields) Gets information about all of the collaborations for this folder.
BoxFolder.Info	getInfo(String... fields) Gets information about this item that's limited to a list of specified fields.
protected URL	getItemURL()
Iterable<BoxFolderLock.Info>	getLocks() Get the lock on this folder.
Metadata	getMetadata() Gets the global properties metadata on this folder.
Metadata	getMetadata(String templateName) Gets the metadata on this folder associated with a specified template.
Metadata	getMetadata(String templateName, String scope) Gets the metadata on this folder associated with a specified scope and template.
Iterable<BoxMetadataCascadePolicy.Info>	getMetadataCascadePolicies(String... fields) Retrieves all Metadata Cascade Policies on a folder.
Iterable<BoxMetadataCascadePolicy.Info>	getMetadataCascadePolicies(String enterpriseID, int limit, String... fields) Retrieves all Metadata Cascade Policies on a folder.
static BoxFolder	getRootFolder(BoxAPIConnection api) Gets the current user's root folder.
BoxWatermark	getWatermark(String... fields) Used to retrieve the watermark for the folder.
Iterator<BoxItem.Info>	iterator() Returns an iterator over the items in this folder.
BoxFolderLock.Info	lock() Lock this folder.
BoxItem.Info	move(BoxFolder destination) Moves this item to another folder.
BoxItem.Info	move(BoxFolder destination, String newName) Moves this item to another folder and gives it a new name.
void	removeWatermark() Removes a watermark from the folder.
void	rename(String newName) Renames this folder.
String	setClassification(String classificationType) Attempts to add classification to a file.
BoxFolder.Info	setCollections(BoxCollection... collections) Sets the collections that this item belongs to.
Metadata	setMetadata(String templateName, String scope, Metadata metadata) Sets the provided metadata on the folder.
String	updateClassification(String classificationType) Updates a metadata classification on the specified file.
void	updateInfo(BoxFolder.Info info) Updates the information about this folder with any info fields that have been modified locally.
Metadata	updateMetadata(Metadata metadata) Updates the folder metadata.
BoxFile.Info	uploadFile(FileUploadParams uploadParams) Uploads a new file to this folder with custom upload parameters.
BoxFile.Info	uploadFile(InputStream fileContent, String name) Uploads a new file to this folder.
BoxFile.Info	uploadFile(InputStream fileContent, String name, long fileSize, ProgressListener listener) Uploads a new file to this folder while reporting the progress to a ProgressListener.
BoxFile.Info	uploadFile(InputStream fileContent, String name, String description) Uploads a new file to this folder with a specified file description.
BoxFile.Info	uploadFile(UploadFileCallback callback, String name) Uploads a new file to this folder.
BoxFile.Info	uploadLargeFile(InputStream inputStream, String fileName, long fileSize) Creates a new file.
BoxFile.Info	uploadLargeFile(InputStream inputStream, String fileName, long fileSize, int nParallelConnections, long timeOut, TimeUnit unit) Creates a new file using specified number of parallel http connections.
BoxFile.Info	uploadLargeFile(InputStream inputStream, String fileName, long fileSize, int nParallelConnections, long timeOut, TimeUnit unit, Map<String,String> fileAttributes) Creates a new file using specified number of parallel http connections.
BoxFile.Info	uploadLargeFile(InputStream inputStream, String fileName, long fileSize, Map<String,String> fileAttributes) Creates a new file.

Methods inherited from class BoxItem

applyWatermark, getSharedItem, getSharedItem, getWatermark, removeWatermark

Methods inherited from class BoxResource

equals, getAPI, getID, getResourceType, hashCode

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Iterable

forEach, spliterator

Field Detail

ALL_FIELDS

public static final String[] ALL_FIELDS

An array of all possible folder fields that can be requested when calling getInfo(String...).

CREATE_FOLDER_URL

public static final URLTemplate CREATE_FOLDER_URL

Create Folder URL Template.

CREATE_WEB_LINK_URL

public static final URLTemplate CREATE_WEB_LINK_URL

Create Web Link URL Template.

COPY_FOLDER_URL

public static final URLTemplate COPY_FOLDER_URL

Copy Folder URL Template.

DELETE_FOLDER_URL

public static final URLTemplate DELETE_FOLDER_URL

Delete Folder URL Template.

FOLDER_INFO_URL_TEMPLATE

public static final URLTemplate FOLDER_INFO_URL_TEMPLATE

Folder Info URL Template.

UPLOAD_FILE_URL

public static final URLTemplate UPLOAD_FILE_URL

Upload File URL Template.

ADD_COLLABORATION_URL

public static final URLTemplate ADD_COLLABORATION_URL

Add Collaboration URL Template.

GET_COLLABORATIONS_URL

public static final URLTemplate GET_COLLABORATIONS_URL

Get Collaborations URL Template.

GET_ITEMS_URL

public static final URLTemplate GET_ITEMS_URL

Get Items URL Template.

SEARCH_URL_TEMPLATE

public static final URLTemplate SEARCH_URL_TEMPLATE

Search URL Template.

METADATA_URL_TEMPLATE

public static final URLTemplate METADATA_URL_TEMPLATE

Metadata URL Template.

UPLOAD_SESSION_URL_TEMPLATE

public static final URLTemplate UPLOAD_SESSION_URL_TEMPLATE

Upload Session URL Template.

FOLDER_LOCK_URL_TEMPLATE

public static final URLTemplate FOLDER_LOCK_URL_TEMPLATE

Folder Locks URL Template.

Constructor Detail

BoxFolder

public BoxFolder(BoxAPIConnection api,
                 String id)

Constructs a BoxFolder for a folder with a given ID.

Parameters:

api - the API connection to be used by the folder.

id - the ID of the folder.

Method Detail

getRootFolder

public static BoxFolder getRootFolder(BoxAPIConnection api)

Gets the current user's root folder.

Parameters:

api - the API connection to be used by the folder.

Returns:

the user's root folder.

getItemURL

protected URL getItemURL()

Overrides:

getItemURL in class BoxItem

Returns:

URL for the current object, constructed as base URL pus an item specifier.

collaborate

public BoxCollaboration.Info collaborate(BoxCollaborator collaborator,
                                         BoxCollaboration.Role role)

Adds a collaborator to this folder.

Parameters:

collaborator - the collaborator to add.

role - the role of the collaborator.

Returns:

info about the new collaboration.

collaborate

public BoxCollaboration.Info collaborate(String email,
                                         BoxCollaboration.Role role)

Adds a collaborator to this folder. An email will be sent to the collaborator if they don't already have a Box account.

Parameters:

email - the email address of the collaborator to add.

role - the role of the collaborator.

Returns:

info about the new collaboration.

collaborate

public BoxCollaboration.Info collaborate(BoxCollaborator collaborator,
                                         BoxCollaboration.Role role,
                                         Boolean notify,
                                         Boolean canViewPath,
                                         Date expiresAt,
                                         Boolean isAccessOnly)

Adds a collaborator to this folder.

Parameters:

collaborator - the collaborator to add.

role - the role of the collaborator.

notify - the user/group should receive email notification of the collaboration or not.

canViewPath - the view path collaboration feature is enabled or not. View path collaborations allow the invitee to see the entire ancestral path to the associated folder. The user will not gain privileges in any ancestral folder.

expiresAt - when the collaboration should expire.

isAccessOnly - whether the collaboration is access only or not.

Returns:

info about the new collaboration.

collaborate

public BoxCollaboration.Info collaborate(BoxCollaborator collaborator,
                                         BoxCollaboration.Role role,
                                         Boolean notify,
                                         Boolean canViewPath)

Adds a collaborator to this folder.

Parameters:

collaborator - the collaborator to add.

role - the role of the collaborator.

notify - the user/group should receive email notification of the collaboration or not.

canViewPath - the view path collaboration feature is enabled or not. View path collaborations allow the invitee to see the entire ancestral path to the associated folder. The user will not gain privileges in any ancestral folder.

Returns:

info about the new collaboration.

collaborate

public BoxCollaboration.Info collaborate(String email,
                                         BoxCollaboration.Role role,
                                         Boolean notify,
                                         Boolean canViewPath,
                                         Date expiresAt,
                                         Boolean isAccessOnly)

Adds a collaborator to this folder. An email will be sent to the collaborator if they don't already have a Box account.

Parameters:

email - the email address of the collaborator to add.

role - the role of the collaborator.

notify - the user/group should receive email notification of the collaboration or not.

canViewPath - the view path collaboration feature is enabled or not. View path collaborations allow the invitee to see the entire ancestral path to the associated folder. The user will not gain privileges in any ancestral folder.

expiresAt - when the collaboration should expire.

isAccessOnly - whether the collaboration is access only or not.

Returns:

info about the new collaboration.

collaborate

public BoxCollaboration.Info collaborate(String email,
                                         BoxCollaboration.Role role,
                                         Boolean notify,
                                         Boolean canViewPath)

Adds a collaborator to this folder. An email will be sent to the collaborator if they don't already have a Box account.

Parameters:

email - the email address of the collaborator to add.

role - the role of the collaborator.

notify - the user/group should receive email notification of the collaboration or not.

canViewPath - the view path collaboration feature is enabled or not. View path collaborations allow the invitee to see the entire ancestral path to the associated folder. The user will not gain privileges in any ancestral folder.

Returns:

info about the new collaboration.

createSharedLink

public BoxSharedLink createSharedLink(BoxSharedLinkRequest sharedLinkRequest)

Creates a shared link.

Parameters:

sharedLinkRequest - Shared link to create

Returns:

Created shared link.

getCollaborations

public Collection<BoxCollaboration.Info> getCollaborations(String... fields)

Gets information about all of the collaborations for this folder.

Returns:

a collection of information about the collaborations for this folder.

getInfo

public BoxFolder.Info getInfo(String... fields)

Description copied from class: BoxItem

Gets information about this item that's limited to a list of specified fields.

Specified by:

getInfo in class BoxItem

Parameters:

fields - the fields to retrieve.

Returns:

info about this item containing only the specified fields.

updateInfo

public void updateInfo(BoxFolder.Info info)

Updates the information about this folder with any info fields that have been modified locally.

Parameters:

info - the updated info.

copy

public BoxFolder.Info copy(BoxFolder destination)

Description copied from class: BoxItem

Copies this item to another folder.

Specified by:

copy in class BoxItem

Parameters:

destination - the destination folder.

Returns:

info about the copied item.

copy

public BoxFolder.Info copy(BoxFolder destination,
                           String newName)

Description copied from class: BoxItem

Copies this item to another folder and gives it a new name. If the destination is the same folder as the item's current parent, then newName must be a new, unique name.

Specified by:

copy in class BoxItem

Parameters:

destination - the destination folder.

newName - a new name for the copied item.

Returns:

info about the copied item.

createFolder

public BoxFolder.Info createFolder(String name)

Creates a new child folder inside this folder.

Parameters:

name - the new folder's name.

Returns:

the created folder's info.

delete

public void delete(boolean recursive)

Deletes this folder, optionally recursively deleting all of its contents.

Parameters:

recursive - true to recursively delete this folder's contents; otherwise false.

move

public BoxItem.Info move(BoxFolder destination)

Description copied from class: BoxItem

Moves this item to another folder.

Specified by:

move in class BoxItem

Parameters:

destination - the destination folder.

Returns:

info about the moved item.

move

public BoxItem.Info move(BoxFolder destination,
                         String newName)

Description copied from class: BoxItem

Moves this item to another folder and gives it a new name.

Specified by:

move in class BoxItem

Parameters:

destination - the destination folder.

newName - a new name for the moved item.

Returns:

info about the moved item.

rename

public void rename(String newName)

Renames this folder.

Parameters:

newName - the new name of the folder.

canUpload

public void canUpload(String name,
                      long fileSize)

Checks if the file can be successfully uploaded by using the preflight check.

Parameters:

name - the name to give the uploaded file.

fileSize - the size of the file used for account capacity calculations.

uploadFile

public BoxFile.Info uploadFile(InputStream fileContent,
                               String name)

Uploads a new file to this folder.

Parameters:

fileContent - a stream containing the contents of the file to upload.

name - the name to give the uploaded file.

Returns:

the uploaded file's info.

uploadFile

public BoxFile.Info uploadFile(UploadFileCallback callback,
                               String name)

Uploads a new file to this folder.

Parameters:

callback - the callback which allows file content to be written on output stream.

name - the name to give the uploaded file.

Returns:

the uploaded file's info.

uploadFile

public BoxFile.Info uploadFile(InputStream fileContent,
                               String name,
                               long fileSize,
                               ProgressListener listener)

Uploads a new file to this folder while reporting the progress to a ProgressListener.

Parameters:

fileContent - a stream containing the contents of the file to upload.

name - the name to give the uploaded file.

fileSize - the size of the file used for determining the progress of the upload.

listener - a listener for monitoring the upload's progress.

Returns:

the uploaded file's info.

uploadFile

public BoxFile.Info uploadFile(InputStream fileContent,
                               String name,
                               String description)

Uploads a new file to this folder with a specified file description.

Parameters:

fileContent - a stream containing the contents of the file to upload.

name - the name to give the uploaded file.

description - the description to give the uploaded file.

Returns:

the uploaded file's info.

uploadFile

public BoxFile.Info uploadFile(FileUploadParams uploadParams)

Uploads a new file to this folder with custom upload parameters.

Parameters:

uploadParams - the custom upload parameters.

Returns:

the uploaded file's info.

createWebLink

public BoxWebLink.Info createWebLink(URL linkURL)

Uploads a new weblink to this folder.

Parameters:

linkURL - the URL the weblink points to.

Returns:

the uploaded weblink's info.

createWebLink

public BoxWebLink.Info createWebLink(String name,
                                     URL linkURL)

Uploads a new weblink to this folder.

Parameters:

name - the filename for the weblink.

linkURL - the URL the weblink points to.

Returns:

the uploaded weblink's info.

createWebLink

public BoxWebLink.Info createWebLink(URL linkURL,
                                     String description)

Uploads a new weblink to this folder.

Parameters:

linkURL - the URL the weblink points to.

description - the weblink's description.

Returns:

the uploaded weblink's info.

createWebLink

public BoxWebLink.Info createWebLink(String name,
                                     URL linkURL,
                                     String description)

Uploads a new weblink to this folder.

Parameters:

name - the filename for the weblink.

linkURL - the URL the weblink points to.

description - the weblink's description.

Returns:

the uploaded weblink's info.

getChildren

public Iterable<BoxItem.Info> getChildren()

Returns an iterable containing the items in this folder. Iterating over the iterable returned by this method is equivalent to iterating over this BoxFolder directly.

Returns:

an iterable containing the items in this folder.

getChildren

public Iterable<BoxItem.Info> getChildren(String... fields)

Returns an iterable containing the items in this folder and specifies which child fields to retrieve from the API.

Parameters:

fields - the fields to retrieve.

Returns:

an iterable containing the items in this folder.

getChildren

public Iterable<BoxItem.Info> getChildren(String sort,
                                          BoxFolder.SortDirection direction,
                                          String... fields)

Returns an iterable containing the items in this folder sorted by name and direction.

Parameters:

sort - the field to sort by, can be set as `name`, `id`, and `date`.

direction - the direction to display the item results.

fields - the fields to retrieve.

Returns:

an iterable containing the items in this folder.

getChildren

public Iterable<BoxItem.Info> getChildren(String sort,
                                          BoxFolder.SortDirection direction,
                                          long offset,
                                          long limit,
                                          String... fields)

Returns an iterable containing the items in this folder sorted by name and direction.

Parameters:

sort - the field to sort by, can be set as `name`, `id`, and `date`.

direction - the direction to display the item results.

offset - the index of the first child item to retrieve.

limit - the maximum number of children to retrieve after the offset.

fields - the fields to retrieve.

Returns:

an iterable containing the items in this folder.

getChildrenRange

public PartialCollection<BoxItem.Info> getChildrenRange(long offset,
                                                        long limit,
                                                        String... fields)

Retrieves a specific range of child items in this folder.

Parameters:

offset - the index of the first child item to retrieve.

limit - the maximum number of children to retrieve after the offset.

fields - the fields to retrieve.

Returns:

a partial collection containing the specified range of child items.

getChildren

public Iterable<BoxItem.Info> getChildren(SortParameters sortParameters,
                                          PagingParameters pagingParameters,
                                          String... fields)

Returns an iterable containing the items in this folder sorted by name and direction.

Parameters:

sortParameters - describes sorting parameters. Sort parameters are supported only with offset based pagination. Use SortParameters.none() to ignore sorting.

pagingParameters - describes paging parameters.

fields - the fields to retrieve.

Returns:

an iterable containing the items in this folder.

iterator

public Iterator<BoxItem.Info> iterator()

Returns an iterator over the items in this folder.

Specified by:

iterator in interface Iterable<BoxItem.Info>

Returns:

an iterator over the items in this folder.

addWebHook

public BoxWebHook.Info addWebHook(URL address,
                                  BoxWebHook.Trigger... triggers)

Adds new BoxWebHook to this BoxFolder.

Parameters:

address - BoxWebHook.Info.getAddress()

triggers - BoxWebHook.Info.getTriggers()

Returns:

created BoxWebHook.Info

getWatermark

public BoxWatermark getWatermark(String... fields)

Used to retrieve the watermark for the folder. If the folder does not have a watermark applied to it, a 404 Not Found will be returned by API.

Parameters:

fields - the fields to retrieve.

Returns:

the watermark associated with the folder.

applyWatermark

public BoxWatermark applyWatermark()

Used to apply or update the watermark for the folder.

Returns:

the watermark associated with the folder.

removeWatermark

public void removeWatermark()

Removes a watermark from the folder. If the folder did not have a watermark applied to it, a 404 Not Found will be returned by API.

getAllMetadata

public Iterable<Metadata> getAllMetadata(String... fields)

Used to retrieve all metadata associated with the folder.

Parameters:

fields - the optional fields to retrieve.

Returns:

An iterable of metadata instances associated with the folder

setCollections

public BoxFolder.Info setCollections(BoxCollection... collections)

Description copied from class: BoxItem

Sets the collections that this item belongs to.

Specified by:

setCollections in class BoxItem

Parameters:

collections - the collections that this item should belong to.

Returns:

info about the item, including the collections it belongs to.

createMetadata

public Metadata createMetadata(Metadata metadata)

Creates global property metadata on this folder.

Parameters:

metadata - the new metadata values.

Returns:

the metadata returned from the server.

createMetadata

public Metadata createMetadata(String templateName,
                               Metadata metadata)

Creates metadata on this folder using a specified template.

Parameters:

templateName - the name of the metadata template.

metadata - the new metadata values.

Returns:

the metadata returned from the server.

createMetadata

public Metadata createMetadata(String templateName,
                               String scope,
                               Metadata metadata)

Creates metadata on this folder using a specified scope and template.

Parameters:

templateName - the name of the metadata template.

scope - the scope of the template (usually "global" or "enterprise").

metadata - the new metadata values.

Returns:

the metadata returned from the server.

setMetadata

public Metadata setMetadata(String templateName,
                            String scope,
                            Metadata metadata)

Sets the provided metadata on the folder. If metadata has already been created on this folder, it overwrites metadata keys specified in the `metadata` param.

Parameters:

templateName - the name of the metadata template.

scope - the scope of the template (usually "global" or "enterprise").

metadata - the new metadata values.

Returns:

the metadata returned from the server.

getMetadata

public Metadata getMetadata()

Gets the global properties metadata on this folder.

Returns:

the metadata returned from the server.

getMetadata

public Metadata getMetadata(String templateName)

Gets the metadata on this folder associated with a specified template.

Parameters:

templateName - the metadata template type name.

Returns:

the metadata returned from the server.

getMetadata

public Metadata getMetadata(String templateName,
                            String scope)

Gets the metadata on this folder associated with a specified scope and template.

Parameters:

templateName - the metadata template type name.

scope - the scope of the template (usually "global" or "enterprise").

Returns:

the metadata returned from the server.

updateMetadata

public Metadata updateMetadata(Metadata metadata)

Updates the folder metadata.

Parameters:

metadata - the new metadata values.

Returns:

the metadata returned from the server.

deleteMetadata

public void deleteMetadata()

Deletes the global properties metadata on this folder.

deleteMetadata

public void deleteMetadata(String templateName)

Deletes the metadata on this folder associated with a specified template.

Parameters:

templateName - the metadata template type name.

deleteMetadata

public void deleteMetadata(String templateName,
                           String scope)

Deletes the metadata on this folder associated with a specified scope and template.

Parameters:

templateName - the metadata template type name.

scope - the scope of the template (usually "global" or "enterprise").

addClassification

public String addClassification(String classificationType)

Adds a metadata classification to the specified file.

Parameters:

classificationType - the metadata classification type.

Returns:

the metadata classification type added to the file.

updateClassification

public String updateClassification(String classificationType)

Updates a metadata classification on the specified file.

Parameters:

classificationType - the metadata classification type.

Returns:

the new metadata classification type updated on the file.

setClassification

public String setClassification(String classificationType)

Attempts to add classification to a file. If classification already exists then do update.

Parameters:

classificationType - the metadata classification type.

Returns:

the metadata classification type on the file.

getClassification

public String getClassification()

Gets the classification type for the specified file.

Returns:

the metadata classification type on the file.

deleteClassification

public void deleteClassification()

Deletes the classification on the file.

createUploadSession

public BoxFileUploadSession.Info createUploadSession(String fileName,
                                                     long fileSize)

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

Parameters:

fileName - the name of the file to be created

fileSize - the size of the file that will be uploaded

Returns:

the created upload session instance

uploadLargeFile

public BoxFile.Info uploadLargeFile(InputStream inputStream,
                                    String fileName,
                                    long fileSize)
                             throws InterruptedException,
                                    IOException

Creates a new file.

Parameters:

inputStream - the stream instance that contains the data.

fileName - the name of the file to be created.

fileSize - the size of the file that will be uploaded.

Returns:

the created file instance.

Throws:

InterruptedException - when a thread execution is interrupted.

IOException - when reading a stream throws exception.

uploadLargeFile

public BoxFile.Info uploadLargeFile(InputStream inputStream,
                                    String fileName,
                                    long fileSize,
                                    Map<String,String> fileAttributes)
                             throws InterruptedException,
                                    IOException

Creates a new file. Also sets file attributes.

Parameters:

inputStream - the stream instance that contains the data.

fileName - the name of the file to be created.

fileSize - the size of the file that will be uploaded.

fileAttributes - file attributes to set

Returns:

the created file instance.

Throws:

InterruptedException - when a thread execution is interrupted.

IOException - when reading a stream throws exception.

uploadLargeFile

public BoxFile.Info uploadLargeFile(InputStream inputStream,
                                    String fileName,
                                    long fileSize,
                                    int nParallelConnections,
                                    long timeOut,
                                    TimeUnit unit)
                             throws InterruptedException,
                                    IOException

Creates a new file using specified number of parallel http connections.

Parameters:

inputStream - the stream instance that contains the data.

fileName - the name of the file to be created.

fileSize - the size of the file that will be uploaded.

nParallelConnections - number of parallel http connections to use

timeOut - time to wait before killing the job

unit - time unit for the time wait value

Returns:

the created file instance.

Throws:

InterruptedException - when a thread execution is interrupted.

IOException - when reading a stream throws exception.

uploadLargeFile

public BoxFile.Info uploadLargeFile(InputStream inputStream,
                                    String fileName,
                                    long fileSize,
                                    int nParallelConnections,
                                    long timeOut,
                                    TimeUnit unit,
                                    Map<String,String> fileAttributes)
                             throws InterruptedException,
                                    IOException

Creates a new file using specified number of parallel http connections. Also sets file attributes.

Parameters:

inputStream - the stream instance that contains the data.

fileName - the name of the file to be created.

fileSize - the size of the file that will be uploaded.

nParallelConnections - number of parallel http connections to use

timeOut - time to wait before killing the job

unit - time unit for the time wait value

fileAttributes - file attributes to set

Returns:

the created file instance.

Throws:

InterruptedException - when a thread execution is interrupted.

IOException - when reading a stream throws exception.

addMetadataCascadePolicy

public BoxMetadataCascadePolicy.Info addMetadataCascadePolicy(String scope,
                                                              String templateKey)

Creates a new Metadata Cascade Policy on a folder.

Parameters:

scope - the scope of the metadata cascade policy.

templateKey - the key of the template.

Returns:

information about the Metadata Cascade Policy.

getMetadataCascadePolicies

public Iterable<BoxMetadataCascadePolicy.Info> getMetadataCascadePolicies(String... fields)

Retrieves all Metadata Cascade Policies on a folder.

Parameters:

fields - optional fields to retrieve for cascade policies.

Returns:

the Iterable of Box Metadata Cascade Policies in your enterprise.

getMetadataCascadePolicies

public Iterable<BoxMetadataCascadePolicy.Info> getMetadataCascadePolicies(String enterpriseID,
                                                                          int limit,
                                                                          String... fields)

Retrieves all Metadata Cascade Policies on a folder.

Parameters:

enterpriseID - the ID of the enterprise to retrieve cascade policies for.

limit - the number of entries of cascade policies to retrieve.

fields - optional fields to retrieve for cascade policies.

Returns:

the Iterable of Box Metadata Cascade Policies in your enterprise.

lock

public BoxFolderLock.Info lock()

Lock this folder.

Returns:

a created folder lock object.

getLocks

public Iterable<BoxFolderLock.Info> getLocks()

Get the lock on this folder.

Returns:

a folder lock object.