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

public Interface FederationClient

Known Direct Implementers
com.oracle.bmc.auth.internal.FileBasedResourcePrincipalFederationClient, com.oracle.bmc.auth.internal.FixedContentResourcePrincipalFederationClient, com.oracle.bmc.auth.internal.X509FederationClient, com.oracle.bmc.auth.internal.AbstractFederationClient
Defines a basic interface for a federation endpoint that provides a security token for authentication.

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

A security token that can be used to authenticate requests.
getSecurityToken()

Gets a security token from the federation endpoint.

public String
getStringClaim(String key)

Get a claim embedded in the security token.

public String

Returns:

A security token that can be used to authenticate requests.
refreshAndGetSecurityToken()

Gets a security token from the federation endpoint.

Method Detail

getSecurityTokenback to summary
public String getSecurityToken()

Gets a security token from the federation endpoint. May use a cached token if it judged to still be valid.

Returns:String

A security token that can be used to authenticate requests.

getStringClaimback to summary
public String getStringClaim(String key)

Get a claim embedded in the security token. May use the cached token if it is judged to still be valid.

refreshAndGetSecurityTokenback to summary
public String refreshAndGetSecurityToken()

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.

Returns:String

A security token that can be used to authenticate requests.