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

public Class SimpleAuthenticationDetailsProvider

extends CustomerAuthenticationDetailsProvider
implements AuthenticationDetailsProvider, RegionProvider
Class Inheritance
All Implemented Interfaces
com.oracle.bmc.auth.RegionProvider, com.oracle.bmc.auth.AuthenticationDetailsProvider, com.oracle.bmc.auth.BasicAuthenticationDetailsProvider, com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider
Imports
com.oracle.bmc.Region, java.io.InputStream, java.util.function.Supplier
Basic implementation of AuthenticationDetailsProvider that just returns configured values.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
SimpleAuthenticationDetailsProvider.SimpleAuthenticationDetailsProviderBuilder

Field Summary

Modifier and TypeField and Description
private final String
fingerprint

private final char[]
passphraseCharacters

private final Supplier<InputStream>
privateKeySupplier

Supplier of the input stream with the private key.

private final Region
region

private final String
tenantId

private final String
userId

Constructor Summary

AccessConstructor and Description
pack-priv
SimpleAuthenticationDetailsProvider(String tenantId, String userId, String fingerprint, char[] passphraseCharacters, Supplier<InputStream> privateKeySupplier, Region region)

Method Summary

Modifier and TypeMethod and Description
public static SimpleAuthenticationDetailsProvider.SimpleAuthenticationDetailsProviderBuilder
builder()

public String
getFingerprint()

Implements com.oracle.bmc.auth.AuthenticationDetailsProvider.getFingerprint.

Returns the fingerprint of the key being used.

public String
getPassPhrase()

Implements com.oracle.bmc.auth.BasicAuthenticationDetailsProvider.getPassPhrase.

Deprecated

Returns the optional pass phrase for the (encrypted) private key.

public char[]
getPassphraseCharacters()

Implements com.oracle.bmc.auth.BasicAuthenticationDetailsProvider.getPassphraseCharacters.

Returns the optional pass phrase for the (encrypted) private key, as a character array.

public InputStream

Returns:

input stream with private key
getPrivateKey()

Implements com.oracle.bmc.auth.BasicAuthenticationDetailsProvider.getPrivateKey.

Get the input stream with the private key.

public Region
getRegion()

Implements com.oracle.bmc.auth.RegionProvider.getRegion.

Returns the region.

public String
getTenantId()

Implements com.oracle.bmc.auth.AuthenticationDetailsProvider.getTenantId.

Returns the tenant OCID.

public String
getUserId()

Implements com.oracle.bmc.auth.AuthenticationDetailsProvider.getUserId.

Returns the user OCID.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from com.oracle.bmc.auth.CustomerAuthenticationDetailsProvider:
getKeyId

Field Detail

fingerprintback to summary
private final String fingerprint
passphraseCharactersback to summary
private final char[] passphraseCharacters
privateKeySupplierback to summary
private final Supplier<InputStream> privateKeySupplier

Supplier of the input stream with the private key. Note that this stream may be read multiple times.

regionback to summary
private final Region region
tenantIdback to summary
private final String tenantId
userIdback to summary
private final String userId

Constructor Detail

SimpleAuthenticationDetailsProviderback to summary
pack-priv SimpleAuthenticationDetailsProvider(String tenantId, String userId, String fingerprint, char[] passphraseCharacters, Supplier<InputStream> privateKeySupplier, Region region)
Annotations
@java.beans.ConstructorProperties

Method Detail

builderback to summary
public static SimpleAuthenticationDetailsProvider.SimpleAuthenticationDetailsProviderBuilder builder()
getFingerprintback to summary
public String getFingerprint()

Implements com.oracle.bmc.auth.AuthenticationDetailsProvider.getFingerprint.

Doc from com.oracle.bmc.auth.AuthenticationDetailsProvider.getFingerprint.

Returns the fingerprint of the key being used.

Returns:String

The fingerprint.

Annotations
@Override
getPassPhraseback to summary
public String getPassPhrase()

Implements com.oracle.bmc.auth.BasicAuthenticationDetailsProvider.getPassPhrase.

Doc from com.oracle.bmc.auth.BasicAuthenticationDetailsProvider.getPassPhrase.

Deprecated

Returns the optional pass phrase for the (encrypted) private key.

Returns:String

The pass phrase, or null if not applicable

Annotations
@Deprecated
@Override
getPassphraseCharactersback to summary
public char[] getPassphraseCharacters()

Implements com.oracle.bmc.auth.BasicAuthenticationDetailsProvider.getPassphraseCharacters.

Doc from com.oracle.bmc.auth.BasicAuthenticationDetailsProvider.getPassphraseCharacters.

Returns the optional pass phrase for the (encrypted) private key, as a character array.

Returns:char[]

