com.microsoft.aad.msal4j

Class PublicClientApplication.Builder

java.lang.Object

com.microsoft.aad.msal4j.PublicClientApplication.Builder

Enclosing class:

PublicClientApplication

public static class PublicClientApplication.Builder
extends Object

Method Summary

Modifier and Type	Method and Description
T	authority(String val) Set URL of the authenticating authority or security token service (STS) from which MSAL will acquire security tokens.
T	b2cAuthority(String val)
PublicClientApplication	build()
T	correlationId(String val) Set optional correlation id to be used by the API.
T	executorService(ExecutorService val) Sets ExecutorService to be used to execute the requests.
T	logPii(boolean val) Set logPii - boolean value, which determines whether Pii (personally identifiable information) will be logged in.
T	proxy(Proxy val) Sets Proxy configuration to be used by the client application for all network communication.
protected PublicClientApplication.Builder	self()
T	setTokenCacheAccessAspect(ITokenCacheAccessAspect val) Sets ITokenCacheAccessAspect to be used for cache_data persistence.
T	sslSocketFactory(SSLSocketFactory val) Sets SSLSocketFactory to be used by the client application for all network communication.
T	validateAuthority(boolean val) Set a boolean value telling the application if the authority needs to be verified against a list of known authorities.

Methods inherited from class java.lang.Object

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

Method Detail

build

public PublicClientApplication build()

self

protected PublicClientApplication.Builder self()

authority

public T authority(String val)
            throws MalformedURLException

Set URL of the authenticating authority or security token service (STS) from which MSAL will acquire security tokens. The default value is IClientApplicationBase.DEFAULT_AUTHORITY

Parameters:

val - a string value of authority

Returns:

instance of the Builder on which method was called

Throws:

MalformedURLException - if val is malformed URL

b2cAuthority

public T b2cAuthority(String val)
               throws MalformedURLException

Throws:

MalformedURLException

validateAuthority

public T validateAuthority(boolean val)

Set a boolean value telling the application if the authority needs to be verified against a list of known authorities. The default value is true.

Parameters:

val - a boolean value for validateAuthority

Returns:

instance of the Builder on which method was called

correlationId

public T correlationId(String val)

Set optional correlation id to be used by the API. If not provided, the API generates a random UUID.

Parameters:

val - a string value of correlation id

Returns:

instance of the Builder on which method was called

logPii

public T logPii(boolean val)

Set logPii - boolean value, which determines whether Pii (personally identifiable information) will be logged in. The default value is false.

Parameters:

val - a boolean value for logPii

Returns:

instance of the Builder on which method was called

executorService

public T executorService(ExecutorService val)

Sets ExecutorService to be used to execute the requests. Developer is responsible for maintaining the lifecycle of the ExecutorService.

Parameters:

val - an instance of ExecutorService

Returns:

instance of the Builder on which method was called

proxy

public T proxy(Proxy val)

Sets Proxy configuration to be used by the client application for all network communication. Default is null and system defined properties if any, would be used.

Parameters:

val - an instance of Proxy

Returns:

instance of the Builder on which method was called

sslSocketFactory

public T sslSocketFactory(SSLSocketFactory val)

Sets SSLSocketFactory to be used by the client application for all network communication.

Parameters:

val - an instance of SSLSocketFactory

Returns:

instance of the Builder on which method was called

setTokenCacheAccessAspect

public T setTokenCacheAccessAspect(ITokenCacheAccessAspect val)

Sets ITokenCacheAccessAspect to be used for cache_data persistence.

Parameters:

val - an instance of ITokenCacheAccessAspect

Returns:

instance of the Builder on which method was called