com.urswolfer.gerrit.client.rest

Class GerritAuthData.Basic

java.lang.Object

com.urswolfer.gerrit.client.rest.GerritAuthData.Basic

All Implemented Interfaces:

GerritAuthData

Enclosing interface:

GerritAuthData

public static class GerritAuthData.Basic
extends Object
implements GerritAuthData

A simple implementation for providing username and password at construction time. Note: It is not related to HTTP basic access authentication.

Nested Class Summary

Nested classes/interfaces inherited from interface com.urswolfer.gerrit.client.rest.GerritAuthData

GerritAuthData.Basic

Constructor Summary

Constructors

Constructor and Description
Basic(String host)
Basic(String host, String login, String password)
Basic(String host, String login, String password, boolean httpPassword)

Method Summary

Modifier and Type	Method and Description
String	getHost() HTTP URL for accessing Gerrit.
String	getLogin() Username used for login.
String	getPassword() Password used for login.
boolean	isHttpPassword() Returns TRUE if the password value is an HTTP password corresponding to the password token displayed on the user Settings -> HTTP Password page.
boolean	isLoginAndPasswordAvailable()

Methods inherited from class java.lang.Object

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

Constructor Detail

Basic

public Basic(String host)

Parameters:

host - see GerritAuthData.getHost().

Basic

public Basic(String host,
             String login,
             String password)

Parameters:

host - see GerritAuthData.getPassword().

login - see GerritAuthData.getLogin().

password - see GerritAuthData.getLogin().

Basic

public Basic(String host,
             String login,
             String password,
             boolean httpPassword)

Parameters:

host - see GerritAuthData.getPassword().

login - see GerritAuthData.getLogin().

password - see GerritAuthData.getLogin().

httpPassword - see GerritAuthData@isHttpPassword.

Method Detail

isHttpPassword

public boolean isHttpPassword()

Description copied from interface: GerritAuthData

Returns TRUE if the password value is an HTTP password corresponding to the password token displayed on the user Settings -> HTTP Password page. Gerrit can accept two types of passwords for authentication, the normal site password (local user database, LDAP, etc) or a user-generated HTTP password token. The HTTP password token is used for REST API requests. If this method returns TRUE, API calls should not be redirected to the /login endpoint, which

Specified by:

isHttpPassword in interface GerritAuthData

Returns:

TRUE if the password is the HTTP password token used for REST API authentication.

See Also:

Gerrit REST API authentication, Gerrit REST API configuration

getLogin

public String getLogin()

Description copied from interface: GerritAuthData

Username used for login.

Specified by:

getLogin in interface GerritAuthData

getPassword

public String getPassword()

Description copied from interface: GerritAuthData

Password used for login.

Specified by:

getPassword in interface GerritAuthData

getHost

public String getHost()

Description copied from interface: GerritAuthData

HTTP URL for accessing Gerrit. Please make sure that Gerrit root URL is used. Example: "https://gerrit-review.googlesource.com"

Specified by:

getHost in interface GerritAuthData

isLoginAndPasswordAvailable

public boolean isLoginAndPasswordAvailable()

Specified by:

isLoginAndPasswordAvailable in interface GerritAuthData

Returns:

true when username and password is available. When false, anonymous access will be used.