Apache Mina SSHD 2.15.0 · org.apache.sshd.agent.common.AbstractAgentProxy

Modifier and Type	Field and Description
private String	channelType
private CloseableExecutorService	executor

Access	Constructor and Description
protected	AbstractAgentProxy(CloseableExecutorService executorService)

Method Summary

Modifier and Type	Method and Description
public void	addIdentity(KeyPair `KeyPair` to add kp, String to associate with the key comment, SshAgentKeyConstraint... `SshAgentKeyConstraint`s for this key to pass on to the agent constraints) Implements org.apache.sshd.agent.SshAgent.addIdentity. Adds a key to the agent.
public void	close() Implements java.nio.channels.Channel.close. Closes this channel.
protected Buffer	createBuffer(byte cmd)
protected Buffer	createBuffer(byte cmd, int extraLen)
public String	getChannelType()
public CloseableExecutorService	getExecutorService() Implements org.apache.sshd.common.util.threads.ExecutorServiceCarrier.getExecutorService.
public Iterable<? extends Map.Entry<PublicKey, String>>	getIdentities() Implements org.apache.sshd.agent.SshAgent.getIdentities.
protected Buffer	prepare(Buffer buffer)
public void	removeAllIdentities() Implements org.apache.sshd.agent.SshAgent.removeAllIdentities.
public void	removeIdentity(PublicKey key) Implements org.apache.sshd.agent.SshAgent.removeIdentity.
protected abstract Buffer	request(Buffer buffer)
public void	setChannelType(String channelType)
public Map.Entry<String, byte[]>	sign(SessionContext The current `SessionContext` session, PublicKey The `PublicKey` to use for signing key, String Recommended signature algorithm - if `null`/empty then one will be selected based on the key type and/or signature factories Note even if specific algorithm specified, the implementation may disregard and choose another algo, byte[] Data to sign data) Implements org.apache.sshd.agent.SshAgent.sign.

Inherited from org.apache.sshd.common.util.logging.AbstractLoggingBean:: debug debug debug debug debug error error error error error getSimplifiedLogger info info warn warn warn warn warn warn warn warn

channelType	back to summary
private String channelType

executor	back to summary
private CloseableExecutorService executor

AbstractAgentProxy	back to summary
protected AbstractAgentProxy(CloseableExecutorService executorService)

Method Detail

addIdentity back to summary

addIdentity	back to summary
public void addIdentity(KeyPair kp, String comment, SshAgentKeyConstraint... constraints) throws IOException Implements org.apache.sshd.agent.SshAgent.addIdentity. Doc from org.apache.sshd.agent.SshAgent.addIdentity. Adds a key to the agent. Parameters kp:KeyPair `KeyPair` to add comment:String to associate with the key constraints:SshAgentKeyConstraint[] `SshAgentKeyConstraint`s for this key to pass on to the agent Annotations @Override Exceptions IOException: if an error in the communication with the agent occurred, or the agent did not return a reply indicating successful addition of the key

public void addIdentity(KeyPair kp, String comment, SshAgentKeyConstraint... constraints) throws IOException

Implements org.apache.sshd.agent.SshAgent.addIdentity.

Doc from org.apache.sshd.agent.SshAgent.addIdentity.

Adds a key to the agent.

Parameters

kp:KeyPair: KeyPair to add
comment:String: to associate with the key
constraints:SshAgentKeyConstraint[]: SshAgentKeyConstraints for this key to pass on to the agent

Annotations

@Override

Exceptions

IOException:: if an error in the communication with the agent occurred, or the agent did not return a reply indicating successful addition of the key

close back to summary

close	back to summary
public void close() throws IOException Implements java.nio.channels.Channel.close. Doc from java.nio.channels.Channel.close. Closes this channel. After a channel is closed, any further attempt to invoke I/O operations upon it will cause a `ClosedChannelException` to be thrown. If this channel is already closed then invoking this method has no effect. This method may be invoked at any time. If some other thread has already invoked it, however, then another invocation will block until the first invocation is complete, after which it will return without effect. Annotations @Override Exceptions IOException: If an I/O error occurs

public void close() throws IOException

Implements java.nio.channels.Channel.close.

Doc from java.nio.channels.Channel.close.

Closes this channel.

After a channel is closed, any further attempt to invoke I/O operations upon it will cause a ClosedChannelException to be thrown.

If this channel is already closed then invoking this method has no effect.

This method may be invoked at any time. If some other thread has already invoked it, however, then another invocation will block until the first invocation is complete, after which it will return without effect.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

