· 5 years ago · Oct 01, 2020, 09:00 PM
1#%Vocabulary 1.0
2usage: Connection Vocabulary
3base: http://anypoint.com/vocabs/connectivity#
4
5classTerms:
6
7 # Connection types
8 Connection:
9 displayName: Connection
10 description: Describes a connection and it's authentication details.
11
12 BasicAuthentication:
13 displayName: Basic Authentication
14 description: Describes a connection that uses Basic as it's authentication method.
15 extends: Connection
16
17 PlatformManagedOAuth:
18 displayName: Platform Managed OAuth
19 description: Describes a connection that uses OCS for authentication.
20 extends: Connection
21
22 PersonalTokenAuthentication:
23 displayName: Personal Token Authentication
24 description: Describes a connection that uses Personal Access Tokens for authentication.
25 extends: Connection
26
27 # Connection terms
28 ProxyConfiguration:
29 displayName: Proxy Configuration
30 description: Proxy Configuration for a connection.
31
32 TlsContext:
33 displayName: TLS Context
34 description: If the HTTPS was configured as protocol, then the user needs to configure at least the keystore configuration.
35
36 TrustStore:
37 displayName: TrustStore
38 description: Trust store configuration. If used client side, the trust store contains the certificates of the trusted servers. If used server side, it contains the certificates of the trusted clients.
39
40 KeyStore:
41 displayName: KeyStore
42 description: Key store configuration. The key store contains the keys of this server/client.
43
44 Reconnection:
45 displayName: Reconnection
46 description: Reconnection strategy configuration.
47
48 ReconnectStrategy:
49 displayName: Reconnect
50 description: Regular reconnection strategy.
51
52 ReconnectForeverStrategy:
53 displayName: ReconnectForever
54 description: Reconnection strategy with infinite retries.
55
56 StandardRevocationCheck:
57 displayName: StandardRevocationCheck
58 description: Uses the standard JVM certificate revocation checks.
59
60 CustomOcspResponderRevocationCheck:
61 displayName: CustomOcspResponder
62 description: Uses a custom OCSP responder for certificate revocation checks.
63
64 CrlFileRevocationCheck:
65 displayName: CrlFile
66 description: Local file based certificate revocation checker.
67
68propertyTerms:
69
70 # Secrets properties
71 secret:
72 displayName: Secret
73 description: A property which value should be encrypted.
74
75 plainSecret:
76 displayName: Plain Secret
77 description: A property that should be encrypted and it's content represents a plain value.
78 extends: secret
79
80 # Behavior properties
81 host:
82 displayName: Host
83 description: A property that describes a host.
84
85 port:
86 displayName: Port
87 description: A property that describes a port.
88
89 username:
90 displayName: Username
91 description: A property that describes an username.
92
93 password:
94 displayName: Password
95 description: A property that describes a password.
96 extends: plainSecret
97
98 url:
99 displayName: URL
100 description: A property that describes an URL.
101
102 urlPath:
103 displayName: URL Path
104 description: A property that describes a path in an URL consisting of a sequence of path segments separated by a slash (/).
105
106 filePath:
107 displayName: File Path
108 description: A property that describes a path that points to a file system location.
109
110 serviceEndpoint:
111 displayName: Service Endpoint
112 description: A property that describes a service endpoint.
113
114 clientId:
115 displayName: Client ID
116 description: A property that describes a client id.
117 extends: plainSecret
118
119 clientSecret:
120 displayName: Client Secret
121 description: A property that describes a password.
122 extends: plainSecret
123
124 personalAccessTokenName:
125 displayName: Personal Access Token Name
126 description: A property that describes the name to refer to a personal access token.
127
128 personalAccessTokenSecret:
129 displayName: Personal Access Token Secret
130 description: A property that describes the secret value of a personal access token.
131 extends: plainSecret
132
133 apiKey:
134 displayName: API Key
135 description: A property that describes an API Key.
136 extends: plainSecret
137
138 secretToken:
139 displayName: Secret Token
140 description: A property that describes a secret token.
141 extends: plainSecret
142
143 securityToken:
144 displayName: Security Token
145 description: A property that describes a secu token.
146 extends: plainSecret
147
148 sessionId:
149 displayName: Session ID
150 description: A property that describes a session ID.
151
152 connectionId:
153 displayName: Connection ID
154 description: A property that describes a connection ID.
155
156 timeUnit:
157 displayName: Time Unit
158 description: A property that describes a time unit such as seconds, minutes, etc.
159
160 alias:
161 displayName: Alias
162 description: A property that describes an alias.
163
164 # Connection Timeout
165 connectionTimeout:
166 displayName: Connection Timeout
167 description: A property that describes the amount of time that the consumer will attempt to establish a connection before it times out.
168
169 connectionTimeoutUnit:
170 displayName: Connection Timeout Unit
171 description: A property that describes a time unit to be used for the Connection Timeout.
172 extends: timeUnit
173
174 connectionIdleTimeout:
175 displayName: Connection Idle Timeout
176 description: A property that describes the connection idle timeout for the request.
177 extends: connectionTimeout
178
179 connectionIdleTimeoutUnit:
180 displayName: Connection Idle Timeout Unit
181 description: A property that describes the time unit to be used in the connection idle timeout configuration.
182 extends: connectionTimeoutUnit
183
184 # Max Entries
185 maxEntries:
186 displayName: Max Entries
187 description: A property that describes the amount of objects that will live in the pool at a certain moment.
188
189 # TTL
190 objectTTL:
191 displayName: Object TTL
192 description: A property that describes a TTL.
193
194 objectTTLTimeoutUnit:
195 displayName: Object TTL Time Unit
196 description: A property that describes a TTL time unit.
197 extends: timeUnit
198
199 # Proxy Configuration
200 proxyConfiguration:
201 displayName: Proxy Configuration
202 description: A property that describes a proxy configuration.
203
204 nonProxyHosts:
205 displayName: Non proxied hosts
206 description: A list of hosts against which the proxy should not be used.
207
208 ntlmDomain:
209 displayName: NTLM Domain
210 description: The domain to authenticate against the proxy, e.g. ntlmDomain\\userName
211
212 # Reconnection
213 reconnection:
214 displayName: Reconnection
215 description: A property that describes a Reconnection Strategy.
216
217 reconnectionFailsDeployment:
218 displayName: Fails Deployment
219 description: A property that describes if a deployment will fail if the test connectivity does not pass after exhausting the associated reconnection strategy.
220
221 reconnectionReconnectionStrategy:
222 displayName: Reconnection Strategy
223 description: A property that describes the reconnection strategy to use.
224
225 # Reconnect
226 reconnectionFrequency:
227 displayName: Frequency
228 description: A property that describes how often (in ms) to reconnect.
229
230 reconnectionBlocking:
231 displayName: Blocking
232 description: If false, the reconnection strategy will run in a separate, non-blocking thread.
233
234 reconnectionCount:
235 displayName: Count
236 description: A property that describes how many reconnection attempts to make.
237
238 # TlS Context
239 tlsContext:
240 displayName: TLS Context
241 description: A property that describes a TLS Context.
242
243 tlsContextEnabledProtocols:
244 displayName: Enabled Protocols
245 description: A property that describes the protocols in the the global TLS configuration.
246
247 tlsContextEnabledCipherSuites:
248 displayName: Enabled Cipher Suites
249 description: A property that describes the cipher suites in global TLS configuration.
250
251 # SSL
252 sslType:
253 displayName: Type
254 description: A property that describes a SSL type a trust store or a key store uses, such as JKS or PKCS12.
255
256 sslAlgorithm:
257 displayName: Algorithm
258 description: A property that describes the algorithm a trust store or a key store uses, such as SunX509.
259
260 # TrustStore
261 trustStore:
262 displayName: TrustStore
263 description: A property that describes a TrustStore.
264
265 trustStoreInsecure:
266 displayName: Insecure
267 description: A flag that determines whether or not to validate the truststore.
268
269 # KeyStore
270 keyStore:
271 displayName: KeyStore
272 description: A property that describes a KeyStore.
273
274 keyStoreKeyPassword:
275 displayName: Key Password
276 description: A property that describes the key manager password, which is the password for the private key inside the key store.
277 extends: password
278
279 keyStoreAlias:
280 displayName: Alias
281 description: A property that describes the key store alias.
282 extends: alias
283
284 # Revocation Check
285 revocationCheck:
286 displayName: Revocation Check
287 description: A property that describes the revocation configuration.
288
289 # Standard Revocation Check
290 standardRevocationCheckOnlyEndEntities:
291 displayName: Only End Entities
292 description: Only verify the last element of the certificate chain.
293
294 standardRevocationCheckPreferCrls:
295 displayName: Prefer Crls
296 description: Try CRL instead of OCSP first.
297
298 standardRevocationCheckNoFallback:
299 displayName: No Fallback
300 description: Do not use the secondary checking method (the one not selected before).
301
302 standardRevocationCheckSoftFail:
303 displayName: Soft Fail
304 description: Avoid verification failure when the revocation server can not be reached or is busy.
305
306 #Custom Ocsp Responder
307 customOcspResponderRevocationCheckCertAlias:
308 displayName: Cert Alias
309 description: Alias of the signing certificate for the OCSP response (must be in the trust store), if present.
310 extends: alias