org.apache.guacamole.net.auth.credentials

Class CredentialsInfo

java.lang.Object

org.apache.guacamole.net.auth.credentials.CredentialsInfo

Direct Known Subclasses:

UserCredentials

public class CredentialsInfo
extends Object

Information which describes a set of valid credentials.

Field Summary

Fields

Modifier and Type	Field and Description
static CredentialsInfo	EMPTY CredentialsInfo object which describes empty credentials.
static Field	PASSWORD A field describing the password HTTP parameter expected by Guacamole during login, if passwords are being used.
static Field	USERNAME A field describing the username HTTP parameter expected by Guacamole during login, if usernames are being used.
static CredentialsInfo	USERNAME_PASSWORD CredentialsInfo object which describes standard username/password credentials.

Constructor Summary

Constructors

Constructor and Description
CredentialsInfo(Collection<Field> fields) Creates a new CredentialsInfo object which requires the given fields for any conforming credentials.

Method Summary

Modifier and Type	Method and Description
Collection<Field>	getFields() Returns all fields required for valid credentials as described by this object.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static final CredentialsInfo EMPTY

CredentialsInfo object which describes empty credentials. No fields are required.

USERNAME

public static final Field USERNAME

A field describing the username HTTP parameter expected by Guacamole during login, if usernames are being used.

PASSWORD

public static final Field PASSWORD

A field describing the password HTTP parameter expected by Guacamole during login, if passwords are being used.

USERNAME_PASSWORD

public static final CredentialsInfo USERNAME_PASSWORD

CredentialsInfo object which describes standard username/password credentials.

Constructor Detail

CredentialsInfo

public CredentialsInfo(Collection<Field> fields)

Creates a new CredentialsInfo object which requires the given fields for any conforming credentials.

Parameters:

fields - The fields to require.

Method Detail

getFields

public Collection<Field> getFields()

Returns all fields required for valid credentials as described by this object.

Returns:

All fields required for valid credentials.