Getting Started

Configuring Credentials

First, you need to set up your credentials and config file. For instructions, see SDK and CLI Configuration File.

Next you need to set up the client to use the credentials. The credentials are abstracted through an AuthenticationDetailsProvider interface. Clients can implement this however you choose. We have included a simple POJO/builder class to help with this task (SimpleAuthenticationDetailsProvider).

• You can load a config with or without a profile:

  ConfigFile config 
      = ConfigFileReader.parse("~/.oci/config");
  ConfigFile configWithProfile 
      = ConfigFileReader.parse("~/.oci/config", "DEFAULT");

• The private key supplier can be created with the file path directly, or using the config file:

  Supplier<InputStream> privateKeySupplier 
      = new SimplePrivateKeySupplier("~/.oci/oci_api_key.pem");
  Supplier<InputStream> privateKeySupplierFromConfigEntry 
      = new SimplePrivateKeySupplier(config.get("key_file"));

• To create an auth provider using the builder:

  AuthenticationDetailsProvider provider 
      = SimpleAuthenticationDetailsProvider.builder()
          .tenantId("myTenantId")
          .userId("myUserId")
          .fingerprint("myFingerprint")
          .privateKeySupplier(privateKeySupplier)
          .build();

• To create an auth provider using the builder with a config file:

  AuthenticationDetailsProvider provider 
      = SimpleAuthenticationDetailsProvider.builder()
          .tenantId(config.get("tenancy"))
          .userId(config.get("user"))
          .fingerprint(config.get("fingerprint"))
          .privateKeySupplier(privateKeySupplier)
          .build();

• Finally, if you use standard config file keys and the standard config file location, you can simplify this further by using ConfigFileAuthenticationDetailsProvider:

  AuthenticationDetailsProvider provider 
      = new ConfigFileAuthenticationDetailsProvider("ADMIN_USER");

Configuring Client-side Options

Create a client-side configuration through the ClientConfiguration class. If you do not provide your own configuration, the SDK for Java uses a default configuration. To provide your own configuration, use the following:

ClientConfiguration clientConfig 
    = ClientConfiguration.builder()
        .connectionTimeoutMillis(3000)
        .readTimeoutMillis(60000)
        .build();

After you have both a credential configuration and the optional client configuration, you can start creating service instances.

For a code sample that demonstrates how to set up and use connection and read timouts in your client configuration, see the Client Configuration Timeout example on GitHub.

Configuring Custom Options

In the config file, you can insert custom key-value pairs that you define, and then reference them as necessary. For example, you can specify a frequently used compartment ID in the config file:

[DEFAULT]
user=ocid1.user.oc1..aaaaaaaat5nvwcna5j6aqzjcmdy5eqbb6qt2jvpkanghtgdaqedqw3rynjq
fingerprint=20:3b:97:13:55:1c:5b:0d:d3:37:d8:50:4e:c5:3a:34
key_file=~/.oci/oci_api_key.pem
tenancy=ocid1.tenancy.oc1..<unique_ID>


custom_compartment_id=ocid1.compartment.oc1..<unique_ID>

Then you can retrieve the value:

ConfigFile config 
    = ConfigFileReader.parse("~/.oci/config");

String compartmentId = config.get("custom_compartment_id");