RestProvider.java

/* 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 com.labs64.netlicensing.provider;

import java.util.Map;

import com.labs64.netlicensing.exception.RestException;
import com.labs64.netlicensing.provider.auth.Authentication;

/**
 */
public interface RestProvider {

    public interface Configuration {

        String getUserAgent();

        boolean isLoggingEnabled();

    }

    /**
     * Helper method for performing REST requests with optional REST parameter map.
     * <p/>
     * This method has a long list of parameters. It is only intended for internal use.
     *
     * @param method
     *            the HTTP method to be used, i.e. GET, PUT, POST.
     * @param urlTemplate
     *            the REST URL urlTemplate.
     * @param request
     *            optional: The request body to be sent to the server. May be null.
     * @param responseType
     *            optional: expected response type. In case no responseType body is expected, responseType may be null.
     * @param queryParams
     *            optional: The REST query parameters values. May be null.
     * @param <REQ>
     *            type of the request entity
     * @param <RES>
     *            type of the responseType entity
     * @return the responseType entity received from the server, or null if responseType is null.
     */
    <REQ, RES> RestResponse<RES> call(String method, String urlTemplate, REQ request, Class<RES> responseType,
            Map<String, Object> queryParams) throws RestException;

    /**
     * @param username
     *            username used for authentication
     * @param password
     *            password used for authentication
     * @return authenticated RESTful provider
     */
    RestProvider authenticate(String username, String password);

    /**
     * @param token
     *            token used for authentication
     * @return authenticated RESTful provider
     */
    RestProvider authenticate(String token);

    /**
     * @param authentication
     *            {@link Authentication} object
     * @return authenticated RESTful provider
     */
    RestProvider authenticate(Authentication authentication);

    /**
     * @param configuration
     *            {@link Configuration} configuration to use for the provider
     */
    void configure(Configuration configuration);

}