| Modifier and Type | Class and Description |
|---|---|
| private static class | |
| pack-priv static class | |
| public static class | |
| public static class | X509FederationClient.
Class is immutable. |
| Modifier and Type | Field and Description |
|---|---|
| private final List | |
| private final OciCircuitBreaker | |
| private final ClientConfigurator | |
| private static final String | |
| private static final String | |
| private final HttpClient | |
| private final Set | |
| private final X509CertificateSupplier | |
| private static final Logger | |
| private final String | |
| private static final RetryConfiguration | |
| private volatile SecurityTokenAdapter | |
| private final SessionKeySupplier | |
| private String |
| Access | Constructor and Description |
|---|---|
| public | X509FederationClient(String federationEndpoint, String tenancyId, X509CertificateSupplier leafCertificateSupplier, SessionKeySupplier sessionKeySupplier, Set<X509CertificateSupplier> intermediateCertificateSuppliers, ClientConfigurator clientConfigurator, List<ClientConfigurator> additionalClientConfigurators, CircuitBreakerConfiguration circuitBreakerConfig)
Same as |
| public | X509FederationClient(String
the auth service endpoint. federationEndpoint, String the tenancy id, to construct the key id tenancyId, X509CertificateSupplier the leaf certificate, used to identify the caller leafCertificateSupplier, SessionKeySupplier the temporary public key, whose corresponding private key will be
used to sign actual API calls sessionKeySupplier, Set<X509CertificateSupplier> intermediate certificates, if there are any (else
null) intermediateCertificateSuppliers, ClientConfigurator client configurator used to configure the federation rest client,
if any (else null) clientConfigurator, List<ClientConfigurator> Additional client configurators to be run after the
primary configurator. additionalClientConfigurators, CircuitBreakerConfiguration circuitBreakerConfig, String The purpose that will be configured for each request. purpose)The constructor. |
| Modifier and Type | Method and Description |
|---|---|
| public X509CertificateSupplier | |
| public String | Returns: the security tokenImplements com. Gets a security token. |
| private SecurityTokenAdapter | Returns: the security token, which is basically a JWT token stringGets a security token from the federation server |
| public String | Returns: the value of the claimthe name of the claim key)Implements com. Return a claim embedded in the security token |
| public String | |
| private static String | |
| pack-priv X509FederationClient. | |
| public String | refreshAndGetSecurityToken()
Implements com. Gets a security token from the federation endpoint. |
| public String | refreshAndGetSecurityTokenIfExpiringWithin(Duration
the duration to check time)Implements com. Gets a security token from the federation endpoint if the security token expires within the provided duration. |
| public String | refreshAndGetSecurityTokenIfExpiringWithin(Duration
the duration to check time, boolean boolean value to enable/disable refresh of keys refreshKeys)Implements com. Gets a security token from the federation endpoint if the security token expires within the provided duration and allows to enable/disable refresh of keys. |
| private String | refreshAndGetSecurityTokenInner(final boolean doFinalTokenValidityCheck, Optional<Duration> time, boolean refreshKeys)
|
| additionalClientConfigurators | back to summary |
|---|---|
| private final List<ClientConfigurator> additionalClientConfigurators | |
| circuitBreaker | back to summary |
|---|---|
| private final OciCircuitBreaker circuitBreaker | |
| clientConfigurator | back to summary |
|---|---|
| private final ClientConfigurator clientConfigurator | |
| DEFAULT_FINGERPRINT | back to summary |
|---|---|
| private static final String DEFAULT_FINGERPRINT | |
| DEFAULT_PURPOSE | back to summary |
|---|---|
| private static final String DEFAULT_PURPOSE | |
| httpClient | back to summary |
|---|---|
| private final HttpClient httpClient | |
| intermediateCertificateSuppliers | back to summary |
|---|---|
| private final Set<X509CertificateSupplier> intermediateCertificateSuppliers | |
| leafCertificateSupplier | back to summary |
|---|---|
| private final X509CertificateSupplier leafCertificateSupplier | |
| LOG | back to summary |
|---|---|
| private static final Logger LOG | |
| purpose | back to summary |
|---|---|
| private final String purpose | |
| RETRY_CONFIGURATION | back to summary |
|---|---|
| private static final RetryConfiguration RETRY_CONFIGURATION | |
| securityTokenAdapter | back to summary |
|---|---|
| private volatile SecurityTokenAdapter securityTokenAdapter | |
| sessionKeySupplier | back to summary |
|---|---|
| private final SessionKeySupplier sessionKeySupplier | |
| tenancyId | back to summary |
|---|---|
| private String tenancyId | |
| X509FederationClient | back to summary |
|---|---|
| public X509FederationClient(String federationEndpoint, String tenancyId, X509CertificateSupplier leafCertificateSupplier, SessionKeySupplier sessionKeySupplier, Set<X509CertificateSupplier> intermediateCertificateSuppliers, ClientConfigurator clientConfigurator, List<ClientConfigurator> additionalClientConfigurators, CircuitBreakerConfiguration circuitBreakerConfig) Same as | |
| X509FederationClient | back to summary |
|---|---|
| public X509FederationClient(String federationEndpoint, String tenancyId, X509CertificateSupplier leafCertificateSupplier, SessionKeySupplier sessionKeySupplier, Set<X509CertificateSupplier> intermediateCertificateSuppliers, ClientConfigurator clientConfigurator, List<ClientConfigurator> additionalClientConfigurators, CircuitBreakerConfiguration circuitBreakerConfig, String purpose) The constructor.
| |
| getLeafCertificateSupplier | back to summary |
|---|---|
| public X509CertificateSupplier getLeafCertificateSupplier() | |
| getSecurityToken | back to summary |
|---|---|
| public String getSecurityToken() Implements com. Gets a security token. If there is already a valid token cached, it will be returned. Else this will make a call to the auth service to get a new token, using the provided suppliers. This method is thread-safe.
| |
| getSecurityTokenFromServer | back to summary |
|---|---|
| private SecurityTokenAdapter getSecurityTokenFromServer() Gets a security token from the federation server
| |
| getStringClaim | back to summary |
|---|---|
| public String getStringClaim(String key) Implements com. Return a claim embedded in the security token | |
| getTenancyId | back to summary |
|---|---|
| public String getTenancyId() | |
| keyIdForX509Request | back to summary |
|---|---|
| private static String keyIdForX509Request(String tenancyId, X509Certificate certificate) | |
| makeCall | back to summary |
|---|---|
pack-priv X509FederationClient.
| |
| refreshAndGetSecurityToken | back to summary |
|---|---|
| public String refreshAndGetSecurityToken() Implements com. Doc from com. Gets a security token from the federation endpoint. This will always retreive a new token from the federation endpoint and does not use a cached token. | |
| refreshAndGetSecurityTokenIfExpiringWithin | back to summary |
|---|---|
| public String refreshAndGetSecurityTokenIfExpiringWithin(Duration time) Implements com. Doc from com. Gets a security token from the federation endpoint if the security token expires within the provided duration. This will always retrieve a new token from the federation endpoint and does not use a cached token. | |
| refreshAndGetSecurityTokenIfExpiringWithin | back to summary |
|---|---|
| public String refreshAndGetSecurityTokenIfExpiringWithin(Duration time, boolean refreshKeys) Implements com. Doc from com. Gets a security token from the federation endpoint if the security token expires within the provided duration and allows to enable/disable refresh of keys. This will always retrieve a new token from the federation endpoint and does not use a cached token. | |
| refreshAndGetSecurityTokenInner | back to summary |
|---|---|
| private String refreshAndGetSecurityTokenInner(final boolean doFinalTokenValidityCheck, Optional<Duration> time, boolean refreshKeys) | |
| Modifier and Type | Field and Description |
|---|---|
| private final X509FederationClient. |
| Access | Constructor and Description |
|---|---|
| pack-priv |
| Modifier and Type | Method and Description |
|---|---|
| public X509FederationClient. | getBody$()
Overrides com. Alternative accessor for the body parameter, if this request supports a body. |
| request | back to summary |
|---|---|
| private final X509FederationClient. | |
| FederationRequestWrapper | back to summary |
|---|---|
| pack-priv FederationRequestWrapper(X509FederationClient. | |
| getBody$ | back to summary |
|---|---|
| public X509FederationClient. Overrides com. Doc from com. Alternative accessor for the body parameter, if this request supports a body. If this request does not support a body, an
| |
| Modifier and Type | Class and Description |
|---|---|
| pack-priv static class |
| Modifier and Type | Field and Description |
|---|---|
| pack-priv final X509FederationClient. |
| Access | Constructor and Description |
|---|---|
| pack-priv |
| token | back to summary |
|---|---|
| pack-priv final X509FederationClient. | |
| FederationResponseWrapper | back to summary |
|---|---|
| pack-priv FederationResponseWrapper(int status, X509FederationClient. | |
| Modifier and Type | Field and Description |
|---|---|
| private Map | |
| private int | |
| pack-priv X509FederationClient. |
| Access | Constructor and Description |
|---|---|
| pack-priv | |
| private |
| Modifier and Type | Method and Description |
|---|---|
| public BmcResponse. | __httpStatusCode__(int __httpStatusCode__)
Implements com.
|
| public X509FederationClient. | |
| public BmcResponse. | copy(X509FederationClient.
other request from which to copy values oImplements com. Copy method to populate the builder with values from the given instance. |
| public BmcResponse. |
| headers | back to summary |
|---|---|
| private Map<String, List<String>> headers | |
| status | back to summary |
|---|---|
| private int status | |
| token | back to summary |
|---|---|
| pack-priv X509FederationClient. | |
| Builder | back to summary |
|---|---|
| pack-priv Builder() | |
| Builder | back to summary |
|---|---|
| private Builder(X509FederationClient. | |
| __httpStatusCode__ | back to summary |
|---|---|
| public BmcResponse. Implements com.
| |
| build | back to summary |
|---|---|
| public X509FederationClient. Implements com. Doc from com. Build the response.
| |
| copy | back to summary |
|---|---|
| public BmcResponse. Implements com. Doc from com. Copy method to populate the builder with values from the given instance.
| |
| headers | back to summary |
|---|---|
| public BmcResponse. Implements com.
| |
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| public String |
| token | back to summary |
|---|---|
| private String token | |
| SecurityToken | back to summary |
|---|---|
| public SecurityToken(String token) | |
| getToken | back to summary |
|---|---|
| public String getToken() | |
| Modifier and Type | Field and Description |
|---|---|
| private final String | |
| private final String | |
| private final Set | |
| private final String | |
| private final String |
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| protected boolean | |
| public boolean | equals(final Object
the reference object with which to compare. o)Overrides java. Indicates whether some other object is "equal to" this one. |
| public String | |
| public String | |
| public Set | |
| public String | |
| public String | |
| public int |
| certificate | back to summary |
|---|---|
| private final String certificate | |
| fingerprintAlgorithm | back to summary |
|---|---|
| private final String fingerprintAlgorithm | |
| intermediateCertificates | back to summary |
|---|---|
| private final Set<String> intermediateCertificates | |
| publicKey | back to summary |
|---|---|
| private final String publicKey | |
| purpose | back to summary |
|---|---|
| private final String purpose | |
| X509FederationRequest | back to summary |
|---|---|
| public X509FederationRequest(String publicKey, String certificate, Set<String> intermediateCertificates, String purpose, String fingerprintAlgorithm) | |
| canEqual | back to summary |
|---|---|
| protected boolean canEqual(final Object other) | |
| equals | back to summary |
|---|---|
| public boolean equals(final Object o) Overrides java. Doc from java. Indicates whether some other object is "equal to" this one.
The
An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.
| |
| getCertificate | back to summary |
|---|---|
| public String getCertificate() | |
| getFingerprintAlgorithm | back to summary |
|---|---|
| public String getFingerprintAlgorithm() | |
| getIntermediateCertificates | back to summary |
|---|---|
| public Set | |
| getPublicKey | back to summary |
|---|---|
| public String getPublicKey() | |
| getPurpose | back to summary |
|---|---|
| public String getPurpose() | |
| hashCode | back to summary |
|---|---|
| public int hashCode() Overrides java. Doc from java. Returns a hash code value for this object. This method is
supported for the benefit of hash tables such as those provided by
The general contract of
| |