org.nuxeo.ecm.automation.client.jaxrs.spi

Class JavaClient

java.lang.Object

org.nuxeo.ecm.automation.client.jaxrs.spi.JavaClient

All Implemented Interfaces:

AutomationClient

public abstract class JavaClient
extends Object
implements AutomationClient

Abstract class for clients running on real JVMs.

When your implementation is designed for running in environment that supports limited Java API like GWT or portable devices you may need to directly implement the AutomationClient interface.

Author:

Bogdan Stefanescu

Field Summary

Fields

Modifier and Type	Field and Description
protected AdapterManager	adapters
protected ExecutorService	async
protected String	url

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JavaClient(String url)
	JavaClient(String url, ExecutorService executor)

Method Summary

Modifier and Type	Method and Description
void	asyncExec(Runnable runnable)
protected abstract JavaSession	createSession(LoginInfo login) Create a valid session using the authenticated login.
<T> T	getAdapter(Object objToAdapt, Class<T> adapterType) Adapts the given object to the given type.
AdapterManager	getAdapterManager()
String	getBaseUrl() Gets the automation service URL.
Session	getSession() Creates a new session.
void	getSession(AsyncCallback<Session> cb) Creates a new session.
Session	getSession(LoginCallback cb) Create a new session using the given login callback to gather login info.
void	getSession(LoginCallback loginCb, AsyncCallback<Session> cb) Create asynchronously a new session using the given login callback to gather login info.
Session	getSession(String username, String password) Creates a new session using the given login.
void	getSession(String username, String password, AsyncCallback<Session> cb) Creates asynchronously a new session using the given login.
protected abstract LoginInfo	login(String username, String password) Validate the credentials.
void	registerAdapter(AdapterFactory<?> factory) Register an adapter for a given type.
void	shutdown() Cleanup any resources held by this client.
void	shutdown(long timeout) TODO Move this in interface?

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.ecm.automation.client.AutomationClient

getSession, getSession

Field Detail

url

protected String url

adapters

protected AdapterManager adapters

async

protected ExecutorService async

Constructor Detail

JavaClient

protected JavaClient(String url)

JavaClient

public JavaClient(String url,
                  ExecutorService executor)

Method Detail

login

protected abstract LoginInfo login(String username,
                                   String password)

Validate the credentials. The login must occurs in first place before a session is created. A stateless session may login each time using these credentials but you canot get a session without login-in first.

Parameters:

username -

password -

Returns:

createSession

protected abstract JavaSession createSession(LoginInfo login)

Create a valid session using the authenticated login. The session will download any required data like the operation registry before being usable.

Parameters:

login -

Returns:

getBaseUrl

public String getBaseUrl()

Description copied from interface: AutomationClient

Gets the automation service URL.

Specified by:

getBaseUrl in interface AutomationClient

getAdapterManager

public AdapterManager getAdapterManager()

asyncExec

public void asyncExec(Runnable runnable)

getAdapter

public <T> T getAdapter(Object objToAdapt,
                        Class<T> adapterType)

Description copied from interface: AutomationClient

Adapts the given object to the given type. Return the adapter instance if any, otherwise null.

Optional operation. Framework that doesn't supports reflection like GWT must throw UnsupportedOperationException

Specified by:

getAdapter in interface AutomationClient

registerAdapter

public void registerAdapter(AdapterFactory<?> factory)

Description copied from interface: AutomationClient

Register an adapter for a given type. Registration is not thread safe. You should register adapters at initialization time. An adapter type can be bound to a single adaptable type.

Specified by:

registerAdapter in interface AutomationClient

getSession

public void getSession(LoginCallback loginCb,
                       AsyncCallback<Session> cb)

Description copied from interface: AutomationClient

Create asynchronously a new session using the given login callback to gather login info. The given callback will be notified after the session is created.

Specified by:

getSession in interface AutomationClient

getSession

public void getSession(AsyncCallback<Session> cb)

Description copied from interface: AutomationClient

Creates a new session. If no interceptors configured connect anonymously.

Specified by:

getSession in interface AutomationClient

getSession

public void getSession(String username,
                       String password,
                       AsyncCallback<Session> cb)

Description copied from interface: AutomationClient

Creates asynchronously a new session using the given login. The given callback will be notified after the session is created.

Specified by:

getSession in interface AutomationClient

getSession

public Session getSession(LoginCallback cb)

Description copied from interface: AutomationClient

Create a new session using the given login callback to gather login info. The given callback will be notified after the session is created.

Specified by:

getSession in interface AutomationClient

getSession

public Session getSession(String username,
                          String password)

Description copied from interface: AutomationClient

Creates a new session using the given login.

Specified by:

getSession in interface AutomationClient

getSession

public Session getSession()

Description copied from interface: AutomationClient

Creates a new session. If no interceptors configured connect anonymously.

Specified by:

getSession in interface AutomationClient

shutdown

public void shutdown()

Description copied from interface: AutomationClient

Cleanup any resources held by this client. After a shutdown the client is no more usable.

Specified by:

shutdown in interface AutomationClient

shutdown

public void shutdown(long timeout)

TODO Move this in interface?

Parameters:

timeout -