org.ow2.proactive.resourcemanager.authentication

Class Client

java.lang.Object

org.ow2.proactive.resourcemanager.authentication.Client

All Implemented Interfaces:

Serializable

public class Client
extends Object
implements Serializable

This class represents a client of the resource manager(RM). It could be an internal service or connected remote user. The class is used to track and associate all activities inside the RM to particular user. It also provides capabilities to detect if the client is still alive. NOTE: The pinger functionality has some drawbacks and limitations. For instance it cannot be used after serialization/deserialization of the class. It relies on ProActive internals and probably will be replaced in the future.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Client()
Client(Subject subject, boolean pingable) Constructs the client object from given client subject.

Method Summary

Modifier and Type	Method and Description
boolean	checkPermission(Permission permission, String errorMessage, Permission... superUserPermissions) Checks that client has the specified permission.
boolean	equals(Object o) Redefined equals method based on client's name
Credentials	getCredentials()
String	getDomain()
Set<String>	getGroups()
UserHistory	getHistory() Returns the connection history object linked to the data base
org.objectweb.proactive.core.UniqueID	getId() Gets the id of the client
static org.objectweb.proactive.core.UniqueID	getId(Object service) Extract the body id from an active object.
String	getName() Gets the name of the client
Subject	getSubject()
String	getTenant()
int	hashCode()
boolean	isAlive() Checks if the client is alive by sending the message to it.
boolean	isPingable() Defines if the client has to be pinged.
void	setCredentials(Credentials credentials)
void	setHistory(UserHistory history) Sets the history DB object associated to the current user connection.
void	setId(org.objectweb.proactive.core.UniqueID id) Sets the id of the client
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Client

public Client()

Client

public Client(Subject subject,
              boolean pingable)

Constructs the client object from given client subject.

Parameters:

subject - with the name of the client authenticated in the resource manager (can be null)

pingable - defines if client has to be pinged

Method Detail

getName

public String getName()

Gets the name of the client

Returns:

the name of the client

getGroups

public Set<String> getGroups()

getTenant

public String getTenant()

getDomain

public String getDomain()

getId

public org.objectweb.proactive.core.UniqueID getId()

Gets the id of the client

Returns:

the id of the client

setId

public void setId(org.objectweb.proactive.core.UniqueID id)

Sets the id of the client

Parameters:

id - new client's id

isPingable

public boolean isPingable()

Defines if the client has to be pinged. Client of the core could be an internal service or connected active object. We heed to ping only connected ones.

Returns:

true if ping is requires

equals

public boolean equals(Object o)

Redefined equals method based on client's name

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

Returns:

string representation of the client

isAlive

public boolean isAlive()

Checks if the client is alive by sending the message to it. There is a blocking network call inside so it should be used carefully. Throws an exception if the client body is not available which is always the case after serialization.

Returns:

true if the client is alive, false otherwise

getId

public static org.objectweb.proactive.core.UniqueID getId(Object service)

Extract the body id from an active object. TODO find more straightforward way to do that

Parameters:

service - a target active object

Returns:

an active object body id

getSubject

public Subject getSubject()

Returns:

the subject of the client

checkPermission

public boolean checkPermission(Permission permission,
                               String errorMessage,
                               Permission... superUserPermissions)

Checks that client has the specified permission.

Returns:

true if it has, throw SecurityException otherwise with specified error message

setHistory

public void setHistory(UserHistory history)

Sets the history DB object associated to the current user connection.

Parameters:

history - is an object to set

getHistory

public UserHistory getHistory()

Returns the connection history object linked to the data base

Returns:

the connection history object linked to the data base

setCredentials

public void setCredentials(Credentials credentials)

getCredentials

public Credentials getCredentials()