org.nuxeo.ecm.automation.client

Interface AutomationClient

All Known Implementing Classes:

AbstractAutomationClient, AsyncAutomationClient, HttpAutomationClient, JavaClient

public interface AutomationClient

The connection to the automation service is done the first time you create a session. To create a session you need to pass the authentication information. If null is passed as the user name an anonymous session will be created. Note that anonymous sessions are not always accepted by a Nuxeo Server (it depends on the server configuration).

When you attempt to create a new session using the same authentication info as an already created session the session will be reused (TODO this is optional for implementors?)

Note for implementors: the implementation should provide a constructor that initialize the base URL

Author:

Bogdan Stefanescu

Method Summary

Modifier and Type	Method and Description
<T> T	getAdapter(Session session, Class<T> adapterType) Adapts the given object to the given type.
String	getBaseUrl() Gets the automation service URL.
Session	getSession() Creates a new session.
Session	getSession(LoginCallback loginCb) Create a new session using the given login callback to gather login info.
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 getSession(String)
void	registerAdapter(AdapterFactory<?> factory) Register an adapter for a given type.
void	registerPojoMarshaller(Class clazz) Marshaller registration for pojo bean
void	setRequestInterceptor(RequestInterceptor interceptor)
void	shutdown() Cleanup any resources held by this client.

Method Detail

setRequestInterceptor

void setRequestInterceptor(RequestInterceptor interceptor)

Parameters:

interceptor -

Since:

6.0

getBaseUrl

String getBaseUrl()

Gets the automation service URL.

getSession

Session getSession()
            throws IOException

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

Throws:

IOException

getSession

Session getSession(LoginCallback loginCb)
            throws IOException

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

Throws:

IOException

getSession

Session getSession(String username,
                   String password)
            throws IOException

Creates a new session using the given login.

Throws:

IOException

getSession

Session getSession(String token)
            throws IOException

Creates a new session using the given token.

Throws:

IOException

Since:

5.7

getSession

Session getSession(TokenCallback cb)
            throws IOException

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 getSession(String)

Throws:

IOException

Since:

5.7

getAdapter

<T> T getAdapter(Session session,
                 Class<T> adapterType)

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

registerAdapter

void registerAdapter(AdapterFactory<?> factory)

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.

Parameters:

typeToAdapt -

adapterType -

registerPojoMarshaller

void registerPojoMarshaller(Class clazz)

Marshaller registration for pojo bean

Parameters:

clazz - the pojo bean to add to Marshalling

Since:

5.7.2

shutdown

void shutdown()

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