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 UWSService to identify the author of a UWS action to apply. It can be set by the function: UWSService.setUserIdentifier(UserIdentifier).

Version:

06/2012

Author:

Grégory Mantelet (CDS)

Method Summary

Modifier and Type	Method and Description
JobOwner	extractUserId(UWSUrl urlInterpreter, javax.servlet.http.HttpServletRequest request) Extracts the ID of the user/owner of the current session.
JobOwner	restoreUser(java.lang.String id, java.lang.String pseudo, java.util.Map<java.lang.String,java.lang.Object> otherData) Creates a user with the given parameters or merely gets it if it already exists after updating it.

Method Detail

extractUserId

JobOwner 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 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:

UWSService.executeRequest(HttpServletRequest, HttpServletResponse)

restoreUser

JobOwner restoreUser(java.lang.String id,
                     java.lang.String pseudo,
                     java.util.Map<java.lang.String,java.lang.Object> otherData)
              throws UWSException

Creates a user with the given parameters or merely gets it if it already exists after updating it.

Parameters:

id - ID of the user.

pseudo - Pseudo of the user (may be NULL).

otherData - Other data about the user (may be NULL or empty).

Returns:

The corresponding user.

Throws:

UWSException - If any error occurs while creating or getting the user.

See Also:

DefaultUWSBackupManager.restoreAll()