org.exist.client.Connection Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of exist-core Show documentation
eXist-db NoSQL Database Core
There is a newer version: 6.3.0
/*
 * eXist-db Open Source Native XML Database
 * Copyright (C) 2001 The eXist-db Authors
 *
 * [email protected]
 * http://www.exist-db.org
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */ 
package org.exist.client;

/**
 * Represents the Connection detail for
 * connecting to either a local or remote eXist-db instance
 * 
 * You can have either:
 *  1) Remote Connection, provide a uri and ssl flag.
 *  2) Embedded Connection, provide a configuration file path.
 * 
 * The two settings are mutually exclusive, when using Remote,
 * configuration is set to "". Likewise when using
 * Embedded, uri is set to "" and ssl is set to false
 * TODO subclass into RemoteConnection and EmbeddedConnection
 */
public class Connection {
    
    private final String username;
    private final String password;
    
    /* remote mode */
    protected String uri;
    protected boolean ssl;
    
    /** path to an alternate configuration file for embedded mode */
    protected String configuration;
    
    public Connection(final String username, final String password, final String uri, final boolean ssl) {
        this.username = username;
        this.password = password;
        this.uri = uri;
        this.ssl = ssl;
        this.configuration = "";
    }
    
    public Connection(final String username, final String password, final String configuration) {
        this.username = username;
        this.password = password;
        this.uri = "";
        this.ssl = false;
        this.configuration = configuration;
    }
    
    /**
     * Returns the username.
     *
     * @return the username
     */
    public String getUsername() {
        return username;
    }

    /**
     * Returns the password.
     *
     * @return the password
     */
    public String getPassword() {
        return password;
    }

    /**
     * Returns the uri.
     *
     * @return the uri
     */
    public String getUri() {
        return uri;
    }

    /**
     * Returns the configuration file path for emebeded mode.
     *
     * @return the url
     */
    public String getConfiguration() {
        return configuration;
    }
    
    /**
     *  Returns whether to use SSL or not
     *
     * @return true if SSL should be enabled.
     */
    public boolean isSsl() {
        return ssl;
    }
}