org.dcache.xrootd.plugins

Interface AuthenticationHandler

All Known Implementing Classes:

NoAuthenticationHandler

public interface AuthenticationHandler

Method Summary

Modifier and Type	Method and Description
XrootdResponse<AuthenticationRequest>	authenticate(AuthenticationRequest request) Authenticate method, parsing the requests and creating adequate responses.
String	getProtocol()
Subject	getSubject() Get the subject containing the credentials/principals found during authentication.
boolean	isCompleted() Indicates if the authentication process completed successfully.

Method Detail

authenticate

XrootdResponse<AuthenticationRequest> authenticate(AuthenticationRequest request)
                                            throws XrootdException

Authenticate method, parsing the requests and creating adequate responses. The internal state of the handler might be changed by this method.

Parameters:

request - Request received from client

Returns:

Response to be sent to the client

Throws:

XrootdException

getProtocol

String getProtocol()

Returns:

the protocol that is implemented by the authentication handler

getSubject

Subject getSubject()

Get the subject containing the credentials/principals found during authentication. The method MUST return null if no user has been authenticated yet. The method MAY return null even if the authentication step has completed - this indicates an anonymous user.

isCompleted

boolean isCompleted()

Indicates if the authentication process completed successfully.