Top Description Fields Constructors Methods
com.oracle.bmc.auth.internal

public Class ResourcePrincipalV2FederationClient

extends AbstractFederationClient
Class Inheritance
Imports
com.oracle.bmc.auth.SessionKeySupplier, com.oracle.bmc.circuitbreaker.CircuitBreakerConfiguration, com.oracle.bmc.http.ClientConfigurator, com.oracle.bmc.http.client.Method, com.oracle.bmc.http.internal.ClientCall, com.oracle.bmc.util.internal.StringUtils, org.slf4j.Logger, java.security.KeyPair, java.security.interfaces.RSAPublicKey

This class gets a security token from the auth service by signing the request with the provided private key.

Field Summary

Modifier and TypeField and Description
private static final Logger
private final KeyPairAuthenticationDetailProvider
provider

The authentication provider to sign the internal requests.

private final String
resourcePrincipalTokenPath

The resource principal token path.

private final String
securityContext

The security context.

Inherited from com.oracle.bmc.auth.internal.AbstractFederationClient:
additionalClientConfiguratorcircuitBreakerclientConfiguratorfederationClientresourcePrincipalTokenClientsessionKeySupplier

Constructor Summary

AccessConstructor and Description
public
ResourcePrincipalV2FederationClient(String
the endpoint that can provide the resource principal token.
resourcePrincipalTokenEndpoint
,
String
the endpoint that can provide the resource principal session token.
federationEndpoint
,
SessionKeySupplier
the session key supplier.
sessionKeySupplier
,
KeyPairAuthenticationDetailProvider
the key pair authentication details provider.
keyPairAuthenticationDetailsProvider
,
ClientConfigurator
the reset client configurator.
clientConfigurator
,
CircuitBreakerConfiguration
the rest client circuit breaker configuration. *
circuitBreakerConfiguration
)

Constructor of ResourcePrincipalsV2FederationClient.

public
ResourcePrincipalV2FederationClient(String
the endpoint that can provide the resource principal token.
resourcePrincipalTokenEndpoint
,
String
the endpoint that can provide the resource principal session token.
federationEndpoint
,
String
the resource principal token path
resourcePrincipalTokenPath
,
String
the security context
securityContext
,
SessionKeySupplier
the session key supplier.
sessionKeySupplier
,
KeyPairAuthenticationDetailProvider
the key pair authentication details provider.
keyPairAuthenticationDetailsProvider
,
ClientConfigurator
the reset client configurator.
clientConfigurator
,
CircuitBreakerConfiguration
the rest client circuit breaker configuration. *
circuitBreakerConfiguration
)

Constructor of ResourcePrincipalsV2FederationClient.

Method Summary

Modifier and TypeMethod and Description
protected SecurityTokenAdapter

Returns:

the security token, which is basically a JWT token string
getSecurityTokenFromServer
()

Implements abstract com.oracle.bmc.auth.internal.AbstractFederationClient.getSecurityTokenFromServer.

Gets a security token from the federation server

Inherited from com.oracle.bmc.auth.internal.AbstractFederationClient:
getSecurityTokengetSecurityTokenAdaptergetStringClaimmakeClientprepareRptCallrefreshAndGetSecurityTokenrefreshAndGetSecurityTokenIfExpiringWithinrefreshAndGetSecurityTokenIfExpiringWithinrefreshAndGetSecurityTokenInnerrequestSessionToken

Field Detail

LOGback to summary
private static final Logger LOG

Hides com.oracle.bmc.auth.internal.AbstractFederationClient.LOG.

providerback to summary
private final KeyPairAuthenticationDetailProvider provider

The authentication provider to sign the internal requests.

resourcePrincipalTokenPathback to summary
private final String resourcePrincipalTokenPath

The resource principal token path.

securityContextback to summary
private final String securityContext

The security context.

Constructor Detail

ResourcePrincipalV2FederationClientback to summary
public ResourcePrincipalV2FederationClient(String resourcePrincipalTokenEndpoint, String federationEndpoint, SessionKeySupplier sessionKeySupplier, KeyPairAuthenticationDetailProvider keyPairAuthenticationDetailsProvider, ClientConfigurator clientConfigurator, CircuitBreakerConfiguration circuitBreakerConfiguration)

Constructor of ResourcePrincipalsV2FederationClient.

Parameters
resourcePrincipalTokenEndpoint:String

the endpoint that can provide the resource principal token.

federationEndpoint:String

the endpoint that can provide the resource principal session token.

sessionKeySupplier:SessionKeySupplier

the session key supplier.

keyPairAuthenticationDetailsProvider:KeyPairAuthenticationDetailProvider

the key pair authentication details provider.

clientConfigurator:ClientConfigurator

the reset client configurator.

circuitBreakerConfiguration:CircuitBreakerConfiguration

the rest client circuit breaker configuration. *

ResourcePrincipalV2FederationClientback to summary
public ResourcePrincipalV2FederationClient(String resourcePrincipalTokenEndpoint, String federationEndpoint, String resourcePrincipalTokenPath, String securityContext, SessionKeySupplier sessionKeySupplier, KeyPairAuthenticationDetailProvider keyPairAuthenticationDetailsProvider, ClientConfigurator clientConfigurator, CircuitBreakerConfiguration circuitBreakerConfiguration)

Constructor of ResourcePrincipalsV2FederationClient.

Parameters
resourcePrincipalTokenEndpoint:String

the endpoint that can provide the resource principal token.

federationEndpoint:String

the endpoint that can provide the resource principal session token.

resourcePrincipalTokenPath:String

the resource principal token path

securityContext:String

the security context

sessionKeySupplier:SessionKeySupplier

the session key supplier.

keyPairAuthenticationDetailsProvider:KeyPairAuthenticationDetailProvider

the key pair authentication details provider.

clientConfigurator:ClientConfigurator

the reset client configurator.

circuitBreakerConfiguration:CircuitBreakerConfiguration

the rest client circuit breaker configuration. *

Method Detail

getSecurityTokenFromServerback to summary
protected SecurityTokenAdapter getSecurityTokenFromServer()

Implements abstract com.oracle.bmc.auth.internal.AbstractFederationClient.getSecurityTokenFromServer.

Gets a security token from the federation server

Returns:SecurityTokenAdapter

the security token, which is basically a JWT token string

Annotations
@Override