FileDocCategorySizeDatePackage
GDataHttpAuthenticator.javaAPI DocApache Lucene 2.1.02856Wed Feb 14 10:46:06 GMT 2007org.apache.lucene.gdata.server.authentication

GDataHttpAuthenticator

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 {@link com.google.gdata.client.Service.GDataRequest} object created by the handler and passed to the {@link org.apache.lucene.gdata.server.Service} instance. Administration interfaces use the plain {@link 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

Fields Summary
Constructors Summary
Methods Summary
public booleanauthenticateAccount(org.apache.lucene.gdata.server.GDataRequest request, org.apache.lucene.gdata.data.GDataAccount.AccountRole role)
Authenticates the client request based on the given GdataRequst and required account role

param
request - the gdata request
param
role - the required role for passing the authentication
return
true if the request successfully authenticates, otherwise false

public booleanauthenticateAccount(javax.servlet.http.HttpServletRequest request, org.apache.lucene.gdata.data.GDataAccount.AccountRole role)
Authenticates the client request based on the given requst and required account role

param
request - the client request
param
role - the required role for passing the authentication
return
true if the request successfully authenticates, otherwise false