Cloudian Adapter

Cloudian HyperStore is an Amazon S3 compatible object storage service that is provided by Cloudian Inc. The Cloudian service on Quantum Fabric connects to the specified S3 bucket on a HyperStore, and also performs supported operations.

You can use the service in scenarios where you want to store the data for your app (such as archives, website data, or data lakes) on a Cloudian HyperStore.

Configure a service for Cloudian

To configure a Cloudian adapter in Integration Service Definition tab, follow these steps:

  1. In the Name field, provide a unique name for your service.
    When you enter the name, the name is updated for the active service under the Services section on the left pane.

    NOTE: If you have an existing service with the same name, you can select a different Version for the service.

  2. From the Service Type list, select Cloudian.
  3. Under Connection Parameters, provide the following details.
    FieldsDescription
    Upload Type

    The type of data that you want to upload to the HyperStore.

    This parameter is optional.

    Access Key

    The access key ID of the Cloudian HyperStore.

    Access SecretThe secret access key of the Cloudian HyperStore.
    Backend URLThe URL of the service endpoint the Cloudian HyperStore.
    RegionThe region code of the service endpoint.
    Bucket PathThe path of the bucket that you want to use on the Cloudian HyperStore.
    Service NamespaceThe namespace of the resource that you want to use on the Cloudian HyperStore.
    Advanced Settings

    Additional settings that are configured for the Cloudian HyperStore.

    This parameter is optional.

  4. Field Description
    Custom code

    Specifies any custom business logic that you want to use for the service and the operations. The custom business logic must be in a JAR file.

    To specify a JAR associated to the service, select one from the Select Existing JAR drop-down menu or click Upload New to add a new JAR file.

    For on-premise instances of Quantum Fabric, make sure that the JAR file that is built on the same JDK version that is used to install Quantum Fabric Integration.
    API Throttling

    API throttling on the Quantum Fabric Console limits the number of request calls within a minute. To use API Throttling, configure the following fields:

    • Total Rate Limit: Limits the number of requests that are processed by the service
    • Rate Limit Per IP: Limits the number of requests that are processed by an IP address

    To override throttling from the Quantum Fabric App Services Console, refer to Override API Throttling Configuration.

    NOTE:
    Options in the Advanced section are optional.

  5. Enter the Description for the service.
  6. Click SAVE to save your service definition.

Create operations for Cloudian

  1. After you configure a service, click SAVE & ADD OPERATION.
    Alternatively, from the left pane, click the add (+) icon, and then click Add New Operation.
  2. Under the Operation List tab. from the drop-down list, select the operations that you want to add.
  3. Click ADD OPERATION. Fabric adds the selected operations to the Operations List page.
  4. Under Configured Operations list, click an operation to view the details of the operation.

  5. The console displays the selected operation in the edit mode. Provide the following details to configure the operation:

    Field Description
    Name The operation name appears in the Name field. You can edit the name based on your preference.
    Operation Security Level

    It specifies how a client must authenticate to invoke this operation.
      • Authenticated App User – It restricts the access to clients who have successfully authenticated using an Identity Service associated with the app.
      • Anonymous App User – It allows the access from trusted clients that have the required App Key and App Secret. Authentication through an Identity Service is not required.
      • Public – It allows any client to invoke this operation without any authentication. This setting does not provide any security to invoke this operation and you should avoid this authentication type if possible.
      • Private - It blocks the access to this operation from any external client. It allows invocation either from an Orchestration/Object Service, or from the custom code in the same run-time environment.
  6. Custom Code Invocation You can add pre and post processing logic to services to modify the request inputs. When you test, the services details of various stages in the service execution are presented to you for better debugging. All options in the Advanced section are optional. For more details, refer to Preprocessor and Postprocessor.
    Additional Configuration Properties Additional Configuration Properties allows you to configure service call time out cache response. For information on different types of configuration properties, refer Properties.
    Front-end API Front-end API allows you map your endpoint (or) backend URL of an operation to a front-end URL. For detailed information, refer Custom Front-end URL.
    Server Events Using Server Events you can configure this service to trigger or process server side events. For detailed information, refer Server Events.

    NOTE: All options in the Advanced section for operations are optional.

  7. Enter the Description for the operation.

NOTE:
The Operations List tab appears only after the service definition is saved.

Configure request input parameters

  1. Under Request Input, on the Body tab, configure the following fields:
    FieldDescription
    Name

    Specifies the name of the input parameter. the name must be unique.

    Test ValueSpecifies the value of the input parameter that is used to test the operation.
    Default ValueSpecifies the default value of the input parameter. The default value is used to test the operation if the test value not set.
    Data Type

    Specifies the data type of the input parameter. Fabric supports the following data types:

    • String is a combination of alpha-numeric and special characters
      Supports all formats including UTF-8 and UTF-16 with no maximum size limit
    • Boolean a value that can be true or false
    • Number an integer or a floating point number
    Record ID

    Specifies the ID of the parent record of the parameter. Applicable for nested payloads.

    Collection ID

    Specifies the ID of the parent collection or parent array of the parameter. Applicable for parameters that are inside an array.

    DescriptionSpecifies the text that is displayed on the console as the description of the parameter.

  2. To validate the provided details, you must test the service operation. You can refer to Test a Service Operation for the steps to test a service.

Configure response output parameters

  1. Under Response Output, on the Body tab, configure the following fields:
    FieldDescription
    Name

    Specifies the name of the output parameter. the name must be unique.

    PathSpecifies the path of the parameter in the back-end response.
    Scope

    Specifies the scope in which the output parameter should be available.

     

    Data Type

    Specifies the data type of the output parameter. Fabric supports the following data types:

    • Collection is an array or an object that contains more parameters
    • Record is a parameter that contains nested parameters
    • String is a combination of alpha-numeric and special characters
      Supports all formats including UTF-8 and UTF-16 with no maximum size limit
    • Boolean a value that can be true or false
    • Number an integer or a floating point number
    Record ID

    Specifies the ID of the parent record of the parameter. Applicable for nested payloads.

    Collection ID

    Specifies the ID of the parent collection or parent array of the parameter. Applicable for parameters that are inside an array.

    DescriptionSpecifies the text that is displayed as the description of the parameter.

  2. To validate the provided details, you must test the service operation. You can refer to Test a Service Operation for the steps to test a service.