summaryrefslogtreecommitdiff
path: root/lib/java/src/main/java/org/apache/thrift/transport
diff options
context:
space:
mode:
Diffstat (limited to 'lib/java/src/main/java/org/apache/thrift/transport')
-rw-r--r--lib/java/src/main/java/org/apache/thrift/transport/AutoExpandingBufferWriteTransport.java4
-rw-r--r--lib/java/src/main/java/org/apache/thrift/transport/TIOStreamTransport.java4
-rw-r--r--lib/java/src/main/java/org/apache/thrift/transport/sasl/FixedSizeHeaderReader.java4
-rw-r--r--lib/java/src/main/java/org/apache/thrift/transport/sasl/FrameHeaderReader.java4
-rw-r--r--lib/java/src/main/java/org/apache/thrift/transport/sasl/FrameReader.java20
-rw-r--r--lib/java/src/main/java/org/apache/thrift/transport/sasl/FrameWriter.java4
-rw-r--r--lib/java/src/main/java/org/apache/thrift/transport/sasl/NonblockingSaslHandler.java12
-rw-r--r--lib/java/src/main/java/org/apache/thrift/transport/sasl/SaslPeer.java4
-rw-r--r--lib/java/src/main/java/org/apache/thrift/transport/sasl/TSaslNegotiationException.java8
9 files changed, 48 insertions, 16 deletions
diff --git a/lib/java/src/main/java/org/apache/thrift/transport/AutoExpandingBufferWriteTransport.java b/lib/java/src/main/java/org/apache/thrift/transport/AutoExpandingBufferWriteTransport.java
index 741d629ae..4888481f0 100644
--- a/lib/java/src/main/java/org/apache/thrift/transport/AutoExpandingBufferWriteTransport.java
+++ b/lib/java/src/main/java/org/apache/thrift/transport/AutoExpandingBufferWriteTransport.java
@@ -80,7 +80,9 @@ public final class AutoExpandingBufferWriteTransport extends TEndpointTransport
return buf;
}
- /** @return length of the buffer, including any front reserve */
+ /**
+ * @return length of the buffer, including any front reserve
+ */
public int getLength() {
return pos;
}
diff --git a/lib/java/src/main/java/org/apache/thrift/transport/TIOStreamTransport.java b/lib/java/src/main/java/org/apache/thrift/transport/TIOStreamTransport.java
index edfd1f414..af745b8b5 100644
--- a/lib/java/src/main/java/org/apache/thrift/transport/TIOStreamTransport.java
+++ b/lib/java/src/main/java/org/apache/thrift/transport/TIOStreamTransport.java
@@ -125,7 +125,9 @@ public class TIOStreamTransport extends TEndpointTransport {
outputStream_ = os;
}
- /** @return false after close is called. */
+ /**
+ * @return false after close is called.
+ */
public boolean isOpen() {
return inputStream_ != null || outputStream_ != null;
}
diff --git a/lib/java/src/main/java/org/apache/thrift/transport/sasl/FixedSizeHeaderReader.java b/lib/java/src/main/java/org/apache/thrift/transport/sasl/FixedSizeHeaderReader.java
index 4f90faf85..b89484ab3 100644
--- a/lib/java/src/main/java/org/apache/thrift/transport/sasl/FixedSizeHeaderReader.java
+++ b/lib/java/src/main/java/org/apache/thrift/transport/sasl/FixedSizeHeaderReader.java
@@ -59,7 +59,9 @@ public abstract class FixedSizeHeaderReader implements FrameHeaderReader {
return true;
}
- /** @return Size of the header. */
+ /**
+ * @return Size of the header.
+ */
protected abstract int headerSize();
/**
diff --git a/lib/java/src/main/java/org/apache/thrift/transport/sasl/FrameHeaderReader.java b/lib/java/src/main/java/org/apache/thrift/transport/sasl/FrameHeaderReader.java
index d618346a4..dd79bc42a 100644
--- a/lib/java/src/main/java/org/apache/thrift/transport/sasl/FrameHeaderReader.java
+++ b/lib/java/src/main/java/org/apache/thrift/transport/sasl/FrameHeaderReader.java
@@ -41,7 +41,9 @@ public interface FrameHeaderReader {
*/
byte[] toBytes();
- /** @return true if this header has all its fields set. */
+ /**
+ * @return true if this header has all its fields set.
+ */
boolean isComplete();
/** Clear the header and make it available to read a new header. */
diff --git a/lib/java/src/main/java/org/apache/thrift/transport/sasl/FrameReader.java b/lib/java/src/main/java/org/apache/thrift/transport/sasl/FrameReader.java
index 1f5872c30..5491ed8e1 100644
--- a/lib/java/src/main/java/org/apache/thrift/transport/sasl/FrameReader.java
+++ b/lib/java/src/main/java/org/apache/thrift/transport/sasl/FrameReader.java
@@ -86,27 +86,37 @@ public abstract class FrameReader<T extends FrameHeaderReader> {
return payload.hasRemaining();
}
- /** @return header of the frame */
+ /**
+ * @return header of the frame
+ */
public T getHeader() {
return header;
}
- /** @return number of bytes of the header */
+ /**
+ * @return number of bytes of the header
+ */
public int getHeaderSize() {
return header.toBytes().length;
}
- /** @return byte array of the payload */
+ /**
+ * @return byte array of the payload
+ */
public byte[] getPayload() {
return payload.array();
}
- /** @return size of the payload */
+ /**
+ * @return size of the payload
+ */
public int getPayloadSize() {
return header.payloadSize();
}
- /** @return true if the reader has fully read a frame */
+ /**
+ * @return true if the reader has fully read a frame
+ */
public boolean isComplete() {
return !(payload == null || payload.hasRemaining());
}
diff --git a/lib/java/src/main/java/org/apache/thrift/transport/sasl/FrameWriter.java b/lib/java/src/main/java/org/apache/thrift/transport/sasl/FrameWriter.java
index bae6d4999..4af4aa099 100644
--- a/lib/java/src/main/java/org/apache/thrift/transport/sasl/FrameWriter.java
+++ b/lib/java/src/main/java/org/apache/thrift/transport/sasl/FrameWriter.java
@@ -113,7 +113,9 @@ public abstract class FrameWriter {
transport.write(frameBytes);
}
- /** @return true when no more data needs to be written out */
+ /**
+ * @return true when no more data needs to be written out
+ */
public boolean isComplete() {
return frameBytes == null || !frameBytes.hasRemaining();
}
diff --git a/lib/java/src/main/java/org/apache/thrift/transport/sasl/NonblockingSaslHandler.java b/lib/java/src/main/java/org/apache/thrift/transport/sasl/NonblockingSaslHandler.java
index 2557a4285..44862d2c9 100644
--- a/lib/java/src/main/java/org/apache/thrift/transport/sasl/NonblockingSaslHandler.java
+++ b/lib/java/src/main/java/org/apache/thrift/transport/sasl/NonblockingSaslHandler.java
@@ -123,17 +123,23 @@ public class NonblockingSaslHandler {
return nextPhase;
}
- /** @return underlying nonblocking socket */
+ /**
+ * @return underlying nonblocking socket
+ */
public TNonblockingTransport getUnderlyingTransport() {
return underlyingTransport;
}
- /** @return SaslServer instance */
+ /**
+ * @return SaslServer instance
+ */
public SaslServer getSaslServer() {
return saslPeer.getSaslServer();
}
- /** @return true if current phase is done. */
+ /**
+ * @return true if current phase is done.
+ */
public boolean isCurrentPhaseDone() {
return currentPhase != nextPhase;
}
diff --git a/lib/java/src/main/java/org/apache/thrift/transport/sasl/SaslPeer.java b/lib/java/src/main/java/org/apache/thrift/transport/sasl/SaslPeer.java
index 9a9e733da..83515b87c 100644
--- a/lib/java/src/main/java/org/apache/thrift/transport/sasl/SaslPeer.java
+++ b/lib/java/src/main/java/org/apache/thrift/transport/sasl/SaslPeer.java
@@ -33,7 +33,9 @@ public interface SaslPeer {
*/
byte[] evaluate(byte[] negotiationMessage) throws TSaslNegotiationException;
- /** @return true if authentication is done. */
+ /**
+ * @return true if authentication is done.
+ */
boolean isAuthenticated();
/**
diff --git a/lib/java/src/main/java/org/apache/thrift/transport/sasl/TSaslNegotiationException.java b/lib/java/src/main/java/org/apache/thrift/transport/sasl/TSaslNegotiationException.java
index 15c597e13..9018e3a7b 100644
--- a/lib/java/src/main/java/org/apache/thrift/transport/sasl/TSaslNegotiationException.java
+++ b/lib/java/src/main/java/org/apache/thrift/transport/sasl/TSaslNegotiationException.java
@@ -40,12 +40,16 @@ public class TSaslNegotiationException extends TTransportException {
return error;
}
- /** @return Errory type plus the message. */
+ /**
+ * @return Errory type plus the message.
+ */
public String getSummary() {
return error.name() + ": " + getMessage();
}
- /** @return Summary and eventually the cause's message. */
+ /**
+ * @return Summary and eventually the cause's message.
+ */
public String getDetails() {
return getCause() == null
? getSummary()