Package fi.bitwards.service

Class BitwardsCredential.Builder

java.lang.Object

fi.bitwards.service.BitwardsCredential.Builder

Enclosing class:

BitwardsCredential

public static final class BitwardsCredential.Builder
extends Object

Builder class to build Credential instance.

Constructor Summary

Constructors

Constructor	Description
Builder(int type)	Constructor for Builder instance

Method Summary

Modifier and Type	Method	Description
BitwardsCredential	build()	Builds the BitwardsCredential instance for given parameters.
BitwardsCredential.Builder	setAuthenticationDomain(String authenticationDomain)	Set the authentication domain of the BitwardsCredential.
BitwardsCredential.Builder	setAuthenticationToken(String authenticationToken)	Set the authentication token or authorization code of the BitwardsCredential.
BitwardsCredential.Builder	setGrantType(String grantType)	Set the (optional) grant type of the BitwardsCredential.
BitwardsCredential.Builder	setPassword(String password)	Set the password of the BitwardsCredential.
BitwardsCredential.Builder	setRedirectUri(String redirectUri)	Set the (optional) redirect URI that was used when obtaining the authentication token or authorization code.
BitwardsCredential.Builder	setRefreshToken(String refreshToken)	Set the (optional) refresh token of the BitwardsCredential.
BitwardsCredential.Builder	setUsername(String username)	Set the username of the BitwardsCredential.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder(int type)

Constructor for Builder instance

Parameters:

type - determines the type of the BitwardsCredential

Method Details

setUsername

public BitwardsCredential.Builder setUsername(String username)

Set the username of the BitwardsCredential. BitwardsCredential type has to be BitwardsCredential.TYPE_USERNAME_PASSWORD.

Parameters:

username - the username of end user

Returns:

setPassword

public BitwardsCredential.Builder setPassword(String password)

Set the password of the BitwardsCredential. BitwardsCredential type has to be BitwardsCredential.TYPE_USERNAME_PASSWORD.

Parameters:

password - the password of end user

Returns:

setAuthenticationToken

public BitwardsCredential.Builder setAuthenticationToken(String authenticationToken)

Set the authentication token or authorization code of the BitwardsCredential. BitwardsCredential type has to be BitwardsCredential.TYPE_OAUTH2_AUTH_TOKEN.

Parameters:

authenticationToken - the authentication token

Returns:

setAuthenticationDomain

public BitwardsCredential.Builder setAuthenticationDomain(String authenticationDomain)

Set the authentication domain of the BitwardsCredential. BitwardsCredential type has to be BitwardsCredential.TYPE_OAUTH2_AUTH_TOKEN.

Parameters:

authenticationDomain - the authentication domain

Returns:

setRefreshToken

public BitwardsCredential.Builder setRefreshToken(String refreshToken)

Set the (optional) refresh token of the BitwardsCredential. BitwardsCredential type has to be BitwardsCredential.TYPE_OAUTH2_AUTH_TOKEN.

Parameters:

refreshToken - the refresh token

Returns:

setGrantType

public BitwardsCredential.Builder setGrantType(String grantType)

Set the (optional) grant type of the BitwardsCredential. BitwardsCredential type has to be BitwardsCredential.TYPE_OAUTH2_AUTH_TOKEN.

Parameters:

grantType - the grant type

Returns:

setRedirectUri

public BitwardsCredential.Builder setRedirectUri(String redirectUri)

Set the (optional) redirect URI that was used when obtaining the authentication token or authorization code. This is typically required when the backend is using the refreshToken to obtain a new authetication token, or when the authorization code is used.

Parameters:

redirectUri -

Returns:

build

public BitwardsCredential build()
                         throws BitwardsException

Builds the BitwardsCredential instance for given parameters.

Returns:

the BitwardsCredential instance

Throws:

BitwardsException - is thrown if an error occurs during building process.