createBuffer	back to summary
protected Buffer createBuffer(byte cmd)

createBuffer	back to summary
protected Buffer createBuffer(byte cmd, int extraLen)

getChannelType	back to summary
public String getChannelType()

getExecutorService back to summary

getExecutorService	back to summary
public CloseableExecutorService getExecutorService() Implements org.apache.sshd.common.util.threads.ExecutorServiceCarrier.getExecutorService. Returns:CloseableExecutorService Doc from org.apache.sshd.common.util.threads.ExecutorServiceCarrier.getExecutorService. The `CloseableExecutorService` to use Annotations @Override

public CloseableExecutorService getExecutorService()

Implements org.apache.sshd.common.util.threads.ExecutorServiceCarrier.getExecutorService.

Returns:CloseableExecutorService

Doc from org.apache.sshd.common.util.threads.ExecutorServiceCarrier.getExecutorService.

The CloseableExecutorService to use

Annotations

@Override

getIdentities	back to summary
public Iterable<? extends Map.Entry<PublicKey, String>> getIdentities() throws IOException Implements org.apache.sshd.agent.SshAgent.getIdentities. Annotations @Override

getIdentities

back to summary

public Iterable<? extends Map.Entry<PublicKey, String>> getIdentities() throws IOException

Implements org.apache.sshd.agent.SshAgent.getIdentities.

Annotations

@Override

prepare	back to summary
protected Buffer prepare(Buffer buffer)

removeAllIdentities	back to summary
public void removeAllIdentities() throws IOException Implements org.apache.sshd.agent.SshAgent.removeAllIdentities. Annotations @Override

removeAllIdentities

back to summary

public void removeAllIdentities() throws IOException

Implements org.apache.sshd.agent.SshAgent.removeAllIdentities.

Annotations

@Override

removeIdentity	back to summary
public void removeIdentity(PublicKey key) throws IOException Implements org.apache.sshd.agent.SshAgent.removeIdentity. Annotations @Override

removeIdentity

back to summary

public void removeIdentity(PublicKey key) throws IOException

Implements org.apache.sshd.agent.SshAgent.removeIdentity.

Annotations

@Override

request	back to summary
protected abstract Buffer request(Buffer buffer) throws IOException

setChannelType	back to summary
public void setChannelType(String channelType)

sign back to summary

sign	back to summary
public Map.Entry<String, byte[]> sign(SessionContext session, PublicKey key, String algo, byte[] data) throws IOException Implements org.apache.sshd.agent.SshAgent.sign. Parameters session:SessionContext Doc from org.apache.sshd.agent.SshAgent.sign. The current `SessionContext` key:PublicKey Doc from org.apache.sshd.agent.SshAgent.sign. The `PublicKey` to use for signing algo:String Doc from org.apache.sshd.agent.SshAgent.sign. Recommended signature algorithm - if `null`/empty then one will be selected based on the key type and/or signature factories Note even if specific algorithm specified, the implementation may disregard and choose another data:byte[] Doc from org.apache.sshd.agent.SshAgent.sign. Data to sign Returns:Map.Entry<String, byte[]> Doc from org.apache.sshd.agent.SshAgent.sign. used algorithm + signed data - using the identity Annotations @Override Exceptions IOException: Doc from org.apache.sshd.agent.SshAgent.sign. If failed to sign

public Map.Entry<String, byte[]> sign(SessionContext session, PublicKey key, String algo, byte[] data) throws IOException

Implements org.apache.sshd.agent.SshAgent.sign.

Parameters

session:SessionContext

Doc from org.apache.sshd.agent.SshAgent.sign.

The current SessionContext

key:PublicKey

Doc from org.apache.sshd.agent.SshAgent.sign.

The PublicKey to use for signing

algo:String

Doc from org.apache.sshd.agent.SshAgent.sign.

Recommended signature algorithm - if null/empty then one will be selected based on the key type and/or signature factories

Note

even if specific algorithm specified, the implementation may disregard and choose another

data:byte[]

Doc from org.apache.sshd.agent.SshAgent.sign.

Data to sign

Returns:Map.Entry<String, byte[]>

Doc from org.apache.sshd.agent.SshAgent.sign.

used algorithm + signed data - using the identity

Annotations

@Override

Exceptions

IOException:

Doc from org.apache.sshd.agent.SshAgent.sign.

If failed to sign

public abstract Class AbstractAgentProxy

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail