-
Notifications
You must be signed in to change notification settings - Fork 11
/
Copy pathcom.microsoft.aad.msal4j.AbstractApplicationBase.Builder.yml
155 lines (155 loc) Β· 11.9 KB
/
com.microsoft.aad.msal4j.AbstractApplicationBase.Builder.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
### YamlMime:JavaType
uid: "com.microsoft.aad.msal4j.AbstractApplicationBase.Builder"
fullName: "com.microsoft.aad.msal4j.AbstractApplicationBase.Builder<T>"
name: "AbstractApplicationBase.Builder<T>"
nameWithType: "AbstractApplicationBase.Builder<T>"
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- 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 **AbstractApplicationBase.Builder<T>**"
constructors:
- uid: "com.microsoft.aad.msal4j.AbstractApplicationBase.Builder.Builder()"
fullName: "com.microsoft.aad.msal4j.AbstractApplicationBase.Builder<T>.Builder()"
name: "Builder()"
nameWithType: "AbstractApplicationBase.Builder<T>.Builder()"
syntax: "public Builder()"
- uid: "com.microsoft.aad.msal4j.AbstractApplicationBase.Builder.Builder(java.lang.String)"
fullName: "com.microsoft.aad.msal4j.AbstractApplicationBase.Builder<T>.Builder(String clientId)"
name: "Builder(String clientId)"
nameWithType: "AbstractApplicationBase.Builder<T>.Builder(String clientId)"
parameters:
- 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)"
methods:
- uid: "com.microsoft.aad.msal4j.AbstractApplicationBase.Builder.connectTimeoutForDefaultHttpClient(java.lang.Integer)"
fullName: "com.microsoft.aad.msal4j.AbstractApplicationBase.Builder<T>.connectTimeoutForDefaultHttpClient(Integer val)"
name: "connectTimeoutForDefaultHttpClient(Integer val)"
nameWithType: "AbstractApplicationBase.Builder<T>.connectTimeoutForDefaultHttpClient(Integer val)"
summary: "Sets the connect timeout value used in Https<wbr>URLConnection connections made by <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DefaultHttpClient\"></xref>, and is not needed if using a custom HTTP client"
parameters:
- description: "timeout value in milliseconds"
name: "val"
type: "<xref href=\"java.lang.Integer?alt=java.lang.Integer&text=Integer\" data-throw-if-not-resolved=\"False\" />"
syntax: "public T connectTimeoutForDefaultHttpClient(Integer val)"
desc: "Sets the connect timeout value used in HttpsURLConnection connections made by <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DefaultHttpClient\"></xref>, and is not needed if using a custom HTTP client"
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.AbstractApplicationBase.Builder.correlationId(java.lang.String)"
fullName: "com.microsoft.aad.msal4j.AbstractApplicationBase.Builder<T>.correlationId(String val)"
name: "correlationId(String val)"
nameWithType: "AbstractApplicationBase.Builder<T>.correlationId(String val)"
summary: "Set optional correlation id to be used by the API."
parameters:
- description: "a string value of correlation id"
name: "val"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public T correlationId(String val)"
desc: "Set optional correlation id to be used by the API. If not provided, the API generates a random UUID."
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.AbstractApplicationBase.Builder.executorService(java.util.concurrent.ExecutorService)"
fullName: "com.microsoft.aad.msal4j.AbstractApplicationBase.Builder<T>.executorService(ExecutorService val)"
name: "executorService(ExecutorService val)"
nameWithType: "AbstractApplicationBase.Builder<T>.executorService(ExecutorService val)"
summary: "Sets Executor<wbr>Service to be used to execute the requests."
parameters:
- description: "an instance of ExecutorService"
name: "val"
type: "<xref href=\"java.util.concurrent.ExecutorService?alt=java.util.concurrent.ExecutorService&text=ExecutorService\" data-throw-if-not-resolved=\"False\" />"
syntax: "public T executorService(ExecutorService val)"
desc: "Sets ExecutorService to be used to execute the requests. Developer is responsible for maintaining the lifecycle of the ExecutorService."
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.AbstractApplicationBase.Builder.httpClient(com.microsoft.aad.msal4j.IHttpClient)"
fullName: "com.microsoft.aad.msal4j.AbstractApplicationBase.Builder<T>.httpClient(IHttpClient val)"
name: "httpClient(IHttpClient val)"
nameWithType: "AbstractApplicationBase.Builder<T>.httpClient(IHttpClient val)"
summary: "Sets HTTP client to be used by the client application for all HTTP requests."
parameters:
- description: "Implementation of <xref uid=\"com.microsoft.aad.msal4j.IHttpClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IHttpClient\"></xref>"
name: "val"
type: "<xref href=\"com.microsoft.aad.msal4j.IHttpClient?alt=com.microsoft.aad.msal4j.IHttpClient&text=IHttpClient\" data-throw-if-not-resolved=\"False\" />"
syntax: "public T httpClient(IHttpClient val)"
desc: "Sets HTTP client to be used by the client application for all HTTP requests. Allows for fine grained configuration of HTTP client."
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.AbstractApplicationBase.Builder.logPii(boolean)"
fullName: "com.microsoft.aad.msal4j.AbstractApplicationBase.Builder<T>.logPii(boolean val)"
name: "logPii(boolean val)"
nameWithType: "AbstractApplicationBase.Builder<T>.logPii(boolean val)"
summary: "Set log<wbr>Pii - boolean value, which determines whether Pii (personally identifiable information) will be logged in."
parameters:
- description: "a boolean value for logPii"
name: "val"
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
syntax: "public T logPii(boolean val)"
desc: "Set logPii - boolean value, which determines whether Pii (personally identifiable information) will be logged in. The default value is false."
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.AbstractApplicationBase.Builder.proxy(java.net.Proxy)"
fullName: "com.microsoft.aad.msal4j.AbstractApplicationBase.Builder<T>.proxy(Proxy val)"
name: "proxy(Proxy val)"
nameWithType: "AbstractApplicationBase.Builder<T>.proxy(Proxy val)"
summary: "Sets Proxy configuration to be used by the client application (MSAL4J by default uses <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"javax.net.ssl.HttpsURLConnection\"></xref>) for all network communication."
parameters:
- description: "an instance of Proxy"
name: "val"
type: "<xref href=\"java.net.Proxy?alt=java.net.Proxy&text=Proxy\" data-throw-if-not-resolved=\"False\" />"
syntax: "public T proxy(Proxy val)"
desc: "Sets Proxy configuration to be used by the client application (MSAL4J by default uses <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"javax.net.ssl.HttpsURLConnection\"></xref>) 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."
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.AbstractApplicationBase.Builder.readTimeoutForDefaultHttpClient(java.lang.Integer)"
fullName: "com.microsoft.aad.msal4j.AbstractApplicationBase.Builder<T>.readTimeoutForDefaultHttpClient(Integer val)"
name: "readTimeoutForDefaultHttpClient(Integer val)"
nameWithType: "AbstractApplicationBase.Builder<T>.readTimeoutForDefaultHttpClient(Integer val)"
summary: "Sets the read timeout value used in Https<wbr>URLConnection connections made by <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DefaultHttpClient\"></xref>, and is not needed if using a custom HTTP client"
parameters:
- description: "timeout value in milliseconds"
name: "val"
type: "<xref href=\"java.lang.Integer?alt=java.lang.Integer&text=Integer\" data-throw-if-not-resolved=\"False\" />"
syntax: "public T readTimeoutForDefaultHttpClient(Integer val)"
desc: "Sets the read timeout value used in HttpsURLConnection connections made by <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DefaultHttpClient\"></xref>, and is not needed if using a custom HTTP client"
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.AbstractApplicationBase.Builder.sslSocketFactory(javax.net.ssl.SSLSocketFactory)"
fullName: "com.microsoft.aad.msal4j.AbstractApplicationBase.Builder<T>.sslSocketFactory(SSLSocketFactory val)"
name: "sslSocketFactory(SSLSocketFactory val)"
nameWithType: "AbstractApplicationBase.Builder<T>.sslSocketFactory(SSLSocketFactory val)"
summary: "Sets SSLSocket<wbr>Factory to be used by the client application for all network communication."
parameters:
- description: "an instance of SSLSocketFactory"
name: "val"
type: "<xref href=\"javax.net.ssl.SSLSocketFactory?alt=javax.net.ssl.SSLSocketFactory&text=SSLSocketFactory\" data-throw-if-not-resolved=\"False\" />"
syntax: "public T sslSocketFactory(SSLSocketFactory val)"
desc: "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."
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.17.2