org.apache.ambari.view.hive.client.HttpRequestInterceptorBase.java Source code

Introduction

Here is the source code for org.apache.ambari.view.hive.client.HttpRequestInterceptorBase.java

Source

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.ambari.view.hive.client;

import org.apache.http.HttpException;
import org.apache.http.HttpRequest;
import org.apache.http.HttpRequestInterceptor;
import org.apache.http.client.CookieStore;
import org.apache.http.client.protocol.ClientContext;
import org.apache.http.protocol.HttpContext;

import java.io.IOException;
import java.util.Map;

public abstract class HttpRequestInterceptorBase implements HttpRequestInterceptor {
    CookieStore cookieStore;
    boolean isCookieEnabled;
    String cookieName;
    boolean isSSL;
    Map<String, String> additionalHeaders;

    public HttpRequestInterceptorBase(CookieStore cs, String cn, boolean isSSL,
            Map<String, String> additionalHeaders) {
        this.cookieStore = cs;
        this.isCookieEnabled = (cs != null);
        this.cookieName = cn;
        this.isSSL = isSSL;
        this.additionalHeaders = additionalHeaders;
    }

    // Abstract function to add HttpAuth Header
    protected abstract void addHttpAuthHeader(HttpRequest httpRequest, HttpContext httpContext) throws Exception;

    @Override
    public void process(HttpRequest httpRequest, HttpContext httpContext) throws HttpException, IOException {
        try {
            // If cookie based authentication is allowed, generate ticket only when necessary.
            // The necessary condition is either when there are no server side cookies in the
            // cookiestore which can be send back or when the server returns a 401 error code
            // indicating that the previous cookie has expired.
            if (isCookieEnabled) {
                httpContext.setAttribute(ClientContext.COOKIE_STORE, cookieStore);
            }
            // Generate the kerberos ticket under the following scenarios:
            // 1. Cookie Authentication is disabled OR
            // 2. The first time when the request is sent OR
            // 3. The server returns a 401, which sometimes means the cookie has expired
            // 4. The cookie is secured where as the client connect does not use SSL
            if (!isCookieEnabled || ((httpContext.getAttribute(Utils.HIVE_SERVER2_RETRY_KEY) == null
                    && (cookieStore == null || (cookieStore != null
                            && Utils.needToSendCredentials(cookieStore, cookieName, isSSL))))
                    || (httpContext.getAttribute(Utils.HIVE_SERVER2_RETRY_KEY) != null && httpContext
                            .getAttribute(Utils.HIVE_SERVER2_RETRY_KEY).equals(Utils.HIVE_SERVER2_RETRY_TRUE)))) {
                addHttpAuthHeader(httpRequest, httpContext);
            }
            if (isCookieEnabled) {
                httpContext.setAttribute(Utils.HIVE_SERVER2_RETRY_KEY, Utils.HIVE_SERVER2_RETRY_FALSE);
            }
            // Insert the additional http headers
            if (additionalHeaders != null) {
                for (Map.Entry<String, String> entry : additionalHeaders.entrySet()) {
                    httpRequest.addHeader(entry.getKey(), entry.getValue());
                }
            }
        } catch (Exception e) {
            throw new HttpException(e.getMessage(), e);
        }
    }
}