org.apache.lucene.gdata.server.authentication
Interface GDataHttpAuthenticator

All Known Implementing Classes:

AbstractAccountHandler, AbstractFeedHandler, AbstractGdataRequestHandler, DefaultDeleteHandler, DefaultGetHandler, DefaultInsertHandler, DefaultUpdateHandler, DeleteAccountStrategy, DeleteFeedHandler, InsertAccountStrategy, InsertFeedHandler, RequestAuthenticator, UpdateAccountStrategy, UpdateFeedHandler

public interface GDataHttpAuthenticator

The GData protocol is based on the widly know REST approach and therefor client authentication will mostly be provided via a REST interface.

This interface describes internally used authentication methods to be implemented by http based authenticator implementations. The GData Server basically has 2 different REST interfaces need authentication. One is for altering feed entries and the other for administration actions.

The interface altering entries work with com.google.gdata.client.Service.GDataRequest object created by the handler and passed to the Service instance. Administration interfaces use the plain javax.servlet.http.HttpServletRequest inside the handler. For each type of interface a authentication type a method has to be provided by implementing classes.

Author:

Simon Willnauer

Method Summary

boolean

authenticateAccount(GDataRequest request, GDataAccount.AccountRole role) Authenticates the client request based on the given GdataRequst and required account role

Method Detail

authenticateAccount

boolean authenticateAccount(GDataRequest request,
                            GDataAccount.AccountRole role)

Authenticates the client request based on the given GdataRequst and required account role

Parameters:

request - - the gdata request

role - - the required role for passing the authentication

Returns:

true if the request successfully authenticates, otherwise false