Package org.jenkins.plugins.lockableresources.remote

Class RemoteCredentials

java.lang.Object

org.jenkins.plugins.lockableresources.remote.RemoteCredentials

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public final class RemoteCredentials
extends Object

Resolves the HTTP Authorization header for a remote connection from its configured username/password credentials (Basic auth). Credentials are looked up first in the Run context (so per-folder credentials work), then in the system (global) store.

Method Summary

Modifier and Type	Method	Description
static String	basicAuthHeader(RemoteConnection remote, Run<?,?> run)

Methods inherited from class java.lang.Object

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

Method Details

basicAuthHeader

public static String basicAuthHeader(RemoteConnection remote,
 Run<?,?> run)
                              throws AbortException

Returns:

a "Basic <base64>" header value, or "" when the connection has no credentialsId. Fails the build (via AbortException) when the referenced credentials cannot be found.

Throws:

AbortException