org.nuxeo.ecm.automation.client

Interface Session

All Known Implementing Classes:

DefaultSession, JavaSession

public interface Session

Author:

Bogdan Stefanescu

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Remove any resources held by this session.
Object	execute(OperationRequest request)
<T> T	getAdapter(Class<T> type) Get an adapter of the current session.
AutomationClient	getClient() Get the client that created this session.
String	getDefaultSchemas() Get the default schemas that should be sent by the server.
Blob	getFile(String path) Get a file from the server given a path identifying the file.
Blobs	getFiles(String path) Get a collection of files from the server given the path identifying the collection.
LoginInfo	getLogin() Get the login used to authenticate against the server
OperationDocumentation	getOperation(String id)
Map<String,OperationDocumentation>	getOperations()
OperationRequest	newRequest(String id) Create a new operation request given an operation ID.
OperationRequest	newRequest(String id, Map<String,Object> ctx) Create a new operation request given an operation ID and an operation context map.
void	setDefaultSchemas(String defaultSchemas) Set the default schemas that should be sent by the server.

Method Detail

getClient

AutomationClient getClient()

Get the client that created this session.

Returns:

the client. cannot be null.

getLogin

LoginInfo getLogin()

Get the login used to authenticate against the server

Returns:

the login. cannot be null.

newRequest

OperationRequest newRequest(String id)

Create a new operation request given an operation ID.

Parameters:

id - the ID of the operation to be executed.

Returns:

the operation request

newRequest

OperationRequest newRequest(String id,
                          Map<String,Object> ctx)

Create a new operation request given an operation ID and an operation context map.

Parameters:

id - the operation id

ctx - the context map to be used when executing the operation on the server.

Returns:

the operation request

execute

Object execute(OperationRequest request)
               throws IOException

Throws:

IOException

getFile

Blob getFile(String path)
             throws IOException

Get a file from the server given a path identifying the file.

Parameters:

path - the file path

Returns:

a blob representation of the file

Throws:

IOException

getFiles

Blobs getFiles(String path)
               throws IOException

Get a collection of files from the server given the path identifying the collection.

Parameters:

path - the file path

Returns:

a collection of files represented as blobs.

Throws:

IOException

getOperation

OperationDocumentation getOperation(String id)

getOperations

Map<String,OperationDocumentation> getOperations()

getAdapter

<T> T getAdapter(Class<T> type)

Get an adapter of the current session. Adapters can be used to define custom API over a Nuxeo Automation Session.

Optional operation. Environments that cannot support this method (like GWT) must throw UnsupportedOperationException

See Also:

AutomationClient#getAdapter(Object, Class)

getDefaultSchemas

String getDefaultSchemas()

Get the default schemas that should be sent by the server.

This is a comma separated String (ex: dublincore,file)

default value is null (let the server decide what to send)

when Automation server convert the Documents to JSON, it will use this list to select what properties should be sent. You can explicitly set the X-NXDocumentProperties header at request level. If defaultSchemas, the request that don't already have the header set will inherit the default value.

Since:

5.7

setDefaultSchemas

void setDefaultSchemas(String defaultSchemas)

Set the default schemas that should be sent by the server.

This is a comma separated String (ex: dublincore,file)

when Automation server convert the Documents to JSON, it will use this list to select what properties should be sent. You can explicitly set the X-NXDocumentProperties header at request level. If defaultSchemas, the request that don't already have the header set will inherit the default value.

Parameters:

defaultSchemas - list of schemas as a comma separated string

Since:

5.7

close

void close()

Remove any resources held by this session. The session will no more be used again.