Package com.google.gerrit.extensions.common

Class AuthInfo

java.lang.Object

com.google.gerrit.extensions.common.AuthInfo

public class AuthInfo
extends Object

Representation of auth-related server configuration in the REST API.

This class determines the JSON format of auth-related server configuration in the REST API.

The contained values come from the auth section of gerrit.config.

Field Summary

Fields

Modifier and Type	Field	Description
AuthType	authType	The authentication type that is configured on the server.
List<AgreementInfo>	contributorAgreements	List of contributor agreements that have been configured on the server.
List<AccountFieldName>	editableAccountFields	List of account fields that are editable.
String	editFullNameUrl	The URL to edit the full name.
GitBasicAuthPolicy	gitBasicAuthPolicy	The policy to authenticate Git over HTTP and REST API requests.
String	httpPasswordUrl	The URL to obtain an HTTP password.
String	loginText	The login text.
String	loginUrl	The login URL.
String	registerText	The register text.
String	registerUrl	The register URL.
String	switchAccountUrl	The URL to switch accounts.
Boolean	useContributorAgreements	Whether contributor agreements are required.

Constructor Summary

Constructors

Constructor	Description
AuthInfo()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

authType

public AuthType authType

The authentication type that is configured on the server.

The value of the auth.type parameter in gerrit.config.

useContributorAgreements

public Boolean useContributorAgreements

Whether contributor agreements are required.

The value of the auth.contributorAgreements parameter in gerrit.config.

contributorAgreements

public List<AgreementInfo> contributorAgreements

List of contributor agreements that have been configured on the server.

editableAccountFields

public List<AccountFieldName> editableAccountFields

List of account fields that are editable.

loginUrl

public String loginUrl

The login URL.

The value of the auth.loginUrl parameter in gerrit.config.

Only set if authentication type is HTTP or HTTP_LDAP.

loginText

public String loginText

The login text.

The value of the auth.loginText parameter in gerrit.config.

Only set if authentication type is HTTP or HTTP_LDAP.

switchAccountUrl

public String switchAccountUrl

The URL to switch accounts.

The value of the auth.switchAccountUrl parameter in gerrit.config.

registerUrl

public String registerUrl

The register URL.

The value of the auth.registerUrl parameter in gerrit.config.

Only set if authentication type is LDAP, LDAP_BIND or CUSTOM_EXTENSION.

registerText

public String registerText

The register text.

The value of the auth.registerText parameter in gerrit.config.

Only set if authentication type is LDAP, LDAP_BIND or CUSTOM_EXTENSION.

editFullNameUrl

public String editFullNameUrl

The URL to edit the full name.

The value of the auth.editFullNameUrl parameter in gerrit.config.

Only set if authentication type is LDAP, LDAP_BIND or CUSTOM_EXTENSION.

httpPasswordUrl

public String httpPasswordUrl

The URL to obtain an HTTP password.

The value of the auth.httpPasswordUrl parameter in gerrit.config.

Only set if authentication type is CUSTOM_EXTENSION.

gitBasicAuthPolicy

public GitBasicAuthPolicy gitBasicAuthPolicy

The policy to authenticate Git over HTTP and REST API requests.

The value of the auth.gitBasicAuthPolicy parameter in gerrit.config.

Only set if authentication type is LDAP, LDAP_BIND or OAUTH.

Constructor Detail

AuthInfo

public AuthInfo()