Skip navigation links

com.oracle.sft.api
Class AuthenticationCallback

java.lang.Object
com.oracle.sft.api.AuthenticationCallback

All Implemented Interfaces:

Callback

public class AuthenticationCallback

extends Object

implements Callback

An instance of AuthenticationCallback will be passed to the CallbackHandler that is set by the application in the CommunicationService when an authentication challenge response is sent to SFT. The SFT will then collect the username and password provided by the CallbackHandler and these credentials will then be used for responding to the authentication challenge.

See Also:

CommunicationService.setAuthenticationCallbackHandler(javax.security.auth.callback.CallbackHandler), Callback, CallbackHandler

Nested Class Summary

static class

AuthenticationCallback.ChallengeType Type of Challenge for which the CallbackHandler is invoked.

Constructor Summary

AuthenticationCallback(AuthenticationCallback.ChallengeType challengeType, Communication communication, String realm)
Creates a AuthenticationCallback for an authentication challenge.

Method Summary

AuthenticationCallback.ChallengeType	getChallengeType() CallbackHandler implementation retrieve the type of challenge using this method.
Communication	getCommunication() Retrieve the Communication whose challenge response has reached SFT.
char[]	getPassword() Retrieve the password as a char array set by the CallbackHandler implementation.
String	getRealm() Retrieve the realm of the authentication challenge.
String	getUserName() Retrieve the username for responding to the authentication challenge.
void	setPassword(char[] password) Set the password as a char array.
void	setRealm(String realm) Set the realm of the authentication challenge.
void	setUserName(String userName) Set the username for responding to the authentication challenge.

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticationCallback

public AuthenticationCallback(AuthenticationCallback.ChallengeType challengeType,
                              Communication communication,
                              String realm)

Creates a AuthenticationCallback for an authentication challenge.

Parameters:

challengeType - Type of Challenge

communication - The Communication for the authentication challenge

realm - Realm used in the authentication challenge.

Method Detail

getCommunication

public Communication getCommunication()

Retrieve the Communication whose challenge response has reached SFT.

Returns:

Communicaion instance.

getChallengeType

public AuthenticationCallback.ChallengeType getChallengeType()

CallbackHandler implementation retrieve the type of challenge using this method.

Returns:

ChallengeType of the challenge.

getPassword

public char[] getPassword()

Retrieve the password as a char array set by the CallbackHandler implementation.

Returns:

The password to use when responding to an authentication challenge.

setPassword

public void setPassword(char[] password)

Set the password as a char array. This is done by the CallbackHandler implementation.

setRealm

public void setRealm(String realm)

Set the realm of the authentication challenge. This is usually done by the SFT.

Parameters:

realm - The realm of the authentication challenge.

getRealm

public String getRealm()

Retrieve the realm of the authentication challenge. This is usually done by the CallbackHandler.

Returns:

The realm of the authentication challenge.

getUserName

public String getUserName()

Retrieve the username for responding to the authentication challenge.

Returns:

The username for responding to the authentication authentication.

setUserName

public void setUserName(String userName)

Set the username for responding to the authentication challenge.

Parameters:

userName - The for responding to the authentication authentication.

Skip navigation links