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