org.sagebionetworks.bridge.rest

Class ApiClientProvider.AuthenticatedClientProviderBuilder

java.lang.Object

org.sagebionetworks.bridge.rest.ApiClientProvider.AuthenticatedClientProviderBuilder

Enclosing class:

ApiClientProvider

public class ApiClientProvider.AuthenticatedClientProviderBuilder
extends Object

Builder for AuthenticatedClientProvider. Configure the builder with credentials for a user

Method Summary

Modifier and Type	Method and Description
ApiClientProvider.AuthenticatedClientProviderBuilder	addUserSessionInfoChangeListener(UserSessionInfoProvider.UserSessionInfoChangeListener changeListener)
ApiClientProvider.AuthenticatedClientProvider	build() Builds an AuthenticatedClientProvider.
ApiClientProvider.AuthenticatedClientProviderBuilder	withEmail(String email)
ApiClientProvider.AuthenticatedClientProviderBuilder	withExternalId(String externalId)
ApiClientProvider.AuthenticatedClientProviderBuilder	withPassword(String password)
ApiClientProvider.AuthenticatedClientProviderBuilder	withPhone(Phone phone)
ApiClientProvider.AuthenticatedClientProviderBuilder	withSession(UserSessionInfo session)

Methods inherited from class java.lang.Object

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

Method Detail

addUserSessionInfoChangeListener

public ApiClientProvider.AuthenticatedClientProviderBuilder addUserSessionInfoChangeListener(UserSessionInfoProvider.UserSessionInfoChangeListener changeListener)

Parameters:

changeListener - UserSessionInfo change listener

Returns:

this builder, for chaining operations

withPhone

public ApiClientProvider.AuthenticatedClientProviderBuilder withPhone(Phone phone)

Parameters:

phone - participant's phone

Returns:

this builder, for chaining operations

withEmail

public ApiClientProvider.AuthenticatedClientProviderBuilder withEmail(String email)

Parameters:

email - participant's email

Returns:

this builder, for chaining operations

withExternalId

public ApiClientProvider.AuthenticatedClientProviderBuilder withExternalId(String externalId)

Parameters:

externalId - participant's externalId

Returns:

this builder, for chaining operations

withPassword

public ApiClientProvider.AuthenticatedClientProviderBuilder withPassword(String password)

Parameters:

password - participant's password, if available

Returns:

this builder, for chaining operations

withSession

public ApiClientProvider.AuthenticatedClientProviderBuilder withSession(UserSessionInfo session)

Parameters:

session - participant's last active session, if available

Returns:

this builder, for chaining operations

build

public ApiClientProvider.AuthenticatedClientProvider build()

Builds an AuthenticatedClientProvider. The credentials and/or session are cleared out when build() is called, and can be set again to build another AuthenticatedClientProvider for a different.

Returns:

instance of AuthenticatedClientProvider tied to a participant