com.microsoft.aad.msal4j.AbstractClientApplicationBase.Builder.yml

### YamlMime:JavaType
uid: "com.microsoft.aad.msal4j.AbstractClientApplicationBase.Builder"
fullName: "com.microsoft.aad.msal4j.AbstractClientApplicationBase.Builder<T>"
name: "AbstractClientApplicationBase.Builder<T>"
nameWithType: "AbstractClientApplicationBase.Builder<T>"
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.aad.msal4j.AbstractApplicationBase.Builder?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"com.microsoft.aad.msal4j.AbstractApplicationBase.Builder?alt=com.microsoft.aad.msal4j.AbstractApplicationBase.Builder&text=Builder\" data-throw-if-not-resolved=\"False\" />"
  methodsRef:
  - "<xref href=\"com.microsoft.aad.msal4j.AbstractApplicationBase.Builder.connectTimeoutForDefaultHttpClient(java.lang.Integer)?alt=com.microsoft.aad.msal4j.AbstractApplicationBase.Builder.connectTimeoutForDefaultHttpClient&text=connectTimeoutForDefaultHttpClient\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"com.microsoft.aad.msal4j.AbstractApplicationBase.Builder.correlationId(java.lang.String)?alt=com.microsoft.aad.msal4j.AbstractApplicationBase.Builder.correlationId&text=correlationId\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"com.microsoft.aad.msal4j.AbstractApplicationBase.Builder.executorService(java.util.concurrent.ExecutorService)?alt=com.microsoft.aad.msal4j.AbstractApplicationBase.Builder.executorService&text=executorService\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"com.microsoft.aad.msal4j.AbstractApplicationBase.Builder.httpClient(com.microsoft.aad.msal4j.IHttpClient)?alt=com.microsoft.aad.msal4j.AbstractApplicationBase.Builder.httpClient&text=httpClient\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"com.microsoft.aad.msal4j.AbstractApplicationBase.Builder.logPii(boolean)?alt=com.microsoft.aad.msal4j.AbstractApplicationBase.Builder.logPii&text=logPii\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"com.microsoft.aad.msal4j.AbstractApplicationBase.Builder.proxy(java.net.Proxy)?alt=com.microsoft.aad.msal4j.AbstractApplicationBase.Builder.proxy&text=proxy\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"com.microsoft.aad.msal4j.AbstractApplicationBase.Builder.readTimeoutForDefaultHttpClient(java.lang.Integer)?alt=com.microsoft.aad.msal4j.AbstractApplicationBase.Builder.readTimeoutForDefaultHttpClient&text=readTimeoutForDefaultHttpClient\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"com.microsoft.aad.msal4j.AbstractApplicationBase.Builder.sslSocketFactory(javax.net.ssl.SSLSocketFactory)?alt=com.microsoft.aad.msal4j.AbstractApplicationBase.Builder.sslSocketFactory&text=sslSocketFactory\" data-throw-if-not-resolved=\"False\" />"
- classRef: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
  methodsRef:
  - "<xref href=\"java.lang.Object.clone()?alt=java.lang.Object.clone&text=clone\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.equals(java.lang.Object)?alt=java.lang.Object.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.finalize()?alt=java.lang.Object.finalize&text=finalize\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.getClass()?alt=java.lang.Object.getClass&text=getClass\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.hashCode()?alt=java.lang.Object.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.notify()?alt=java.lang.Object.notify&text=notify\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.notifyAll()?alt=java.lang.Object.notifyAll&text=notifyAll\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.toString()?alt=java.lang.Object.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.wait()?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.wait(long)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.wait(long,int)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract static class **AbstractClientApplicationBase.Builder<T>**</br> extends <xref href=\"com.microsoft.aad.msal4j.AbstractApplicationBase.Builder?alt=com.microsoft.aad.msal4j.AbstractApplicationBase.Builder&text=Builder\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />&gt;"
constructors:
- uid: "com.microsoft.aad.msal4j.AbstractClientApplicationBase.Builder.Builder(java.lang.String)"
  fullName: "com.microsoft.aad.msal4j.AbstractClientApplicationBase.Builder<T>.Builder(String clientId)"
  name: "Builder(String clientId)"
  nameWithType: "AbstractClientApplicationBase.Builder<T>.Builder(String clientId)"
  summary: "Constructor to create instance of Builder of client application"
  parameters:
  - description: "Client ID (Application ID) of the application as registered\n\n                 in the application registration portal (portal.azure.com)"
    name: "clientId"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public Builder(String clientId)"
  desc: "Constructor to create instance of Builder of client application"