The pass phrase as character array, or null if not applicable

Annotations
@Override
getPrivateKeyback to summary
public InputStream getPrivateKey()

Implements com.oracle.bmc.auth.BasicAuthenticationDetailsProvider.getPrivateKey.

Get the input stream with the private key. Note that this stream may be read multiple times.

Returns:InputStream

input stream with private key

Annotations
@Override
getRegionback to summary
public Region getRegion()

Implements com.oracle.bmc.auth.RegionProvider.getRegion.

Doc from com.oracle.bmc.auth.RegionProvider.getRegion.

Returns the region.

Returns:Region

Region object.

Annotations
@Override
getTenantIdback to summary
public String getTenantId()

Implements com.oracle.bmc.auth.AuthenticationDetailsProvider.getTenantId.

Doc from com.oracle.bmc.auth.AuthenticationDetailsProvider.getTenantId.

Returns the tenant OCID.

Returns:String

The tenant OCID.

Annotations
@Override
getUserIdback to summary
public String getUserId()

Implements com.oracle.bmc.auth.AuthenticationDetailsProvider.getUserId.

Doc from com.oracle.bmc.auth.AuthenticationDetailsProvider.getUserId.

Returns the user OCID.

Returns:String

The user OCID.

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override
com.oracle.bmc.auth back to summary

public Class SimpleAuthenticationDetailsProvider.SimpleAuthenticationDetailsProviderBuilder

extends Object
Class Inheritance
  • java.lang.Object
  • com.oracle.bmc.auth.SimpleAuthenticationDetailsProvider.SimpleAuthenticationDetailsProviderBuilder

Field Summary

Modifier and TypeField and Description
private String
fingerprint

private char[]
passphraseCharacters

private Supplier<InputStream>
privateKeySupplier

private Region
region

private String
tenantId

private String
userId

Constructor Summary

AccessConstructor and Description
pack-priv
SimpleAuthenticationDetailsProviderBuilder()

Method Summary

Modifier and TypeMethod and Description
public SimpleAuthenticationDetailsProvider
build()

public SimpleAuthenticationDetailsProvider.SimpleAuthenticationDetailsProviderBuilder
fingerprint(String fingerprint)

public SimpleAuthenticationDetailsProvider.SimpleAuthenticationDetailsProviderBuilder
passPhrase(String passPhrase)

public SimpleAuthenticationDetailsProvider.SimpleAuthenticationDetailsProviderBuilder
passphraseCharacters(char[] passphraseCharacters)

public SimpleAuthenticationDetailsProvider.SimpleAuthenticationDetailsProviderBuilder
privateKeySupplier(Supplier<InputStream> privateKeySupplier)

public SimpleAuthenticationDetailsProvider.SimpleAuthenticationDetailsProviderBuilder
region(Region region)

public SimpleAuthenticationDetailsProvider.SimpleAuthenticationDetailsProviderBuilder
tenantId(String tenantId)

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

public SimpleAuthenticationDetailsProvider.SimpleAuthenticationDetailsProviderBuilder
userId(String userId)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

fingerprintback to summary
private String fingerprint
passphraseCharactersback to summary
private char[] passphraseCharacters
privateKeySupplierback to summary
private Supplier<InputStream> privateKeySupplier
regionback to summary
private Region region
tenantIdback to summary
private String tenantId
userIdback to summary
private String userId

Constructor Detail

SimpleAuthenticationDetailsProviderBuilderback to summary
pack-priv SimpleAuthenticationDetailsProviderBuilder()

Method Detail

buildback to summary
public SimpleAuthenticationDetailsProvider build()
fingerprintback to summary
public SimpleAuthenticationDetailsProvider.SimpleAuthenticationDetailsProviderBuilder fingerprint(String fingerprint)
passPhraseback to summary
public SimpleAuthenticationDetailsProvider.SimpleAuthenticationDetailsProviderBuilder passPhrase(String passPhrase)
passphraseCharactersback to summary
public SimpleAuthenticationDetailsProvider.SimpleAuthenticationDetailsProviderBuilder passphraseCharacters(char[] passphraseCharacters)
privateKeySupplierback to summary
public SimpleAuthenticationDetailsProvider.SimpleAuthenticationDetailsProviderBuilder privateKeySupplier(Supplier<InputStream> privateKeySupplier)
regionback to summary
public SimpleAuthenticationDetailsProvider.SimpleAuthenticationDetailsProviderBuilder region(Region region)
tenantIdback to summary
public SimpleAuthenticationDetailsProvider.SimpleAuthenticationDetailsProviderBuilder tenantId(String tenantId)
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override
userIdback to summary
public SimpleAuthenticationDetailsProvider.SimpleAuthenticationDetailsProviderBuilder userId(String userId)