org.echocat.marquardt.client.Client Maven / Gradle / Ivy

Go to download
/*
 * echocat Marquardt Java SDK, Copyright (c) 2015 echocat
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */

package org.echocat.marquardt.client;

import org.echocat.marquardt.common.domain.Credentials;
import org.echocat.marquardt.common.domain.Signable;
import org.echocat.marquardt.common.domain.certificate.Certificate;

import java.io.IOException;

/**
 * Interface of the client to perform authentication with the authority and to call service APIs.
 *
 * @param  type of the payload contained in the certificate.
 */
public interface Client {

    /**
     * Sign up with the provided user credentials to the authority. This will create a new user account
     * if an account for the credentials does not exist already and return a certificate.
     *
     * @throws IOException
     */
    Certificate signup(final Credentials credentials) throws IOException;

    /**
     * Sign in to the authority with the provided user credentials. This will return a certificate if the
     * credentials are accepted by the authority.
     *
     * @throws IOException
     */
    Certificate signin(final Credentials credentials) throws IOException;

    /**
     * Refresh the current session by obtaining a new certificate. This will return a new certificate if a valid
     * certificate is provided. Refreshing the certificate is also possible if the certificate is expired.
     *
     * @throws IOException
     */
    Certificate refresh(final Certificate certificateToRefresh) throws IOException;

    /**
     * Sign out the user by deleting the current session. This will return true if sign out was successful.
     *
     * @throws IOException
     */
    boolean signout(final Certificate certificate) throws IOException;

    /**
     * Call a protected service API endpoint by using the certificate obtained earlier (either by signing in or signing up).
     */
     RESPONSE sendSignedPayloadTo(final String url,
                                                     final String httpMethod,
                                                     final REQUEST payload,
                                                     final Class responseType,
                                                     final Certificate certificate) throws IOException;
}