Index (SSH Agent Plugin 1.18 API)

A C D E G I J M O P R S T _

A

addIdentity(String, String, String, Launcher, TaskListener) - Method in class com.cloudbees.jenkins.plugins.sshagent.exec.ExecRemoteAgent: Adds the provided identity to the agent.
addIdentity(String, String, String, Launcher, TaskListener) - Method in class com.cloudbees.jenkins.plugins.sshagent.jna.JNRRemoteAgent: Adds the provided identity to the agent.
addIdentity(String, String, String, Launcher, TaskListener) - Method in class com.cloudbees.jenkins.plugins.sshagent.mina.MinaRemoteAgent: Adds the provided identity to the agent.
addIdentity(String, String, String, Launcher, TaskListener) - Method in interface com.cloudbees.jenkins.plugins.sshagent.RemoteAgent: Adds the provided identity to the agent.
AgentServer - Class in com.cloudbees.jenkins.plugins.sshagent.jna: A server for an SSH Agent.
AgentServer(File) - Constructor for class com.cloudbees.jenkins.plugins.sshagent.jna.AgentServer
AgentServer(SshAgent, File) - Constructor for class com.cloudbees.jenkins.plugins.sshagent.jna.AgentServer

C

call() - Method in class com.cloudbees.jenkins.plugins.sshagent.jna.JNRRemoteAgentStarter
call() - Method in class com.cloudbees.jenkins.plugins.sshagent.mina.MinaRemoteAgentStarter
close() - Method in class com.cloudbees.jenkins.plugins.sshagent.jna.AgentServer
com.cloudbees.jenkins.plugins.sshagent - package com.cloudbees.jenkins.plugins.sshagent
com.cloudbees.jenkins.plugins.sshagent.exec - package com.cloudbees.jenkins.plugins.sshagent.exec
com.cloudbees.jenkins.plugins.sshagent.jna - package com.cloudbees.jenkins.plugins.sshagent.jna
com.cloudbees.jenkins.plugins.sshagent.mina - package com.cloudbees.jenkins.plugins.sshagent.mina
CredentialHolder(String) - Constructor for class com.cloudbees.jenkins.plugins.sshagent.SSHAgentBuildWrapper.CredentialHolder: Stapler's constructor.

D

description(StandardUsernameCredentials) - Static method in class com.cloudbees.jenkins.plugins.sshagent.SSHAgentBuildWrapper: Helper method that returns a safe description of a StandardUsernameCredentials.
DescriptorImpl() - Constructor for class com.cloudbees.jenkins.plugins.sshagent.SSHAgentBuildWrapper.CredentialHolder.DescriptorImpl
DescriptorImpl() - Constructor for class com.cloudbees.jenkins.plugins.sshagent.SSHAgentBuildWrapper.DescriptorImpl
DescriptorImpl() - Constructor for class com.cloudbees.jenkins.plugins.sshagent.SSHAgentStep.DescriptorImpl
doFillCredentialsItems() - Method in class com.cloudbees.jenkins.plugins.sshagent.SSHAgentStep.DescriptorImpl: Populate the list of credentials available to the job.
doFillIdItems() - Method in class com.cloudbees.jenkins.plugins.sshagent.SSHAgentBuildWrapper.CredentialHolder.DescriptorImpl: Populate the list of credentials available to the job.

E

ExecRemoteAgent - Class in com.cloudbees.jenkins.plugins.sshagent.exec: An implementation that uses native SSH agent installed on a system.
ExecRemoteAgentFactory - Class in com.cloudbees.jenkins.plugins.sshagent.exec: A factory that uses the native SSH agent installed on a remote system.
ExecRemoteAgentFactory() - Constructor for class com.cloudbees.jenkins.plugins.sshagent.exec.ExecRemoteAgentFactory

G

