org.kitteh.irc.client.library.feature.auth

Class AbstractSaslProtocol<AuthValue>

java.lang.Object

org.kitteh.irc.client.library.feature.auth.AbstractAccountProtocol

org.kitteh.irc.client.library.feature.auth.AbstractSaslProtocol<AuthValue>

Type Parameters:

AuthValue - authentication value type

All Implemented Interfaces:

ClientLinked, AuthProtocol, AccountName, EventListening

Direct Known Subclasses:

SaslEcdsaNist256PChallenge, SaslExternal, SaslPlain

public abstract class AbstractSaslProtocol<AuthValue>
extends AbstractAccountProtocol
implements EventListening

SASL authentication. Automatically attempts auth during connection.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractSaslProtocol.Listener

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSaslProtocol(Client client, String accountName, AuthValue authValue, String saslType) Creates an instance.

Method Summary

Modifier and Type	Method and Description
protected String	getAuthentication() Gets a String for AbstractAccountProtocol.startAuthentication().
protected abstract String	getAuthLine() Gets the info to base64 encode in the first AUTHENTICATE message.
protected AuthValue	getAuthValue() Gets the authentication value, be it a password or key.
Object	getEventListener() Gets the object for listening.
protected void	setAuthValue(AuthValue authValue) Sets the authentication value.

Methods inherited from class org.kitteh.irc.client.library.feature.auth.AbstractAccountProtocol

getAccountName, getClient, setAccountName, startAuthentication, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSaslProtocol

protected AbstractSaslProtocol(@Nonnull
                               Client client,
                               @Nonnull
                               String accountName,
                               @Nonnull
                               AuthValue authValue,
                               @Nonnull
                               String saslType)

Creates an instance.

Parameters:

client - client

accountName - account name

authValue - authentication value

saslType - type of SASL auth

Method Detail

getAuthentication

@Nonnull
protected final String getAuthentication()

Description copied from class: AbstractAccountProtocol

Gets a String for AbstractAccountProtocol.startAuthentication().

Specified by:

getAuthentication in class AbstractAccountProtocol

Returns:

auth string

getEventListener

@Nonnull
public Object getEventListener()

Description copied from interface: EventListening

Gets the object for listening.

Specified by:

getEventListener in interface EventListening

Returns:

listener

getAuthValue

@Nonnull
protected final AuthValue getAuthValue()

Gets the authentication value, be it a password or key.

Returns:

the authentication value

setAuthValue

protected final void setAuthValue(@Nonnull
                                  AuthValue authValue)

Sets the authentication value.

Parameters:

authValue - the authentication value

Throws:

IllegalArgumentException - if the value is null

getAuthLine

@Nonnull
protected abstract String getAuthLine()

Gets the info to base64 encode in the first AUTHENTICATE message.

Returns:

value to encode