org.nuxeo.ecm.platform.api.ws

Interface NuxeoRemoting

All Superinterfaces:

BaseNuxeoWebService, Serializable

All Known Subinterfaces:

WSExalead, WSIndexingGateway

All Known Implementing Classes:

NuxeoRemotingBean, WSExaleadBean, WSIndexingGatewayBean

public interface NuxeoRemoting
extends BaseNuxeoWebService

Nuxeo EP remoting API.

Author:

Julien Anguenot

Method Summary

Methods

Modifier and Type	Method and Description
DocumentDescriptor[]	getChildren(String sessionId, String uuid) Gets the children of the given document.
DocumentDescriptor	getCurrentVersion(String sid, String uid) Gets the current version of the given document.
DocumentDescriptor	getDocument(String sessionId, String uuid) Gets the doc descriptor given the doc UUID.
WsACE[]	getDocumentACL(String sid, String uuid) Returns the merged ACL of the document (contains all ACEs defined on the document and its parents).
DocumentBlob[]	getDocumentBlobs(String sid, String uuid) Returns the document blobs only using byte[] format
DocumentBlob[]	getDocumentBlobsExt(String sid, String uuid, boolean useDownloadUrl) Returns the document blobs only.
WsACE[]	getDocumentLocalACL(String sid, String uuid) Returns the merged ACL of the document (contains all ACEs defined on the document, filtering the inherited ones).
DocumentProperty[]	getDocumentNoBlobProperties(String sid, String uuid) Same as getDocumentProperties(String, String) but skips blobs.
DocumentProperty[]	getDocumentProperties(String sid, String uuid) Returns the document properties.
DocumentSnapshot	getDocumentSnapshot(String sid, String uuid) Gets all properties and ACLs from a document uses byte[] format to export blob
DocumentSnapshot	getDocumentSnapshotExt(String sid, String uuid, boolean useDownloadUrl) Gets all properties and ACLs from a document
String[]	getGroups(String sid, String parentGroup) Gets all sub-groups inside the given group.
String	getRelativePathAsString(String sessionId, String uuid) Returns the relative path as a displayable path with parent titles.
String	getRepositoryName(String sid) Gets the current repository name.
DocumentDescriptor	getRootDocument(String sessionId) Gets the root document descriptor.
DocumentDescriptor	getSourceDocument(String sid, String uid) Gets the document that created the version specified by the given uid.
String[]	getUsers(String sid, String parentGroup) Get all users inside the given group.
DocumentDescriptor[]	getVersions(String sid, String uid) Gets the versions of the given document.
boolean	hasPermission(String sid, String uuid, String permission) Checks the given permission for the current user on the given document.
String[]	listGroups(String sid, int from, int to) Return the list of all groups.
String[]	listUsers(String sid, int from, int to) Returns the list of all users.
String	uploadDocument(String sid, String path, String type, String[] properties)

Methods inherited from interface org.nuxeo.ecm.platform.api.ws.BaseNuxeoWebService

connect, disconnect

Method Detail

getRepositoryName

String getRepositoryName(String sid)
                         throws ClientException

Gets the current repository name.

Parameters:

sid - the session id

Returns:

the repository name

Throws:

ClientException

getRootDocument

DocumentDescriptor getRootDocument(String sessionId)
                                   throws ClientException

Gets the root document descriptor.

Returns:

the root document

Throws:

ClientException

getDocument

DocumentDescriptor getDocument(String sessionId,
                             String uuid)
                               throws ClientException

Gets the doc descriptor given the doc UUID.

Parameters:

sessionId - the session id

uuid - the doc uuid

Returns:

the descriptor

Throws:

ClientException

getChildren

DocumentDescriptor[] getChildren(String sessionId,
                               String uuid)
                                 throws ClientException

Gets the children of the given document.

Parameters:

sessionId - the session id

uuid - the doc uuid

Returns:

the children descriptors

Throws:

ClientException

getRelativePathAsString

String getRelativePathAsString(String sessionId,
                             String uuid)
                               throws ClientException

Returns the relative path as a displayable path with parent titles.

Example: /Workspaces/My Workspaces/Nice Document

Parameters:

sessionId - : the session id

uuid - : the document uuid

Returns:

a relative path

Throws:

ClientException

getVersions

DocumentDescriptor[] getVersions(String sid,
                               String uid)
                                 throws ClientException

Gets the versions of the given document.

Parameters:

sid -

uid -

Returns:

Throws:

ClientException

getCurrentVersion

DocumentDescriptor getCurrentVersion(String sid,
                                   String uid)
                                     throws ClientException

