uws.job.user

Interface JobOwner

All Known Implementing Classes:

DefaultJobOwner

public interface JobOwner

Represents a user of a UWS and a potential job owner.

Version:

05/2012

Author:

Grégory Mantelet (CDS)

See Also:

UserIdentifier

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	getDataToSave() Gets all user data to save (including ID and pseudo/name).
java.lang.String	getID() Unique ID of a user.
java.lang.String	getPseudo() Pseudo of a user.
boolean	hasExecutePermission(UWSJob job) Tells whether this user has the right to execute and to abort the given job.
boolean	hasReadPermission(JobList jl) Tells whether this user has the right to list the jobs of the given jobs list.
boolean	hasReadPermission(UWSJob job) Tells whether this user has the right to read all parameters, errors and results of the given job.
boolean	hasWritePermission(JobList jl) Tells whether this user has the right to add/remove jobs to/from the given jobs list.
boolean	hasWritePermission(UWSJob job) Tells whether this user has the right to destroy the given job and to change the value of its parameters.
void	restoreData(java.util.Map<java.lang.String,java.lang.Object> data) Restores any additional user data from the given map.

Method Detail

getID

java.lang.String getID()

Unique ID of a user.

Returns:

User ID.

getPseudo

java.lang.String getPseudo()

Pseudo of a user. It is used only to display the identity of a user. note: a same pseudo may be used by several job owner.

Returns:

Pseudo/Name of a user.

hasReadPermission

boolean hasReadPermission(JobList jl)

Tells whether this user has the right to list the jobs of the given jobs list.

Parameters:

jl - A jobs list.

Returns:

true if this user can read the given jobs list, false otherwise.

hasWritePermission

boolean hasWritePermission(JobList jl)

Tells whether this user has the right to add/remove jobs to/from the given jobs list.

Parameters:

jl - A jobs list.

Returns:

true if this user can write the given jobs list, false otherwise.

hasReadPermission

boolean hasReadPermission(UWSJob job)

Tells whether this user has the right to read all parameters, errors and results of the given job.

Parameters:

job - A job.

Returns:

true if this user can read the given job, false otherwise.

hasWritePermission

boolean hasWritePermission(UWSJob job)

Tells whether this user has the right to destroy the given job and to change the value of its parameters.

Parameters:

job - A job.

Returns:

true if this user can write the given job, false otherwise.

hasExecutePermission

boolean hasExecutePermission(UWSJob job)

Tells whether this user has the right to execute and to abort the given job.

Parameters:

job - A job.

Returns:

true if this user can execute/abort the given job, false otherwise.

getDataToSave

java.util.Map<java.lang.String,java.lang.Object> getDataToSave()

Gets all user data to save (including ID and pseudo/name).

Returns:

A map with some key/value pairs, null or an empty map if no additional user data.

restoreData

void restoreData(java.util.Map<java.lang.String,java.lang.Object> data)

Restores any additional user data from the given map.

Parameters:

data - A map with some key/value pairs, null or an empty map if no additional user data.