com.hp.autonomy.hod.client.api.developer.ApplicationService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of java-hod-client Show documentation
Java Client for communicating with HP Haven OnDemand
There is a newer version: 0.25.3
/*
 * Copyright 2015-2016 Hewlett-Packard Development Company, L.P.
 * Licensed under the MIT License (the "License"); you may not use this file except in compliance with the License.
 */

package com.hp.autonomy.hod.client.api.developer;

import com.hp.autonomy.hod.client.api.authentication.ApiKey;
import com.hp.autonomy.hod.client.api.authentication.AuthenticationToken;
import com.hp.autonomy.hod.client.api.authentication.EntityType;
import com.hp.autonomy.hod.client.api.authentication.TokenType;
import com.hp.autonomy.hod.client.error.HodErrorException;

import java.util.List;

public interface ApplicationService {

    /**
     * List applications associated with this developer token.
     * @param token The developer token
     * @return Applications and their privileges
     * @throws HodErrorException
     */
    List list(AuthenticationToken token) throws HodErrorException;

    /**
     * Create an application in the given domain.
     * @param token The developer token to use for authentication
     * @param domain The domain in which to create the application
     * @param name The name of the new application
     * @param description The description of the new application
     * @throws HodErrorException
     */
    void create(AuthenticationToken token, String domain, String name, String description) throws HodErrorException;

    /**
     * Delete an application from a domain.
     * @param token The developer token to use for authentication
     * @param domain The domain of the application
     * @param name The name of the application
     * @throws HodErrorException
     */
    void delete(AuthenticationToken token, String domain, String name) throws HodErrorException;

    /**
     * List the authentications associated with the given application.
     * @param token The developer token to use for authentication
     * @param domain The domain of the application
     * @param name The name of the application
     * @return The authentications associated with the application
     * @throws HodErrorException
     */
    List listAuthentications(AuthenticationToken token, String domain, String name) throws HodErrorException;

    /**
     * Create a new authentication and associate it with the given application.
     * @param token The developer token to use for authentication
     * @param domain The domain of the application
     * @param name The name of the application
     * @return The API key of the new authentication
     * @throws HodErrorException
     */
    ApiKey addAuthentication(AuthenticationToken token, String domain, String name) throws HodErrorException;

    /**
     * Add an authentication mode to the given application.
     * @param token The developer token to use for authentication
     * @param domain The domain of the application
     * @param name The name of the application
     * @param applicationMode The mode by which the application can authenticate
     * @param userMode The mode by which users must authenticate to create a combined token
     * @param returnTokenType The token type associated with this authentication mode
     * @throws HodErrorException
     */
    void addAuthenticationMode(
        AuthenticationToken token,
        String domain,
        String name,
        ApplicationAuthMode applicationMode,
        UserAuthMode userMode,
        TokenType returnTokenType
    ) throws HodErrorException;

}