com.tsgrp.opencontent.sharefile.util

Class ShareFileUtils

java.lang.Object

com.tsgrp.opencontent.sharefile.util.ShareFileUtils

public class ShareFileUtils
extends java.lang.Object

Utils for interacting with the Sharefile SDK

Constructor Summary

Constructors

Constructor and Description
ShareFileUtils()

Method Summary

Modifier and Type	Method and Description
static boolean	closeSession(java.lang.String subdomain, java.lang.String sfdomain, com.citrix.sharefile.api.authentication.SFOAuth2Token token) Util for closing the sharefile session over REST
static com.citrix.sharefile.api.models.SFFolder	createFolder(com.citrix.sharefile.api.interfaces.ISFApiClient apiClient, java.lang.String folderName) Create the specified folder on the root directory of this user
static com.google.gson.JsonObject	createShare(java.lang.String subdomain, java.lang.String sfdomain, com.citrix.sharefile.api.interfaces.ISFApiClient apiClient, com.citrix.sharefile.api.authentication.SFOAuth2Token token, com.citrix.sharefile.api.models.SFFolder parentFolder, Email email) Wrapper for creating a Share link with an expiration date
static java.lang.String	getAttachmentFilename(java.lang.String ticket, Email email, java.lang.String documentId) returns the filename for the email attachment with the passed in documentId, taking into account that the attachment filename may be stored on the email if the attachment has no content (aka is an extra attachment)
static com.citrix.sharefile.api.models.SFFolder	getParentFolder(com.citrix.sharefile.api.interfaces.ISFApiClient apiClient)
static void	uploadFile(java.lang.String ticket, ShareFileConfig config, com.citrix.sharefile.api.authentication.SFOAuth2Token token, java.lang.String parentId, java.lang.String objectId, java.io.InputStream inputStream, java.lang.String filename) Uploads a File using the Standard upload method with a multipart/form mime encoded POST.

Methods inherited from class java.lang.Object

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

Constructor Detail

ShareFileUtils

public ShareFileUtils()

Method Detail

getParentFolder

public static com.citrix.sharefile.api.models.SFFolder getParentFolder(com.citrix.sharefile.api.interfaces.ISFApiClient apiClient)
                                                                throws com.citrix.sharefile.api.exceptions.SFInvalidStateException,
                                                                       com.citrix.sharefile.api.exceptions.SFServerException,
                                                                       com.citrix.sharefile.api.exceptions.SFNotAuthorizedException,
                                                                       com.citrix.sharefile.api.exceptions.SFOAuthTokenRenewException,
                                                                       com.citrix.sharefile.api.exceptions.SFOtherException

Throws:

com.citrix.sharefile.api.exceptions.SFInvalidStateException

com.citrix.sharefile.api.exceptions.SFServerException

com.citrix.sharefile.api.exceptions.SFNotAuthorizedException

com.citrix.sharefile.api.exceptions.SFOAuthTokenRenewException

com.citrix.sharefile.api.exceptions.SFOtherException

createFolder

public static com.citrix.sharefile.api.models.SFFolder createFolder(com.citrix.sharefile.api.interfaces.ISFApiClient apiClient,
                                                                    java.lang.String folderName)

Create the specified folder on the root directory of this user

Parameters:

apiClient -

folderName -

Returns:

createShare

public static com.google.gson.JsonObject createShare(java.lang.String subdomain,
                                                     java.lang.String sfdomain,
                                                     com.citrix.sharefile.api.interfaces.ISFApiClient apiClient,
                                                     com.citrix.sharefile.api.authentication.SFOAuth2Token token,
                                                     com.citrix.sharefile.api.models.SFFolder parentFolder,
                                                     Email email)
                                              throws java.lang.Exception

Wrapper for creating a Share link with an expiration date

Parameters:

subdomain - - i.e. tsgrp

sfdomain - - i.e. sharefile.com

token - - valid Sharefile OAuth token

parentFolder -

recipients - - list of email addresses

Returns:

Throws:

java.lang.Exception

closeSession

public static boolean closeSession(java.lang.String subdomain,
                                   java.lang.String sfdomain,
                                   com.citrix.sharefile.api.authentication.SFOAuth2Token token)
                            throws java.lang.Exception

Util for closing the sharefile session over REST

Parameters:

subdomain - - i.e. tsgrp

sfdomain - - i.e. sharefile.com

token - - the OAuth2Token returned from authenticate

Returns:

boolean - true if status less than 400, false if we error out

Throws:

java.lang.Exception

uploadFile

public static void uploadFile(java.lang.String ticket,
                              ShareFileConfig config,
                              com.citrix.sharefile.api.authentication.SFOAuth2Token token,
                              java.lang.String parentId,
                              java.lang.String objectId,
                              java.io.InputStream inputStream,
                              java.lang.String filename)
                       throws java.io.IOException,
                              org.apache.http.ParseException

Uploads a File using the Standard upload method with a multipart/form mime encoded POST.

Parameters:

token - - the OAuth2Token returned from authenticate

parentId - - where to upload the File

localPath - - the path of the file to upload, like "c:\\path\\to\\file.name"

Throws:

java.text.ParseException

java.io.IOException

org.apache.http.ParseException

getAttachmentFilename

public static java.lang.String getAttachmentFilename(java.lang.String ticket,
                                                     Email email,
                                                     java.lang.String documentId)

returns the filename for the email attachment with the passed in documentId, taking into account that the attachment filename may be stored on the email if the attachment has no content (aka is an extra attachment)

Parameters:

ticket -

email - - the email that the document is attached to

documentId - - Id of the document we want to return the name for