8 Upgrading

8.1 From 3.0.X

Both of the managers also now have underlying interfaces that define how a manager should behave. In addition, the objects being managed are now called Contexts, which also have interfaces that define their general behavior. It is the intention that with these changes the plugin becomes more stable with less backwards- compatibility breaking changes being introduced moving forward.

Here are the items authors may need to address when upgrading to this version of the plugin.

• The rabbitContext.getConnection() methods now return the RabbitMQ Connection object instead of the ConnectionContext instance. This was done to make the methods more consistent with the createChannel methods and to encapsulate the ConnectionContext objects inside the manager. The ConnectionContext objects can now be retrieved from the consumerManager bean.
• Many of the methods inside of the ConsumerManager and ConnectionManager have been renamed to adhere to a common interface. This should only affect projects that use these beans directly.
• Some of the methods inside of the RabbitContext have been renamed to match the interface used by the various managers.

Overall, users of the plugin should see no impact if the rabbitContext or any of the other beans are not used in their projects.

If the use of the plugin's beans is limited to the rabbitContext, the impact should be minimal, with some minor changes need to method names and some refactored code if retrieving a ConnectionContext. Users that use the other manager beans will need to account for the changed interface implemented by those beans.

8.2 From 2.0.X

Below are the changes that were made, at a high level:

• RabbitMessageBuilder is deprecated. The class still exists and its interface is the same, however, the code in the class has been ripped out and now proxies requests to the rabbitMessagePublisher bean. The builder will be removed at some point in the near future.
• RabbitContext used to contain a significant amount of code related to management of message converters, consumers, and connections. That functionality has been broken out into their own respective classes. The RabbitContext now serves only as a class to aggregate functionality useful to users of the plugin, and should still be used to simplify interfacing with the plugin rather than using the underlying beans directly.
• Introduced the rabbitMessagePublisher as a replacement for the RabbitMessageBuilder. This bean can be injected into other spring managed beans, such as services, controllers, and rabbit consumers. Its functionality follows the builder closely, and users may send messages based on configurations made through closures or through the new RabbitMessageProperties object. The short-hand convenience methods are still available as well.
• Introduced the messageConverterManager bean to handle all operations pertaining to message converters.
• Introduced the consumerManager bean to handle all operations pertaining to message consumers.
• Introduced the connectionManager bean to handle all operations pertaining to RabbitMQ connections and channels.
• Introduced the queueBuilder bean to handle creating configured exchanges and queues.
• The MessageContext class has been moved into a new package: com.budjb.rabbitmq.consumer.
• The AutoAck enum has been moved into a new package: com.budjb.rabbitmq.consumer.
• The ConsumerConfiguration class has been moved into a new package: com.budjb.rabbitmq.consumer.
• The MessageConvertMethod class has been moved into a new package: com.budjb.rabbitmq.consumer.
• The ConnectionContext class has been moved into a new package: com.budjb.rabbitmq.connection.
• The ConnectionConfiguration class has been moved into a new package: com.budjb.rabbitmq.connection.
• The MessageConverter abstract class has been moved into a new package: com.budjb.rabbitmq.converter.
• All of the bundles message converters have been moved into a new package: com.budjb.rabbitmq.converter.
• The RabbitMessageBuilder class has been moved into a new package: com.budjb.rabbitmq.publisher.
• A large amount of unit tests and some integration tests have been added to the project. These tests rely on the Spock mocking framework, but the test files and dependencies are not exported with the plugin so that a new plugin dependency on Spock is not created.
• The closures used for publishing messages have had their resolving strategy changed from OWNER_FIRST to DELEGATE_FIRST. This should not have much of an impact, but in some cases closures may need to explicity qualify some properties in the closures with delegate.