Apache
/
activemq-artemis
mirror of https://github.com/apache/activemq-artemis.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

ARTEMIS-4711 removing the dependency on JMS code by XmlDataImporter 

Introducing ConnectionConfigurationAbtract to expose the configuration
to connect to a broker without requiring the JMS code.

Signed-off-by: Emmanuel Hugonnet <ehugonne@redhat.com>
This commit is contained in:
Emmanuel Hugonnet 2024-04-03 11:59:15 +02:00 committed by Justin Bertram
parent bf1ea41287
commit 604c6d3d90
No known key found for this signature in database
GPG Key ID: F41830B875BB8633
3 changed files with 162 additions and 137 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

136
artemis-cli/src/main/java/org/apache/activemq/artemis/cli/commands/messages/BasicConnectionAbstract.java
View File

@ -22,98 +22,9 @@ import javax.jms.JMSException;
import javax.jms.JMSSecurityException;
import org.apache.activemq.artemis.api.core.management.ManagementHelper;
import org.apache.activemq.artemis.cli.Shell;
import org.apache.activemq.artemis.cli.commands.ActionContext;
import org.apache.activemq.artemis.cli.commands.InputAbstract;
import org.apache.activemq.artemis.jms.client.ActiveMQConnectionFactory;
import picocli.CommandLine.Option;
public class BasicConnectionAbstract extends InputAbstract {
@Option(names = "--url", description = "Connection URL. Default: build URL from the 'artemis' acceptor defined in the broker.xml or tcp://localhost:61616 if the acceptor cannot be parsed.")
protected String brokerURL = DEFAULT_BROKER_URL;
@Option(names = "--acceptor", description = "Name used to find the default connection URL on the acceptor list. If an acceptor with that name cannot be found the CLI will look for a connector with the same name.")
protected String acceptor;
@Option(names = "--user", description = "User used to connect.")
protected String user;
@Option(names = "--password", description = "Password used to connect.")
protected String password;
protected static ThreadLocal<ConnectionInformation> CONNECTION_INFORMATION = new ThreadLocal<>();
static class ConnectionInformation {
String uri, user, password;
private ConnectionInformation(String uri, String user, String password) {
this.uri = uri;
this.user = user;
this.password = password;
}
}
public String getBrokerURL() {
return brokerURL;
}
public void setBrokerURL(String brokerURL) {
this.brokerURL = brokerURL;
}
public String getAcceptor() {
return acceptor;
}
public BasicConnectionAbstract setAcceptor(String acceptor) {
this.acceptor = acceptor;
return this;
}
public String getUser() {
return user;
}
public BasicConnectionAbstract setUser(String user) {
this.user = user;
return this;
}
public String getPassword() {
return password;
}
public BasicConnectionAbstract setPassword(String password) {
this.password = password;
return this;
}
@SuppressWarnings("StringEquality")
@Override
public Object execute(ActionContext context) throws Exception {
super.execute(context);
recoverConnectionInformation();
// it is intentional to make a comparison on the String object here
// this is to test if the original option was switched or not.
// we don't care about being .equals at all.
// as a matter of fact if you pass brokerURL in a way it's equals to DEFAULT_BROKER_URL,
// we should not the broker URL Instance
// and still honor the one passed by parameter.
// SupressWarnings was added to this method to supress the false positive here from error-prone.
if (brokerURL == DEFAULT_BROKER_URL) {
String brokerURLInstance = getBrokerURLInstance(acceptor);
if (brokerURLInstance != null) {
brokerURL = brokerURLInstance;
}
}
context.out.println("Connection brokerURL = " + brokerURL);
return null;
}
public class BasicConnectionAbstract extends ConnectionConfigurationAbtract {
protected ConnectionFactory createConnectionFactory() throws Exception {
recoverConnectionInformation();
@ -159,31 +70,6 @@ public class BasicConnectionAbstract extends InputAbstract {
}
}
protected void recoverConnectionInformation() {
if (CONNECTION_INFORMATION.get() != null) {
ConnectionInformation connectionInfo = CONNECTION_INFORMATION.get();
if (this.user == null) {
this.user = connectionInfo.user;
}
if (this.password == null) {
this.password = connectionInfo.password;
}
if (this.brokerURL == null || this.brokerURL == DEFAULT_BROKER_URL) {
this.brokerURL = connectionInfo.uri;
}
}
}
protected void saveConnectionInfo(String brokerURL, String user, String password) {
if (Shell.inShell() && CONNECTION_INFORMATION.get() == null) {
CONNECTION_INFORMATION.set(new ConnectionInformation(brokerURL, user, password));
getActionContext().out.println("CLI connected to broker " + brokerURL + ", user:" + user);
this.brokerURL = brokerURL;
this.user = user;
this.password = password;
}
}
protected void tryConnect(String brokerURL,
String user,
String password,
@ -193,26 +79,6 @@ public class BasicConnectionAbstract extends InputAbstract {
saveConnectionInfo(brokerURL, user, password);
}
protected String inputBrokerURL(String defaultValue) {
return input("--url", "Type in the connection URL for a retry (e.g. tcp://localhost:61616)", defaultValue);
}
protected String inputUser(String user) {
if (user == null) {
this.user = input("--user", "Type the username for a retry", null);
return this.user;
}
return user;
}
protected String inputPassword(String password) {
if (password == null) {
this.password = inputPassword("--password", "Type the password for a retry", null);
return this.password;
}
return password;
}
protected void performCoreManagement(ManagementHelper.MessageAcceptor setup, ManagementHelper.MessageAcceptor ok, ManagementHelper.MessageAcceptor failed) throws Exception {
try (ActiveMQConnectionFactory factory = (ActiveMQConnectionFactory) createConnectionFactory()) {
ManagementHelper.doManagement(factory.getServerLocator(), user, password, setup, ok, failed);

159
artemis-cli/src/main/java/org/apache/activemq/artemis/cli/commands/messages/ConnectionConfigurationAbtract.java Normal file
View File

@ -0,0 +1,159 @@
/*
* 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.activemq.artemis.cli.commands.messages;
import static org.apache.activemq.artemis.cli.commands.ActionAbstract.DEFAULT_BROKER_URL;
import org.apache.activemq.artemis.cli.Shell;
import org.apache.activemq.artemis.cli.commands.ActionContext;
import org.apache.activemq.artemis.cli.commands.InputAbstract;
import picocli.CommandLine;
public class ConnectionConfigurationAbtract extends InputAbstract {
@CommandLine.Option(names = "--url", description = "Connection URL. Default: build URL from the 'artemis' acceptor defined in the broker.xml or tcp://localhost:61616 if the acceptor cannot be parsed.")
protected String brokerURL = DEFAULT_BROKER_URL;
@CommandLine.Option(names = "--acceptor", description = "Name used to find the default connection URL on the acceptor list. If an acceptor with that name cannot be found the CLI will look for a connector with the same name.")
protected String acceptor;
@CommandLine.Option(names = "--user", description = "User used to connect.")
protected String user;
@CommandLine.Option(names = "--password", description = "Password used to connect.")
protected String password;
protected static ThreadLocal<ConnectionInformation> CONNECTION_INFORMATION = new ThreadLocal<>();
static class ConnectionInformation {
String uri, user, password;
private ConnectionInformation(String uri, String user, String password) {
this.uri = uri;
this.user = user;
this.password = password;
}
}
public String getBrokerURL() {
return brokerURL;
}
public void setBrokerURL(String brokerURL) {
this.brokerURL = brokerURL;
}
public String getAcceptor() {
return acceptor;
}
public ConnectionConfigurationAbtract setAcceptor(String acceptor) {
this.acceptor = acceptor;
return this;
}
public String getUser() {
return user;
}
public ConnectionConfigurationAbtract setUser(String user) {
this.user = user;
return this;
}
public String getPassword() {
return password;
}
public ConnectionConfigurationAbtract setPassword(String password) {
this.password = password;
return this;
}
@SuppressWarnings("StringEquality")
@Override
public Object execute(ActionContext context) throws Exception {
super.execute(context);
recoverConnectionInformation();
// it is intentional to make a comparison on the String object here
// this is to test if the original option was switched or not.
// we don't care about being .equals at all.
// as a matter of fact if you pass brokerURL in a way it's equals to DEFAULT_BROKER_URL,
// we should not the broker URL Instance
// and still honor the one passed by parameter.
// SupressWarnings was added to this method to supress the false positive here from error-prone.
if (brokerURL == DEFAULT_BROKER_URL) {
String brokerURLInstance = getBrokerURLInstance(acceptor);
if (brokerURLInstance != null) {
brokerURL = brokerURLInstance;
}
}
context.out.println("Connection brokerURL = " + brokerURL);
return null;
}
protected void recoverConnectionInformation() {
if (CONNECTION_INFORMATION.get() != null) {
ConnectionInformation connectionInfo = CONNECTION_INFORMATION.get();
if (this.user == null) {
this.user = connectionInfo.user;
}
if (this.password == null) {
this.password = connectionInfo.password;
}
if (this.brokerURL == null || this.brokerURL == DEFAULT_BROKER_URL) {
this.brokerURL = connectionInfo.uri;
}
}
}
protected void saveConnectionInfo(String brokerURL, String user, String password) {
if (Shell.inShell() && CONNECTION_INFORMATION.get() == null) {
CONNECTION_INFORMATION.set(new ConnectionInformation(brokerURL, user, password));
getActionContext().out.println("CLI connected to broker " + brokerURL + ", user:" + user);
this.brokerURL = brokerURL;
this.user = user;
this.password = password;
}
}
protected String inputBrokerURL(String defaultValue) {
return input("--url", "Type in the connection URL for a retry (e.g. tcp://localhost:61616)", defaultValue);
}
protected String inputUser(String user) {
if (user == null) {
this.user = input("--user", "Type the username for a retry", null);
return this.user;
}
return user;
}
protected String inputPassword(String password) {
if (password == null) {
this.password = inputPassword("--password", "Type the password for a retry", null);
return this.password;
}
return password;
}
}

4
artemis-cli/src/main/java/org/apache/activemq/artemis/cli/commands/tools/xml/XmlDataImporter.java
View File

@ -50,7 +50,7 @@ import org.apache.activemq.artemis.api.core.client.ServerLocator;
import org.apache.activemq.artemis.api.core.management.ManagementHelper;
import org.apache.activemq.artemis.api.core.management.ResourceNames;
import org.apache.activemq.artemis.cli.commands.ActionContext;
import org.apache.activemq.artemis.cli.commands.messages.BasicConnectionAbstract;
import org.apache.activemq.artemis.cli.commands.messages.ConnectionConfigurationAbtract;
import org.apache.activemq.artemis.core.filter.impl.FilterImpl;
import org.apache.activemq.artemis.core.protocol.core.impl.PacketImpl;
import org.apache.activemq.artemis.core.remoting.impl.netty.NettyConnectorFactory;
@ -69,7 +69,7 @@ import picocli.CommandLine.Option;
* for speed and simplicity.
*/
@Command(name = "imp", description = "Import all message-data using an XML that could be interpreted by any system.")
public final class XmlDataImporter extends BasicConnectionAbstract {
public final class XmlDataImporter extends ConnectionConfigurationAbtract {
private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());