com.hashicorp.nomad.javasdk.AclTokensApi Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of nomad-sdk Show documentation
There is a newer version: 0.11.3.0
package com.hashicorp.nomad.javasdk;

import com.hashicorp.nomad.apimodel.AclToken;
import com.hashicorp.nomad.apimodel.AclTokenListStub;

import javax.annotation.Nullable;
import java.io.IOException;
import java.util.List;

/**
 * API for managing ACL tokens,
 * exposing the ACL tokens functionality of the
 * Nomad HTTP API.
 */
public class AclTokensApi extends ApiBase {

    AclTokensApi(NomadApiClient apiClient) {
        super(apiClient);
    }

    /**
     * Bootstraps the ACL system and returns the initial management token.
     *
     * @throws IOException    if there is an HTTP or lower-level problem
     * @throws NomadException if the response signals an error or cannot be deserialized
     * @see {@code PUT /v1/acl/bootstrap}
     */
    public ServerResponse bootstrap() throws IOException, NomadException {
        return bootstrap(null);
    }

    /**
     * Bootstraps the ACL system and returns the initial management token.
     *
     * @param options options controlling how the request is performed
     * @throws IOException    if there is an HTTP or lower-level problem
     * @throws NomadException if the response signals an error or cannot be deserialized
     * @see {@code PUT /v1/acl/bootstrap}
     */
    public ServerResponse bootstrap(@Nullable WriteOptions options) throws IOException, NomadException {
        return executeServerAction(put("/v1/acl/bootstrap", options), NomadJson.parserFor(AclToken.class));
    }

    /**
     * Creates an ACL token, returning a token with a server-assigned accessor ID and secret ID.
     *
     * @param token a token with no accessor ID
     * @throws IOException    if there is an HTTP or lower-level problem
     * @throws NomadException if the response signals an error or cannot be deserialized
     * @see {@code PUT /v1/acl/token}
     */
    public ServerResponse create(AclToken token)
            throws IOException, NomadException {
        return create(token, null);
    }

    /**
     * Creates an ACL token, returning a token with a server-assigned accessor ID and secret ID.
     *
     * @param token   a token with no accessor ID
     * @param options options controlling how the request is performed
     * @throws IOException    if there is an HTTP or lower-level problem
     * @throws NomadException if the response signals an error or cannot be deserialized
     * @see {@code PUT /v1/acl/token}
     */
    public ServerResponse create(AclToken token, @Nullable WriteOptions options)
            throws IOException, NomadException {
        if (token.getAccessorId() != null && !token.getAccessorId().isEmpty()) {
            throw new java.lang.IllegalArgumentException("Cannot create an ACL token that already has an accessor ID");
        }
        return executeServerAction(put("/v1/acl/token", token, options), NomadJson.parserFor(AclToken.class));
    }

    /**
     * Deletes an ACL token.
     *
     * @param accessorId accessorId of the token to delete
     * @throws IOException    if there is an HTTP or lower-level problem
     * @throws NomadException if the response signals an error or cannot be deserialized
     * @see {@code DELETE /v1/acl/token/:accessor_id}
     */
    public ServerResponse delete(final String accessorId) throws IOException, NomadException {
        return delete(accessorId, null);
    }

    /**
     * Deletes an ACL token.
     *
     * @param accessorId accessorId of the token to delete
     * @param options    options controlling how the request is performed
     * @throws IOException    if there is an HTTP or lower-level problem
     * @throws NomadException if the response signals an error or cannot be deserialized
     * @see {@code DELETE /v1/acl/token/:accessor_id}
     */
    public ServerResponse delete(final String accessorId, @Nullable final WriteOptions options)
            throws IOException, NomadException {

        return executeServerAction(delete(uri("/v1/acl/token/" + accessorId), options), null);
    }

    /**
     * Retrieves an ACL token.
     *
     * @param accessorId accessor ID of the token.
     * @throws IOException    if there is an HTTP or lower-level problem
     * @throws NomadException if the response signals an error or cannot be deserialized
     * @see {@code GET /v1/acl/token/:accessor_id}
     */
    public ServerQueryResponse info(final String accessorId) throws IOException, NomadException {
        return info(accessorId, null);
    }

