uws.service
Interface UserIdentifier

All Superinterfaces:

java.io.Serializable

public interface UserIdentifier
extends java.io.Serializable

Lets defining how identifying a user thanks to a HTTP request.

This interface is mainly used by any subclass of AbstractUWS to extract the user ID of the author of a UWS action to apply. It can be set by the function: AbstractUWS.setUserIdentifier(UserIdentifier).

Version:

02/2011

Author:

Grégory Mantelet (CDS)

Method Summary

java.lang.String

extractUserId(UWSUrl urlInterpreter, javax.servlet.http.HttpServletRequest request) Extracts the ID of the user/owner of the current session.

Method Detail

extractUserId

java.lang.String extractUserId(UWSUrl urlInterpreter,
                               javax.servlet.http.HttpServletRequest request)
                               throws UWSException

Extracts the ID of the user/owner of the current session.

This method is called just before choosing and applying a UWSAction.

Parameters:

urlInterpreter - The interpreter of the request URL.

request - The request.

Returns:

The ID of an owner/user or null to mean all users.

Throws:

UWSException - If any error occurs while extraction the user ID from the given parameters.

See Also:

AbstractUWS.executeRequest(HttpServletRequest, HttpServletResponse)