public class DefaultSession extends Object implements Session
Constructor and Description |
---|
DefaultSession(AbstractAutomationClient client,
Connector connector,
LoginInfo login) |
Modifier and Type | Method and Description |
---|---|
void |
close()
Remove any resources held by this session.
|
Object |
execute(OperationRequest request) |
void |
execute(OperationRequest request,
AsyncCallback<Object> cb) |
<T> T |
getAdapter(Class<T> type)
Get an adapter of the current session.
|
AutomationClient |
getClient()
Get the client that created this session.
|
Connector |
getConnector() |
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.
|
void |
getFile(String path,
AsyncCallback<Blob> cb) |
Blobs |
getFiles(String path)
Get a collection of files from the server given the path identifying the
collection.
|
void |
getFiles(String path,
AsyncCallback<Blobs> cb) |
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.
|
public DefaultSession(AbstractAutomationClient client, Connector connector, LoginInfo login)
public AutomationClient getClient()
Session
public Connector getConnector()
public LoginInfo getLogin()
Session
public <T> T getAdapter(Class<T> type)
Session
Optional operation. Environments that cannot support this method (like
GWT) must throw UnsupportedOperationException
getAdapter
in interface Session
AutomationClient#getAdapter(Object, Class)
public String getDefaultSchemas()
Session
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.
getDefaultSchemas
in interface Session
public void setDefaultSchemas(String defaultSchemas)
Session
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.
setDefaultSchemas
in interface Session
defaultSchemas
- list of schemas as a comma separated stringpublic Object execute(OperationRequest request) throws Exception
public void execute(OperationRequest request, AsyncCallback<Object> cb)
public Blob getFile(String path) throws Exception
Session
public Blobs getFiles(String path) throws Exception
Session
public void getFile(String path, AsyncCallback<Blob> cb) throws Exception
public void getFiles(String path, AsyncCallback<Blobs> cb) throws Exception
public OperationRequest newRequest(String id) throws Exception
Session
newRequest
in interface Session
id
- the ID of the operation to be executed.Exception
public OperationRequest newRequest(String id, Map<String,Object> ctx) throws Exception
Session
newRequest
in interface Session
id
- the operation idctx
- the context map to be used when executing the operation on
the server.Exception
public OperationDocumentation getOperation(String id)
getOperation
in interface Session
public Map<String,OperationDocumentation> getOperations()
getOperations
in interface Session
Copyright © 2013 Nuxeo SA. All Rights Reserved.