org.exoplatform.services.security.sso
Interface SSOAuthenticator

All Known Implementing Classes:

NTLMAuthenticator, SpnegoAuthenticator

public interface SSOAuthenticator

Version:

$Id: $

Author:

Andrey Parfonov

Method Summary

void	doAuthenticate(byte[] token)
Principal	getPrincipal()
byte[]	getSendBackToken()
String	getUser()
boolean	isComplete() Says is authentication complete.
boolean	isSuccess() Says is authentication successful.

Method Detail

doAuthenticate

void doAuthenticate(byte[] token)
                    throws Exception

Parameters:

token - the token from client.

Throws:

Exception - if any error occurs.

getUser

String getUser()

Returns:

the name of user if authentication is success otherwise null.

getPrincipal

Principal getPrincipal()

Returns:

the user Principal.

getSendBackToken

byte[] getSendBackToken()

Returns:

Token for sending back to client, can be null if server has nothing to say.

isComplete

boolean isComplete()

Says is authentication complete.

Returns:

true is authentication completed (with error or success), false otherwise.

isSuccess

boolean isSuccess()

Says is authentication successful.

Returns:

true if authentication (or step of it) successful false otherwise.