getAgent() - Method in class com.cloudbees.jenkins.plugins.sshagent.jna.AgentServer
getCredentialHolders() - Method in class com.cloudbees.jenkins.plugins.sshagent.SSHAgentBuildWrapper: Returns the value objects used to hold the credential ids.
getCredentialIds() - Method in class com.cloudbees.jenkins.plugins.sshagent.SSHAgentBuildWrapper: Gets the IdCredentials.getId()s of the credentials to use.
getCredentials() - Method in class com.cloudbees.jenkins.plugins.sshagent.SSHAgentStep
getDisplayName() - Method in class com.cloudbees.jenkins.plugins.sshagent.exec.ExecRemoteAgentFactory: The display name of the factory.
getDisplayName() - Method in class com.cloudbees.jenkins.plugins.sshagent.jna.JNRRemoteAgentFactory: The display name of the factory.
getDisplayName() - Method in class com.cloudbees.jenkins.plugins.sshagent.mina.MinaRemoteAgentFactory: The display name of the factory.
getDisplayName() - Method in class com.cloudbees.jenkins.plugins.sshagent.RemoteAgentFactory: The display name of the factory.
getDisplayName() - Method in class com.cloudbees.jenkins.plugins.sshagent.SSHAgentBuildWrapper.CredentialHolder.DescriptorImpl
getDisplayName() - Method in class com.cloudbees.jenkins.plugins.sshagent.SSHAgentBuildWrapper.DescriptorImpl
getDisplayName() - Method in class com.cloudbees.jenkins.plugins.sshagent.SSHAgentStep.DescriptorImpl
getFunctionName() - Method in class com.cloudbees.jenkins.plugins.sshagent.SSHAgentStep.DescriptorImpl
getId() - Method in class com.cloudbees.jenkins.plugins.sshagent.SSHAgentBuildWrapper.CredentialHolder: Gets the id.
getSocket() - Method in class com.cloudbees.jenkins.plugins.sshagent.exec.ExecRemoteAgent: Returns the value that the environment variable should be set to.
getSocket() - Method in class com.cloudbees.jenkins.plugins.sshagent.jna.JNRRemoteAgent: Returns the value that the environment variable should be set to.
getSocket() - Method in class com.cloudbees.jenkins.plugins.sshagent.mina.MinaRemoteAgent: Returns the value that the environment variable should be set to.
getSocket() - Method in interface com.cloudbees.jenkins.plugins.sshagent.RemoteAgent: Returns the value that the environment variable should be set to.
getUser() - Method in class com.cloudbees.jenkins.plugins.sshagent.SSHAgentBuildWrapper: Deprecated.

I

isApplicable(AbstractProject<?, ?>) - Method in class com.cloudbees.jenkins.plugins.sshagent.SSHAgentBuildWrapper.DescriptorImpl
isIgnoreMissing() - Method in class com.cloudbees.jenkins.plugins.sshagent.SSHAgentBuildWrapper: When true then any missing credentials will be ignored.
isIgnoreMissing() - Method in class com.cloudbees.jenkins.plugins.sshagent.SSHAgentStep
isSupported(Launcher, TaskListener) - Method in class com.cloudbees.jenkins.plugins.sshagent.exec.ExecRemoteAgentFactory: Checks if the supplied launcher is supported by this factory.
isSupported(Launcher, TaskListener) - Method in class com.cloudbees.jenkins.plugins.sshagent.jna.JNRRemoteAgentFactory: Checks if the supplied launcher is supported by this factory.
isSupported(Launcher, TaskListener) - Method in class com.cloudbees.jenkins.plugins.sshagent.mina.MinaRemoteAgentFactory: Checks if the supplied launcher is supported by this factory.
isSupported(Launcher, TaskListener) - Method in class com.cloudbees.jenkins.plugins.sshagent.RemoteAgentFactory: Checks if the supplied launcher is supported by this factory.

J

JNRRemoteAgent - Class in com.cloudbees.jenkins.plugins.sshagent.jna: An implementation that uses Apache SSH to provide the Agent over JNR's UnixSocket implementation.
JNRRemoteAgent(TaskListener, File) - Constructor for class com.cloudbees.jenkins.plugins.sshagent.jna.JNRRemoteAgent: Constructor.
JNRRemoteAgentFactory - Class in com.cloudbees.jenkins.plugins.sshagent.jna: A factory that uses the Apache Mina/SSH library support to natively provide a ssh-agent implementation on platforms supported by jnr-unixsocket
JNRRemoteAgentFactory() - Constructor for class com.cloudbees.jenkins.plugins.sshagent.jna.JNRRemoteAgentFactory
JNRRemoteAgentStarter - Class in com.cloudbees.jenkins.plugins.sshagent.jna: Callable to start the remote agent.
JNRRemoteAgentStarter(TaskListener, String) - Constructor for class com.cloudbees.jenkins.plugins.sshagent.jna.JNRRemoteAgentStarter: Constructor.

M

Messages - Class in com.cloudbees.jenkins.plugins.sshagent: Generated localization support class.
Messages() - Constructor for class com.cloudbees.jenkins.plugins.sshagent.Messages
MinaRemoteAgent - Class in com.cloudbees.jenkins.plugins.sshagent.mina: An implementation that uses Apache SSH to provide the Agent.
MinaRemoteAgent(TaskListener) - Constructor for class com.cloudbees.jenkins.plugins.sshagent.mina.MinaRemoteAgent: Constructor.
MinaRemoteAgentFactory - Class in com.cloudbees.jenkins.plugins.sshagent.mina: A factory that uses the Apache Mina/SSH library support to (semi-)natively provide a ssh-agent implementation
MinaRemoteAgentFactory() - Constructor for class com.cloudbees.jenkins.plugins.sshagent.mina.MinaRemoteAgentFactory
MinaRemoteAgentStarter - Class in com.cloudbees.jenkins.plugins.sshagent.mina: Callable to start the remote agent.
MinaRemoteAgentStarter(TaskListener) - Constructor for class com.cloudbees.jenkins.plugins.sshagent.mina.MinaRemoteAgentStarter: Constructor.

