Package org.apache.camel.component.box
Class BoxFilesManagerEndpointConfiguration
- java.lang.Object
-
- org.apache.camel.component.box.BoxConfiguration
-
- org.apache.camel.component.box.BoxFilesManagerEndpointConfiguration
-
@ApiParams(apiName="files",producerOnly=true,description="Provides operations to manage Box files",apiMethods={@ApiMethod(methodName="checkUpload",description="Does a pre-verification before upload, to check if the filename already exists or if there is permission to upload",signatures="void checkUpload(String fileName, String parentFolderId, Long size)"),@ApiMethod(methodName="copyFile",description="Copy file to destination folder while optionally giving it a new name",signatures="com.box.sdk.BoxFile copyFile(String fileId, String destinationFolderId, String newName)"),@ApiMethod(methodName="createFileMetadata",description="Create metadata for file in either the global properties template or the specified template type",signatures="com.box.sdk.Metadata createFileMetadata(String fileId, com.box.sdk.Metadata metadata, String typeName)"),@ApiMethod(methodName="createFileSharedLink",description="Create a shared link to file",signatures="com.box.sdk.BoxSharedLink createFileSharedLink(String fileId, com.box.sdk.BoxSharedLink$Access access, java.util.Date unshareDate, com.box.sdk.BoxSharedLink$Permissions permissions)"),@ApiMethod(methodName="deleteFile",description="Delete the file",signatures="void deleteFile(String fileId)"),@ApiMethod(methodName="deleteFileMetadata",description="Delete the file properties metadata",signatures="void deleteFileMetadata(String fileId)"),@ApiMethod(methodName="deleteFileVersion",description="Delete a file version",signatures="void deleteFileVersion(String fileId, Integer version)"),@ApiMethod(methodName="downloadFile",description="Download a file",signatures="java.io.OutputStream downloadFile(String fileId, java.io.OutputStream output, Long rangeStart, Long rangeEnd, com.box.sdk.ProgressListener listener)"),@ApiMethod(methodName="downloadPreviousFileVersion",description="Download a previous version of file",signatures="java.io.OutputStream downloadPreviousFileVersion(String fileId, Integer version, java.io.OutputStream output, com.box.sdk.ProgressListener listener)"),@ApiMethod(methodName="getDownloadURL",description="Get an expiring URL for downloading a file directly from Box",signatures="java.net.URL getDownloadURL(String fileId)"),@ApiMethod(methodName="getFileInfo",description="Get file information",signatures="com.box.sdk.BoxFile$Info getFileInfo(String fileId, String[] fields)"),@ApiMethod(methodName="getFileMetadata",description="Gets the file properties metadata",signatures="com.box.sdk.Metadata getFileMetadata(String fileId, String typeName)"),@ApiMethod(methodName="getFilePreviewLink",description="Get an expiring URL for creating an embedded preview session",signatures="java.net.URL getFilePreviewLink(String fileId)"),@ApiMethod(methodName="getFileThumbnail",description="Retrieves a thumbnail, or smaller image representation, of this file",signatures="byte[] getFileThumbnail(String fileId, com.box.sdk.BoxFile$ThumbnailFileType fileType, Integer minWidth, Integer minHeight, Integer maxWidth, Integer maxHeight)"),@ApiMethod(methodName="getFileVersions",description="Get any previous versions of file",signatures="java.util.Collection<com.box.sdk.BoxFileVersion> getFileVersions(String fileId)"),@ApiMethod(methodName="moveFile",description="Move file to destination folder while optionally giving it a new name",signatures="com.box.sdk.BoxFile moveFile(String fileId, String destinationFolderId, String newName)"),@ApiMethod(methodName="promoteFileVersion",description="Promote a previous version of file",signatures="com.box.sdk.BoxFileVersion promoteFileVersion(String fileId, Integer version)"),@ApiMethod(methodName="renameFile",description="Rename file giving it the name newName",signatures="com.box.sdk.BoxFile renameFile(String fileId, String newFileName)"),@ApiMethod(methodName="updateFileInfo",description="Update file information",signatures="com.box.sdk.BoxFile updateFileInfo(String fileId, com.box.sdk.BoxFile$Info info)"),@ApiMethod(methodName="updateFileMetadata",description="Update the file properties metadata",signatures="com.box.sdk.Metadata updateFileMetadata(String fileId, com.box.sdk.Metadata metadata)"),@ApiMethod(methodName="uploadFile",description="Upload a new file to parent folder",signatures="com.box.sdk.BoxFile uploadFile(String parentFolderId, java.io.InputStream content, String fileName, java.util.Date created, java.util.Date modified, Long size, Boolean check, com.box.sdk.ProgressListener listener)"),@ApiMethod(methodName="uploadNewFileVersion",description="Upload a new version of file",signatures="com.box.sdk.BoxFile uploadNewFileVersion(String fileId, java.io.InputStream fileContent, java.util.Date modified, Long fileSize, com.box.sdk.ProgressListener listener)")},aliases={"uploadFile=upload","downloadFile=download","copyFile=copy","moveFile=move","renameFile=rename","createFileSharedLink=link","deleteFile=delete","uploadNewFileVersion=uploadVersion","promoteFileVersion=promoteVersion","getFileVersions=versions","downloadPreviousFileVersion=downloadVersion","deleteFileVersion=deleteVersion","getFileInfo=info","updateFileInfo=updateInfo","createFileMetadata=createMetadata","getFileMetadata=metadata","updateFileMetadata=updateMetadata","deleteFileMetadata=deleteMetadata","getDownloadUrl=url","getPreviewLink=preview","getFileThumbnail=thumbnail","checkUpload=canUpload"}) @UriParams @Configurer(extended=true) public final class BoxFilesManagerEndpointConfiguration extends BoxConfiguration
Camel endpoint configuration forBoxFilesManager
.
-
-
Field Summary
-
Fields inherited from class org.apache.camel.component.box.BoxConfiguration
APP_ENTERPRISE_AUTHENTICATION, APP_USER_AUTHENTICATION, RSA_SHA_256, RSA_SHA_384, RSA_SHA_512, STANDARD_AUTHENTICATION
-
-
Constructor Summary
Constructors Constructor Description BoxFilesManagerEndpointConfiguration()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description com.box.sdk.BoxSharedLink.Access
getAccess()
Boolean
getCheck()
InputStream
getContent()
Date
getCreated()
String
getDestinationFolderId()
String[]
getFields()
InputStream
getFileContent()
String
getFileId()
String
getFileName()
Long
getFileSize()
com.box.sdk.BoxFile.ThumbnailFileType
getFileType()
com.box.sdk.BoxFile.Info
getInfo()
com.box.sdk.ProgressListener
getListener()
Integer
getMaxHeight()
Integer
getMaxWidth()
com.box.sdk.Metadata
getMetadata()
Integer
getMinHeight()
Integer
getMinWidth()
Date
getModified()
String
getNewFileName()
String
getNewName()
OutputStream
getOutput()
String
getParentFolderId()
com.box.sdk.BoxSharedLink.Permissions
getPermissions()
Long
getRangeEnd()
Long
getRangeStart()
Long
getSize()
String
getTypeName()
Date
getUnshareDate()
Integer
getVersion()
void
setAccess(com.box.sdk.BoxSharedLink.Access access)
void
setCheck(Boolean check)
void
setContent(InputStream content)
void
setCreated(Date created)
void
setDestinationFolderId(String destinationFolderId)
void
setFields(String[] fields)
void
setFileContent(InputStream fileContent)
void
setFileId(String fileId)
void
setFileName(String fileName)
void
setFileSize(Long fileSize)
void
setFileType(com.box.sdk.BoxFile.ThumbnailFileType fileType)
void
setInfo(com.box.sdk.BoxFile.Info info)
void
setListener(com.box.sdk.ProgressListener listener)
void
setMaxHeight(Integer maxHeight)
void
setMaxWidth(Integer maxWidth)
void
setMetadata(com.box.sdk.Metadata metadata)
void
setMinHeight(Integer minHeight)
void
setMinWidth(Integer minWidth)
void
setModified(Date modified)
void
setNewFileName(String newFileName)
void
setNewName(String newName)
void
setOutput(OutputStream output)
void
setParentFolderId(String parentFolderId)
void
setPermissions(com.box.sdk.BoxSharedLink.Permissions permissions)
void
setRangeEnd(Long rangeEnd)
void
setRangeStart(Long rangeStart)
void
setSize(Long size)
void
setTypeName(String typeName)
void
setUnshareDate(Date unshareDate)
void
setVersion(Integer version)
-
Methods inherited from class org.apache.camel.component.box.BoxConfiguration
getAccessTokenCache, getApiName, getAuthenticationType, getClientId, getClientSecret, getEncryptionAlgorithm, getEnterpriseId, getHttpParams, getMaxCacheEntries, getMethodName, getPrivateKeyFile, getPrivateKeyPassword, getPublicKeyId, getSslContextParameters, getUserId, getUserName, getUserPassword, setAccessTokenCache, setApiName, setAuthenticationType, setClientId, setClientSecret, setEncryptionAlgorithm, setEncryptionAlgorithm, setEnterpriseId, setHttpParams, setMaxCacheEntries, setMaxCacheEntries, setMethodName, setPrivateKeyFile, setPrivateKeyPassword, setPublicKeyId, setSslContextParameters, setUserId, setUserName, setUserPassword
-
-
-
-
Method Detail
-
getAccess
public com.box.sdk.BoxSharedLink.Access getAccess()
-
setAccess
public void setAccess(com.box.sdk.BoxSharedLink.Access access)
-
getCheck
public Boolean getCheck()
-
setCheck
public void setCheck(Boolean check)
-
getContent
public InputStream getContent()
-
setContent
public void setContent(InputStream content)
-
getCreated
public Date getCreated()
-
setCreated
public void setCreated(Date created)
-
getDestinationFolderId
public String getDestinationFolderId()
-
setDestinationFolderId
public void setDestinationFolderId(String destinationFolderId)
-
getFields
public String[] getFields()
-
setFields
public void setFields(String[] fields)
-
getFileContent
public InputStream getFileContent()
-
setFileContent
public void setFileContent(InputStream fileContent)
-
getFileId
public String getFileId()
-
setFileId
public void setFileId(String fileId)
-
getFileName
public String getFileName()
-
setFileName
public void setFileName(String fileName)
-
getFileSize
public Long getFileSize()
-
setFileSize
public void setFileSize(Long fileSize)
-
getFileType
public com.box.sdk.BoxFile.ThumbnailFileType getFileType()
-
setFileType
public void setFileType(com.box.sdk.BoxFile.ThumbnailFileType fileType)
-
getInfo
public com.box.sdk.BoxFile.Info getInfo()
-
setInfo
public void setInfo(com.box.sdk.BoxFile.Info info)
-
getListener
public com.box.sdk.ProgressListener getListener()
-
setListener
public void setListener(com.box.sdk.ProgressListener listener)
-
getMaxHeight
public Integer getMaxHeight()
-
setMaxHeight
public void setMaxHeight(Integer maxHeight)
-
getMaxWidth
public Integer getMaxWidth()
-
setMaxWidth
public void setMaxWidth(Integer maxWidth)
-
getMetadata
public com.box.sdk.Metadata getMetadata()
-
setMetadata
public void setMetadata(com.box.sdk.Metadata metadata)
-
getMinHeight
public Integer getMinHeight()
-
setMinHeight
public void setMinHeight(Integer minHeight)
-
getMinWidth
public Integer getMinWidth()
-
setMinWidth
public void setMinWidth(Integer minWidth)
-
getModified
public Date getModified()
-
setModified
public void setModified(Date modified)
-
getNewFileName
public String getNewFileName()
-
setNewFileName
public void setNewFileName(String newFileName)
-
getNewName
public String getNewName()
-
setNewName
public void setNewName(String newName)
-
getOutput
public OutputStream getOutput()
-
setOutput
public void setOutput(OutputStream output)
-
getParentFolderId
public String getParentFolderId()
-
setParentFolderId
public void setParentFolderId(String parentFolderId)
-
getPermissions
public com.box.sdk.BoxSharedLink.Permissions getPermissions()
-
setPermissions
public void setPermissions(com.box.sdk.BoxSharedLink.Permissions permissions)
-
getRangeEnd
public Long getRangeEnd()
-
setRangeEnd
public void setRangeEnd(Long rangeEnd)
-
getRangeStart
public Long getRangeStart()
-
setRangeStart
public void setRangeStart(Long rangeStart)
-
getSize
public Long getSize()
-
setSize
public void setSize(Long size)
-
getTypeName
public String getTypeName()
-
setTypeName
public void setTypeName(String typeName)
-
getUnshareDate
public Date getUnshareDate()
-
setUnshareDate
public void setUnshareDate(Date unshareDate)
-
getVersion
public Integer getVersion()
-
setVersion
public void setVersion(Integer version)
-
-