org.ow2.proactive.resourcemanager.frontend

Class RMConnection

java.lang.Object

org.ow2.proactive.authentication.Connection<RMAuthentication>

org.ow2.proactive.resourcemanager.frontend.RMConnection

All Implemented Interfaces:

Serializable, Loggable

@PublicAPI
public class RMConnection
extends Connection<RMAuthentication>

This class provides means to connect to an existing RM. As a result of connection returns RMAuthentication for further authentication.

Since:

ProActive Scheduling 0.9

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
static RMConnection	getInstance()
org.apache.log4j.Logger	getLogger() Retrieves a corresponding logger.
static RMAuthentication	join(String url) Returns the RMAuthentication from the specified URL.
static RMAuthentication	waitAndJoin(String url) Connects to the resource manager using given URL.
static RMAuthentication	waitAndJoin(String url, long timeout) Connects to the resource manager with a specified timeout value.

Methods inherited from class org.ow2.proactive.authentication.Connection

connect, getNetworkInterfaceFor, normalize, waitAndConnect, waitAndConnect

Methods inherited from class java.lang.Object

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

Method Detail

getLogger

public org.apache.log4j.Logger getLogger()

Description copied from interface: Loggable

Retrieves a corresponding logger.

Returns:

a logger for further utilization

getInstance

public static RMConnection getInstance()

join

public static RMAuthentication join(String url)
                             throws RMException

Returns the RMAuthentication from the specified URL. If resource manager is not available or initializing throws an exception.

Parameters:

url - the URL of the resource manager to join.

Returns:

the resource manager authentication at the specified URL.

Throws:

RMException - thrown if the connection to the resource manager cannot be established.

waitAndJoin

public static RMAuthentication waitAndJoin(String url)
                                    throws RMException

Connects to the resource manager using given URL. The current thread will be block until connection established or an error occurs.

Throws:

RMException

waitAndJoin

public static RMAuthentication waitAndJoin(String url,
                                           long timeout)
                                    throws RMException

Connects to the resource manager with a specified timeout value. A timeout of zero is interpreted as an infinite timeout. The connection will then block until established or an error occurs.

Throws:

RMException