com.ibm.cloud.objectstorage.auth.profile.internal

Class BasicProfile

java.lang.Object

com.ibm.cloud.objectstorage.auth.profile.internal.BasicProfile

@Immutable
public class BasicProfile
extends Object

Represents a CLI style config profile with a name and simple properties. Provides convenient access to the properties the Java SDK deals with and also raw access to all properties.

Constructor Summary

Constructors

Constructor and Description
BasicProfile(String profileName, Map<String,String> properties)

Method Summary

Modifier and Type	Method and Description
String	getAwsAccessIdKey()
String	getAwsSecretAccessKey()
String	getAwsSessionToken()
String	getCredentialProcess()
String	getEndpointDiscovery()
String	getIBMApiKey()
String	getIBMServiceInstanceId()
String	getProfileName()
Map<String,String>	getProperties() Returns a map of profile properties included in this Profile instance.
String	getPropertyValue(String propertyName) Returns the value of a specific property that is included in this Profile instance.
String	getRegion()
String	getRoleArn()
String	getRoleExternalId()
String	getRoleSessionName()
String	getRoleSourceProfile()
String	getWebIdentityTokenFilePath()
boolean	isProcessBasedProfile()
boolean	isRoleBasedProfile()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BasicProfile

public BasicProfile(String profileName,
                    Map<String,String> properties)

Method Detail

getProfileName

public String getProfileName()

Returns:

The name of this profile.

getProperties

public Map<String,String> getProperties()

Returns a map of profile properties included in this Profile instance. The returned properties corresponds to how this profile is described in the credential profiles file, i.e., profiles with basic credentials consist of two properties {"aws_access_key_id", "aws_secret_access_key"} and profiles with session credentials have three properties, with an additional "aws_session_token" property.

getPropertyValue

public String getPropertyValue(String propertyName)

Returns the value of a specific property that is included in this Profile instance.

See Also:

BasicProfile.getProperties()

getAwsAccessIdKey

public String getAwsAccessIdKey()

getAwsSecretAccessKey

public String getAwsSecretAccessKey()

getAwsSessionToken

public String getAwsSessionToken()

getRoleArn

public String getRoleArn()

getRoleSourceProfile

public String getRoleSourceProfile()

getRoleSessionName

public String getRoleSessionName()

getRoleExternalId

public String getRoleExternalId()

getRegion

public String getRegion()

getEndpointDiscovery

public String getEndpointDiscovery()

getCredentialProcess

public String getCredentialProcess()

getWebIdentityTokenFilePath

public String getWebIdentityTokenFilePath()

isRoleBasedProfile

public boolean isRoleBasedProfile()

isProcessBasedProfile

public boolean isProcessBasedProfile()

getIBMApiKey

public String getIBMApiKey()

getIBMServiceInstanceId

public String getIBMServiceInstanceId()