com.dke.data.agrirouter.api.service.onboard.secured.OnboardingService Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of agrirouter-api-java-api Show documentation

This project contains the API for the communication with the agrirouter. Everything you need for the onboarding process, secure communication and much more.

There is a newer version: 1.0.0-jdk11-RC1

Show newest version

package com.dke.data.agrirouter.api.service.onboard.secured;

import com.dke.data.agrirouter.api.dto.onboard.OnboardingError;
import com.dke.data.agrirouter.api.dto.onboard.OnboardingResponse;
import com.dke.data.agrirouter.api.service.parameters.AuthorizationRequestParameters;
import com.dke.data.agrirouter.api.service.parameters.SecuredOnboardingParameters;
import java.util.Optional;

/** Service for the onboarding process. */
public interface OnboardingService {

  /**
   * Oboarding of an endpoint.
   *
   * @param parameters-
   * @return -
   */
  OnboardingResponse onboard(SecuredOnboardingParameters parameters);

  /**
   * Verify the onboarding request to ensure correct signature and hashing.
   *
   * @param parameters -
   */
  void verify(SecuredOnboardingParameters parameters);

  /**
   * Generating the authorization URL.
   *
   * @param parameters -
   * @return -
   */
  String generateAuthorizationUrl(AuthorizationRequestParameters parameters);

  /**
   * The last error as OnboardingError-Object, if the last onboarding failed as object read from the
   * JSON String
   *
   * @param errorResponse -
   * @return The last error as OnboardingError-Object
   */
  Optional getLastOnboardingError(String errorResponse);
}