O

onResume() - Method in class com.cloudbees.jenkins.plugins.sshagent.SSHAgentStepExecution

P

preCheckout(AbstractBuild, Launcher, BuildListener) - Method in class com.cloudbees.jenkins.plugins.sshagent.SSHAgentBuildWrapper

R

registerBouncyCastle(VirtualChannel, TaskListener) - Static method in class com.cloudbees.jenkins.plugins.sshagent.RemoteHelper: Registers Bouncy Castle on a remote node logging the result.
RemoteAgent - Interface in com.cloudbees.jenkins.plugins.sshagent: Need an interface in order to export the object from the channel.
RemoteAgentFactory - Class in com.cloudbees.jenkins.plugins.sshagent: Extension point for ssh-agent providers.
RemoteAgentFactory() - Constructor for class com.cloudbees.jenkins.plugins.sshagent.RemoteAgentFactory
RemoteHelper - Class in com.cloudbees.jenkins.plugins.sshagent: Helper class for common remote tasks
RemoteHelper() - Constructor for class com.cloudbees.jenkins.plugins.sshagent.RemoteHelper

S

setIgnoreMissing(boolean) - Method in class com.cloudbees.jenkins.plugins.sshagent.SSHAgentStep
setUp(AbstractBuild, Launcher, BuildListener) - Method in class com.cloudbees.jenkins.plugins.sshagent.SSHAgentBuildWrapper
SSHAgentBuildWrapper - Class in com.cloudbees.jenkins.plugins.sshagent: A build wrapper that provides an SSH agent using supplied credentials
SSHAgentBuildWrapper(String) - Constructor for class com.cloudbees.jenkins.plugins.sshagent.SSHAgentBuildWrapper: Deprecated.
use SSHAgentBuildWrapper.SSHAgentBuildWrapper(java.util.List,boolean)
SSHAgentBuildWrapper(SSHAgentBuildWrapper.CredentialHolder[], boolean) - Constructor for class com.cloudbees.jenkins.plugins.sshagent.SSHAgentBuildWrapper: Constructs a new instance.
SSHAgentBuildWrapper(List<String>, boolean) - Constructor for class com.cloudbees.jenkins.plugins.sshagent.SSHAgentBuildWrapper: Constructs a new instance.
SSHAgentBuildWrapper.CredentialHolder - Class in com.cloudbees.jenkins.plugins.sshagent: A value object to make it possible to pass back multiple credentials via the UI.
SSHAgentBuildWrapper.CredentialHolder.DescriptorImpl - Class in com.cloudbees.jenkins.plugins.sshagent: Our descriptor.
SSHAgentBuildWrapper.DescriptorImpl - Class in com.cloudbees.jenkins.plugins.sshagent: Our descriptor.
SSHAgentBuildWrapper_CouldNotStartAgent() - Static method in class com.cloudbees.jenkins.plugins.sshagent.Messages: Key SSHAgentBuildWrapper.CouldNotStartAgent: [ssh-agent] Unable to start agent.
SSHAgentBuildWrapper_CredentialHolder_DisplayName() - Static method in class com.cloudbees.jenkins.plugins.sshagent.Messages: Key SSHAgentBuildWrapper.CredentialHolder.DisplayName: Credentials.
SSHAgentBuildWrapper_CredentialsNotFound() - Static method in class com.cloudbees.jenkins.plugins.sshagent.Messages: Key SSHAgentBuildWrapper.CredentialsNotFound: [ssh-agent] Could not find specified credentials.
SSHAgentBuildWrapper_DisplayName() - Static method in class com.cloudbees.jenkins.plugins.sshagent.Messages: Key SSHAgentBuildWrapper.DisplayName: SSH Agent.
SSHAgentBuildWrapper_Started() - Static method in class com.cloudbees.jenkins.plugins.sshagent.Messages: Key SSHAgentBuildWrapper.Started: [ssh-agent] Started..
SSHAgentBuildWrapper_Stopped() - Static method in class com.cloudbees.jenkins.plugins.sshagent.Messages: Key SSHAgentBuildWrapper.Stopped: [ssh-agent] Stopped..
SSHAgentBuildWrapper_UnableToReadKey(Object) - Static method in class com.cloudbees.jenkins.plugins.sshagent.Messages: Key SSHAgentBuildWrapper.UnableToReadKey: [ssh-agent] Unable to read key: {0}.
SSHAgentBuildWrapper_UsingCredentials(Object) - Static method in class com.cloudbees.jenkins.plugins.sshagent.Messages: Key SSHAgentBuildWrapper.UsingCredentials: [ssh-agent] Using credentials {0}.
SSHAgentStep - Class in com.cloudbees.jenkins.plugins.sshagent
SSHAgentStep(List<String>) - Constructor for class com.cloudbees.jenkins.plugins.sshagent.SSHAgentStep: Default parameterized constructor.
SSHAgentStep.DescriptorImpl - Class in com.cloudbees.jenkins.plugins.sshagent
SSHAgentStepExecution - Class in com.cloudbees.jenkins.plugins.sshagent
SSHAgentStepExecution() - Constructor for class com.cloudbees.jenkins.plugins.sshagent.SSHAgentStepExecution
start(Launcher, TaskListener, FilePath) - Method in class com.cloudbees.jenkins.plugins.sshagent.exec.ExecRemoteAgentFactory: Start a ssh-agent on the specified launcher.
start() - Method in class com.cloudbees.jenkins.plugins.sshagent.jna.AgentServer
start(Launcher, TaskListener, FilePath) - Method in class com.cloudbees.jenkins.plugins.sshagent.jna.JNRRemoteAgentFactory: Start a ssh-agent on the specified launcher.
start(Launcher, TaskListener, FilePath) - Method in class com.cloudbees.jenkins.plugins.sshagent.mina.MinaRemoteAgentFactory: Start a ssh-agent on the specified launcher.
start(Launcher, TaskListener) - Method in class com.cloudbees.jenkins.plugins.sshagent.RemoteAgentFactory: Deprecated.
start(Launcher, TaskListener, FilePath) - Method in class com.cloudbees.jenkins.plugins.sshagent.RemoteAgentFactory: Start a ssh-agent on the specified launcher.
start() - Method in class com.cloudbees.jenkins.plugins.sshagent.SSHAgentStepExecution
stop(Launcher, TaskListener) - Method in class com.cloudbees.jenkins.plugins.sshagent.exec.ExecRemoteAgent: Stops the agent.
stop(Launcher, TaskListener) - Method in class com.cloudbees.jenkins.plugins.sshagent.jna.JNRRemoteAgent: Stops the agent.
stop(Launcher, TaskListener) - Method in class com.cloudbees.jenkins.plugins.sshagent.mina.MinaRemoteAgent: Stops the agent.
stop(Launcher, TaskListener) - Method in interface com.cloudbees.jenkins.plugins.sshagent.RemoteAgent: Stops the agent.
stop(Throwable) - Method in class com.cloudbees.jenkins.plugins.sshagent.SSHAgentStepExecution

