Description

Instances of this class can be used to store credentials for use with Kerberos authentication as supported by the GDHttpClient class.

Public Member Functions
	Kerberos5Credentials (String userName, String password, String host)
	Constructor that prepares a new object from user name, password and host, with unspecified Kerberos delegation. More...

	Kerberos5Credentials (String userName, String password, String host, Boolean allowDelegation)
	Constructor that prepares a new object from user name, password and host, with specified Kerberos delegation. More...

Principal	getUserPrincipal ()
	Get the user principal value. More...

String	getHost ()
	Get the host address. More...

String	getUserName ()
	Get the user name. More...

String	getPassword ()
	Get the password. More...

Boolean	isDelegationAllowed ()
	Get the Kerberos delegation specification, if set. More...

int	hashCode ()
	Get the hash code of the user principal. More...

boolean	equals (Object o)
	Comparator for user principal values. More...

String	toString ()
	Get the user principal as a String. More...

Constructor & Destructor Documentation

◆ Kerberos5Credentials() [1/2]

Kerberos5Credentials	(	String	userName,
		String	password,
		String	host
	)

Call this method to prepare a new object of the class. The user name and password can be blank, but the host must always be specified.

The value set in the kerberosAllowDelegation method determines whether Kerberos tickets that can be delegated are requested when the credentials are to be used.

Parameters

userName	`String` containing the Kerberos user name.
password	`String` containing the password for the user.
host	`String` containing the host address to which the HTTP request will be made.

◆ Kerberos5Credentials() [2/2]

Kerberos5Credentials	(	String	userName,
		String	password,
		String	host,
		Boolean	allowDelegation
	)

Call this function to prepare a new object of the class. The user name and password can be blank, but the host must always be specified.

The value set in the kerberosAllowDelegation method is ignored when the credentials are used to request Kerberos tickets.

Parameters

userName	`String` containing the Kerberos user name.
password	`String` containing the password for the user.
host	`String` containing the host address to which the HTTP request will be made.
allowDelegation	`Boolean` for whether tickets that can be delegated are to be requested when the credentials are used.

Member Function Documentation

◆ getUserPrincipal()

Principal getUserPrincipal ( )

Returns: The user principal value.

Implements Credentials.

◆ getHost()

String getHost ( )

Returns: String containing the host address.

◆ getUserName()

String getUserName ( )

Returns: String containing the user name.

◆ getPassword()

String getPassword ( )

Returns: String containing the password.

Implements Credentials.

◆ isDelegationAllowed()

Boolean isDelegationAllowed ( )

Returns: true if tickets that can be delegated are to be requested.; false if tickets that cannot be delegated are to be requested.; null if delegation hasn't been specified.

◆ hashCode()

int hashCode ( )

Returns: Hash code of the user principal.

◆ equals()

boolean equals ( Object o )

Returns: true if the user principal values are the same, false otherwise.

◆ toString()

String toString ( )

Returns: String representation of the user principal.