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

ACTIVEMQ6-89 Refactored stomp support contributed 

https://issues.apache.org/jira/browse/ACTIVEMQ6-89

I have done a lot of refactoring on this. So we can a different version of the interceptor for each protocol based on a base class now.
Just an abstract class over Stomp would be a bit hacky... this is a better approach.
This commit is contained in:
Clebert Suconic 2015-03-16 15:11:25 -04:00
parent b2524b1be4
commit 519a47f023
18 changed files with 463 additions and 193 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
activemq-core-client/src/main/java/org/apache/activemq/api/core/BaseInterceptor.java Normal file
View File

@ -0,0 +1,35 @@
/**
* 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.api.core;
import org.apache.activemq.spi.core.protocol.RemotingConnection;
public interface BaseInterceptor<P>
{
/**
* Intercepts a packet which is received before it is sent to the channel
*
* @param packet the packet being received
* @param connection the connection the packet was received on
* @return {@code true} to process the next interceptor and handle the packet,
* {@code false} to abort processing of the packet
* @throws ActiveMQException
*/
boolean intercept(P packet, RemotingConnection connection) throws ActiveMQException;
}

13
activemq-core-client/src/main/java/org/apache/activemq/api/core/Interceptor.java
View File

@ -17,7 +17,6 @@
package org.apache.activemq.api.core;
import org.apache.activemq.core.protocol.core.Packet;
import org.apache.activemq.spi.core.protocol.RemotingConnection;
/**
* This is class is a simple way to intercepting calls on ActiveMQ client and servers.
@ -26,16 +25,6 @@ import org.apache.activemq.spi.core.protocol.RemotingConnection;
* {@literal activemq-configuration.xml}.<br>
* To add it to a client, use {@link org.apache.activemq.api.core.client.ServerLocator#addIncomingInterceptor(Interceptor)}
*/
public interface Interceptor
public interface Interceptor extends BaseInterceptor<Packet>
{
/**
* Intercepts a packet which is received before it is sent to the channel
*
* @param packet the packet being received
* @param connection the connection the packet was received on
* @return {@code true} to process the next interceptor and handle the packet,
* {@code false} to abort processing of the packet
* @throws ActiveMQException
*/
boolean intercept(Packet packet, RemotingConnection connection) throws ActiveMQException;
}

24
activemq-protocols/activemq-amqp-protocol/src/main/java/org/apache/activemq/core/protocol/proton/ProtonProtocolManager.java
View File

