org.bonitasoft.web.client.feign.ApiProvider Maven / Gradle / Ivy

Go to download

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

Java client for Bonita REST API

The newest version!

/** 
 * Copyright (C) 2023 BonitaSoft S.A.
 * BonitaSoft, 32 rue Gustave Eiffel - 38000 Grenoble
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 2.0 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see .
 */
package org.bonitasoft.web.client.feign;

import org.bonitasoft.web.client.invoker.ApiClient;

public interface ApiProvider {

    /**
     * Return the underlying raw http client API. 

     * 

     * Beware that raw API access directly map to http request !!  

     * 

     * You won't benefit from bonita client facilities ( ie. request and payload validation, ...)
     * and that your code will be highly coupled to the underlying client technology !
     * This access is provided to avoid people being blocked by the current limited Bonita client
     * implementation. This may be removed in the future.
     *
     * @param apiClass the class of the requested API instance type
     * @param  the specific API type
     * @return an API instance of type T
     */
     T get(Class apiClass);
}