Gremlin Docs
Dashboard
Application Layer

Installation

ALFI Java Integration Guide

These instructions will help you integrate ALFI into your Java stack.

Connect to the ALFI Maven Repository

Gradle

Respository

repositories {
    maven {
        url 'https://maven.gremlin.com/'
    }
}

Dependencies

Required

compile group: 'com.gremlin', name: 'alfi-core', version: '0.5+'

Optional

// If your application is hosted on AWS EC2 or Lambda, use this to integrate with AWS
// (like Parameter Store Configuration support)
compile group: 'com.gremlin', name: 'alfi-aws', version: '0.5+'

// DynamoDB Injection Points
compile group: 'com.gremlin', name: 'alfi-aws-dynamodb-client', version: '0.5+'

// Apache HTTP Client Injection Points
compile group: 'com.gremlin', name: 'alfi-apache-http-client', version: '0.5+'
Maven

Repository

<!-- Source for all Gremlin artifacts -->
<repository>
    <snapshots>
        <enabled>false</enabled>
    </snapshots>
    <id>gremlin</id>
    <name>The Gremlin Repository</name>
    <url>https://maven.gremlin.com/</url>
</repository>

Dependencies

Required

<dependency>
    <groupId>com.gremlin</groupId>
    <artifactId>alfi-core</artifactId>
    <version>[0.5.0, )</version>
</dependency>

Optional

<!-- If your application is hosted on AWS EC2 or Lambda, use this to integrate with AWS
    (like Parameter Store Configuration support) -->
<dependency>
    <groupId>com.gremlin</groupId>
    <artifactId>alfi-aws</artifactId>
    <version>[0.5.0, )</version>
</dependency>

<!-- DynamoDB Injection Points -->
<dependency>
    <groupId>com.gremlin</groupId>
    <artifactId>alfi-aws-dynamodb-client</artifactId>
    <version>[0.5.0, )</version>
</dependency>

<!-- Apache HTTP Client Injection Points -->
<dependency>
    <groupId>com.gremlin</groupId>
    <artifactId>alfi-apache-http-client</artifactId>
    <version>[0.5.0, )</version>
</dependency>

Authenticate your Application with Gremlin

In order to authenticate to Gremlin, you must provide the following configuration values to your application.

  • GREMLIN_ALFI_IDENTIFIER : A unique identifier for the application. This will be used to distinguish all of the application instances from one another
  • GREMLIN_TEAM_ID : The Team ID that this application belongs to. Only users in that team may conduct attacks on it.
  • GREMLIN_TEAM_CERTIFICATE_OR_FILE : Certificate for authenticating to Gremlin. See below for syntax on permissible values.
  • GREMLIN_TEAM_PRIVATE_KEY_OR_FILE : Private key for authenticating to Gremlin. See below for syntax on permissible values.

You may set these as environment variables or in a gremlin.properties file on the classpath. Certificates can be downloaded for each team from the Settings Page.

Examples:

As a raw value

GREMLIN_TEAM_CERTIFICATE_OR_FILE=-----BEGIN CERTIFICATE-----...

Or pointing to a file

GREMLIN_TEAM_CERTIFICATE_OR_FILE=file:///usr/gremlin/certificate.pem

Optional Configuration

The following keys may be set to tune how ALFI operates.

  • GREMLIN_ALFI_ENABLED : If set to anything other than true, all functionality is turned off. This is designed to give you the ability to safely deploy ALFI, knowing you've got a simple off-switch. When the functionality is off, no failures are ever injected by ALFI, no calls are made to the API, and no logging past configuration-time occurs.
  • GREMLIN_REFRESH_INTERVAL_MS : You may optionally provide this value to set the frequency with which the library will contact the Gremlin API. Minimum of 1000 (1 second), maximum of 300000 (5 minutes). Default of 10000 (10 seconds). This determines how quickly your application reacts to attacks being halted or created and the amount of network traffic generated by the library.

Examples:

  • GREMLIN_ALFI_ENABLED=true
  • GREMLIN_ALFI_IDENTIFIER=recommendation-service-i-0ab123456
  • GREMLIN_REFRESH_INTERVAL_MS=20000
PreviousNext