com.ibm.cos.v2.auth.credentials

Class CredentialUtils

java.lang.Object

com.ibm.cos.v2.auth.credentials.CredentialUtils

public final class CredentialUtils
extends Object

Method Summary

Modifier and Type	Method and Description
static boolean	isAnonymous(AwsCredentials credentials) Determine whether the provided credentials are anonymous credentials, indicating that the customer is not attempting to authenticate themselves.
static boolean	isAnonymous(AwsCredentialsIdentity credentials) Determine whether the provided credentials are anonymous credentials, indicating that the customer is not attempting to authenticate themselves.
static AwsCredentials	toCredentials(AwsCredentialsIdentity awsCredentialsIdentity) Converts an AwsCredentialsIdentity to AwsCredentials.
static AwsCredentialsProvider	toCredentialsProvider(IdentityProvider<? extends AwsCredentialsIdentity> identityProvider) Converts an extends AwsCredentialsIdentity> to AwsCredentialsProvider based on toCredentials(AwsCredentialsIdentity).
static IBMOAuthCredentials	toIAMCredentials(IBMOAuthIdentity iamCredentialsIdentity) Converts an IBMOAuthIdentity to IBM credentials

Methods inherited from class java.lang.Object

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

Method Detail

isAnonymous

public static boolean isAnonymous(AwsCredentials credentials)

Determine whether the provided credentials are anonymous credentials, indicating that the customer is not attempting to authenticate themselves.

isAnonymous

public static boolean isAnonymous(AwsCredentialsIdentity credentials)

Determine whether the provided credentials are anonymous credentials, indicating that the customer is not attempting to authenticate themselves.

toCredentials

public static AwsCredentials toCredentials(AwsCredentialsIdentity awsCredentialsIdentity)

Converts an AwsCredentialsIdentity to AwsCredentials.

Usage of the new AwsCredentialsIdentity type is preferred over AwsCredentials. But some places may need to still convert to the older AwsCredentials type to work with existing code.

The conversion is only aware of AwsCredentialsIdentity and AwsSessionCredentialsIdentity types. If the input is another sub-type that has other properties, they are not carried over. i.e.,

• AwsSessionCredentialsIdentity -> AwsSessionCredentials
• AwsCredentialsIdentity -> AwsBasicCredentials

Parameters:

awsCredentialsIdentity - The AwsCredentialsIdentity to convert

Returns:

The corresponding AwsCredentials

toIAMCredentials

public static IBMOAuthCredentials toIAMCredentials(IBMOAuthIdentity iamCredentialsIdentity)

Converts an IBMOAuthIdentity to IBM credentials

Usage of the new IBMOAuthIdentity type is preferred over IBM credentials. But some places may need to still convert to the older IBM credentials type to work with existing code.

Parameters:

iamCredentialsIdentity - The AwsCredentialsIdentity to convert

Returns:

The corresponding AwsCredentials

toCredentialsProvider

public static AwsCredentialsProvider toCredentialsProvider(IdentityProvider<? extends AwsCredentialsIdentity> identityProvider)

Converts an extends AwsCredentialsIdentity> to AwsCredentialsProvider based on toCredentials(AwsCredentialsIdentity).

Usage of the new IdentityProvider type is preferred over AwsCredentialsProvider. But some places may need to still convert to the older AwsCredentialsProvider type to work with existing code.

Parameters:

identityProvider - The extends AwsCredentialsIdentity> to convert

Returns:

The corresponding AwsCredentialsProvider