uws.job.user

Class DefaultJobOwner

java.lang.Object

uws.job.user.DefaultJobOwner

All Implemented Interfaces:

JobOwner

public final class DefaultJobOwner
extends java.lang.Object
implements JobOwner

Default implementation of JobOwner.

In this implementation, a job owner has only an ID and a pseudo (which may be the same). However, other informations may be added thanks to putUserData(String, String). These additional data will also be saved with the ID and the pseudo/name of the user by a backup manager.

Version:

05/2012

Author:

Grégory Mantelet (CDS)

Constructor Summary

Constructors

Constructor and Description
DefaultJobOwner(java.lang.String name) Builds a Job Owner which has the given ID.
DefaultJobOwner(java.lang.String id, java.lang.String pseudo)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) By default: a DefaultJobOwner is equal to any JobOwner only if their ID are equals.
java.util.Set<java.lang.String>	getAllUserData()
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.
java.lang.String	getUserData(java.lang.String name)
boolean	hasExecutePermission(UWSJob job) By default: ONLY owners of the given job have the EXECUTE permission.
int	hashCode() By default: this function returns the hashCode of the ID.
boolean	hasReadPermission(JobList jl) By default: ALL users have the READ permission for ALL jobs lists.
boolean	hasReadPermission(UWSJob job) By default: ONLY owners of the given job have the READ permission.
boolean	hasWritePermission(JobList jl) By default: ALL users have the WRITE permission for ALL jobs lists.
boolean	hasWritePermission(UWSJob job) By default: ONLY owners of the given job have the WRITE permission.
java.lang.String	putUserData(java.lang.String name, java.lang.String value)
java.lang.String	removeUserData(java.lang.String name)
void	restoreData(java.util.Map<java.lang.String,java.lang.Object> data) Restores any additional user data from the given map.
void	setPseudo(java.lang.String pseudo)
java.lang.String	toString() By default: the user ID.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DefaultJobOwner

public DefaultJobOwner(java.lang.String name)

Builds a Job Owner which has the given ID. Its pseudo will also be equal to the given ID.

Parameters:

name - ID/Pseudo of the Job Owner to create.

DefaultJobOwner

public DefaultJobOwner(java.lang.String id,
                       java.lang.String pseudo)

Method Detail

getID

public final java.lang.String getID()

Description copied from interface: JobOwner

Unique ID of a user.

Specified by:

getID in interface JobOwner

Returns:

User ID.

getPseudo

public final java.lang.String getPseudo()

Description copied from interface: JobOwner

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.

Specified by:

getPseudo in interface JobOwner

Returns:

Pseudo/Name of a user.

setPseudo

public final void setPseudo(java.lang.String pseudo)

hasReadPermission

public boolean hasReadPermission(JobList jl)

By default: ALL users have the READ permission for ALL jobs lists.

Specified by:

hasReadPermission in interface JobOwner

Parameters:

jl - A jobs list.

Returns:

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

See Also:

JobOwner.hasReadPermission(uws.job.JobList)

hasWritePermission

public boolean hasWritePermission(JobList jl)

By default: ALL users have the WRITE permission for ALL jobs lists.

Specified by:

hasWritePermission in interface JobOwner

Parameters:

jl - A jobs list.

Returns:

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

See Also:

JobOwner.hasWritePermission(uws.job.JobList)

hasReadPermission

public boolean hasReadPermission(UWSJob job)

By default: ONLY owners of the given job have the READ permission.

Specified by:

hasReadPermission in interface JobOwner

Parameters:

job - A job.

Returns:

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

See Also:

JobOwner.hasReadPermission(uws.job.UWSJob)

hasWritePermission

public boolean hasWritePermission(UWSJob job)

By default: ONLY owners of the given job have the WRITE permission.

Specified by:

hasWritePermission in interface JobOwner

Parameters:

job - A job.

Returns:

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

See Also:

JobOwner.hasWritePermission(uws.job.UWSJob)

hasExecutePermission

public boolean hasExecutePermission(UWSJob job)

By default: ONLY owners of the given job have the EXECUTE permission.

Specified by:

hasExecutePermission in interface JobOwner

Parameters:

job - A job.

Returns:

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

See Also:

JobOwner.hasExecutePermission(uws.job.UWSJob)

putUserData

public java.lang.String putUserData(java.lang.String name,
                                    java.lang.String value)

getUserData

public java.lang.String getUserData(java.lang.String name)

removeUserData

public java.lang.String removeUserData(java.lang.String name)

getAllUserData

public java.util.Set<java.lang.String> getAllUserData()

getDataToSave

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

Description copied from interface: JobOwner

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

Specified by:

getDataToSave in interface JobOwner

Returns:

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

restoreData

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

Description copied from interface: JobOwner

Restores any additional user data from the given map.

Specified by:

restoreData in interface JobOwner

Parameters:

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

toString

public java.lang.String toString()

By default: the user ID.

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()

equals

public boolean equals(java.lang.Object obj)

By default: a DefaultJobOwner is equal to any JobOwner only if their ID are equals.

Overrides:

equals in class java.lang.Object

See Also:

Object.equals(java.lang.Object)

hashCode

public int hashCode()

By default: this function returns the hashCode of the ID.

Overrides:

hashCode in class java.lang.Object

See Also:

Object.hashCode()