@ -16,10 +16,13 @@
*/
package org.apache.activemq.core.protocol.proton;
import java.util.List;
import java.util.concurrent.Executor;
import io.netty.channel.ChannelPipeline;
import org.apache.activemq.api.core.ActiveMQBuffer;
import org.apache.activemq.api.core.BaseInterceptor;
import org.apache.activemq.api.core.Interceptor;
import org.apache.activemq.api.core.client.ActiveMQClient;
import org.apache.activemq.core.protocol.proton.converter.ProtonMessageConverter;
import org.apache.activemq.core.protocol.proton.plug.ActiveMQProtonConnectionCallback;
@ -30,6 +33,7 @@ import org.apache.activemq.core.server.management.NotificationListener;
import org.apache.activemq.spi.core.protocol.ConnectionEntry;
import org.apache.activemq.spi.core.protocol.MessageConverter;
import org.apache.activemq.spi.core.protocol.ProtocolManager;
import org.apache.activemq.spi.core.protocol.ProtocolManagerFactory;
import org.apache.activemq.spi.core.protocol.RemotingConnection;
import org.apache.activemq.spi.core.remoting.Acceptor;
import org.apache.activemq.spi.core.remoting.Connection;
@ -39,14 +43,18 @@ import org.proton.plug.context.server.ProtonServerConnectionContextFactory;
/**
* A proton protocol manager, basically reads the Proton Input and maps proton resources to ActiveMQ resources
*/
public class ProtonProtocolManager implements ProtocolManager, NotificationListener
public class ProtonProtocolManager implements ProtocolManager<Interceptor>, NotificationListener
{
private final ActiveMQServer server;
private MessageConverter protonConverter;
public ProtonProtocolManager(ActiveMQServer server)
private final ProtonProtocolManagerFactory factory;
public ProtonProtocolManager(ProtonProtocolManagerFactory factory, ActiveMQServer server)
{
this.factory = factory;
this.server = server;
this.protonConverter = new ProtonMessageConverter(server.getStorageManager());
}
@ -69,6 +77,18 @@ public class ProtonProtocolManager implements ProtocolManager, NotificationListe
}
@Override
public ProtocolManagerFactory<Interceptor> getFactory()
{
return factory;
}
@Override
public void updateInterceptors(List<BaseInterceptor> incomingInterceptors, List<BaseInterceptor> outgoingInterceptors)
{
// no op
}
@Override
public ConnectionEntry createConnectionEntry(Acceptor acceptorUsed, Connection remotingConnection)
{

15
activemq-protocols/activemq-amqp-protocol/src/main/java/org/apache/activemq/core/protocol/proton/ProtonProtocolManagerFactory.java
View File

@ -16,14 +16,16 @@
*/
package org.apache.activemq.core.protocol.proton;
import org.apache.activemq.api.core.BaseInterceptor;
import org.apache.activemq.api.core.Interceptor;
import org.apache.activemq.core.server.ActiveMQServer;
import org.apache.activemq.spi.core.protocol.AbstractProtocolManagerFactory;
import org.apache.activemq.spi.core.protocol.ProtocolManager;
import org.apache.activemq.spi.core.protocol.ProtocolManagerFactory;
import java.util.Collections;
import java.util.List;
public class ProtonProtocolManagerFactory implements ProtocolManagerFactory
public class ProtonProtocolManagerFactory extends AbstractProtocolManagerFactory<Interceptor>
{
private static final String AMQP_PROTOCOL_NAME = "AMQP";
@ -32,7 +34,14 @@ public class ProtonProtocolManagerFactory implements ProtocolManagerFactory
@Override
public ProtocolManager createProtocolManager(ActiveMQServer server, List<Interceptor> incomingInterceptors, List<Interceptor> outgoingInterceptors)
{
return new ProtonProtocolManager(server);
return new ProtonProtocolManager(this, server);
}
@Override
public List<Interceptor> filterInterceptors(List<BaseInterceptor> interceptors)
{
// no interceptors on Proton
return Collections.emptyList();
}
@Override

47
activemq-protocols/activemq-openwire-protocol/src/main/java/org/apache/activemq/core/protocol/openwire/OpenWireProtocolManager.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.activemq.core.protocol.openwire;
import javax.jms.InvalidClientIDException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
@ -27,12 +28,12 @@ import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.CopyOnWriteArrayList;
import javax.jms.InvalidClientIDException;
import io.netty.channel.ChannelPipeline;
import org.apache.activemq.advisory.AdvisorySupport;
import org.apache.activemq.api.core.ActiveMQBuffer;
import org.apache.activemq.api.core.BaseInterceptor;
import org.apache.activemq.api.core.Interceptor;
import org.apache.activemq.api.core.SimpleString;
import org.apache.activemq.command.ActiveMQDestination;
import org.apache.activemq.command.ActiveMQMessage;
import org.apache.activemq.command.ActiveMQTopic;
@ -54,16 +55,6 @@ import org.apache.activemq.command.TransactionId;
import org.apache.activemq.command.TransactionInfo;
import org.apache.activemq.command.WireFormatInfo;
import org.apache.activemq.command.XATransactionId;
import org.apache.activemq.core.server.ActiveMQServerLogger;
import org.apache.activemq.openwire.OpenWireFormat;
import org.apache.activemq.openwire.OpenWireFormatFactory;
import org.apache.activemq.state.ConnectionState;
import org.apache.activemq.state.ProducerState;
import org.apache.activemq.state.SessionState;
import org.apache.activemq.util.IdGenerator;
import org.apache.activemq.util.InetAddressUtil;
import org.apache.activemq.util.LongSequenceGenerator;
import org.apache.activemq.api.core.SimpleString;
import org.apache.activemq.core.journal.IOAsyncTask;
import org.apache.activemq.core.protocol.openwire.amq.AMQConnectionContext;
import org.apache.activemq.core.protocol.openwire.amq.AMQPersistenceAdapter;
@ -74,16 +65,26 @@ import org.apache.activemq.core.protocol.openwire.amq.AMQTransportConnectionStat
import org.apache.activemq.core.remoting.impl.netty.NettyServerConnection;
import org.apache.activemq.core.security.CheckType;
import org.apache.activemq.core.server.ActiveMQServer;
import org.apache.activemq.core.server.ActiveMQServerLogger;
import org.apache.activemq.core.server.impl.ActiveMQServerImpl;
import org.apache.activemq.openwire.OpenWireFormat;
import org.apache.activemq.openwire.OpenWireFormatFactory;
import org.apache.activemq.spi.core.protocol.ConnectionEntry;
import org.apache.activemq.spi.core.protocol.MessageConverter;
import org.apache.activemq.spi.core.protocol.ProtocolManager;
import org.apache.activemq.spi.core.protocol.ProtocolManagerFactory;
import org.apache.activemq.spi.core.protocol.RemotingConnection;
import org.apache.activemq.spi.core.remoting.Acceptor;
import org.apache.activemq.spi.core.remoting.Connection;
import org.apache.activemq.spi.core.security.ActiveMQSecurityManager;
import org.apache.activemq.state.ConnectionState;
import org.apache.activemq.state.ProducerState;
import org.apache.activemq.state.SessionState;
import org.apache.activemq.util.IdGenerator;
import org.apache.activemq.util.InetAddressUtil;
import org.apache.activemq.util.LongSequenceGenerator;
public class OpenWireProtocolManager implements ProtocolManager
public class OpenWireProtocolManager implements ProtocolManager<Interceptor>
{
private static final IdGenerator BROKER_ID_GENERATOR = new IdGenerator();
private static final IdGenerator ID_GENERATOR = new IdGenerator();
@ -91,6 +92,8 @@ public class OpenWireProtocolManager implements ProtocolManager
private final LongSequenceGenerator messageIdGenerator = new LongSequenceGenerator();
private final ActiveMQServer server;
private final OpenWireProtocolManagerFactory factory;
private OpenWireFormatFactory wireFactory;
private boolean tightEncodingEnabled = true;
@ -118,8 +121,9 @@ public class OpenWireProtocolManager implements ProtocolManager
private Map<TransactionId, AMQSession> transactions = new ConcurrentHashMap<TransactionId, AMQSession>();
public OpenWireProtocolManager(ActiveMQServer server)
public OpenWireProtocolManager(OpenWireProtocolManagerFactory factory, ActiveMQServer server)
{
this.factory = factory;
this.server = server;
this.wireFactory = new OpenWireFormatFactory();
// preferred prop, should be done via config
@ -128,6 +132,19 @@ public class OpenWireProtocolManager implements ProtocolManager
advisoryProducerId.setConnectionId(ID_GENERATOR.generateId());
}
public ProtocolManagerFactory<Interceptor> getFactory()
{
return factory;
}
@Override
public void updateInterceptors(List<BaseInterceptor> incomingInterceptors, List<BaseInterceptor> outgoingInterceptors)
{
// NO-OP
}
@Override
public ConnectionEntry createConnectionEntry(Acceptor acceptorUsed,
Connection connection)

14
activemq-protocols/activemq-openwire-protocol/src/main/java/org/apache/activemq/core/protocol/openwire/OpenWireProtocolManagerFactory.java
View File

@ -16,14 +16,16 @@
*/
package org.apache.activemq.core.protocol.openwire;
import java.util.Collections;
import java.util.List;
import org.apache.activemq.api.core.BaseInterceptor;
import org.apache.activemq.api.core.Interceptor;
import org.apache.activemq.core.server.ActiveMQServer;
import org.apache.activemq.spi.core.protocol.AbstractProtocolManagerFactory;
import org.apache.activemq.spi.core.protocol.ProtocolManager;
import org.apache.activemq.spi.core.protocol.ProtocolManagerFactory;
public class OpenWireProtocolManagerFactory implements ProtocolManagerFactory
public class OpenWireProtocolManagerFactory extends AbstractProtocolManagerFactory<Interceptor>
{
public static final String OPENWIRE_PROTOCOL_NAME = "OPENWIRE";
@ -31,7 +33,13 @@ public class OpenWireProtocolManagerFactory implements ProtocolManagerFactory
public ProtocolManager createProtocolManager(final ActiveMQServer server, final List<Interceptor> incomingInterceptors, List<Interceptor> outgoingInterceptors)
{
return new OpenWireProtocolManager(server);
return new OpenWireProtocolManager(this, server);
}
@Override
public List<Interceptor> filterInterceptors(List<BaseInterceptor> interceptors)
{
return Collections.emptyList();
}
@Override

33
activemq-protocols/activemq-stomp-protocol/src/main/java/org/apache/activemq/core/protocol/stomp/StompFrameInterceptor.java
View File

@ -16,10 +16,7 @@
*/
package org.apache.activemq.core.protocol.stomp;
import org.apache.activemq.api.core.ActiveMQException;
import org.apache.activemq.api.core.Interceptor;
import org.apache.activemq.core.protocol.core.Packet;
import org.apache.activemq.spi.core.protocol.RemotingConnection;
import org.apache.activemq.api.core.BaseInterceptor;
/**
* This class is a simple way to intercepting client calls on ActiveMQ using STOMP protocol.
@ -27,32 +24,6 @@ import org.apache.activemq.spi.core.protocol.RemotingConnection;
* To add an interceptor to ActiveMQ server, you have to modify the server configuration file
* {@literal activemq-configuration.xml}.<br>
*/
public abstract class StompFrameInterceptor implements Interceptor
public interface StompFrameInterceptor extends BaseInterceptor<StompFrame>
{
/**
* Intercepts a packet which is received before it is sent to the channel.
* By default does not do anything and returns true allowing other interceptors perform logic.
*
* @param packet the packet being received
* @param connection the connection the packet was received on
* @return {@code true} to process the next interceptor and handle the packet,
* {@code false} to abort processing of the packet
* @throws ActiveMQException
*/
@Override
public boolean intercept(Packet packet, RemotingConnection connection) throws ActiveMQException
{
return true;
}
/**
* Intercepts a stomp frame sent by a client.
*
* @param stompFrame the stomp frame being received
* @param connection the connection the stomp frame was received on
* @return {@code true} to process the next interceptor and handle the stomp frame,
* {@code false} to abort processing of the stomp frame
*/
public abstract boolean intercept(StompFrame stompFrame, RemotingConnection connection);
}

40
activemq-protocols/activemq-stomp-protocol/src/main/java/org/apache/activemq/core/protocol/stomp/StompProtocolManager.java
View File

@ -26,10 +26,9 @@ import java.util.Set;
import java.util.concurrent.Executor;
import io.netty.channel.ChannelPipeline;
import org.apache.activemq.api.core.ActiveMQBuffer;
import org.apache.activemq.api.core.ActiveMQExceptionType;
import org.apache.activemq.api.core.Interceptor;
import org.apache.activemq.api.core.BaseInterceptor;
import org.apache.activemq.api.core.SimpleString;
import org.apache.activemq.api.core.client.ActiveMQClient;
import org.apache.activemq.api.core.management.CoreNotificationType;
@ -49,6 +48,7 @@ import org.apache.activemq.core.server.management.NotificationListener;
import org.apache.activemq.spi.core.protocol.ConnectionEntry;
import org.apache.activemq.spi.core.protocol.MessageConverter;
import org.apache.activemq.spi.core.protocol.ProtocolManager;
import org.apache.activemq.spi.core.protocol.ProtocolManagerFactory;
import org.apache.activemq.spi.core.protocol.RemotingConnection;
import org.apache.activemq.spi.core.remoting.Acceptor;
import org.apache.activemq.spi.core.remoting.Connection;
@ -62,7 +62,7 @@ import static org.apache.activemq.core.protocol.stomp.ActiveMQStompProtocolMessa
/**
* StompProtocolManager
*/
class StompProtocolManager implements ProtocolManager, NotificationListener
class StompProtocolManager implements ProtocolManager<StompFrameInterceptor>, NotificationListener
{
// Constants -----------------------------------------------------
@ -70,6 +70,8 @@ class StompProtocolManager implements ProtocolManager, NotificationListener
private final ActiveMQServer server;
private final StompProtocolManagerFactory factory;
private final Executor executor;
private final Map<String, StompSession> transactedSessions = new HashMap<String, StompSession>();
@ -79,15 +81,16 @@ class StompProtocolManager implements ProtocolManager, NotificationListener
private final Set<String> destinations = new ConcurrentHashSet<String>();
private final List<Interceptor> incomingInterceptors;
private final List<Interceptor> outgoingInterceptors;
private final List<StompFrameInterceptor> incomingInterceptors;
private final List<StompFrameInterceptor> outgoingInterceptors;
// Static --------------------------------------------------------
// Constructors --------------------------------------------------
public StompProtocolManager(final ActiveMQServer server, final List<Interceptor> incomingInterceptors, final List<Interceptor> outgoingInterceptors)
public StompProtocolManager(final StompProtocolManagerFactory factory, final ActiveMQServer server, final List<StompFrameInterceptor> incomingInterceptors, final List<StompFrameInterceptor> outgoingInterceptors)
{
this.factory = factory;
this.server = server;
this.executor = server.getExecutorFactory().getExecutor();
ManagementService service = server.getManagementService();
@ -101,6 +104,22 @@ class StompProtocolManager implements ProtocolManager, NotificationListener
this.outgoingInterceptors = outgoingInterceptors;
}
@Override
public ProtocolManagerFactory<StompFrameInterceptor> getFactory()
{
return factory;
}
@Override
public void updateInterceptors(List<BaseInterceptor> incoming, List<BaseInterceptor> outgoing)
{
this.incomingInterceptors.clear();
this.incomingInterceptors.addAll(getFactory().filterInterceptors(incoming));
this.outgoingInterceptors.clear();
this.outgoingInterceptors.addAll(getFactory().filterInterceptors(outgoing));
}
@Override
public MessageConverter getConverter()
{
@ -514,17 +533,15 @@ class StompProtocolManager implements ProtocolManager, NotificationListener
return server;
}
private void invokeInterceptors(List<Interceptor> interceptors, final StompFrame frame, final StompConnection connection)
private void invokeInterceptors(List<StompFrameInterceptor> interceptors, final StompFrame frame, final StompConnection connection)
{
if (interceptors != null && !interceptors.isEmpty())
{
for (Interceptor interceptor : interceptors)
{
if (interceptor instanceof StompFrameInterceptor)
for (StompFrameInterceptor interceptor : interceptors)
{
try
{
if (!((StompFrameInterceptor)interceptor).intercept(frame, connection))
if (!interceptor.intercept(frame, connection))
{
break;
}
@ -537,4 +554,3 @@ class StompProtocolManager implements ProtocolManager, NotificationListener
}
}
}
}

16
activemq-protocols/activemq-stomp-protocol/src/main/java/org/apache/activemq/core/protocol/stomp/StompProtocolManagerFactory.java
View File

@ -18,20 +18,26 @@ package org.apache.activemq.core.protocol.stomp;
import java.util.List;
import org.apache.activemq.api.core.Interceptor;
import org.apache.activemq.api.core.BaseInterceptor;
import org.apache.activemq.core.server.ActiveMQServer;
import org.apache.activemq.spi.core.protocol.AbstractProtocolManagerFactory;
import org.apache.activemq.spi.core.protocol.ProtocolManager;
import org.apache.activemq.spi.core.protocol.ProtocolManagerFactory;
public class StompProtocolManagerFactory implements ProtocolManagerFactory
public class StompProtocolManagerFactory extends AbstractProtocolManagerFactory<StompFrameInterceptor>
{
public static final String STOMP_PROTOCOL_NAME = "STOMP";
private static String[] SUPPORTED_PROTOCOLS = {STOMP_PROTOCOL_NAME};
public ProtocolManager createProtocolManager(final ActiveMQServer server, final List<Interceptor> incomingInterceptors, List<Interceptor> outgoingInterceptors)
public ProtocolManager createProtocolManager(final ActiveMQServer server, final List<StompFrameInterceptor> incomingInterceptors, List<StompFrameInterceptor> outgoingInterceptors)
{
return new StompProtocolManager(server, incomingInterceptors, outgoingInterceptors);
return new StompProtocolManager(this, server, incomingInterceptors, outgoingInterceptors);
}
@Override
public List<StompFrameInterceptor> filterInterceptors(List<BaseInterceptor> interceptors)
{
return filterInterceptors(StompFrameInterceptor.class, interceptors);
}
@Override

30
activemq-server/src/main/java/org/apache/activemq/core/protocol/core/impl/CoreProtocolManager.java
View File

@ -25,11 +25,12 @@ import java.util.concurrent.RejectedExecutionException;
import io.netty.channel.ChannelPipeline;
import org.apache.activemq.api.core.ActiveMQBuffer;
import org.apache.activemq.api.core.BaseInterceptor;
import org.apache.activemq.api.core.Interceptor;
import org.apache.activemq.api.core.Pair;
import org.apache.activemq.api.core.TransportConfiguration;
import org.apache.activemq.api.core.client.ClusterTopologyListener;
import org.apache.activemq.api.core.client.ActiveMQClient;
import org.apache.activemq.api.core.client.ClusterTopologyListener;
import org.apache.activemq.api.core.client.TopologyMember;
import org.apache.activemq.core.config.Configuration;
import org.apache.activemq.core.protocol.ServerPacketDecoder;
@ -53,11 +54,12 @@ import org.apache.activemq.core.server.ActiveMQServerLogger;
import org.apache.activemq.spi.core.protocol.ConnectionEntry;
import org.apache.activemq.spi.core.protocol.MessageConverter;
import org.apache.activemq.spi.core.protocol.ProtocolManager;
import org.apache.activemq.spi.core.protocol.ProtocolManagerFactory;
import org.apache.activemq.spi.core.protocol.RemotingConnection;
import org.apache.activemq.spi.core.remoting.Acceptor;
import org.apache.activemq.spi.core.remoting.Connection;
class CoreProtocolManager implements ProtocolManager
class CoreProtocolManager implements ProtocolManager<Interceptor>
{
private static final boolean isTrace = ActiveMQServerLogger.LOGGER.isTraceEnabled();
@ -67,8 +69,12 @@ class CoreProtocolManager implements ProtocolManager
private final List<Interceptor> outgoingInterceptors;
CoreProtocolManager(final ActiveMQServer server, final List<Interceptor> incomingInterceptors, List<Interceptor> outgoingInterceptors)
private final CoreProtocolManagerFactory protocolManagerFactory;
CoreProtocolManager(final CoreProtocolManagerFactory factory, final ActiveMQServer server, final List<Interceptor> incomingInterceptors, List<Interceptor> outgoingInterceptors)
{
this.protocolManagerFactory = factory;
this.server = server;
this.incomingInterceptors = incomingInterceptors;
@ -76,8 +82,26 @@ class CoreProtocolManager implements ProtocolManager
this.outgoingInterceptors = outgoingInterceptors;
}
@Override
public ProtocolManagerFactory<Interceptor> getFactory()
{
return protocolManagerFactory;
}
@Override
public void updateInterceptors(List<BaseInterceptor> incoming, List<BaseInterceptor> outgoing)
{
this.incomingInterceptors.clear();
this.incomingInterceptors.addAll(getFactory().filterInterceptors(incoming));
this.outgoingInterceptors.clear();
this.outgoingInterceptors.addAll(getFactory().filterInterceptors(outgoing));
}
/**
* no need to implement this now
*
* @return
*/
@Override

23
activemq-server/src/main/java/org/apache/activemq/core/protocol/core/impl/CoreProtocolManagerFactory.java
View File

@ -18,19 +18,36 @@ package org.apache.activemq.core.protocol.core.impl;
import java.util.List;
import org.apache.activemq.api.core.BaseInterceptor;
import org.apache.activemq.api.core.Interceptor;
import org.apache.activemq.api.core.client.ActiveMQClient;
import org.apache.activemq.core.server.ActiveMQServer;
import org.apache.activemq.spi.core.protocol.AbstractProtocolManagerFactory;
import org.apache.activemq.spi.core.protocol.ProtocolManager;
import org.apache.activemq.spi.core.protocol.ProtocolManagerFactory;
public class CoreProtocolManagerFactory implements ProtocolManagerFactory
public class CoreProtocolManagerFactory extends AbstractProtocolManagerFactory<Interceptor>
{
private static String[] SUPPORTED_PROTOCOLS = {ActiveMQClient.DEFAULT_CORE_PROTOCOL};
/**
* {@inheritDoc} *
* @param server
* @param incomingInterceptors
* @param outgoingInterceptors
* @return
*/
public ProtocolManager createProtocolManager(final ActiveMQServer server, final List<Interceptor> incomingInterceptors, List<Interceptor> outgoingInterceptors)
{
return new CoreProtocolManager(server, incomingInterceptors, outgoingInterceptors);
return new CoreProtocolManager(this, server, incomingInterceptors, outgoingInterceptors);
}
@Override
public List<Interceptor> filterInterceptors(List<BaseInterceptor> interceptors)
{
// This is using this tool method
// it wouldn't be possible to write a generic method without this class parameter
// and I didn't want to bloat the cllaers for this
return filterInterceptors(Interceptor.class, interceptors);
}
@Override

51
activemq-server/src/main/java/org/apache/activemq/core/remoting/server/impl/RemotingServiceImpl.java
View File

@ -38,6 +38,7 @@ import java.util.concurrent.TimeUnit;
import org.apache.activemq.api.core.ActiveMQBuffer;
import org.apache.activemq.api.core.ActiveMQException;
import org.apache.activemq.api.core.ActiveMQInterruptedException;
import org.apache.activemq.api.core.BaseInterceptor;
import org.apache.activemq.api.core.Interceptor;
import org.apache.activemq.api.core.TransportConfiguration;
import org.apache.activemq.core.config.Configuration;
@ -53,8 +54,8 @@ import org.apache.activemq.core.server.ActiveMQServer;
import org.apache.activemq.core.server.ActiveMQServerLogger;
import org.apache.activemq.core.server.cluster.ClusterConnection;
import org.apache.activemq.core.server.cluster.ClusterManager;
import org.apache.activemq.core.server.impl.ServiceRegistry;
import org.apache.activemq.core.server.impl.ServerSessionImpl;
import org.apache.activemq.core.server.impl.ServiceRegistry;
import org.apache.activemq.core.server.management.ManagementService;
import org.apache.activemq.spi.core.protocol.ConnectionEntry;
import org.apache.activemq.spi.core.protocol.ProtocolManager;
@ -65,9 +66,9 @@ import org.apache.activemq.spi.core.remoting.AcceptorFactory;
import org.apache.activemq.spi.core.remoting.BufferHandler;
import org.apache.activemq.spi.core.remoting.Connection;
import org.apache.activemq.spi.core.remoting.ConnectionLifeCycleListener;
import org.apache.activemq.utils.ActiveMQThreadFactory;
import org.apache.activemq.utils.ClassloadingUtil;
import org.apache.activemq.utils.ConfigurationHelper;
import org.apache.activemq.utils.ActiveMQThreadFactory;
import org.apache.activemq.utils.ReusableLatch;
public class RemotingServiceImpl implements RemotingService, ConnectionLifeCycleListener
@ -84,9 +85,9 @@ public class RemotingServiceImpl implements RemotingService, ConnectionLifeCycle
private final Set<TransportConfiguration> acceptorsConfig;
private final List<Interceptor> incomingInterceptors = new CopyOnWriteArrayList<Interceptor>();
private final List<BaseInterceptor> incomingInterceptors = new CopyOnWriteArrayList<>();
private final List<Interceptor> outgoingInterceptors = new CopyOnWriteArrayList<Interceptor>();
private final List<BaseInterceptor> outgoingInterceptors = new CopyOnWriteArrayList<>();
private final Map<String, Acceptor> acceptors = new HashMap<String, Acceptor>();
@ -147,7 +148,8 @@ public class RemotingServiceImpl implements RemotingService, ConnectionLifeCycle
ActiveMQServerLogger.LOGGER.addingProtocolSupport(coreProtocolManagerFactory.getProtocols()[0]);
this.protocolMap.put(coreProtocolManagerFactory.getProtocols()[0],
coreProtocolManagerFactory.createProtocolManager(server, incomingInterceptors, outgoingInterceptors));
coreProtocolManagerFactory.createProtocolManager(server, coreProtocolManagerFactory.filterInterceptors(incomingInterceptors),
coreProtocolManagerFactory.filterInterceptors(outgoingInterceptors)));
if (config.isResolveProtocols())
{
@ -160,7 +162,8 @@ public class RemotingServiceImpl implements RemotingService, ConnectionLifeCycle
for (String protocol : protocols)
{
ActiveMQServerLogger.LOGGER.addingProtocolSupport(protocol);
protocolMap.put(protocol, next.createProtocolManager(server, incomingInterceptors, outgoingInterceptors));
protocolMap.put(protocol, next.createProtocolManager(server, next.filterInterceptors(incomingInterceptors),
next.filterInterceptors(outgoingInterceptors)));
}
}
}
@ -190,11 +193,11 @@ public class RemotingServiceImpl implements RemotingService, ConnectionLifeCycle
outgoingInterceptors.addAll(serviceRegistry.getOutgoingInterceptors());
}
private void addReflectivelyInstantiatedInterceptors(List<String> classNames, List<Interceptor> interceptors)
private void addReflectivelyInstantiatedInterceptors(List<String> classNames, List<BaseInterceptor> interceptors)
{
for (String className : classNames)
{
Interceptor interceptor = ((Interceptor) safeInitNewInstance(className));
BaseInterceptor interceptor = ((BaseInterceptor) safeInitNewInstance(className));
interceptors.add(interceptor);
}
}
@ -620,24 +623,43 @@ public class RemotingServiceImpl implements RemotingService, ConnectionLifeCycle
public void addIncomingInterceptor(final Interceptor interceptor)
{
incomingInterceptors.add(interceptor);
updateProtocols();
}
@Override
public boolean removeIncomingInterceptor(final Interceptor interceptor)
{
return incomingInterceptors.remove(interceptor);
if (incomingInterceptors.remove(interceptor))
{
updateProtocols();
return true;
}
else
{
return false;
}
}
@Override
public void addOutgoingInterceptor(final Interceptor interceptor)
{
outgoingInterceptors.add(interceptor);
updateProtocols();
}
@Override
public boolean removeOutgoingInterceptor(final Interceptor interceptor)
{
return outgoingInterceptors.remove(interceptor);
if (outgoingInterceptors.remove(interceptor))
{
updateProtocols();
return true;
}
else
{
return false;
}
}
private ClusterConnection lookupClusterConnection(TransportConfiguration acceptorConfig)
@ -803,4 +825,13 @@ public class RemotingServiceImpl implements RemotingService, ConnectionLifeCycle
});
}
protected void updateProtocols()
{
for (ProtocolManager<?> protocolManager : this.protocolMap.values())
{
protocolManager.updateInterceptors(incomingInterceptors, outgoingInterceptors);
}
}
}

57
activemq-server/src/main/java/org/apache/activemq/spi/core/protocol/AbstractProtocolManagerFactory.java Normal file
View File

@ -0,0 +1,57 @@
/**
* 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.spi.core.protocol;
import java.util.Collections;
import java.util.List;
import java.util.concurrent.CopyOnWriteArrayList;
import org.apache.activemq.api.core.BaseInterceptor;
public abstract class AbstractProtocolManagerFactory<P extends BaseInterceptor> implements ProtocolManagerFactory<P>
{
/**
* This method exists because java templates won't store the type of P at runtime.
* So it's not possible to write a generic method with having the Class Type.
* This will serve as a tool for sub classes to filter properly* * *
*
* @param type
* @param listIn
* @return
*/
protected List<P> filterInterceptors(Class<P> type, List<? extends BaseInterceptor> listIn)
{
if (listIn == null)
{
return Collections.emptyList();
}
else
{
CopyOnWriteArrayList<P> listOut = new CopyOnWriteArrayList();
for (BaseInterceptor<?> in : listIn)
{
if (type.isInstance(in))
{
listOut.add((P) in);
}
}
return listOut;
}
}
}

16
activemq-server/src/main/java/org/apache/activemq/spi/core/protocol/ProtocolManager.java
View File

@ -16,14 +16,27 @@
*/
package org.apache.activemq.spi.core.protocol;
import java.util.List;
import io.netty.channel.ChannelPipeline;
import org.apache.activemq.api.core.ActiveMQBuffer;
import org.apache.activemq.api.core.BaseInterceptor;
import org.apache.activemq.core.remoting.impl.netty.NettyServerConnection;
import org.apache.activemq.spi.core.remoting.Acceptor;
import org.apache.activemq.spi.core.remoting.Connection;
public interface ProtocolManager
public interface ProtocolManager<P extends BaseInterceptor>
{
ProtocolManagerFactory<P> getFactory();
/**
* This method will receive all the interceptors on the system and you should filter them out *
*
* @param incomingInterceptors
* @param outgoingInterceptors
*/
void updateInterceptors(List<BaseInterceptor> incomingInterceptors, List<BaseInterceptor> outgoingInterceptors);
ConnectionEntry createConnectionEntry(Acceptor acceptorUsed, Connection connection);
void removeHandler(final String name);
@ -37,6 +50,7 @@ public interface ProtocolManager
/**
* Gets the Message Converter towards ActiveMQ.
* Notice this being null means no need to convert
*
* @return
*/
MessageConverter getConverter();

22
activemq-server/src/main/java/org/apache/activemq/spi/core/protocol/ProtocolManagerFactory.java
View File

@ -18,12 +18,28 @@ package org.apache.activemq.spi.core.protocol;
import java.util.List;
import org.apache.activemq.api.core.Interceptor;
import org.apache.activemq.api.core.BaseInterceptor;
import org.apache.activemq.core.server.ActiveMQServer;
public interface ProtocolManagerFactory
public interface ProtocolManagerFactory<P extends BaseInterceptor>
{
ProtocolManager createProtocolManager(ActiveMQServer server, List<Interceptor> incomingInterceptors, List<Interceptor> outgoingInterceptors);
/**
* When you create the ProtocolManager, you should filter out any interceptors that won't belong
* to this Protocol.
* For example don't send any core Interceptors {@link org.apache.activemq.api.core.Interceptor} to Stomp * * *
* @param server
* @param incomingInterceptors
* @param outgoingInterceptors
* @return
*/
ProtocolManager createProtocolManager(ActiveMQServer server, List<P> incomingInterceptors, List<P> outgoingInterceptors);
/**
* This should get the entire list and only return the ones this factory can deal with *
* @param interceptors
* @return
*/
List<P> filterInterceptors(List<BaseInterceptor> interceptors);
String[] getProtocols();
}

4
docs/user-manual/en/intercepting-operations.md
View File

@ -20,12 +20,12 @@ public interface Interceptor
}
```
For stomp protocol an interceptor must extend the `StompFrameInterceptor class`:
For stomp protocol an interceptor must implement the `StompFrameInterceptor class`:
``` java
package org.apache.activemq.core.protocol.stomp;
public abstract class StompFrameInterceptor
public interface StompFrameInterceptor
{
public abstract boolean intercept(StompFrame stompFrame, RemotingConnection connection);
}

68
tests/integration-tests/src/test/java/org/apache/activemq/tests/integration/stomp/ExtraStompTest.java
View File

@ -26,9 +26,11 @@ import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.apache.activemq.api.core.Interceptor;
import org.apache.activemq.api.core.TransportConfiguration;
import org.apache.activemq.api.core.client.ActiveMQClient;
import org.apache.activemq.core.config.Configuration;
import org.apache.activemq.core.protocol.core.Packet;
import org.apache.activemq.core.protocol.stomp.Stomp;
import org.apache.activemq.core.protocol.stomp.StompFrame;
import org.apache.activemq.core.protocol.stomp.StompFrameInterceptor;
@ -820,11 +822,25 @@ public class ExtraStompTest extends StompTestBase
return server;
}
static List<StompFrame> incomingInterceptedFrames = new ArrayList<StompFrame>();
static List<StompFrame> outgoingInterceptedFrames = new ArrayList<StompFrame>();
public static class MyIncomingStompFrameInterceptor extends StompFrameInterceptor
public static class MyCoreInterceptor implements Interceptor
{
static List<Packet> incomingInterceptedFrames = new ArrayList<Packet>();
@Override
public boolean intercept(Packet packet, RemotingConnection connection)
{
incomingInterceptedFrames.add(packet);
return true;
}
}
public static class MyIncomingStompFrameInterceptor implements StompFrameInterceptor
{
static List<StompFrame> incomingInterceptedFrames = new ArrayList<StompFrame>();
@Override
public boolean intercept(StompFrame stompFrame, RemotingConnection connection)
{
@ -834,8 +850,12 @@ public class ExtraStompTest extends StompTestBase
}
}
public static class MyOutgoingStompFrameInterceptor extends StompFrameInterceptor
public static class MyOutgoingStompFrameInterceptor implements StompFrameInterceptor
{
static List<StompFrame> outgoingInterceptedFrames = new ArrayList<StompFrame>();
@Override
public boolean intercept(StompFrame stompFrame, RemotingConnection connection)
{
@ -848,17 +868,23 @@ public class ExtraStompTest extends StompTestBase
@Test
public void stompFrameInterceptor() throws Exception
{
MyIncomingStompFrameInterceptor.incomingInterceptedFrames.clear();
MyOutgoingStompFrameInterceptor.outgoingInterceptedFrames.clear();
try
{
List<String> incomingInterceptorList = new ArrayList<String>();
incomingInterceptorList.add("org.apache.activemq.tests.integration.stomp.ExtraStompTest$MyIncomingStompFrameInterceptor");
incomingInterceptorList.add("org.apache.activemq.tests.integration.stomp.ExtraStompTest$MyCoreInterceptor");
List<String> outgoingInterceptorList = new ArrayList<String>();
outgoingInterceptorList.add("org.apache.activemq.tests.integration.stomp.ExtraStompTest$MyOutgoingStompFrameInterceptor");
server = createServerWithStompInterceptor(incomingInterceptorList, outgoingInterceptorList);
server.start();
setUpAfterServer();
setUpAfterServer(); // This will make some calls through core
// So we clear them here
MyCoreInterceptor.incomingInterceptedFrames.clear();
String frame = "CONNECT\n" + "login: brianm\n" + "passcode: wombats\n\n" + Stomp.NULL;
sendFrame(frame);
@ -868,8 +894,12 @@ public class ExtraStompTest extends StompTestBase
frame = "SUBSCRIBE\n" + "destination:" + getQueuePrefix() + getQueueName() + "\n" + "ack:auto\n\nfff" + Stomp.NULL;
sendFrame(frame);
assertEquals(0, MyCoreInterceptor.incomingInterceptedFrames.size());
sendMessage(getName());
// Something was supposed to be called on sendMessages
assertTrue("core interceptor is not working", MyCoreInterceptor.incomingInterceptedFrames.size() > 0);
receiveFrame(10000);
frame = "SEND\n" + "destination:" +
@ -904,22 +934,32 @@ public class ExtraStompTest extends StompTestBase
outgoingCommands.add("MESSAGE");
outgoingCommands.add("MESSAGE");
Assert.assertEquals(4, incomingInterceptedFrames.size());
Assert.assertEquals(3, outgoingInterceptedFrames.size());
long timeout = System.currentTimeMillis() + 1000;
for (int i = 0; i < incomingInterceptedFrames.size(); i++)
// Things are async, giving some time to things arrive before we actually assert
while (MyIncomingStompFrameInterceptor.incomingInterceptedFrames.size() < 4 &&
MyOutgoingStompFrameInterceptor.outgoingInterceptedFrames.size() < 3 &&
timeout > System.currentTimeMillis())
{
Assert.assertEquals(incomingCommands.get(i), incomingInterceptedFrames.get(i).getCommand());
Assert.assertEquals("incomingInterceptedVal", incomingInterceptedFrames.get(i).getHeader("incomingInterceptedProp"));
Thread.sleep(10);
}
for (int i = 0; i < outgoingInterceptedFrames.size(); i++)
Assert.assertEquals(4, MyIncomingStompFrameInterceptor.incomingInterceptedFrames.size());
Assert.assertEquals(3, MyOutgoingStompFrameInterceptor.outgoingInterceptedFrames.size());
for (int i = 0; i < MyIncomingStompFrameInterceptor.incomingInterceptedFrames.size(); i++)
{
Assert.assertEquals(outgoingCommands.get(i), outgoingInterceptedFrames.get(i).getCommand());
Assert.assertEquals(incomingCommands.get(i), MyIncomingStompFrameInterceptor.incomingInterceptedFrames.get(i).getCommand());
Assert.assertEquals("incomingInterceptedVal", MyIncomingStompFrameInterceptor.incomingInterceptedFrames.get(i).getHeader("incomingInterceptedProp"));
}
Assert.assertEquals("incomingInterceptedVal", outgoingInterceptedFrames.get(2).getHeader("incomingInterceptedProp"));
Assert.assertEquals("outgoingInterceptedVal", outgoingInterceptedFrames.get(2).getHeader("outgoingInterceptedProp"));
for (int i = 0; i < MyOutgoingStompFrameInterceptor.outgoingInterceptedFrames.size(); i++)
{
Assert.assertEquals(outgoingCommands.get(i), MyOutgoingStompFrameInterceptor.outgoingInterceptedFrames.get(i).getCommand());
}
Assert.assertEquals("incomingInterceptedVal", MyOutgoingStompFrameInterceptor.outgoingInterceptedFrames.get(2).getHeader("incomingInterceptedProp"));
Assert.assertEquals("outgoingInterceptedVal", MyOutgoingStompFrameInterceptor.outgoingInterceptedFrames.get(2).getHeader("outgoingInterceptedProp"));
}
protected JMSServerManager createServerWithStompInterceptor(List<String> stompIncomingInterceptor, List<String> stompOutgoingInterceptor) throws Exception

2
tests/integration-tests/src/test/java/org/apache/activemq/tests/integration/stomp/StompTestBase.java
View File

@ -182,10 +182,10 @@ public abstract class StompTestBase extends UnitTestCase
createBootstrap();
connection = connectionFactory.createConnection();
connection.start();
session = connection.createSession(false, Session.AUTO_ACKNOWLEDGE);
queue = session.createQueue(getQueueName());
topic = session.createTopic(getTopicName());
connection.start();
}