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

Class AbstractAutomationClient

java.lang.Object

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

All Implemented Interfaces:

AutomationClient

Direct Known Subclasses:

AsyncAutomationClient

public abstract class AbstractAutomationClient
extends Object
implements AutomationClient

Author:

Bogdan Stefanescu, Antoine Taillefer

Field Summary

Fields

Modifier and Type	Field and Description
protected AdapterManager	adapterManager
protected OperationRegistry	registry
protected RequestInterceptor	requestInterceptor
protected String	url

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAutomationClient(String url)

Method Summary

Modifier and Type	Method and Description
void	asyncExec(Runnable runnable)
protected OperationRegistry	connect(Connector connector)
protected Session	createSession(Connector connector, LoginInfo login)
<T> T	getAdapter(Session session, Class<T> adapterType) Adapts the given object to the given type.
String	getBaseUrl() Gets the automation service URL.
protected OperationRegistry	getRegistry()
RequestInterceptor	getRequestInterceptor() Gets access to this request interceptor
Session	getSession() Creates a new session.
Session	getSession(LoginCallback loginCb) Create a new session using the given login callback to gather login info.
protected Session	getSession(RequestInterceptor interceptor)
Session	getSession(String token) Creates a new session using the given token.
Session	getSession(String username, String password) Creates a new session using the given login.
Session	getSession(TokenCallback cb) Creates a new session using the given token callback by following these steps: Look for a token saved locally using TokenCallback.getLocalToken() If it doesn't exist, use TokenCallback#getRemoteToken(java.util.Map)) to acquire a token remotely using the information gathered by TokenCallback.getTokenParams(), and save the token locally using TokenCallback.saveToken(String) Get a session with the token using AutomationClient.getSession(String)
protected Session	login(Connector connector)
protected abstract Connector	newConnector()
void	registerAdapter(AdapterFactory<?> factory) Register an adapter for a given type.
void	registerPojoMarshaller(Class clazz) Marshaller registration for pojo bean
void	setBasicAuth(String username, String password)
void	setRequestInterceptor(RequestInterceptor interceptor) Can be used for intercepting requests before they are being sent to the server.
void	setSharedRegistryExpirationDelay(long delay)
void	shutdown() Cleanup any resources held by this client.

Methods inherited from class java.lang.Object

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

Field Detail

adapterManager

protected final AdapterManager adapterManager

url

protected String url

registry

protected volatile OperationRegistry registry

requestInterceptor

protected RequestInterceptor requestInterceptor

Constructor Detail

AbstractAutomationClient

protected AbstractAutomationClient(String url)

Method Detail

getRequestInterceptor

public RequestInterceptor getRequestInterceptor()

Gets access to this request interceptor

setRequestInterceptor

public void setRequestInterceptor(RequestInterceptor interceptor)

Can be used for intercepting requests before they are being sent to the server.

Specified by:

setRequestInterceptor in interface AutomationClient

getBaseUrl

public String getBaseUrl()

Description copied from interface: AutomationClient

Gets the automation service URL.

Specified by:

getBaseUrl in interface AutomationClient

setBasicAuth

public void setBasicAuth(String username,
                         String password)

getRegistry

protected OperationRegistry getRegistry()

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

getAdapter

public <T> T getAdapter(Session session,
                        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

connect

protected OperationRegistry connect(Connector connector)
                             throws IOException

Throws:

IOException

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

getSession

public Session getSession()
                   throws IOException

Description copied from interface: AutomationClient

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

Specified by:

getSession in interface AutomationClient

Throws:

IOException

getSession

public Session getSession(String username,
                          String password)
                   throws IOException

Description copied from interface: AutomationClient

Creates a new session using the given login.

Specified by:

getSession in interface AutomationClient

Throws:

IOException

getSession

public Session getSession(String token)
                   throws IOException

Description copied from interface: AutomationClient

Creates a new session using the given token.

Specified by:

getSession in interface AutomationClient

Throws:

IOException

getSession

protected Session getSession(RequestInterceptor interceptor)
                      throws IOException

Throws:

IOException

getSession

public Session getSession(TokenCallback cb)
                   throws IOException

Description copied from interface: AutomationClient

Creates a new session using the given token callback by following these steps:

• Look for a token saved locally using TokenCallback.getLocalToken()
• If it doesn't exist, use TokenCallback#getRemoteToken(java.util.Map)) to acquire a token remotely using the information gathered by TokenCallback.getTokenParams(), and save the token locally using TokenCallback.saveToken(String)
• Get a session with the token using AutomationClient.getSession(String)

Specified by:

getSession in interface AutomationClient

Throws:

IOException

getSession

public Session getSession(LoginCallback loginCb)

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

login

protected Session login(Connector connector)
                 throws IOException

Throws:

IOException

createSession

protected Session createSession(Connector connector,
                                LoginInfo login)

asyncExec

public void asyncExec(Runnable runnable)

newConnector

protected abstract Connector newConnector()

setSharedRegistryExpirationDelay

public void setSharedRegistryExpirationDelay(long delay)

Since:

5.7

registerPojoMarshaller

public void registerPojoMarshaller(Class clazz)

Description copied from interface: AutomationClient

Marshaller registration for pojo bean

Specified by:

registerPojoMarshaller in interface AutomationClient

Parameters:

clazz - the pojo bean to add to Marshalling