rspec/rules/S4818/java/rule.adoc
Fred Tingaud 51369b610e
Make sure that includes are always surrounded by empty lines (#2270)
When an include is not surrounded by empty lines, its content is inlined
on the same line as the adjacent content. That can lead to broken tags
and other display issues.
This PR fixes all such includes and introduces a validation step that
forbids introducing the same problem again.
2023-06-22 10:38:01 +02:00

107 lines
3.0 KiB
Plaintext

include::../description.adoc[]
include::../ask-yourself.adoc[]
include::../recommended.adoc[]
== Sensitive Code Example
----
// === java.net ===
import java.net.Socket;
import java.net.InetAddress;
import java.net.Proxy;
import java.net.ServerSocket;
import javax.net.SocketFactory;
class A {
void foo(SocketFactory factory, String address, int port, InetAddress localAddr, int localPort, boolean stream,
String host, Proxy proxy, int backlog, InetAddress bindAddr)
throws Exception {
new Socket(); // Sensitive.
new Socket(address, port); // Sensitive.
new Socket(address, port, localAddr, localPort); // Sensitive.
new Socket(host, port, stream); // Sensitive.
new Socket(proxy); // Sensitive.
new Socket(host, port); // Sensitive.
new Socket(host, port, stream); // Sensitive.
new Socket(host, port, localAddr, localPort); // Sensitive.
new ServerSocket(); // Sensitive.
new ServerSocket(port); // Sensitive.
new ServerSocket(port, backlog); // Sensitive.
new ServerSocket(port, backlog, bindAddr); // Sensitive.
factory.createSocket(); // Sensitive
}
}
abstract class mySocketFactory extends SocketFactory { // Sensitive. Review how the sockets are created.
// ...
}
----
----
// === java.nio.channels ===
import java.net.SocketAddress;
import java.nio.channels.AsynchronousChannelGroup;
import java.nio.channels.AsynchronousServerSocketChannel;
import java.nio.channels.AsynchronousSocketChannel;
import java.nio.channels.SocketChannel;
import java.nio.channels.ServerSocketChannel;
class A {
void foo(AsynchronousChannelGroup group, SocketAddress remote) throws Exception {
AsynchronousServerSocketChannel.open(); // Sensitive.
AsynchronousServerSocketChannel.open(group); // Sensitive.
AsynchronousSocketChannel.open(); // Sensitive.
AsynchronousSocketChannel.open(group); // Sensitive.
SocketChannel.open(); // Sensitive.
SocketChannel.open(remote); // Sensitive.
ServerSocketChannel.open(); // Sensitive.
}
}
----
----
// === Netty ===
import io.netty.channel.ChannelInitializer;
import io.netty.channel.socket.ServerSocketChannel;
import io.netty.channel.socket.SocketChannel;
class CustomChannelInitializer extends ChannelInitializer<ServerSocketChannel> { // Sensitive. Review how the SocketChannel is used.
@Override
protected void initChannel(ServerSocketChannel ch) throws Exception {
}
}
class A {
void foo() {
new ChannelInitializer<SocketChannel>() { // Sensitive
@Override
public void initChannel(SocketChannel ch) throws Exception {
// ...
}
};
}
}
----
include::../see.adoc[]
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::../message.adoc[]
'''
== Comments And Links
(visible only on this page)
include::../comments-and-links.adoc[]
endif::env-github,rspecator-view[]