com.urswolfer.gerrit.client.rest

Interface GerritAuthData

All Known Implementing Classes:

GerritAuthData.Basic

public interface GerritAuthData

In most cases GerritAuthData.Basic is what you need. You can create your own implementation when you for example want to access application settings dynamically (after setting up the REST client).

Author:

Thomas Forrer

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	GerritAuthData.Basic A simple implementation for providing username and password at construction time.

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()

Method Detail

getLogin

String getLogin()

Username used for login.

getPassword

String getPassword()

Password used for login.

isHttpPassword

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. 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

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

getHost

String getHost()

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

isLoginAndPasswordAvailable

boolean isLoginAndPasswordAvailable()

Returns:

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