RIPS API Java Connector

The platform distribution of the connector and utils for the RIPS API.

License	BSD-3-Clause
Categories	ORM Data
GroupId	com.ripstech.api
ArtifactId	connector-platform
Last Version	3.13.0
Release Date	Apr 3, 2020
Type	pom
Description	RIPS API Java Connector The platform distribution of the connector and utils for the RIPS API.
Project URL	https://www.ripstech.com
Source Code Management	https://github.com/rips/java-connector/tree/master

Download connector-platform

Filename	Size
connector-platform-3.13.0.pom

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/com.ripstech.api/connector-platform/ -->
<dependency>
    <groupId>com.ripstech.api</groupId>
    <artifactId>connector-platform</artifactId>
    <version>3.13.0</version>
    <type>pom</type>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/com.ripstech.api/connector-platform/
implementation 'com.ripstech.api:connector-platform:3.13.0'

Gradle Kotlin

// https://jarcasting.com/artifacts/com.ripstech.api/connector-platform/
implementation ("com.ripstech.api:connector-platform:3.13.0")

Apache Buildr

'com.ripstech.api:connector-platform:pom:3.13.0'

Apache Ivy

<dependency org="com.ripstech.api" name="connector-platform" rev="3.13.0">
  <artifact name="connector-platform" type="pom" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='com.ripstech.api', module='connector-platform', version='3.13.0')
)

Scala SBT

libraryDependencies += "com.ripstech.api" % "connector-platform" % "3.13.0"

Leiningen

[com.ripstech.api/connector-platform "3.13.0"]

Dependencies

There are no dependencies for this project. It is a standalone project that does not depend on any other jars.

Project Modules

There are no modules declared in this project.

RIPS Java Connector

A Java library to provide easy access to RIPS and all of its features.

Installation

The utils dependency is optional.

Gradle

implementation("com.ripstech.api:connector:3.1.0")
implementation("com.ripstech.api:utils:3.1.0")

Maven

<dependencies>
  ...
  <dependency>
    <groupId>com.ripstech.api</groupId>
    <artifactId>connector</artifactId>
    <version>3.1.0</version>
  </dependency>
    <dependency>
      <groupId>com.ripstech.api</groupId>
      <artifactId>utils</artifactId>
      <version>3.1.0</version>
    </dependency>
  ...
</dependencies>

Use locally

./gradlew clean entity-gen:run api:publishToMavenLocal utils:publishToMavenLocal

Usage

Create API-Connector

String baseUrl = "https://api-3.ripstech.com";
String email = "";
String password = "";

Api api = new Api.Builder(baseUrl)
                 .withOAuthv2(username, password)
                 .build();

Upload and start scan

long appId = 0;
String scanName = "";
File zipFile = ...;

ScanHandler scanHandler = new ScanHandler(api, appId);
scanHandler.uploadFile(zipFile);
long scanId = scanHandler.startScan(scanName).getId();

Getting issues

long appId = 0;
long scanId = 0;
List<Issue> issues = new IssueHandler(api, appId, scanId)
                          .setLogger(System.out::println)
                          .getAllIssues();

Error handling

Exceptions

String version = api.status().get().orThrow(ApiException::new).getVersion();

val version = when(val result = api.status().get().result()) {
                is Failure -> throw result.exception()
                is Success -> result.value.getVersion()
              }

Functional Style

Optional<String> version = api.status().get().map(Status::getVersion);

api.status().get().ifOk(status -> System.out.println(status.getVersion()));

RIPS Technologies

The technology leader in web application security testing

Versions

Version
3.13.0 Apr 3, 2020
3.12.2 Mar 10, 2020
3.11.1 Mar 10, 2020
3.11.0 Mar 10, 2020
3.10.0 Mar 10, 2020
3.9.0 Dec 9, 2019
3.8.0 Aug 30, 2019
3.7.0 Aug 7, 2019