https://github.com/cybercentrecanada/assemblyline-java-client

Java client for Assemblyline V4
https://github.com/cybercentrecanada/assemblyline-java-client

Last synced: 5 months ago
JSON representation

Java client for Assemblyline V4

• Host: GitHub
• URL: https://github.com/cybercentrecanada/assemblyline-java-client
• Owner: CybercentreCanada
• License: mit
• Created: 2021-06-04T17:49:41.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-06-17T12:58:46.000Z (over 1 year ago)
• Last Synced: 2025-03-02T03:33:37.110Z (7 months ago)
• Language: Java
• Size: 552 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Assemblyline Java Client Library

The assemblyline java client library provides methods to submit requests to assemblyline.

## Using the client

To instantiate the client bean set the application properties associated with the desired authentication method. The

client can be accessed by autowiring the bean into the class using it.

There are two authentication methods: username/apikey or username/password.

### API Key Authentication

To instantiate an API key authenticated assemblyline client, define the following properties:

    assemblyline-java-client:

        url: 

        api-auth:

            apikey: 

            username: 

### Password Authentication

To instantiate a password-authenticated assemblyline client, define the following properties:

    assemblyline-java-client:

        url: 

        password-auth:

            password: 

            username: 

### HttpClient Configuration

By default, the AssemblyLine client will use an HttpClient with default settings and HTTPS support.

#### Proxy

To go through a proxy, configure a custom ```reactor.netty.httpclient.HttpClient``` bean that includes proxy settings.

For example:

    @Bean

    public HttpClient httpClient() {

        return HttpClient.create()

            // Enable HTTPS support

            .secure()

            // Configure proxy

            .proxy(proxyOptions -> proxyOptions

                .type(ProxyProvider.Proxy.HTTP)

                .host("https://proxy.example.com")

                .port(443));

    }

#### HTTPS

HTTPS options can be configured with one of two methods:

1. Use the standard JVM options (```-Djavax.net.ssl.trustStore```, ```-Djavax.net.ssl.trustStorePassword```, etc)

2. Configure a custom ```reactor.netty.httpclient.HttpClient``` bean that includes the desired settings.