IPWorks Cloud 2020 Java Edition

Questions / Feedback?

CloudStorageAccount Type

This type holds non-OAuth storage account credentials.

Remarks

This type is used to hold account credentials for storages services which do not use OAuth for authentication.

Fields

AccessKey
String

A storage service provider access key.

This field specifies the access key to use for authentication. It must be populated when using one of these storage service providers:

  • spAmazonS3 (0)
  • spAzureBlob (6)
  • spWasabi (7)
  • spDigitalOcean (8)
  • spGoogleStorage (9) (only if Authorization and ProjectId are not populated)
  • spAzureFile (11)
  • spIBMStorage (13)
  • spLinode (14)

Account
String

A storage service provider account string.

This field specifies the account string to use for authentication. It must be populated when using one of these storage service providers:

  • spAzureBlob (6)
  • spAzureFile (11)

ApplicationKey
String

A storage service provider application key.

This field specifies the application key to use for authentication. It must be populated when using one of these storage service providers:

  • spBackblazeB2 (12)

ApplicationKeyId
String

A storage service provider application key Id.

This field specifies the application key Id to use for authentication. It must be populated when using one of these storage service providers:

  • spBackblazeB2 (12)

AuthMechanism
int

The HTTP authentication scheme to use (for storage service providers that support multiple).

For storage service providers that support more than one HTTP authentication scheme, this field specifies which should be used. This field is only relevant for the following storage service providers:

  • spHadoopDFS (10)
(For all other storage service providers, the class determines the correct authentication scheme automatically).

Usage

Possible values for this field are:

camNone (0) (default) No authentication is performed.
camSimple (1) Hadoop pseudo/simple authentication is performed.
camBasic (2) Basic authentication is performed.
camNTLM (3) NTLM authentication is performed.
camNegotiate (4) Negotiate authentication is performed.
camOAuth (5) OAuth authentication is performed.

When set to camSimple (1), the value of the User field is automatically sent in every request using the user.name query parameter. (Note: This authentication scheme is only valid for the spHadoopDFS (10) storage service provider.)

When set to camBasic (2), camNTLM (3), or camNegotiate (4), the values held by the User and Password fields will be used to perform Basic, NTLM, or Negotiate authentication.

When set to camOAuth (5), the value of the Authorization property is automatically sent in every request using the Authorization HTTP header.

HadoopURL
String

The URL of the Hadoop WebHDFS server.

This field specifies the URL of the Hadoop WebHDFS server to make requests against. It must be set when ServiceProvider is set to spHadoopDFS (10).

A full WebHDFS URL looks like http[s]://<HOST>:<PORT>/webhdfs/v1. The class will automatically append /webhdfs/v1 when making requests (if necessary).

The class automatically detects whether to secure the connection using SSL/TLS based on whether the value begins with http (not secured) or https (secured).

Password
String

A storage service provider password.

This field specifies the password to use for authentication. It must be populated when using one of these storage service providers:

  • spHadoopDFS (10) (only required for certain AuthMechanism options)

ProjectId
String

A Google Cloud Platform project Id string.

This field specifies the Google Cloud Platform project Id string to use for authentication. It must be set when using OAuth 2.0 authentication (i.e., the Authorization property is populated) with one of these storage service providers:

  • spGoogleStorage (9)

Note that the above providers will fall back to using an AccessKey and SecretKey for authentication if either this field or the Authorization property is empty.

SecretKey
String

A storage service provider access key.

This field specifies the access key to use for authentication. It must be populated when using one of these storage service providers:

  • spAmazonS3 (0)
  • spWasabi (7)
  • spDigitalOcean (8)
  • spGoogleStorage (9) (only if Authorization and ProjectId are not populated)
  • spIBMStorage (13)
  • spLinode (14)

User
String

A storage service provider user name.

This field specifies the user name to use for authentication. It must be populated when using one of these storage service providers:

  • spHadoopDFS (10) (only required for certain AuthMechanism options)

Constructors

public CloudStorageAccount();



Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Cloud 2020 Java Edition - Version 20.0 [Build 8265]