Package org.topbraidlive.client.java

Class UsernameClientCredentials

java.lang.Object

org.topbraidlive.client.java.UsernameClientCredentials

All Implemented Interfaces:

ClientCredentials

public final class UsernameClientCredentials
extends Object
implements ClientCredentials

Immutable username credentials, used with TopBraid Composer and the cookie authentication method.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UsernameClientCredentials.Builder

Constructor Summary

Constructors

Constructor	Description
UsernameClientCredentials()	Construct a configuration by reading it from the environment.
UsernameClientCredentials(org.apache.commons.configuration2.Configuration configuration)	Construct a configuration by reading it from a commons-configuration Configuration instance.

Method Summary

Modifier and Type	Method	Description
static UsernameClientCredentials.Builder	builder()
boolean	equals(Object o)
ClientAuthenticationMethod	getDefaultAuthenticationMethod()
String	getUsername()	Get the username for authentication.
int	hashCode()
boolean	isCompatibleWithAuthenticationMethod(ClientAuthenticationMethod authenticationMethod)

Methods inherited from class java.lang.Object

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

Constructor Detail

UsernameClientCredentials

public UsernameClientCredentials()

Construct a configuration by reading it from the environment.

Throws:

InvalidClientConfigurationException

UsernameClientCredentials

public UsernameClientCredentials(org.apache.commons.configuration2.Configuration configuration)

Construct a configuration by reading it from a commons-configuration Configuration instance.

Throws:

InvalidClientConfigurationException

See Also:

UsernameClientCredentials.Builder.setFromConfiguration(Configuration)

Method Detail

builder

public static final UsernameClientCredentials.Builder builder()

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

getDefaultAuthenticationMethod

public final ClientAuthenticationMethod getDefaultAuthenticationMethod()

Specified by:

getDefaultAuthenticationMethod in interface ClientCredentials

getUsername

public final String getUsername()

Get the username for authentication.

isCompatibleWithAuthenticationMethod

public final boolean isCompatibleWithAuthenticationMethod(ClientAuthenticationMethod authenticationMethod)

Specified by:

isCompatibleWithAuthenticationMethod in interface ClientCredentials