com.marklogic.xcc.jndi.ContentSourceBean Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of marklogic-xcc Show documentation
MarkLogic XML Contentbase Connector for Java (XCC/J)
There is a newer version: 11.3.0
/*
 * Copyright (c) 2020 MarkLogic Corporation
 *
 * Licensed 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 com.marklogic.xcc.jndi;

import java.net.URI;
import java.net.URISyntaxException;
import java.util.logging.Logger;

import com.marklogic.xcc.ContentSource;
import com.marklogic.xcc.ContentSourceFactory;
import com.marklogic.xcc.Session;
import com.marklogic.xcc.exceptions.XccConfigException;
import com.marklogic.xcc.spi.ConnectionProvider;

/**
 * 
 * This is a Java Bean compatible implementation of {@link ContentSource} intended for use in a JNDI
 * context or container where configuration must be done via setter methods.
 * 
 * 
 * Use of this class to directly instantiate a {@link ContentSource} is discouraged. If you wish to
 * programmatically create an instance use the primary factory class {@link ContentSourceFactory}
 * instead.
 * 
 * 
 * This class depends on a container-provided {@link javax.naming.spi.ObjectFactory} implementation.
 * If you have the option of configuring a custom bean factory, you are encouraged to use
 * {@link ContentSourceBeanFactory} instead.
 * 
 *  An example of configuring Tomcat to use this bean would look like this:
 * 
 * 
 * 
 * <Context path="/">
 *    <Resource name="marklogic/ContentSource" auth="Container"
 *        type="com.marklogic.xcc.jndi.ContentSourceBean"
 *        factory="org.apache.naming.factory.BeanFactory"
 *         host="somehost.mycorp.com" port="8003" user="fred" password="hush"
 *         contentbase="productiondb"/>
 * <Context>
 * 
 * 
 * See {@link ContentSourceBeanFactory} for more details and an example of looking up a
 * {@link ContentSource} with JNDI. The lookup code will be identical for both configuration
 * approaches.
 * 
 * 
 * @see ContentSourceBeanFactory
 */
@SuppressWarnings("deprecation")
public class ContentSourceBean implements ContentSource {
    private ContentSource cs = null;
    private String host = null;
    private int port = 0;
    private String user = null;
    private String password = null;
    private String contentBase = null;
    private URI url = null;
    private boolean authenticationPreemptive = false;

    public ContentSourceBean() {
    }

    // ----------------------------------------------------------
    // ContentSource interface

    public Session newSession() {
        return getContentSource().newSession();
    }

    public Session newSession(String databaseId) {
        return getContentSource().newSession(databaseId);
    }

    public Session newSession(String userName, String password) {
        return getContentSource().newSession(userName, password);
    }

    public Session newSession(String userName, String password, String databaseId) {
        return getContentSource().newSession(userName, password, databaseId);
    }

    public Logger getDefaultLogger() {
        return getContentSource().getDefaultLogger();
    }

    public void setDefaultLogger(Logger logger) {
        getContentSource().setDefaultLogger(logger);
    }

    public ConnectionProvider getConnectionProvider() {
        return getContentSource().getConnectionProvider();
    }

    @Override
    public String toString() {
        return getContentSource().toString();
    }

    // ----------------------------------------------------------
    // Bean setter methods exposed to JNDI container

    public void setHost(String host) {
        this.host = host;
    }

    public void setPort(int port) {
        this.port = port;
    }

    public void setUser(String user) {
        this.user = user;
    }

    public void setPassword(String password) {
        this.password = password;
    }

    public void setContentBase(String contentBase) {
        this.contentBase = contentBase;
    }

    public void setUrl(String url) throws URISyntaxException {
        this.url = new URI(url);
    }

    public boolean isAuthenticationPreemptive() {
    	return this.authenticationPreemptive;
    }
    
    public void setAuthenticationPreemptive(boolean value) {
    	this.authenticationPreemptive = value;
    }

    // ----------------------------------------------------------

    private ContentSource getContentSource() {
        if (cs != null) {
            return cs;
        }

        if (url == null) {
            cs = ContentSourceFactory.newContentSource(host, port, user, password, contentBase);
        } else {
            try {
                cs = ContentSourceFactory.newContentSource(url);
            } catch (XccConfigException e) {
                throw new IllegalArgumentException("Cannot create ContentSource from URI", e);
            }
        }
        
        cs.setAuthenticationPreemptive(authenticationPreemptive);

        return cs;
    }

    @Override
    public Session newSession(String userName, char[] password) {
        return getContentSource().newSession(userName, password);
    }

    @Override
    public Session newSession(String userName, char[] password,
            String contentbaseId) {
        return getContentSource().newSession(userName, password, 
                contentbaseId);
    }
}