andreacavalli/netty5
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Some javadocs fixed to remove dead links

Browse Source
This commit is contained in:
Norman Maurer 2012-12-19 15:36:07 +01:00
parent 77c01d252e
commit a1368f0fa8
6 changed files with 14 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
handler/src/main/java/io/netty/handler/ssl/SslHandler.java
View File

@ -64,32 +64,9 @@ import java.util.regex.Pattern;
*
* <h3>Handshake</h3>
* <p>
* If {@link #isIssueHandshake()} is {@code false}
* (default) you will need to take care of calling {@link #handshake()} by your own. In most
* situations were {@link SslHandler} is used in 'client mode' you want to issue a handshake once
* the connection was established. if {@link #setIssueHandshake(boolean)} is set to {@code true}
* you don't need to worry about this as the {@link SslHandler} will take care of it.
* <p>
*
* <h3>Renegotiation</h3>
* <p>
* If {@link #isEnableRenegotiation() enableRenegotiation} is {@code true}
* (default) and the initial handshake has been done successfully, you can call
* {@link #handshake()} to trigger the renegotiation.
* <p>
* If {@link #isEnableRenegotiation() enableRenegotiation} is {@code false},
* an attempt to trigger renegotiation will result in the connection closure.
* <p>
* Please note that TLS renegotiation had a security issue before. If your
* runtime environment did not fix it, please make sure to disable TLS
* renegotiation by calling {@link #setEnableRenegotiation(boolean)} with
* {@code false}. For more information, please refer to the following documents:
* <ul>
* <li><a href="http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2009-3555">CVE-2009-3555</a></li>
* <li><a href="http://www.ietf.org/rfc/rfc5746.txt">RFC5746</a></li>
* <li><a href="http://www.oracle.com/technetwork/java/javase/documentation/tlsreadme2-176330.html">Phased
* Approach to Fixing the TLS Renegotiation Issue</a></li>
* </ul>
* The handshake will be automaticly issued for you once the {@link Channel} is active and
* {@link SSLEngine#getUseClientMode()} returns {@code true}.
* So no need to bother with it by your self.
*
* <h3>Closing the session</h3>
* <p>

7
handler/src/main/java/io/netty/handler/stream/ChunkedFile.java
View File

@ -16,6 +16,7 @@
package io.netty.handler.stream;
import io.netty.buffer.ByteBuf;
import io.netty.channel.FileRegion;
import java.io.File;
import java.io.IOException;
@ -47,7 +48,7 @@ public class ChunkedFile implements ChunkedByteInput {
* Creates a new instance that fetches data from the specified file.
*
* @param chunkSize the number of bytes to fetch on each
* {@link #nextChunk()} call
* {@link #readChunk(ByteBuf)} call
*/
public ChunkedFile(File file, int chunkSize) throws IOException {
this(new RandomAccessFile(file, "r"), chunkSize);
@ -64,7 +65,7 @@ public class ChunkedFile implements ChunkedByteInput {
* Creates a new instance that fetches data from the specified file.
*
* @param chunkSize the number of bytes to fetch on each
* {@link #nextChunk()} call
* {@link #readChunk(ByteBuf)} call
*/
public ChunkedFile(RandomAccessFile file, int chunkSize) throws IOException {
this(file, 0, file.length(), chunkSize);
@ -76,7 +77,7 @@ public class ChunkedFile implements ChunkedByteInput {
* @param offset the offset of the file where the transfer begins
* @param length the number of bytes to transfer
* @param chunkSize the number of bytes to fetch on each
* {@link #nextChunk()} call
* {@link #readChunk(ByteBuf)} call
*/
public ChunkedFile(RandomAccessFile file, long offset, long length, int chunkSize) throws IOException {
if (file == null) {

7
handler/src/main/java/io/netty/handler/stream/ChunkedNioFile.java
View File

@ -16,6 +16,7 @@
package io.netty.handler.stream;
import io.netty.buffer.ByteBuf;
import io.netty.channel.FileRegion;
import java.io.File;
import java.io.FileInputStream;
@ -49,7 +50,7 @@ public class ChunkedNioFile implements ChunkedByteInput {
* Creates a new instance that fetches data from the specified file.
*
* @param chunkSize the number of bytes to fetch on each
* {@link #nextChunk()} call
* {@link #readChunk(ByteBuf)} call
*/
public ChunkedNioFile(File in, int chunkSize) throws IOException {
this(new FileInputStream(in).getChannel(), chunkSize);
@ -66,7 +67,7 @@ public class ChunkedNioFile implements ChunkedByteInput {
* Creates a new instance that fetches data from the specified file.
*
* @param chunkSize the number of bytes to fetch on each
* {@link #nextChunk()} call
* {@link #readChunk(ByteBuf)} call
*/
public ChunkedNioFile(FileChannel in, int chunkSize) throws IOException {
this(in, 0, in.size(), chunkSize);
@ -78,7 +79,7 @@ public class ChunkedNioFile implements ChunkedByteInput {
* @param offset the offset of the file where the transfer begins
* @param length the number of bytes to transfer
* @param chunkSize the number of bytes to fetch on each
* {@link #nextChunk()} call
* {@link #readChunk(ByteBuf)} call
*/
public ChunkedNioFile(FileChannel in, long offset, long length, int chunkSize)
throws IOException {

2
handler/src/main/java/io/netty/handler/stream/ChunkedNioStream.java
View File

@ -48,7 +48,7 @@ public class ChunkedNioStream implements ChunkedByteInput {
* Creates a new instance that fetches data from the specified channel.
*
* @param chunkSize the number of bytes to fetch on each
* {@link #nextChunk()} call
* {@link #readChunk(ByteBuf)} call
*/
public ChunkedNioStream(ReadableByteChannel in, int chunkSize) {
if (in == null) {

2
handler/src/main/java/io/netty/handler/stream/ChunkedStream.java
View File

@ -49,7 +49,7 @@ public class ChunkedStream implements ChunkedByteInput {
* Creates a new instance that fetches data from the specified stream.
*
* @param chunkSize the number of bytes to fetch on each
* {@link #nextChunk()} call
* {@link #readChunk(ByteBuf)} call
*/
public ChunkedStream(InputStream in, int chunkSize) {
if (in == null) {

2
handler/src/main/java/io/netty/handler/stream/ChunkedWriteHandler.java
View File

@ -60,7 +60,7 @@ import java.util.concurrent.atomic.AtomicInteger;
*
* Some {@link ChunkedInput} generates a chunk on a certain event or timing.
* Such {@link ChunkedInput} implementation often returns {@code null} on
* {@link ChunkedInput#nextChunk()}, resulting in the indefinitely suspended
* {@link ChunkedInput#readChunk(Object)}, resulting in the indefinitely suspended
* transfer. To resume the transfer when a new chunk is available, you have to
* call {@link #resumeTransfer()}.
* @apiviz.landmark