public class

BoxRequestFactory

extends BaseBoxFactory
java.lang.Object
   ↳ cn.com.believer.songyuanframework.openapi.storage.box.factories.BaseBoxFactory
     ↳ cn.com.believer.songyuanframework.openapi.storage.box.factories.BoxRequestFactory

Summary

Fields
protected static final Logger LOGGER log4j object.
[Expand]
Inherited Fields
From class cn.com.believer.songyuanframework.openapi.storage.box.factories.BaseBoxFactory
Public Constructors
BoxRequestFactory()
Public Methods
static AddToMyBoxRequest createAddToMyBoxRequest(String apiKey, String authToken, String fileId, String publicName, String folderId, String[] tags)
create request object.
static AddToMyBoxRequest createAddToMyBoxRequest()
create request object.
static AddToTagRequest createAddToTagRequest(String apiKey, String authToken, String[] tags, String target, String targetId)
create request object.
static AddToTagRequest createAddToTagRequest()
create request object.
static CreateFolderRequest createCreateFolderRequest(String apiKey, String authToken, String parentFolderId, String folderName, boolean share)
create request object.
static CreateFolderRequest createCreateFolderRequest()
create request object.
static DeleteRequest createDeleteRequest()
create request object.
static DeleteRequest createDeleteRequest(String apiKey, String authToken, String target, String targetId)
create request object.
static DownloadRequest createDownloadRequest(String authToken, String fileId, boolean asFile, File inFile)
create request object.
static DownloadRequest createDownloadRequest()
create request object.
static ExportTagsRequest createExportTagsRequest()
create request object.
static ExportTagsRequest createExportTagsRequest(String apiKey, String authToken)
create request object.
static GetAccountTreeRequest createGetAccountTreeRequest(String apiKey, String authToken, String folderId, String[] params)
create request object.
static GetAccountTreeRequest createGetAccountTreeRequest()
create request object.
static GetAuthTokenRequest createGetAuthTokenRequest()
create request object.
static GetAuthTokenRequest createGetAuthTokenRequest(String apiKey, String ticket)
create request object.
static GetFileInfoRequest createGetFileInfoRequest()
create request object.
static GetFileInfoRequest createGetFileInfoRequest(String apiKey, String authToken, String fileId)
create request object.
static GetFriendsRequest createGetFriendsRequest()
create request object.
static GetFriendsRequest createGetFriendsRequest(String apiKey, String authToken, String[] params)
create request object.
static GetTicketRequest createGetTicketRequest(String apiKey)
create request object.
static GetTicketRequest createGetTicketRequest()
create request object.
static LogoutRequest createLogoutRequest(String apiKey, String authToken)
create request object.
static LogoutRequest createLogoutRequest()
create request object.
static MoveRequest createMoveRequest()
create request object.
static MoveRequest createMoveRequest(String apiKey, String authToken, String target, String targetId, String destinationId)
create request object.
static PrivateShareRequest createPrivateShareRequest(String apiKey, String authToken, String target, String targetId, String[] emails, String message, boolean nofity)
create request object.
static PrivateShareRequest createPrivateShareRequest()
create request object.
static PublicShareRequest createPublicShareRequest(String apiKey, String authToken, String target, String targetId, String password, String message, String[] emails)
create request object.
static PublicShareRequest createPublicShareRequest()
create request object.
static PublicUnshareRequest createPublicUnshareRequest(String apiKey, String authToken, String target, String targetId)
create request object.
static PublicUnshareRequest createPublicUnshareRequest()
create request object.
static RegisterNewUserRequest createRegisterNewUserRequest(String apiKey, String loginName, String password)
create request object.
static RegisterNewUserRequest createRegisterNewUserRequest()
create request object.
static RenameRequest createRenameRequest(String apiKey, String authToken, String target, String targetId, String newName)
create request object.
static RenameRequest createRenameRequest()
create request object.
static RequestFriendsRequest createRequestFriendsRequest()
create request object.
static RequestFriendsRequest createRequestFriendsRequest(String apiKey, String authToken, String[] emails, String message, String[] params)
create request object.
static SetDescriptionRequest createSetDescriptionRequest(String apiKey, String authToken, String target, String targetId, String description)
create request object.
static SetDescriptionRequest createSetDescriptionRequest()
create request object.
static UploadRequest createUploadRequest()
create request object.
static UploadRequest createUploadRequest(String authToken, boolean asFile, String parentFolderId, Map nameValueMap)
create request object.
static VerifyRegistrationEmailRequest createVerifyRegistrationEmailRequest(String apiKey, String loginName)
create request object.
static VerifyRegistrationEmailRequest createVerifyRegistrationEmailRequest()
create request object.
[Expand]
Inherited Methods
From class cn.com.believer.songyuanframework.openapi.storage.box.factories.BaseBoxFactory
From class java.lang.Object

