com.palantir.giraffe.host

Class Credential<A extends Authenticator>

java.lang.Object

com.palantir.giraffe.host.Credential<A>

Type Parameters:

A - the type of Authenticator that accepts this credential

Direct Known Subclasses:

SshCredential

public abstract class Credential<A extends Authenticator>
extends Object

Contains information required to authenticate with a host or service.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Credential(Class<A> authenticatorType)

Method Summary

Modifier and Type	Method and Description
abstract void	authenticate(A authenticator) Authenticates the connection managed by the given Authenticator using this credential.
Class<A>	getAuthenticatorType() Returns the type of Authenticator accepted by this credential.

Methods inherited from class java.lang.Object

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

Constructor Detail

Credential

protected Credential(Class<A> authenticatorType)

Method Detail

getAuthenticatorType

public final Class<A> getAuthenticatorType()

Returns the type of Authenticator accepted by this credential.

authenticate

public abstract void authenticate(A authenticator)
                           throws IOException

Authenticates the connection managed by the given Authenticator using this credential.

This method participates in the visitor pattern with methods defined by Authenticator implementations.

Parameters:

authenticator - the Authenticator for the connection

Throws:

AuthenticationException - if authentication fails

IOException - if an I/O error occurs while authenticating the connection