org.jboss.pnc.environmentdriver.clients.IndyService Maven / Gradle / Ivy

Go to download
/**
 * JBoss, Home of Professional Open Source.
 * Copyright 2021 Red Hat, Inc., and individual contributors
 * as indicated by the @author tags.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.jboss.pnc.environmentdriver.clients;

import org.eclipse.microprofile.rest.client.inject.RegisterRestClient;

import javax.ws.rs.Consumes;
import javax.ws.rs.HeaderParam;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;

/**
 * Indy service representing the Indy server. It uses Quarkus magical rest client to generate the client implementation
 */
@RegisterRestClient(configKey = "indy-service")
public interface IndyService {

    /**
     * Ask Indy to give us the token that we will use for Maven communication with Indy, in the builder pod for the
     * particular buildId
     *
     * @param indyTokenRequestDTO the DTO to send to Indy
     * @param accessToken accessToken required to send data. Note that it should include "Bearer "
     *
     * @return Token DTO
     */
    @Path("/api/security/auth/token")
    @Produces(MediaType.APPLICATION_JSON)
    @Consumes(MediaType.APPLICATION_JSON)
    @POST
    public IndyTokenResponseDTO getAuthToken(
            IndyTokenRequestDTO indyTokenRequestDTO,
            @HeaderParam("Authorization") String accessToken);
}