Top Fields Constructors Methods
org.apache.sshd.scp.common.helpers

public Class ScpAckInfo

extends Object
Class Inheritance
Imports
java.io.EOFException, .IOException, .InputStream, .OutputStream, java.nio.charset.Charset, org.apache.sshd.common.util.GenericUtils, .ValidateUtils, org.apache.sshd.scp.common.ScpException
Author
Apache MINA SSHD Project

Field Summary

Modifier and TypeField and Description
public static final int
ERROR

private final String
line

public static final int
OK

public static final ScpAckInfo
OK_ACK_INFO

private final int
statusCode

public static final int
WARNING

Constructor Summary

AccessConstructor and Description
public
ScpAckInfo(int statusCode)

public
ScpAckInfo(int statusCode, String line)

Method Summary

Modifier and TypeMethod and Description
public String
getLine()

public int
getStatusCode()

public static ScpAckInfo
readAck(InputStream in, Charset cs, boolean canEof)

public <O extends OutputStream> O
send(O out, Charset cs)

public static <O extends OutputStream> O
sendAck(O out, Charset cs, int level, String message)

public static <O extends OutputStream> O
sendError(O out, Charset cs, String message)

public static void
sendOk(OutputStream
The target OutputStream
out, Charset
The Charset to use to write the textual data
cs)

Sends OK ACK code

public static <O extends OutputStream> O
sendWarning(O out, Charset cs, String message)

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

public void
validateCommandStatusCode(String command, Object location)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

ERRORback to summary
public static final int ERROR
lineback to summary
private final String line
OKback to summary
public static final int OK
OK_ACK_INFOback to summary
public static final ScpAckInfo OK_ACK_INFO
statusCodeback to summary
private final int statusCode
WARNINGback to summary
public static final int WARNING

Constructor Detail

ScpAckInfoback to summary
public ScpAckInfo(int statusCode)
ScpAckInfoback to summary
public ScpAckInfo(int statusCode, String line)

Method Detail

getLineback to summary
public String getLine()
getStatusCodeback to summary
public int getStatusCode()
readAckback to summary
public static ScpAckInfo readAck(InputStream in, Charset cs, boolean canEof) throws IOException
sendback to summary
public <O extends OutputStream> O send(O out, Charset cs) throws IOException
sendAckback to summary
public static <O extends OutputStream> O sendAck(O out, Charset cs, int level, String message) throws IOException
sendErrorback to summary
public static <O extends OutputStream> O sendError(O out, Charset cs, String message) throws IOException
sendOkback to summary
public static void sendOk(OutputStream out, Charset cs) throws IOException

Sends OK ACK code

Parameters
out:OutputStream

The target OutputStream

cs:Charset

The Charset to use to write the textual data

Exceptions
IOException:
If failed to send the ACK code
sendWarningback to summary
public static <O extends OutputStream> O sendWarning(O out, Charset cs, String message) throws IOException
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override
validateCommandStatusCodeback to summary
public void validateCommandStatusCode(String command, Object location) throws IOException