net.worcade.client.api.ApplicationApi Maven / Gradle / Ivy

Go to download

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

A library for interacting with the Worcade API

There is a newer version: 1.1.2

// Copyright (c) 2017, Worcade. Please see the AUTHORS file for details.
// All rights reserved. Use of this source code is governed by a MIT-style
// license that can be found in the LICENSE file.

package net.worcade.client.api;

import net.worcade.client.Result;
import net.worcade.client.api.mixin.ApiKeysApi;
import net.worcade.client.api.mixin.RemoteIdsApi;
import net.worcade.client.create.ApplicationCreate;
import net.worcade.client.get.Application;
import net.worcade.client.get.ApplicationProfile;
import net.worcade.client.get.CreateWithApiKey;
import net.worcade.client.get.Reference;
import net.worcade.client.modify.ApplicationModification;

import java.security.KeyPair;
import java.security.KeyPairGenerator;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.SecureRandom;
import java.util.Collection;

public interface ApplicationApi extends ApiKeysApi, RemoteIdsApi {
    ApplicationCreate createBuilder();

    Result get(String id);
    Result getProfile(String id);
    /**
     * Create a new Application. Use the {@link #createBuilder()} method for a new, empty template.
     */
    Result create(ApplicationModification subject);
    Result createWithApiKey(ApplicationModification subject, String apiKeyDescription);
    Result updateProfile(ApplicationModification subject);
    Result setupKeyExchange(String id, PublicKey applicationKey);
    Result addVersions(String id, String... versions);
    Result> getByFingerprint(String fingerprint);

    /**
     * Helper method to generate a proper keypair used for application authentication.
     * Keep the private key somewhere safe, and send the public key to Worcade using {@link #setupKeyExchange(String, PublicKey)}
     *
     * @return a securely generated key pair
     * @throws NoSuchAlgorithmException if there's no provider for the RSA algorithm
     */
    static KeyPair generateKeyPair() throws NoSuchAlgorithmException {
        KeyPairGenerator generator = KeyPairGenerator.getInstance("RSA");
        generator.initialize(2048, new SecureRandom());
        return generator.generateKeyPair();
    }
}