    /**
     * Retrieves an ACL token.
     *
     * @param accessorId accessor ID of the token.
     * @param options    options controlling how the request is performed
     * @throws IOException    if there is an HTTP or lower-level problem
     * @throws NomadException if the response signals an error or cannot be deserialized
     * @see {@code GET /v1/acl/token/:accessor_id}
     */
    public ServerQueryResponse info(
            final String accessorId,
            @Nullable final QueryOptions options
    ) throws IOException, NomadException {
        return executeServerQuery("/v1/acl/token/" + accessorId, options, NomadJson.parserFor(AclToken.class));
    }

    /**
     * Lists ACL tokens.
     *
     * @throws IOException    if there is an HTTP or lower-level problem
     * @throws NomadException if the response signals an error or cannot be deserialized
     * @see {@code GET /v1/acl/tokens}
     */
    public ServerQueryResponse> list() throws IOException, NomadException {
        return list(null, null);
    }

    /**
     * Lists all ACL tokens.
     *
     * @param options options controlling how the request is performed
     * @throws IOException    if there is an HTTP or lower-level problem
     * @throws NomadException if the response signals an error or cannot be deserialized
     * @see {@code GET /v1/acl/tokens}
     */
    public ServerQueryResponse> list(
            @Nullable final QueryOptions> options
    ) throws IOException, NomadException {

        return list(null, options);
    }

    /**
     * Lists ACL tokens.
     *
     * @param accessorIdPrefix an even-length accessor ID prefix that, if given,
     *                         restricts the results to only tokens having an accessor ID with this prefix
     * @throws IOException    if there is an HTTP or lower-level problem
     * @throws NomadException if the response signals an error or cannot be deserialized
     * @see {@code GET /v1/acl/tokens}
     */
    public ServerQueryResponse> list(@Nullable final String accessorIdPrefix)
            throws IOException, NomadException {

        return list(accessorIdPrefix, null);
    }

    /**
     * Lists ACL tokens.
     *
     * @param accessorIdPrefix an even-length accessor ID prefix that, if given,
     *                         restricts the results to only tokens having an accessor ID with this prefix
     * @param options          options controlling how the request is performed
     * @throws IOException    if there is an HTTP or lower-level problem
     * @throws NomadException if the response signals an error or cannot be deserialized
     * @see {@code GET /v1/acl/tokens}
     */
    public ServerQueryResponse> list(
            @Nullable final String accessorIdPrefix,
            @Nullable final QueryOptions> options
    ) throws IOException, NomadException {

        return executeServerQueryForPrefixFilteredList(
                "/v1/acl/tokens",
                accessorIdPrefix,
                options,
                NomadJson.parserForListOf(AclTokenListStub.class));
    }

    /**
     * Retrieves the ACL token currently being used.
     *
     * @throws IOException    if there is an HTTP or lower-level problem
     * @throws NomadException if the response signals an error or cannot be deserialized
     * @see {@code GET /v1/acl/token/self}
     */
    public ServerQueryResponse self() throws IOException, NomadException {
        return self(null);
    }

    /**
     * Retrieves the ACL token currently being used.
     *
     * @param options options controlling how the request is performed
     * @throws IOException    if there is an HTTP or lower-level problem
     * @throws NomadException if the response signals an error or cannot be deserialized
     * @see {@code GET /v1/acl/token/self}
     */
    public ServerQueryResponse self(
            @Nullable final QueryOptions options
    ) throws IOException, NomadException {
        return executeServerQuery("/v1/acl/token/self", options, NomadJson.parserFor(AclToken.class));
    }

    /**
     * Updates an ACL token.
     *
     * @param token a token with with an accessor ID
     * @throws IOException    if there is an HTTP or lower-level problem
     * @throws NomadException if the response signals an error or cannot be deserialized
     * @see {@code PUT /v1/acl/token/:accessor_id}
     */
    public ServerResponse update(AclToken token)
            throws IOException, NomadException {
        return update(token, null);
    }

    /**
     * Updates an ACL token.
     *
     * @param token   a token with with an accessor ID
     * @param options options controlling how the request is performed
     * @throws IOException    if there is an HTTP or lower-level problem
     * @throws NomadException if the response signals an error or cannot be deserialized
     * @see {@code PUT /v1/acl/token/:accessor_id}
     */
    public ServerResponse update(AclToken token, @Nullable WriteOptions options)
            throws IOException, NomadException {

        if (token.getAccessorId() == null || token.getAccessorId().isEmpty()) {
            throw new java.lang.IllegalArgumentException("Cannot update an ACL token that doesn't have an accessor ID");
        }
        return executeServerAction(
                put("/v1/acl/token/" + token.getAccessorId(), token, options),
                NomadJson.parserFor(AclToken.class));
    }

}