org.sagebionetworks.bridge.rest

Class RestUtils

java.lang.Object

org.sagebionetworks.bridge.rest.RestUtils

public class RestUtils
extends Object

Utilities for working with the REST model objects returned from the Bridge REST client.

Field Summary

Fields

Modifier and Type	Field and Description
static com.google.gson.Gson	GSON

Constructor Summary

Constructors

Constructor and Description
RestUtils()

Method Summary

Modifier and Type	Method and Description
static String	getAcceptLanguage(List<String> langs)
static String	getUserAgent(ClientInfo info) Convert ClientInfo object into a User-Agent header value that can be used by the Bridge server to filter content appropriately for your app.
static boolean	isConsentCurrent(UserSessionInfo session) Are all the required consents up-to-date?
static boolean	isUserConsented(UserSessionInfo session) Are all required consents signed?
static UploadRequest	makeUploadRequestForFile(File file) Creates an upload request for the given file.
static UserSessionInfo	signInWithSynapse(AuthenticationApi authApi, SignIn signIn) Sign in to the Synapse server using a Synapse account, and use this to authenticate with Bridge via OAuth.
static UserSessionInfo	signInWithSynapseDev(AuthenticationApi authApi, SignIn signIn) Sign in to Bridge using Synapse Dev.
static com.google.gson.JsonElement	toJSON(Object object) Convert an object returned as part of the API to a JSON object model
static <T> T	toType(Object object, Class<T> type) Downcast an object to a specific subtype where GSON does not know the type during deserialization.
static UploadSession	upload(ForConsentedUsersApi usersApi, File file) Manages the conversation with the Bridge server and Amazon's S3 service to upload an encrypted zip file to Bridge.
static String	uploadHostedFileToS3(HostedFilesApi fileApi, String fileGuid, File file) A utility method for uploading static asset files that are hosted by Bridge and referenceable from the AppConfig defined for an application.
static String	uploadStudyLogoToS3(StudiesApi studiesApi, String studyId, File file)
static void	uploadToS3(File file, String url) Uploads the given file to the given S3 URL.
static void	uploadToS3(File file, String url, String contentType) Uploads the given file to the given S3 URL.

Methods inherited from class java.lang.Object

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

Field Detail

GSON

public static final com.google.gson.Gson GSON

Constructor Detail

RestUtils

public RestUtils()

Method Detail

toType

public static <T> T toType(Object object,
                           Class<T> type)

Downcast an object to a specific subtype where GSON does not know the type during deserialization. In that case, GSON uses a generic Map structure to hold the data. This can convert that generic representation into a specific type.

Type Parameters:

T - the target type of the cast

Parameters:

object - - an object to cast to the supplied type

type - - the target type of the cast

Returns:

the object to downcast to the supplied type

toJSON

public static com.google.gson.JsonElement toJSON(Object object)

Convert an object returned as part of the API to a JSON object model

Parameters:

object -

Returns:

a JSON object model of the object.

isUserConsented

public static boolean isUserConsented(UserSessionInfo session)

Are all required consents signed?

Parameters:

session - A UserSessionInfo object

Returns:

true if all required consents are signed, false if there are no consents, or they are not all signed

isConsentCurrent

public static boolean isConsentCurrent(UserSessionInfo session)

Are all the required consents up-to-date?

Parameters:

session - A UserSessionInfo object

Returns:

true if all required consents are signed and up-to-date, false if there are no consents, or they are not all signed, or they are not all up-to-date.

getUserAgent

public static String getUserAgent(ClientInfo info)

Convert ClientInfo object into a User-Agent header value that can be used by the Bridge server to filter content appropriately for your app.

There are three main stanzas in the Bridge User-Agent header, and all parts of a given stanza must be provided or that stanza will be dropped from the final header:

• appName and appVersion;
• deviceName, osName and osVersion;
• sdkName and sdkVersion

The ClientManager will provide values for the final two groupings (and enforces settings for the SDK information).

Parameters:

info - a ClientInfo object

Returns:

string User-Agent header value

getAcceptLanguage

public static String getAcceptLanguage(List<String> langs)

upload

public static UploadSession upload(ForConsentedUsersApi usersApi,
                                   File file)
                            throws IOException

Manages the conversation with the Bridge server and Amazon's S3 service to upload an encrypted zip file to Bridge. This completes the upload in asynchronous mode and returns the UploadSession.

Parameters:

usersApi - The ForConsentedUsersApi for the user making the upload

file - A File referencing a zip file to upload

Returns:

An UploadSession with information about the upload session

Throws:

IOException - IOException if an issue occurs during upload. Callers are responsible for re-trying the upload

makeUploadRequestForFile

public static UploadRequest makeUploadRequestForFile(File file)
                                              throws IOException

Creates an upload request for the given file. This method assumes the default content type of "application/zip".

Parameters:

file - File to upload to Bridge

Returns:

the Bridge upload request

Throws:

IOException - IOException if an issue occurs during upload. Callers are responsible for re-trying the upload

uploadToS3

public static void uploadToS3(File file,
                              String url)
                       throws IOException

Uploads the given file to the given S3 URL. This method assumes the default content type of "application/zip".

Parameters:

file - File to upload to Bridge

url - S3 URL to upload to, generally as returned by Bridge Upload Session

Throws:

IOException - IOException if an issue occurs during upload. Callers are responsible for re-trying the upload

uploadToS3

public static void uploadToS3(File file,
                              String url,
                              String contentType)
                       throws IOException

Uploads the given file to the given S3 URL.

Parameters:

file - File to upload to Bridge

url - S3 URL to upload to, generally as returned by Bridge Upload Session

contentType - MIME type of the uploaded file, must match what was sent in the upload request

Throws:

IOException - IOException if an issue occurs during upload. Callers are responsible for re-trying the upload

uploadHostedFileToS3

public static String uploadHostedFileToS3(HostedFilesApi fileApi,
                                          String fileGuid,
                                          File file)
                                   throws IOException

A utility method for uploading static asset files that are hosted by Bridge and referenceable from the AppConfig defined for an application.

Parameters:

fileApi - the FileApi client object

fileGuid - the GUID of the FileMetadata object of which this file is one revision

file - a File reference to the content of the FileRevision

Returns:

a download URL for any client to request and download the file via HTTP GET.

Throws:

IOException

uploadStudyLogoToS3

public static String uploadStudyLogoToS3(StudiesApi studiesApi,
                                         String studyId,
                                         File file)
                                  throws IOException

Throws:

IOException

signInWithSynapse

public static UserSessionInfo signInWithSynapse(AuthenticationApi authApi,
                                                SignIn signIn)
                                         throws Exception

Sign in to the Synapse server using a Synapse account, and use this to authenticate with Bridge via OAuth. This utility method combines the several calls needed to complete an OAuth-based authentication. By signing into Bridge using a Synapse account, you consent to release your Synapse user ID to Bridge so it can confirm your identity.

Parameters:

authApi - the Bridge REST authentication API (does not require authentication)

signIn - the sign in form with your Synapse credentials and target app to sign in to

Returns:

a Bridge user session if you successfully authenticate with Synapse

Throws:

Exception

signInWithSynapseDev

public static UserSessionInfo signInWithSynapseDev(AuthenticationApi authApi,
                                                   SignIn signIn)
                                            throws Exception

Sign in to Bridge using Synapse Dev. This is used when connecting to Bridge Dev or Staging.

Throws:

Exception