com.adobe.platform.operation.auth

Class ServiceAccountCredentials.Builder

java.lang.Object

com.adobe.platform.operation.auth.ServiceAccountCredentials.Builder

Enclosing class:

ServiceAccountCredentials

public static class ServiceAccountCredentials.Builder
extends Object

Builds a ServiceAccountCredentials instance.

Constructor Summary

Constructors

Constructor and Description
Builder() Constructs a Builder instance.

Method Summary

Modifier and Type	Method and Description
ServiceAccountCredentials	build() Returns a new ServiceAccountCredentials instance built from the current state of this builder.
ServiceAccountCredentials.Builder	fromFile(String credentialsFilePath) Sets Service Account Credentials using the JSON credentials file path.
ServiceAccountCredentials.Builder	withAccountId(String accountId) Set Account Id (format: id@techacct.adobe.com)
ServiceAccountCredentials.Builder	withClientId(String clientId) Set Client ID (API Key)
ServiceAccountCredentials.Builder	withClientSecret(String clientSecret) Set Client Secret
ServiceAccountCredentials.Builder	withOrganizationId(String organizationId) Set Organization Id (format: org_ident@AdobeOrg) that has been configured for access to DC Services
ServiceAccountCredentials.Builder	withPrivateKey(String privateKey) Set private key

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Constructs a Builder instance.

Method Detail

withClientId

public ServiceAccountCredentials.Builder withClientId(String clientId)

Set Client ID (API Key)

Parameters:

clientId - Service Account ClientID

Returns:

this Builder instance to add any additional parameters

withClientSecret

public ServiceAccountCredentials.Builder withClientSecret(String clientSecret)

Set Client Secret

Parameters:

clientSecret - Service Account Client Secret

Returns:

this Builder instance to add any additional parameters

withPrivateKey

public ServiceAccountCredentials.Builder withPrivateKey(String privateKey)

Set private key

Parameters:

privateKey - content of the private key file in PEM format

Returns:

this Builder instance to add any additional parameters

withOrganizationId

public ServiceAccountCredentials.Builder withOrganizationId(String organizationId)

Set Organization Id (format: org_ident@AdobeOrg) that has been configured for access to DC Services

Parameters:

organizationId - Service Account organizationID

Returns:

this Builder instance to add any additional parameters

withAccountId

public ServiceAccountCredentials.Builder withAccountId(String accountId)

Set Account Id (format: id@techacct.adobe.com)

Parameters:

accountId - Service Account ID

Returns:

this Builder instance to add any additional parameters

fromFile

public ServiceAccountCredentials.Builder fromFile(String credentialsFilePath)
                                           throws IOException

Sets Service Account Credentials using the JSON credentials file path. All the keys in the JSON structure are optional.

JSON structure:

{
   "client_credentials": {
     "client_id": "CLIENT_ID",
     "client_secret": "CLIENT_SECRET"
   },
   "service_account_credentials": {
     "organization_id": "org_ident@AdobeOrg",
     "account_id": "id@techacct.adobe.com",
     "private_key_file": "private.key"
   }
 }

private_key_file is the path of private key file. It will be looked up in the classpath and the directory of JSON credentials file.

Parameters:

credentialsFilePath - path to json credentials file

Returns:

this Builder instance to add any additional parameters

Throws:

IOException - throws IOException due to parsing error or invalid file path

build

public ServiceAccountCredentials build()

Returns a new ServiceAccountCredentials instance built from the current state of this builder.

Returns:

a new ServiceAccountCredentials instance

Throws:

IllegalArgumentException - if any of clientId, clientSecret, privateKey, accountId and organizationId are not provided.