evolvedbinary / elemental / 982

Committed 29 Apr 2025 08:34PM UTC coverage: 56.409% (+0.007%) from 56.402%

Build # 982

Build Type

push

circleci

Committed by

adamretter

Commit Message

[feature] Improve README.md badges

Run Details

28451 of 55847 branches covered (50.94%)

Branch coverage included in aggregate %.

77468 of 131924 relevant lines covered (58.72%)

0.59 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/exist-core/src/main/java/org/exist/client/Connection.java

/*
 * Elemental
 * Copyright (C) 2024, Evolved Binary Ltd
 *
 * admin@evolvedbinary.com
 * https://www.evolvedbinary.com | https://www.elemental.xyz
 *
 * Use of this software is governed by the Business Source License 1.1
 * included in the LICENSE file and at www.mariadb.com/bsl11.
 *
 * Change Date: 2028-04-27
 *
 * On the date above, in accordance with the Business Source License, use
 * of this software will be governed by the Apache License, Version 2.0.
 *
 * Additional Use Grant: Production use of the Licensed Work for a permitted
 * purpose. A Permitted Purpose is any purpose other than a Competing Use.
 * A Competing Use means making the Software available to others in a commercial
 * product or service that: substitutes for the Software; substitutes for any
 * other product or service we offer using the Software that exists as of the
 * date we make the Software available; or offers the same or substantially
 * similar functionality as the Software.
 *
 * NOTE: Parts of this file contain code from 'The eXist-db Authors'.
 *       The original license header is included below.
 *
 * =====================================================================
 *
 * eXist-db Open Source Native XML Database
 * Copyright (C) 2001 The eXist-db Authors
 *
 * info@exist-db.org
 * 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 Elemental 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;
    }
}

1	/*
2	* Elemental
3	* Copyright (C) 2024, Evolved Binary Ltd
4	*
5	* admin@evolvedbinary.com
6	* https://www.evolvedbinary.com \| https://www.elemental.xyz
7	*
8	* Use of this software is governed by the Business Source License 1.1
9	* included in the LICENSE file and at www.mariadb.com/bsl11.
10	*
11	* Change Date: 2028-04-27
12	*
13	* On the date above, in accordance with the Business Source License, use
14	* of this software will be governed by the Apache License, Version 2.0.
15	*
16	* Additional Use Grant: Production use of the Licensed Work for a permitted
17	* purpose. A Permitted Purpose is any purpose other than a Competing Use.
18	* A Competing Use means making the Software available to others in a commercial
19	* product or service that: substitutes for the Software; substitutes for any
20	* other product or service we offer using the Software that exists as of the
21	* date we make the Software available; or offers the same or substantially
22	* similar functionality as the Software.
23	*
24	* NOTE: Parts of this file contain code from 'The eXist-db Authors'.
25	* The original license header is included below.
26	*
27	* =====================================================================
28	*
29	* eXist-db Open Source Native XML Database
30	* Copyright (C) 2001 The eXist-db Authors
31	*
32	* info@exist-db.org
33	* http://www.exist-db.org
34	*
35	* This library is free software; you can redistribute it and/or
36	* modify it under the terms of the GNU Lesser General Public
37	* License as published by the Free Software Foundation; either
38	* version 2.1 of the License, or (at your option) any later version.
39	*
40	* This library is distributed in the hope that it will be useful,
41	* but WITHOUT ANY WARRANTY; without even the implied warranty of
42	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
43	* Lesser General Public License for more details.
44	*
45	* You should have received a copy of the GNU Lesser General Public
46	* License along with this library; if not, write to the Free Software
47	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
48	*/
49	package org.exist.client;
50
51	/**
52	* Represents the Connection detail for
53	* connecting to either a local or remote Elemental instance
54	*
55	* You can have either:
56	* 1) Remote Connection, provide a uri and ssl flag.
57	* 2) Embedded Connection, provide a configuration file path.
58	*
59	* The two settings are mutually exclusive, when using Remote,
60	* configuration is set to "". Likewise when using
61	* Embedded, uri is set to "" and ssl is set to false
62	* TODO subclass into RemoteConnection and EmbeddedConnection
63	*/
64	public class Connection {
65
66	private final String username;
67	private final String password;
68
69	/* remote mode */
70	protected String uri;
71	protected boolean ssl;
72
73	/** path to an alternate configuration file for embedded mode */
74	protected String configuration;
75
76	public Connection(final String username, final String password, final String uri, final boolean ssl) {	×
77	this.username = username;	×
78	this.password = password;	×
79	this.uri = uri;	×
80	this.ssl = ssl;	×
81	this.configuration = "";	×
82	}	×
83
84	public Connection(final String username, final String password, final String configuration) {	×
85	this.username = username;	×
86	this.password = password;	×
87	this.uri = "";	×
88	this.ssl = false;	×
89	this.configuration = configuration;	×
90	}	×
91
92	/**
93	* Returns the username.
94	*
95	* @return the username
96	*/
97	public String getUsername() {
98	return username;	×
99	}
100
101	/**
102	* Returns the password.
103	*
104	* @return the password
105	*/
106	public String getPassword() {
107	return password;	×
108	}
109
110	/**
111	* Returns the uri.
112	*
113	* @return the uri
114	*/
115	public String getUri() {
116	return uri;	×
117	}
118
119	/**
120	* Returns the configuration file path for emebeded mode.
121	*
122	* @return the url
123	*/
124	public String getConfiguration() {
125	return configuration;	×
126	}
127
128	/**
129	* Returns whether to use SSL or not
130	*
131	* @return true if SSL should be enabled.
132	*/
133	public boolean isSsl() {
134	return ssl;	×
135	}
136	}

evolvedbinary / elemental / 982

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous