org.ow2.proactive.scheduler.common

Class SchedulerConnection

java.lang.Object

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

org.ow2.proactive.scheduler.common.SchedulerConnection

All Implemented Interfaces:

Serializable, Loggable

@PublicAPI
public class SchedulerConnection
extends Connection<SchedulerAuthenticationInterface>

Start here, it provides a method to join an existing scheduler.
The method join(String) returns a SchedulerAuthenticationInterface in order to give the scheduler the possibility to authenticate user that wants to connect a scheduler.

Since:

ProActive Scheduling 0.9

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
static SchedulerConnection	getInstance() Get the instance of the Scheduler connection
org.apache.log4j.Logger	getLogger() Retrieves a corresponding logger.
static SchedulerAuthenticationInterface	join(String url) Returns the SchedulerAuthenticationInterface from the specified URL.
static SchedulerAuthenticationInterface	waitAndJoin(String url) Connects to the scheduler using given URL.
static SchedulerAuthenticationInterface	waitAndJoin(String url, long timeout) Connects to the scheduler 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

See Also:

Loggable.getLogger()

getInstance

public static SchedulerConnection getInstance()

Get the instance of the Scheduler connection

Returns:

the instance of the Scheduler connection

join

public static SchedulerAuthenticationInterface join(String url)
                                             throws ConnectionException

Returns the SchedulerAuthenticationInterface from the specified URL. If scheduler is not available or initializing throws an exception.
Note that you can use the provided SchedulerAuthenticationGUIHelper class to display a graphical interface that will ask the URL, login and password.

Parameters:

url - the URL of the scheduler to join.

Returns:

the scheduler authentication at the specified URL.

Throws:

ConnectionException - if connection is not possible on the given URL.

waitAndJoin

public static SchedulerAuthenticationInterface waitAndJoin(String url)
                                                    throws ConnectionException

Connects to the scheduler using given URL. The current thread will be block until connection established or an error occurs.
Note that you can use the provided SchedulerAuthenticationGUIHelper class to display a graphical interface that will ask the URL, login and password.

Parameters:

url - the URL of the scheduler to join.

Returns:

the interface to be authenticate by the Scheduler

Throws:

ConnectionException - if connection is not possible on the given URL.

waitAndJoin

public static SchedulerAuthenticationInterface waitAndJoin(String url,
                                                           long timeout)
                                                    throws ConnectionException

Connects to the scheduler 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.
Note that you can use the provided SchedulerAuthenticationGUIHelper class to display a graphical interface that will ask the URL, login and password.

Parameters:

url - the URL of the scheduler to join.

timeout - the amount of time during which it will try to join the Scheduler

Returns:

the interface to be authenticate by the Scheduler

Throws:

ConnectionException