Gets the current version of the given document.

Parameters:

sid -

Returns:

Throws:

ClientException

getSourceDocument

DocumentDescriptor getSourceDocument(String sid,
                                   String uid)
                                     throws ClientException

Gets the document that created the version specified by the given uid.

Parameters:

sid -

uid -

Returns:

Throws:

ClientException

getDocumentProperties

DocumentProperty[] getDocumentProperties(String sid,
                                       String uuid)
                                         throws ClientException

Returns the document properties.

All property are returned even blobs. All values are converted to strings.

It includes the perm link of the document.

No need to includes blobs here. See the dedicated API.

Parameters:

uuid - uuid of the document.

Returns:

a map from name of the property to its value

Throws:

ClientException

getDocumentNoBlobProperties

DocumentProperty[] getDocumentNoBlobProperties(String sid,
                                             String uuid)
                                               throws ClientException

Same as getDocumentProperties(String, String) but skips blobs.

Parameters:

sid -

uuid -

Returns:

Throws:

ClientException

getDocumentBlobs

DocumentBlob[] getDocumentBlobs(String sid,
                              String uuid)
                                throws ClientException

Returns the document blobs only using byte[] format

Parameters:

uuid - the uuid of the document.

Returns:

an array of document blob instances.

Throws:

ClientException

getDocumentBlobsExt

DocumentBlob[] getDocumentBlobsExt(String sid,
                                 String uuid,
                                 boolean useDownloadUrl)
                                   throws ClientException

Returns the document blobs only.

Parameters:

uuid - the uuid of the document.

useDownloadUrl - defines if blob are exported as download url or as byte|[]

Returns:

an array of document blob instances.

Throws:

ClientException

getDocumentACL

WsACE[] getDocumentACL(String sid,
                     String uuid)
                       throws ClientException

Returns the merged ACL of the document (contains all ACEs defined on the document and its parents).

It includes all ACLs for each ACP.

Parameters:

uuid - the uuid of the document

Returns:

the ordered list of ACLs

Throws:

ClientException

getDocumentLocalACL

WsACE[] getDocumentLocalACL(String sid,
                          String uuid)
                            throws ClientException

Returns the merged ACL of the document (contains all ACEs defined on the document, filtering the inherited ones).

It includes all ACLs for each ACP.

Parameters:

uuid - the uuid of the document

Returns:

the ordered list of ACLs

Throws:

ClientException

hasPermission

boolean hasPermission(String sid,
                    String uuid,
                    String permission)
                      throws ClientException

Checks the given permission for the current user on the given document.

Parameters:

sid -

uuid -

permission -

Returns:

Throws:

ClientException

listUsers

String[] listUsers(String sid,
                 int from,
                 int to)
                   throws ClientException

Returns the list of all users.

This method supports pagination in case of large user dbs.

Pagination is not yet working!

Parameters:

from - pagination start

to - pagination stop

Returns:

an array of principal names

Throws:

ClientException

listGroups

String[] listGroups(String sid,
                  int from,
                  int to)
                    throws ClientException

Return the list of all groups.

This method supports pagination in case of large user dbs

Pagination is not yet working!

Parameters:

from - pagination start

to - pagination stop

Returns:

an array of group names

Throws:

ClientException

getUsers

String[] getUsers(String sid,
                String parentGroup)
                  throws ClientException

Get all users inside the given group. If the group is null then return all users in the system.

Parameters:

sid - the session id

parentGroup - the parent group

Throws:

ClientException - if any error occurs

getGroups

String[] getGroups(String sid,
                 String parentGroup)
                   throws ClientException

Gets all sub-groups inside the given group. If the parent group is null returns all top level groups.

Parameters:

sid - the session id

parentGroup - the parent group

Returns:

Throws:

ClientException

uploadDocument

String uploadDocument(String sid,
                    String path,
                    String type,
                    String[] properties)
                      throws ClientException

Throws:

ClientException

getDocumentSnapshot

DocumentSnapshot getDocumentSnapshot(String sid,
                                   String uuid)
                                     throws ClientException

Gets all properties and ACLs from a document uses byte[] format to export blob

Parameters:

sid - the session id

uuid - the doc uuid

Returns:

Throws:

ClientException

getDocumentSnapshotExt

DocumentSnapshot getDocumentSnapshotExt(String sid,
                                      String uuid,
                                      boolean useDownloadUrl)
                                        throws ClientException

Gets all properties and ACLs from a document

Parameters:

sid - the session id

uuid - the doc uuid

useDownloadUrl - define blob export format

Returns:

Throws:

ClientException