Package org.eclipse.jgit.transport.sshd.agent

Class AbstractConnector

java.lang.Object

org.eclipse.jgit.transport.sshd.agent.AbstractConnector

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, Connector

Direct Known Subclasses:

PageantConnector, UnixDomainSocketConnector, WinPipeConnector

public abstract class AbstractConnector
extends java.lang.Object
implements Connector

Provides some utility methods for implementing Connectors.

Since:

6.0

Field Summary

Fields

Modifier and Type	Field	Description
protected static int	DEFAULT_MAX_REPLY_LENGTH	Default maximum reply length.
private int	maxReplyLength
private static int	MIN_REPLY_LENGTH

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractConnector()	Creates a new instance using the DEFAULT_MAX_REPLY_LENGTH.
protected	AbstractConnector(int maxReplyLength)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
protected int	getMaximumMessageLength()	Retrieves the maximum message length this AbstractConnector is configured for.
protected void	prepareMessage(byte command, byte[] message)	Prepares a message for sending by inserting the command and message length.
protected int	toLength(byte command, byte[] length)	Checks the received length of a reply.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.eclipse.jgit.transport.sshd.agent.Connector

connect, rpc, rpc

Field Detail

MIN_REPLY_LENGTH

private static final int MIN_REPLY_LENGTH

See Also:

Constant Field Values

DEFAULT_MAX_REPLY_LENGTH

protected static final int DEFAULT_MAX_REPLY_LENGTH

Default maximum reply length. 256kB is the OpenSSH limit.

See Also:

Constant Field Values

maxReplyLength

private final int maxReplyLength

Constructor Detail

AbstractConnector

protected AbstractConnector()

Creates a new instance using the DEFAULT_MAX_REPLY_LENGTH.

AbstractConnector

protected AbstractConnector(int maxReplyLength)

Creates a new instance.

Parameters:

maxReplyLength - maximum number of payload bytes we're ready to accept

Method Detail

getMaximumMessageLength

protected int getMaximumMessageLength()

Retrieves the maximum message length this AbstractConnector is configured for.

Returns:

the maximum message length

prepareMessage

protected void prepareMessage(byte command,
                              byte[] message)
                       throws java.lang.IllegalArgumentException

Prepares a message for sending by inserting the command and message length.

Parameters:

command - SSH agent command the request is for

message - about to be sent, including the 5 spare bytes at the front

Throws:

java.lang.IllegalArgumentException - if message has less than 5 bytes

toLength

protected int toLength(byte command,
                       byte[] length)
                throws java.io.IOException

Checks the received length of a reply.

Parameters:

command - SSH agent command the reply is for

length - length as received: number of payload bytes

Returns:

the length as an int

Throws:

java.io.IOException - if the length is invalid