Fields

protected static final Logger LOGGER

log4j object.

Public Constructors

public BoxRequestFactory ()

Public Methods

public static AddToMyBoxRequest createAddToMyBoxRequest (String apiKey, String authToken, String fileId, String publicName, String folderId, String[] tags)

create request object.

Parameters
apiKey API key
authToken Auth token
fileId File id
publicName Public name
folderId Folder id
tags Tag string array
Returns
  • request object

public static AddToMyBoxRequest createAddToMyBoxRequest ()

create request object.

Returns
  • request object

public static AddToTagRequest createAddToTagRequest (String apiKey, String authToken, String[] tags, String target, String targetId)

create request object.

Parameters
apiKey API key
authToken Auth token
tags Tag string array
target Target
targetId Target id
Returns
  • request object

public static AddToTagRequest createAddToTagRequest ()

create request object.

Returns
  • request object

public static CreateFolderRequest createCreateFolderRequest (String apiKey, String authToken, String parentFolderId, String folderName, boolean share)

create request object.

Parameters
apiKey API key
authToken Auth token
parentFolderId Parent folder id
folderName Folder name
share Share flag
Returns
  • request object

public static CreateFolderRequest createCreateFolderRequest ()

create request object.

Returns
  • request object

public static DeleteRequest createDeleteRequest ()

create request object.

Returns
  • request object

public static DeleteRequest createDeleteRequest (String apiKey, String authToken, String target, String targetId)

create request object.

Parameters
apiKey API key
authToken Auth token
target Target
targetId Target id
Returns
  • request object

public static DownloadRequest createDownloadRequest (String authToken, String fileId, boolean asFile, File inFile)

create request object.

Parameters
authToken Auth token
fileId File id
asFile If download as JAVA file object
inFile Input JAVA File object
Returns
  • request object

public static DownloadRequest createDownloadRequest ()

create request object.

Returns
  • request object

public static ExportTagsRequest createExportTagsRequest ()

create request object.

Returns
  • request object

public static ExportTagsRequest createExportTagsRequest (String apiKey, String authToken)

create request object.

Parameters
apiKey API key
authToken Auth token
Returns
  • request object

public static GetAccountTreeRequest createGetAccountTreeRequest (String apiKey, String authToken, String folderId, String[] params)

create request object.

Parameters
apiKey API key
authToken Auth token
folderId Folder id
params Parameters
Returns
  • request object

public static GetAccountTreeRequest createGetAccountTreeRequest ()

create request object.

Returns
  • request object

public static GetAuthTokenRequest createGetAuthTokenRequest ()

create request object.

Returns
  • request object

public static GetAuthTokenRequest createGetAuthTokenRequest (String apiKey, String ticket)

create request object.

Parameters
apiKey API key
ticket The ticket
Returns
  • request object

public static GetFileInfoRequest createGetFileInfoRequest ()

create request object.

Returns
  • request object

public static GetFileInfoRequest createGetFileInfoRequest (String apiKey, String authToken, String fileId)

create request object.

Parameters
apiKey API key
authToken Auth token
fileId File id
Returns
  • request object

public static GetFriendsRequest createGetFriendsRequest ()

create request object.

Returns
  • request object

public static GetFriendsRequest createGetFriendsRequest (String apiKey, String authToken, String[] params)

