org.ow2.proactive.scheduler.common.job

Class UserIdentification

java.lang.Object

org.ow2.proactive.scheduler.common.job.UserIdentification

All Implemented Interfaces:

Serializable, Comparable<UserIdentification>

Direct Known Subclasses:

UserIdentificationImpl, UserIdentificationImpl

@PublicAPI
public abstract class UserIdentification
extends Object
implements Serializable, Comparable<UserIdentification>

SchedulerUser is an internal representation of a user.
It provides some information like user name, admin status, etc...

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	ASC_ORDER
static int	DESC_ORDER
static int	SORT_BY_CONNECTION
static int	SORT_BY_HOST
static int	SORT_BY_LASTSUBMIT
static int	SORT_BY_NAME Value for
static int	SORT_BY_SUBMIT
protected boolean	toRemove

Constructor Summary

Constructors

Constructor and Description
UserIdentification()

Method Summary

Modifier and Type	Method and Description
int	compareTo(UserIdentification user)
abstract long	getConnectionTime() Get the time of the connection of this user.
abstract Set<String>	getGroups() To get the groups associated with this user name
abstract String	getHostName() Get the host name of this user.
abstract long	getLastSubmitTime() Get the last time this user has submit a job.
abstract TimerTask	getSession() Get the session for this user (timer task)
abstract int	getSubmitNumber() Get the number of submit for this user.
abstract String	getUsername() To get the user name
abstract boolean	isMyEventsOnly() Get the myEventsOnly.
boolean	isToRemove() Returns true if this user has to be removed, false if not.
static void	setSortingBy(int sortBy) Set the field to sort on.
static void	setSortingOrder(int order) Set the order for the next sort.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SORT_BY_NAME

public static final int SORT_BY_NAME

Value for

See Also:

Constant Field Values

SORT_BY_SUBMIT

public static final int SORT_BY_SUBMIT

See Also:

Constant Field Values

SORT_BY_HOST

public static final int SORT_BY_HOST

See Also:

Constant Field Values

SORT_BY_CONNECTION

public static final int SORT_BY_CONNECTION

See Also:

Constant Field Values

SORT_BY_LASTSUBMIT

public static final int SORT_BY_LASTSUBMIT

See Also:

Constant Field Values

ASC_ORDER

public static final int ASC_ORDER

See Also:

Constant Field Values

DESC_ORDER

public static final int DESC_ORDER

See Also:

Constant Field Values

toRemove

protected boolean toRemove

Constructor Detail

UserIdentification

public UserIdentification()

Method Detail

getUsername

public abstract String getUsername()

To get the user name

Returns:

the user name

getGroups

public abstract Set<String> getGroups()

To get the groups associated with this user name

Returns:

a set of groups

getSubmitNumber

public abstract int getSubmitNumber()

Get the number of submit for this user.

Returns:

the number of submit for this user.

getHostName

public abstract String getHostName()

Get the host name of this user.

Returns:

the host name of this user.

getConnectionTime

public abstract long getConnectionTime()

Get the time of the connection of this user.

Returns:

the time of the connection of this user.

getLastSubmitTime

public abstract long getLastSubmitTime()

Get the last time this user has submit a job.

Returns:

the last time this user has submit a job.

isMyEventsOnly

public abstract boolean isMyEventsOnly()

Get the myEventsOnly.

Returns:

the myEventsOnly.

getSession

public abstract TimerTask getSession()

Get the session for this user (timer task)

Returns:

the session for this user, null if it has no session.

setSortingBy

public static void setSortingBy(int sortBy)

Set the field to sort on.

Parameters:

sortBy - the field on which the sort will be made.

setSortingOrder

public static void setSortingOrder(int order)

Set the order for the next sort.

Parameters:

order - the new order to set.

compareTo

public int compareTo(UserIdentification user)

Specified by:

compareTo in interface Comparable<UserIdentification>

Parameters:

user - The user to compare to this user.

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

See Also:

Comparable.compareTo(java.lang.Object)

isToRemove

public boolean isToRemove()

Returns true if this user has to be removed, false if not.

Returns:

true if this user has to be removed, false if not.