chemistry-opencmis-client/chemistry-opencmis-client-bindings/src/main/java/org/apache/chemistry/opencmis/client/bindings/spi/AbstractAuthenticationProvider.java

/*
 * 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.chemistry.opencmis.client.bindings.spi;

import java.util.List;
import java.util.Map;

import javax.net.ssl.HostnameVerifier;
import javax.net.ssl.SSLSocketFactory;
import javax.net.ssl.X509TrustManager;
import javax.xml.ws.handler.HandlerResolver;

import org.apache.chemistry.opencmis.commons.SessionParameter;
import org.w3c.dom.Element;

/**
 * Authentication provider class.
 */
public abstract class AbstractAuthenticationProvider implements SessionAwareAuthenticationProvider {

    private static final long serialVersionUID = 1L;

    private BindingSession session;

    /**
     * Sets the {@link BindingSession} the authentication provider lives in.
     */
    @Override
    public void setSession(BindingSession session) {
        this.session = session;
    }

    /**
     * Returns {@link BindingSession}.
     */
    public BindingSession getSession() {
        return session;
    }

    @Override
    public Map<String, List<String>> getHTTPHeaders(String url) {
        return null;
    }

    @Override
    public Element getSOAPHeaders(Object portObject) {
        return null;
    }

    @Override
    public HandlerResolver getHandlerResolver() {
        return null;
    }

    @Override
    public void putResponseHeaders(String url, int statusCode, Map<String, List<String>> headers) {
    }

    @Override
    public SSLSocketFactory getSSLSocketFactory() {
        return null;
    }

    @Override
    public HostnameVerifier getHostnameVerifier() {
        return null;
    }

    /**
     * Gets the trust manager corresponding to the SSL socket factory.
     * 
     * @return a {@link X509TrustManager} or {@code null}
     */
    public X509TrustManager getTrustManager() {
        return null;
    }

    /**
     * Gets the user name from the session.
     * 
     * @return the user name or {@code null} if the user name is not set
     */
    protected String getUser() {
        Object userObject = getSession().get(SessionParameter.USER);
        if (userObject instanceof String) {
            return (String) userObject;
        }

        return null;
    }

    /**
     * Gets the password from the session.
     * 
     * @return the password or {@code null} if the password is not set
     */
    protected String getPassword() {
        Object passwordObject = getSession().get(SessionParameter.PASSWORD);
        if (passwordObject instanceof String) {
            return (String) passwordObject;
        }

        return null;
    }

    /**
     * Gets the bearer token from the session.
     * 
     * @return the bearer token or {@code null} if the token is not set
     */
    protected String getBearerToken() {
        Object tokenObject = getSession().get(SessionParameter.OAUTH_ACCESS_TOKEN);
        if (tokenObject instanceof String) {
            return (String) tokenObject;
        }

        return null;
    }

    /**
     * Gets the proxy user name from the session.
     * 
     * @return the proxy user name or {@code null} if the user name is not set
     */
    protected String getProxyUser() {
        Object userObject = getSession().get(SessionParameter.PROXY_USER);
        if (userObject instanceof String) {
            return (String) userObject;
        }

        return null;
    }

    /**
     * Gets the proxy password from the session.
     * 
     * @return the proxy password or {@code null} if the password is not set
     */
    protected String getProxyPassword() {
        Object passwordObject = getSession().get(SessionParameter.PROXY_PASSWORD);
        if (passwordObject instanceof String) {
            return (String) passwordObject;
        }

        return null;
    }

    /**
     * Gets the CSRF header name.
     * 
     * @return the CSRF header name or {@code null} if the CSRF header name is
     *         not set
     */
    protected String getCsrfHeader() {
        Object csrfHeaderObject = getSession().get(SessionParameter.CSRF_HEADER);
        if (csrfHeaderObject instanceof String) {
            return (String) csrfHeaderObject;
        }

        return null;
    }
}