create request object.

Parameters
apiKey API key
authToken Auth token
params Parameters
Returns
  • request object

public static GetTicketRequest createGetTicketRequest (String apiKey)

create request object.

Parameters
apiKey API key
Returns
  • request object

public static GetTicketRequest createGetTicketRequest ()

create request object.

Returns
  • request object

public static LogoutRequest createLogoutRequest (String apiKey, String authToken)

create request object.

Parameters
apiKey API key
authToken Auth token
Returns
  • request object

public static LogoutRequest createLogoutRequest ()

create request object.

Returns
  • request object

public static MoveRequest createMoveRequest ()

create request object.

Returns
  • request object

public static MoveRequest createMoveRequest (String apiKey, String authToken, String target, String targetId, String destinationId)

create request object.

Parameters
apiKey API key
authToken Auth token
target Target
targetId Target id
destinationId Destination id
Returns
  • request object

public static PrivateShareRequest createPrivateShareRequest (String apiKey, String authToken, String target, String targetId, String[] emails, String message, boolean nofity)

create request object.

Parameters
apiKey API key
authToken Auth token
target Target
targetId Target id
emails Email array
message Message
nofity Notify flag
Returns
  • request object

public static PrivateShareRequest createPrivateShareRequest ()

create request object.

Returns
  • request object

public static PublicShareRequest createPublicShareRequest (String apiKey, String authToken, String target, String targetId, String password, String message, String[] emails)

create request object.

Parameters
apiKey API key
authToken Auth token
target Target
targetId Target id
password Password to protect the item
message Message of the item
emails Email array
Returns
  • request object

public static PublicShareRequest createPublicShareRequest ()

create request object.

Returns
  • request object

public static PublicUnshareRequest createPublicUnshareRequest (String apiKey, String authToken, String target, String targetId)

create request object.

Parameters
apiKey API key
authToken Auth token
target Target
targetId Target id
Returns
  • request object

public static PublicUnshareRequest createPublicUnshareRequest ()

create request object.

Returns
  • request object

public static RegisterNewUserRequest createRegisterNewUserRequest (String apiKey, String loginName, String password)

create request object.

Parameters
apiKey API key
loginName Login name
password Password
Returns
  • request object

public static RegisterNewUserRequest createRegisterNewUserRequest ()

create request object.

Returns
  • request object

public static RenameRequest createRenameRequest (String apiKey, String authToken, String target, String targetId, String newName)

create request object.

Parameters
apiKey API key
authToken Auth token
target Target
targetId Target id
newName New name of item
Returns
  • request object

public static RenameRequest createRenameRequest ()

create request object.

Returns
  • request object

public static RequestFriendsRequest createRequestFriendsRequest ()

create request object.

Returns
  • request object

public static RequestFriendsRequest createRequestFriendsRequest (String apiKey, String authToken, String[] emails, String message, String[] params)

create request object.

Parameters
apiKey API key
authToken Auth token
emails Email arrays
message Message
params Parameters
Returns
  • request object

public static SetDescriptionRequest createSetDescriptionRequest (String apiKey, String authToken, String target, String targetId, String description)

create request object.

Parameters
apiKey API key
authToken Auth token
target Target
targetId Target id
description Description
Returns
  • request object

public static SetDescriptionRequest createSetDescriptionRequest ()

create request object.

Returns
  • request object

public static UploadRequest createUploadRequest ()

create request object.

Returns
  • request object

public static UploadRequest createUploadRequest (String authToken, boolean asFile, String parentFolderId, Map nameValueMap)

create request object.

Parameters
authToken Auth token
asFile Upload as file flag
parentFolderId Parent folder id
nameValueMap Key is file name, value could be file or byte array.
Returns
  • request object

public static VerifyRegistrationEmailRequest createVerifyRegistrationEmailRequest (String apiKey, String loginName)

create request object.

Parameters
apiKey API key
loginName Login name
Returns
  • request object

public static VerifyRegistrationEmailRequest createVerifyRegistrationEmailRequest ()

create request object.

Returns
  • request object