PublicClientApplication.Builder (msal4j 1.3.0 API)

java.lang.Object
- com.microsoft.aad.msal4j.PublicClientApplication.Builder

Enclosing class:: PublicClientApplication

public static class PublicClientApplication.Builder
extends Object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`T`	`aadInstanceDiscoveryResponse(String val)` Sets instance discovery response data which will be used for determining tenant discovery endpoint and authority aliases.
`T`	`applicationName(String val)` Sets application name for telemetry purposes
`T`	`applicationVersion(String val)` Sets application version for telemetry purposes
`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`	`httpClient(IHttpClient val)` Sets HTTP client to be used by the client application for all HTTP 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 (MSAL4J by default uses `HttpsURLConnection`) 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. Authority is only validated when: 1 - It is an Azure Active Directory authority (not B2C or ADFS) 2 - Instance discovery metadata is not set via ClientApplicationBase.aadAadInstanceDiscoveryResponse 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 (MSAL4J by default uses HttpsURLConnection) for all network communication. If no proxy value is passed in, system defined properties are used. If HTTP client is set on the client application (via ClientApplication.builder().httpClient()), proxy configuration should be done on the HTTP client object being passed in, and not through this method.
    
    Parameters:
    
    val - an instance of Proxy
    
    Returns:
    
    instance of the Builder on which method was called
  - httpClient
```
public T httpClient(IHttpClient val)
```
    Sets HTTP client to be used by the client application for all HTTP requests. Allows for fine grained configuration of HTTP client.
    
    Parameters:
    
    val - Implementation of IHttpClient
    
    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. If HTTP client is set on the client application (via ClientApplication.builder().httpClient()), any configuration of SSL should be done on the HTTP client and not through this method.
    
    Parameters:
    
    val - an instance of SSLSocketFactory
    
    Returns:
    
    instance of the Builder on which method was called
  - applicationName
```
public T applicationName(String val)
```
    Sets application name for telemetry purposes
    
    Parameters:
    
    val - application name
    
    Returns:
    
    instance of the Builder on which method was called
  - applicationVersion
```
public T applicationVersion(String val)
```
    Sets application version for telemetry purposes
    
    Parameters:
    
    val - application version
    
    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
  - aadInstanceDiscoveryResponse
```
public T aadInstanceDiscoveryResponse(String val)
```
    Sets instance discovery response data which will be used for determining tenant discovery endpoint and authority aliases. Note that authority validation is not done even if ClientApplicationBase.validateAuthority is set to true. For more information, see https://aka.ms/msal4j-instance-discovery
    
    Parameters:
    
    val - JSON formatted value of response from AAD instance discovery endpoint
    
    Returns:
    
    instance of the Builder on which method was called

Class PublicClientApplication.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

build

self

authority

b2cAuthority

validateAuthority

correlationId

logPii

executorService

proxy

httpClient

sslSocketFactory

applicationName

applicationVersion

setTokenCacheAccessAspect

aadInstanceDiscoveryResponse