1 /*
2 * Copyright (C) 2010-2012 Atlassian
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 package com.atlassian.jira.rest.client.api;
18
19 import com.atlassian.httpclient.api.Request;
20
21 /**
22 * Interface for classes which authenticate the requests. The configure method is invoked during each request.
23 * For instance, the implementation of this handling which would configure the request to do a basic http authentication would
24 * have a following implementation.
25 * <p/>
26 * public void configure(final Request request) {
27 * request.setHeader("Authorization", "Basic " + base64EncodedCredentials());
28 * }
29 *
30 * @since v0.1
31 */
32 public interface AuthenticationHandler {
33
34 void configure(final Request request);
35
36 }