fields:
- uid: "com.microsoft.aad.msal4j.AbstractClientApplicationBase.Builder.isInstanceDiscoveryEnabled"
  fullName: "com.microsoft.aad.msal4j.AbstractClientApplicationBase.Builder<T>.isInstanceDiscoveryEnabled"
  name: "isInstanceDiscoveryEnabled"
  nameWithType: "AbstractClientApplicationBase.Builder<T>.isInstanceDiscoveryEnabled"
  modifiers:
  - "protected"
  field:
    type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
  syntax: "protected boolean isInstanceDiscoveryEnabled"
methods:
- uid: "com.microsoft.aad.msal4j.AbstractClientApplicationBase.Builder.aadInstanceDiscoveryResponse(java.lang.String)"
  fullName: "com.microsoft.aad.msal4j.AbstractClientApplicationBase.Builder<T>.aadInstanceDiscoveryResponse(String val)"
  name: "aadInstanceDiscoveryResponse(String val)"
  nameWithType: "AbstractClientApplicationBase.Builder<T>.aadInstanceDiscoveryResponse(String val)"
  summary: "Sets instance discovery response data which will be used for determining tenant discovery endpoint and authority aliases."
  parameters:
  - description: "JSON formatted value of response from AAD instance discovery endpoint"
    name: "val"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public T aadInstanceDiscoveryResponse(String val)"
  desc: "Sets instance discovery response data which will be used for determining tenant discovery endpoint and authority aliases.\n\nNote that authority validation is not done even if <xref uid=\"com.microsoft.aad.msal4j.AbstractClientApplicationBase.validateAuthority*\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AbstractClientApplicationBase#validateAuthority\"></xref> is set to true.\n\nFor more information, see https://aka.ms/msal4j-instance-discovery"
  returns:
    description: "instance of the Builder on which method was called"
    type: "<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.aad.msal4j.AbstractClientApplicationBase.Builder.applicationName(java.lang.String)"
  fullName: "com.microsoft.aad.msal4j.AbstractClientApplicationBase.Builder<T>.applicationName(String val)"
  name: "applicationName(String val)"
  nameWithType: "AbstractClientApplicationBase.Builder<T>.applicationName(String val)"
  summary: "Sets application name for telemetry purposes"
  parameters:
  - description: "application name"
    name: "val"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public T applicationName(String val)"
  desc: "Sets application name for telemetry purposes"
  returns:
    description: "instance of the Builder on which method was called"
    type: "<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.aad.msal4j.AbstractClientApplicationBase.Builder.applicationVersion(java.lang.String)"
  fullName: "com.microsoft.aad.msal4j.AbstractClientApplicationBase.Builder<T>.applicationVersion(String val)"
  name: "applicationVersion(String val)"
  nameWithType: "AbstractClientApplicationBase.Builder<T>.applicationVersion(String val)"
  summary: "Sets application version for telemetry purposes"
  parameters:
  - description: "application version"
    name: "val"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public T applicationVersion(String val)"
  desc: "Sets application version for telemetry purposes"
  returns:
    description: "instance of the Builder on which method was called"
    type: "<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.aad.msal4j.AbstractClientApplicationBase.Builder.authority(java.lang.String)"
  fullName: "com.microsoft.aad.msal4j.AbstractClientApplicationBase.Builder<T>.authority(String val)"
  name: "authority(String val)"
  nameWithType: "AbstractClientApplicationBase.Builder<T>.authority(String val)"
  summary: "Set URL of the authenticating authority or security token service (STS) from which MSAL will acquire security tokens."
  parameters:
  - description: "a string value of authority"
    name: "val"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public T authority(String val)"
  exceptions:
  - description: "if val is malformed URL"
    type: "<xref href=\"java.net.MalformedURLException?alt=java.net.MalformedURLException&text=MalformedURLException\" data-throw-if-not-resolved=\"False\" />"
  desc: "Set URL of the authenticating authority or security token service (STS) from which MSAL will acquire security tokens. The default value is <xref uid=\"com.microsoft.aad.msal4j.AbstractClientApplicationBase.DEFAULT_AUTHORITY\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AbstractClientApplicationBase#DEFAULT_AUTHORITY\"></xref>"
  returns:
    description: "instance of the Builder on which method was called"
    type: "<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.aad.msal4j.AbstractClientApplicationBase.Builder.autoDetectRegion(boolean)"
  fullName: "com.microsoft.aad.msal4j.AbstractClientApplicationBase.Builder<T>.autoDetectRegion(boolean val)"
  name: "autoDetectRegion(boolean val)"
  nameWithType: "AbstractClientApplicationBase.Builder<T>.autoDetectRegion(boolean val)"
  summary: "Indicates that the library should attempt to discover the Azure region the application is running in when fetching the instance discovery metadata."
  parameters:
  - description: "boolean (default is false)"
    name: "val"
    type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public T autoDetectRegion(boolean val)"
  desc: "Indicates that the library should attempt to discover the Azure region the application is running in when fetching the instance discovery metadata. Regions can only be detected when running in an Azure environment, such as an Azure VM or other service, or if the environment has environment variable named REGION\\_NAME configured. Although you can enable both autodetection here and a specific region with <xref uid=\"com.microsoft.aad.msal4j.AbstractClientApplicationBase.azureRegion*\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AbstractClientApplicationBase#azureRegion\"></xref> at the same time, the region set with <xref uid=\"com.microsoft.aad.msal4j.AbstractClientApplicationBase.azureRegion*\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AbstractClientApplicationBase#azureRegion\"></xref> will take priority if there is a mismatch. See here for more information about supported scenarios: https://aka.ms/msal4j-azure-regions"
  returns:
    description: "instance of the Builder on which method was called"
    type: "<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.aad.msal4j.AbstractClientApplicationBase.Builder.azureRegion(java.lang.String)"
  fullName: "com.microsoft.aad.msal4j.AbstractClientApplicationBase.Builder<T>.azureRegion(String val)"
  name: "azureRegion(String val)"
  nameWithType: "AbstractClientApplicationBase.Builder<T>.azureRegion(String val)"
  summary: "Set the region that the library will use to format authorities in token requests."
  parameters:
  - description: "String region name"
    name: "val"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public T azureRegion(String val)"
  desc: "Set the region that the library will use to format authorities in token requests. If given a valid Azure region, the library will attempt to make token requests at a regional ESTS-R endpoint rather than the global ESTS endpoint. Regions must be valid Azure regions and their short names should be used, such as 'westus' for the West US Azure region, 'centralus' for the Central US Azure region, etc. Although you can set a specific region here and enable autodetection with <xref uid=\"com.microsoft.aad.msal4j.AbstractClientApplicationBase.autoDetectRegion*\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AbstractClientApplicationBase#autoDetectRegion\"></xref> at the same time the specific region set here will take priority over the autodetected region if there is a mismatch. See here for more information about supported scenarios: https://aka.ms/msal4j-azure-regions"
  returns:
    description: "instance of the Builder on which method was called"
    type: "<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.aad.msal4j.AbstractClientApplicationBase.Builder.b2cAuthority(java.lang.String)"
  fullName: "com.microsoft.aad.msal4j.AbstractClientApplicationBase.Builder<T>.b2cAuthority(String val)"
  name: "b2cAuthority(String val)"
  nameWithType: "AbstractClientApplicationBase.Builder<T>.b2cAuthority(String val)"
  summary: "Set URL of the authenticating B2C authority from which MSAL will acquire tokens Valid B2C authorities should look like: https://<something.<wbr>b2clogin.<wbr>com/<tenant>/<policy> MSAL Java also supports a legacy B2C authority format, which looks like: https://<host>/tfp/<tenant>/<policy> However, MSAL Java will eventually stop supporting the legacy format."
  parameters:
  - description: "a boolean value for validateAuthority"
    name: "val"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public T b2cAuthority(String val)"
  exceptions:
  - type: "<xref href=\"java.net.MalformedURLException?alt=java.net.MalformedURLException&text=MalformedURLException\" data-throw-if-not-resolved=\"False\" />"
  desc: "Set URL of the authenticating B2C authority from which MSAL will acquire tokens Valid B2C authorities should look like: https://<something.b2clogin.com/<tenant>/<policy> MSAL Java also supports a legacy B2C authority format, which looks like: https://<host>/tfp/<tenant>/<policy> However, MSAL Java will eventually stop supporting the legacy format. See here for information on how to migrate to the new format: https://aka.ms/msal4j-b2c"
  returns:
    description: "instance of the Builder on which method was called"
    type: "<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.aad.msal4j.AbstractClientApplicationBase.Builder.clientCapabilities(java.util.Set<java.lang.String>)"
  fullName: "com.microsoft.aad.msal4j.AbstractClientApplicationBase.Builder<T>.clientCapabilities(Set<String> capabilities)"
  name: "clientCapabilities(Set<String> capabilities)"
  nameWithType: "AbstractClientApplicationBase.Builder<T>.clientCapabilities(Set<String> capabilities)"
  parameters:
  - name: "capabilities"
    type: "<xref href=\"java.util.Set?alt=java.util.Set&text=Set\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />&gt;"
  syntax: "public T clientCapabilities(Set<String> capabilities)"
  returns:
    type: "<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.aad.msal4j.AbstractClientApplicationBase.Builder.instanceDiscovery(boolean)"
  fullName: "com.microsoft.aad.msal4j.AbstractClientApplicationBase.Builder<T>.instanceDiscovery(boolean val)"
  name: "instanceDiscovery(boolean val)"
  nameWithType: "AbstractClientApplicationBase.Builder<T>.instanceDiscovery(boolean val)"
  summary: "Historically, MSAL would connect to a central endpoint located at \\`\\`https://login.<wbr>microsoftonline.<wbr>com\\`\\` to acquire some metadata, especially when using an unfamiliar authority."
  parameters:
  - name: "val"
    type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public T instanceDiscovery(boolean val)"
  desc: "Historically, MSAL would connect to a central endpoint located at \\`\\`https://login.microsoftonline.com\\`\\` to acquire some metadata, especially when using an unfamiliar authority. This behavior is known as Instance Discovery. This parameter defaults to true, which enables the Instance Discovery. If you do not know some authorities beforehand, yet still want MSAL to accept any authority that you will provide, you can use a \\`\\`False\\`\\` to unconditionally disable Instance Discovery."
  returns:
    type: "<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.aad.msal4j.AbstractClientApplicationBase.Builder.setTokenCacheAccessAspect(com.microsoft.aad.msal4j.ITokenCacheAccessAspect)"
  fullName: "com.microsoft.aad.msal4j.AbstractClientApplicationBase.Builder<T>.setTokenCacheAccessAspect(ITokenCacheAccessAspect val)"
  name: "setTokenCacheAccessAspect(ITokenCacheAccessAspect val)"
  nameWithType: "AbstractClientApplicationBase.Builder<T>.setTokenCacheAccessAspect(ITokenCacheAccessAspect val)"
  summary: "Sets IToken<wbr>Cache<wbr>Access<wbr>Aspect to be used for cache\\_data persistence."
  parameters:
  - description: "an instance of ITokenCacheAccessAspect"
    name: "val"
    type: "<xref href=\"com.microsoft.aad.msal4j.ITokenCacheAccessAspect?alt=com.microsoft.aad.msal4j.ITokenCacheAccessAspect&text=ITokenCacheAccessAspect\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public T setTokenCacheAccessAspect(ITokenCacheAccessAspect val)"
  desc: "Sets ITokenCacheAccessAspect to be used for cache\\_data persistence."
  returns:
    description: "instance of the Builder on which method was called"
    type: "<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.aad.msal4j.AbstractClientApplicationBase.Builder.validateAuthority(boolean)"
  fullName: "com.microsoft.aad.msal4j.AbstractClientApplicationBase.Builder<T>.validateAuthority(boolean val)"
  name: "validateAuthority(boolean val)"
  nameWithType: "AbstractClientApplicationBase.Builder<T>.validateAuthority(boolean val)"
  summary: "Set a boolean value telling the application if the authority needs to be verified against a list of known authorities."
  parameters:
  - description: "a boolean value for validateAuthority"
    name: "val"
    type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public T validateAuthority(boolean val)"
  desc: "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 <xref uid=\"com.microsoft.aad.msal4j.AbstractClientApplicationBase.aadAadInstanceDiscoveryResponse*\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AbstractClientApplicationBase#aadAadInstanceDiscoveryResponse\"></xref>\n\nThe default value is true."
  returns:
    description: "instance of the Builder on which method was called"
    type: "<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />"
type: "class"
typeParameters:
- name: "T"
metadata: {}
package: "com.microsoft.aad.msal4j"
artifact: com.microsoft.azure:msal4j:1.15.0