T

takesImplicitBlockArgument() - Method in class com.cloudbees.jenkins.plugins.sshagent.SSHAgentStep.DescriptorImpl
toIdList(SSHAgentBuildWrapper.CredentialHolder[]) - Static method in class com.cloudbees.jenkins.plugins.sshagent.SSHAgentBuildWrapper.CredentialHolder: Converts an array of value objects into a list of ids.

_

_SSHAgentBuildWrapper_CouldNotStartAgent() - Static method in class com.cloudbees.jenkins.plugins.sshagent.Messages: Key SSHAgentBuildWrapper.CouldNotStartAgent: [ssh-agent] Unable to start agent.
_SSHAgentBuildWrapper_CredentialHolder_DisplayName() - Static method in class com.cloudbees.jenkins.plugins.sshagent.Messages: Key SSHAgentBuildWrapper.CredentialHolder.DisplayName: Credentials.
_SSHAgentBuildWrapper_CredentialsNotFound() - Static method in class com.cloudbees.jenkins.plugins.sshagent.Messages: Key SSHAgentBuildWrapper.CredentialsNotFound: [ssh-agent] Could not find specified credentials.
_SSHAgentBuildWrapper_DisplayName() - Static method in class com.cloudbees.jenkins.plugins.sshagent.Messages: Key SSHAgentBuildWrapper.DisplayName: SSH Agent.
_SSHAgentBuildWrapper_Started() - Static method in class com.cloudbees.jenkins.plugins.sshagent.Messages: Key SSHAgentBuildWrapper.Started: [ssh-agent] Started..
_SSHAgentBuildWrapper_Stopped() - Static method in class com.cloudbees.jenkins.plugins.sshagent.Messages: Key SSHAgentBuildWrapper.Stopped: [ssh-agent] Stopped..
_SSHAgentBuildWrapper_UnableToReadKey(Object) - Static method in class com.cloudbees.jenkins.plugins.sshagent.Messages: Key SSHAgentBuildWrapper.UnableToReadKey: [ssh-agent] Unable to read key: {0}.
_SSHAgentBuildWrapper_UsingCredentials(Object) - Static method in class com.cloudbees.jenkins.plugins.sshagent.Messages: Key SSHAgentBuildWrapper.UsingCredentials: [ssh-agent] Using credentials {0}.

A C D E G I J M O P R S T _