Skip to main content

Migrates from Netty 3.2.x to Netty 4.1.x

org.openrewrite.netty.UpgradeNetty_3_2_to_4_1

Migrate applications to the latest Netty 4.1.x release.

Tags​

Recipe source​

GitHub: netty-3_2_to_4_1.yml, Issue Tracker, Maven Central

info

This recipe is composed of more than one recipe. If you want to customize the set of recipes this is composed of, you can find and copy the GitHub source for the recipe from the link above.

This recipe is available under the Apache License Version 2.0.

Definition​

  • Change method name
    • methodPattern: *..* channelOpen(org.jboss.netty.channel.ChannelHandlerContext, org.jboss.netty.channel.ChannelStateEvent)
    • newMethodName: channelActive
  • Change method name
    • methodPattern: *..* channelClosed(org.jboss.netty.channel.ChannelHandlerContext, org.jboss.netty.channel.ChannelStateEvent)
    • newMethodName: channelInactive
  • Change method name
    • methodPattern: *..* messageReceived(org.jboss.netty.channel.ChannelHandlerContext, org.jboss.netty.channel.MessageEvent)
    • newMethodName: channelRead
  • Change parameter type for a method declaration
    • methodPattern: *..* channelRead(org.jboss.netty.channel.ChannelHandlerContext, org.jboss.netty.channel.MessageEvent)
    • parameterType: java.lang.Object
    • parameterIndex: 1
  • Change method name
    • methodPattern: org.jboss.netty.channel.ChannelHandlerContext getChannel()
    • newMethodName: channel
  • Change method name
    • methodPattern: org.jboss.netty.channel.ChannelHandlerContext getPipeline()
    • newMethodName: pipeline
  • Change method name
    • methodPattern: org.jboss.netty.channel.Channel getPipeline()
    • newMethodName: pipeline
  • Change method name
    • methodPattern: org.jboss.netty.channel.Channel isConnected()
    • newMethodName: isActive
  • Change method name
    • methodPattern: org.jboss.netty.channel.Channel getLocalAddress()
    • newMethodName: localAddress
  • Change method name
    • methodPattern: org.jboss.netty.channel.Channel getRemoteAddress()
    • newMethodName: remoteAddress
  • Change method name
    • methodPattern: org.jboss.netty.channel.Channel getCloseFuture()
    • newMethodName: closeFuture
  • Change method name
    • methodPattern: org.jboss.netty.channel.ChannelFuture getChannel()
    • newMethodName: channel
  • Change method name
    • methodPattern: org.jboss.netty.channel.ChannelFuture getCause()
    • newMethodName: cause
  • Remove ChannelStateEvent parameter from handler methods
  • Migrate Channel.setReadable(boolean) to Channel.config().setAutoRead(boolean)
  • Replace annotation
    • annotationPatternToReplace: @org.jboss.netty.channel.ChannelPipelineCoverage(org.jboss.netty.channel.ChannelPipelineCoverage.ONE)
    • annotationTemplateToInsert: @io.netty.channel.ChannelHandler.Sharable
    • classpathResourceName: netty-transport
  • Change type
    • oldFullyQualifiedTypeName: org.jboss.netty.channel.SimpleChannelHandler
    • newFullyQualifiedTypeName: io.netty.channel.ChannelInboundHandlerAdapter
  • Change type
    • oldFullyQualifiedTypeName: org.jboss.netty.channel.SimpleChannelUpstreamHandler
    • newFullyQualifiedTypeName: io.netty.channel.ChannelInboundHandlerAdapter
  • Change type
    • oldFullyQualifiedTypeName: org.jboss.netty.handler.codec.frame.CorruptedFrameException
    • newFullyQualifiedTypeName: io.netty.handler.codec.CorruptedFrameException
  • Change type
    • oldFullyQualifiedTypeName: org.jboss.netty.buffer.ChannelBuffer
    • newFullyQualifiedTypeName: io.netty.buffer.ByteBuf
  • Change type
    • oldFullyQualifiedTypeName: org.jboss.netty.buffer.ChannelBuffers
    • newFullyQualifiedTypeName: io.netty.buffer.Unpooled
  • Change type
    • oldFullyQualifiedTypeName: org.jboss.netty.channel.ExceptionEvent
    • newFullyQualifiedTypeName: java.lang.Throwable
  • Change type
    • oldFullyQualifiedTypeName: org.jboss.netty.handler.codec.oneone.OneToOneDecoder
    • newFullyQualifiedTypeName: io.netty.handler.codec.MessageToMessageDecoder
  • Change type
    • oldFullyQualifiedTypeName: org.jboss.netty.util.ObjectSizeEstimator
    • newFullyQualifiedTypeName: io.netty.channel.MessageSizeEstimator
  • Change type
    • oldFullyQualifiedTypeName: org.jboss.netty.util.DefaultObjectSizeEstimator
    • newFullyQualifiedTypeName: io.netty.channel.DefaultMessageSizeEstimator
  • Migrate StringEncoder(String) to StringEncoder(StandardCharsets)
  • Rename package name
    • oldPackageName: org.jboss.netty.logging
    • newPackageName: io.netty.util.internal.logging
    • recursive: true
  • Rename package name
    • oldPackageName: org.jboss.netty
    • newPackageName: io.netty
    • recursive: true
  • Change Maven dependency
    • oldGroupId: org.jboss.netty
    • oldArtifactId: netty
    • newGroupId: io.netty
    • newArtifactId: netty-all
    • newVersion: 4.1.x
  • Replace Channels.fireMessageReceived(..) with ctx.fireChannelRead(e)

Examples​

Example 1​

UpgradeNetty_3_2_to_4_1Test#changeMethodSignature

Before​
import org.jboss.netty.channel.ChannelHandlerContext;
import org.jboss.netty.channel.ChannelStateEvent;

class Test {
    	public void channelOpen(ChannelHandlerContext ctx, ChannelStateEvent e) throws Exception {}
}
After​
import io.netty.channel.ChannelHandlerContext;

class Test {
    	public void channelActive(ChannelHandlerContext ctx) throws Exception {}
}
Example 2​

UpgradeNetty_3_2_to_4_1Test#changeMethodSignature

Before​
import org.jboss.netty.channel.ChannelHandlerContext;
import org.jboss.netty.channel.ChannelStateEvent;

class Test {
    	public void channelOpen(ChannelHandlerContext ctx, ChannelStateEvent e) throws Exception {}
}
After​
import io.netty.channel.ChannelHandlerContext;

class Test {
    	public void channelActive(ChannelHandlerContext ctx) throws Exception {}
}

Usage​

This recipe has no required configuration options. Users of Moderne can run it via the Moderne CLI.

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell
mod run . --recipe UpgradeNetty_3_2_to_4_1

If the recipe is not available locally, then you can install it using:

mod config recipes jar install org.openrewrite.recipe:rewrite-netty:0.8.0

See how this recipe works across multiple open-source repositories​

Run this recipe on OSS repos at scale with the Moderne SaaS.

The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.

Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.

Data Tables​

Source files that had results​

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column NameDescription
Source path before the runThe source path of the file before the run. null when a source file was created during the run.
Source path after the runA recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changesIn a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changesThe specific recipe that made a change.
Estimated time savingAn estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
CycleThe recipe cycle in which the change was made.