com.aliyun.oss.common.auth

Class ProfileCredentialsProvider

java.lang.Object

com.aliyun.oss.common.auth.ProfileCredentialsProvider

All Implemented Interfaces:

CredentialsProvider

public class ProfileCredentialsProvider
extends Object
implements CredentialsProvider

Credentials provider based on OSS configuration profiles. This provider vends Credentials from the profile configuration file for the default profile, or for a specific, named profile. The OSS credentials file locates at ~/.oss/credentials on Linux, macOS, or Unix, or at C:\Users\USERNAME \.oss\credentials on Windows. This file can contain multiple named profiles in addition to a default profile.

Constructor Summary

Constructors

Constructor and Description
ProfileCredentialsProvider() Creates a new profile credentials provider that returns the OSS security credentials configured for the default profile.
ProfileCredentialsProvider(ProfileConfigFile profilesConfigFile, String profileName) Creates a new profile credentials provider that returns the OSS security credentials for the specified profiles configuration file and profile name.
ProfileCredentialsProvider(String profileName) Creates a new profile credentials provider that returns the OSS security credentials configured for the named profile.
ProfileCredentialsProvider(String profilesConfigFilePath, String profileName) Creates a new profile credentials provider that returns the OSS security credentials for the specified profiles configuration file and profile name.

Method Summary

Modifier and Type	Method and Description
Credentials	getCredentials()
long	getRefreshForceIntervalMillis() Gets the forced refresh interval in milliseconds.
long	getRefreshIntervalMillis() Gets the refresh interval in milliseconds.
void	refresh()
void	setCredentials(Credentials creds)
void	setRefreshForceIntervalMillis(long refreshForceIntervalMillis) Sets the forced refresh interval in milliseconds.
void	setRefreshIntervalNanos(long refreshIntervalMillis) Sets the refresh interval in milliseconds.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProfileCredentialsProvider

public ProfileCredentialsProvider()

Creates a new profile credentials provider that returns the OSS security credentials configured for the default profile. Loading the credential file is deferred until the getCredentials() method is called.

ProfileCredentialsProvider

public ProfileCredentialsProvider(String profileName)

Creates a new profile credentials provider that returns the OSS security credentials configured for the named profile. Loading the credential file is deferred until the getCredentials() method is called.

Parameters:

profileName - The name of a local configuration profile.

ProfileCredentialsProvider

public ProfileCredentialsProvider(String profilesConfigFilePath,
                                  String profileName)

Creates a new profile credentials provider that returns the OSS security credentials for the specified profiles configuration file and profile name.

Parameters:

profilesConfigFilePath - The file path where the profile configuration file is located.

profileName - The name of a configuration profile in the specified configuration file.

ProfileCredentialsProvider

public ProfileCredentialsProvider(ProfileConfigFile profilesConfigFile,
                                  String profileName)

Creates a new profile credentials provider that returns the OSS security credentials for the specified profiles configuration file and profile name.

Parameters:

profilesConfigFile - The profile configuration file containing the profiles used by this credentials provider or null to defer load to first use.

profileName - The name of a configuration profile in the specified configuration file.

Method Detail

setCredentials

public void setCredentials(Credentials creds)

Specified by:

setCredentials in interface CredentialsProvider

getCredentials

public Credentials getCredentials()

Specified by:

getCredentials in interface CredentialsProvider

refresh

public void refresh()

getRefreshIntervalMillis

public long getRefreshIntervalMillis()

Gets the refresh interval in milliseconds.

Returns:

milliseconds

setRefreshIntervalNanos

public void setRefreshIntervalNanos(long refreshIntervalMillis)

Sets the refresh interval in milliseconds.

Parameters:

refreshIntervalMillis - milliseconds.

getRefreshForceIntervalMillis

public long getRefreshForceIntervalMillis()

Gets the forced refresh interval in milliseconds.

Returns:

milliseconds.

setRefreshForceIntervalMillis

public void setRefreshForceIntervalMillis(long refreshForceIntervalMillis)

Sets the forced refresh interval in milliseconds.

Parameters:

refreshForceIntervalMillis - milliseconds.