001/*
002 *   Copyright 2020 Vonage
003 *
004 *   Licensed under the Apache License, Version 2.0 (the "License");
005 *   you may not use this file except in compliance with the License.
006 *   You may obtain a copy of the License at
007 *
008 *        http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *   Unless required by applicable law or agreed to in writing, software
011 *   distributed under the License is distributed on an "AS IS" BASIS,
012 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *   See the License for the specific language governing permissions and
014 *   limitations under the License.
015 */
016package com.vonage.client.auth;
017
018import org.apache.http.client.methods.RequestBuilder;
019
020
021public interface AuthMethod extends Comparable<AuthMethod> {
022    RequestBuilder apply(RequestBuilder request);
023
024    /**
025     * Apply the authentication to the header as basic authentication.
026     *
027     * @param requestBuilder The request being built
028     *
029     * @return RequestBuilder for more building of the request.
030     */
031    RequestBuilder applyAsBasicAuth(RequestBuilder requestBuilder);
032
033    /**
034     * Apply the authentication by adding it to the entity payload.
035     *
036     * @param requestBuilder The request being built
037     *
038     * @return RequestBuilder for more building of the request.
039     */
040    RequestBuilder applyAsJsonProperties(RequestBuilder requestBuilder);
041
042    int getSortKey();
043}