org.eclipse.jgit.transport

Class HttpAuthMethod

java.lang.Object

org.eclipse.jgit.transport.HttpAuthMethod

Direct Known Subclasses:

HttpAuthMethod.Basic, HttpAuthMethod.Digest, HttpAuthMethod.Negotiate, HttpAuthMethod.None

abstract class HttpAuthMethod
extends java.lang.Object

Support class to populate user authentication data on a connection.

Instances of an HttpAuthMethod are not thread-safe, as some implementations may need to maintain per-connection state information.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	HttpAuthMethod.Basic Performs HTTP basic authentication (plaintext username/password).
private static class	HttpAuthMethod.Digest Performs HTTP digest authentication.
private static class	HttpAuthMethod.Negotiate
private static class	HttpAuthMethod.None Performs no user authentication.
static class	HttpAuthMethod.Type Enum listing the http authentication method types supported by jgit.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static java.lang.String	EMPTY_STRING
(package private) static java.lang.String	SCHEMA_NAME_SEPARATOR
protected HttpAuthMethod.Type	type

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HttpAuthMethod(HttpAuthMethod.Type type) Constructor for HttpAuthMethod.

Method Summary

Modifier and Type	Method and Description
(package private) abstract void	authorize(java.lang.String user, java.lang.String pass) Update this method with the given username and password pair.
(package private) boolean	authorize(URIish uri, CredentialsProvider credentialsProvider) Update this method with the credentials from the URIish.
(package private) abstract void	configureRequest(HttpConnection conn) Update connection properties based on this authentication method.
HttpAuthMethod.Type	getType() Gives the method type associated to this http auth method
(package private) static HttpAuthMethod	scanResponse(HttpConnection conn, java.util.Collection<HttpAuthMethod.Type> ignoreTypes) Handle an authentication failure and possibly return a new response.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_STRING

static final java.lang.String EMPTY_STRING

See Also:

Constant Field Values

SCHEMA_NAME_SEPARATOR

static final java.lang.String SCHEMA_NAME_SEPARATOR

See Also:

Constant Field Values

type

protected final HttpAuthMethod.Type type

Constructor Detail

HttpAuthMethod

protected HttpAuthMethod(HttpAuthMethod.Type type)

Constructor for HttpAuthMethod.

Parameters:

type - authentication method type

Method Detail

scanResponse

static HttpAuthMethod scanResponse(HttpConnection conn,
                                   java.util.Collection<HttpAuthMethod.Type> ignoreTypes)

Handle an authentication failure and possibly return a new response.

Parameters:

conn - the connection that failed.

ignoreTypes - authentication types to be ignored.

Returns:

new authentication method to try.

authorize

boolean authorize(URIish uri,
                  CredentialsProvider credentialsProvider)

Update this method with the credentials from the URIish.

Parameters:

uri - the URI used to create the connection.

credentialsProvider - the credentials provider, or null. If provided, credentials in the URI are ignored.

Returns:

true if the authentication method is able to provide authorization for the given URI

authorize

abstract void authorize(java.lang.String user,
                        java.lang.String pass)

Update this method with the given username and password pair.

Parameters:

user -

pass -

configureRequest

abstract void configureRequest(HttpConnection conn)
                        throws java.io.IOException

Update connection properties based on this authentication method.

Parameters:

conn -

Throws:

java.io.IOException

getType

public HttpAuthMethod.Type getType()

Gives the method type associated to this http auth method

Returns:

the method type