foundation.greensoftware.carbonaware.webapi.auth

Interface Authentication

All Known Implementing Classes:

ApiKeyAuth, HttpBasicAuth, HttpBearerAuth

public interface Authentication

Method Summary

Modifier and Type	Method and Description
void	applyToParams(List<Pair> queryParams, Map<String,String> headerParams, Map<String,String> cookieParams, String payload, String method, URI uri) Apply authentication settings to header and query params.

Method Detail

applyToParams

void applyToParams(List<Pair> queryParams,
                   Map<String,String> headerParams,
                   Map<String,String> cookieParams,
                   String payload,
                   String method,
                   URI uri)
            throws ApiException

Apply authentication settings to header and query params.

Parameters:

queryParams - List of query parameters

headerParams - Map of header parameters

cookieParams - Map of cookie parameters

payload - HTTP request body

method - HTTP method

uri - URI

Throws:

ApiException - if failed to update the parameters