|
Nuxeo ECM Projects 5.4.3-SNAPSHOT | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface NuxeoRemoting
Nuxeo EP remoting API.
Method Summary | |
---|---|
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 |
---|
String getRepositoryName(String sid) throws ClientException
sid
- the session id
ClientException
DocumentDescriptor getRootDocument(String sessionId) throws ClientException
ClientException
DocumentDescriptor getDocument(String sessionId, String uuid) throws ClientException
sessionId
- the session iduuid
- the doc uuid
ClientException
DocumentDescriptor[] getChildren(String sessionId, String uuid) throws ClientException
sessionId
- the session iduuid
- the doc uuid
ClientException
String getRelativePathAsString(String sessionId, String uuid) throws ClientException
Example: /Workspaces/My Workspaces/Nice Document
sessionId
- : the session iduuid
- : the document uuid
ClientException
DocumentDescriptor[] getVersions(String sid, String uid) throws ClientException
sid
- uid
-
ClientException
DocumentDescriptor getCurrentVersion(String sid, String uid) throws ClientException
sid
-
ClientException
DocumentDescriptor getSourceDocument(String sid, String uid) throws ClientException
sid
- uid
-
ClientException
DocumentProperty[] getDocumentProperties(String sid, String uuid) throws ClientException
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.
uuid
- uuid of the document.
ClientException
DocumentProperty[] getDocumentNoBlobProperties(String sid, String uuid) throws ClientException
getDocumentProperties(String, String)
but skips
blobs.
sid
- uuid
-
ClientException
DocumentBlob[] getDocumentBlobs(String sid, String uuid) throws ClientException
uuid
- the uuid of the document.
ClientException
DocumentBlob[] getDocumentBlobsExt(String sid, String uuid, boolean useDownloadUrl) throws ClientException
uuid
- the uuid of the document.useDownloadUrl
- defines if blob are exported as download url or as byte|[]
ClientException
WsACE[] getDocumentACL(String sid, String uuid) throws ClientException
It includes all ACLs for each ACP.
uuid
- the uuid of the document
ClientException
WsACE[] getDocumentLocalACL(String sid, String uuid) throws ClientException
It includes all ACLs for each ACP.
uuid
- the uuid of the document
ClientException
boolean hasPermission(String sid, String uuid, String permission) throws ClientException
sid
- uuid
- permission
-
ClientException
String[] listUsers(String sid, int from, int to) throws ClientException
This method supports pagination in case of large user dbs.
Pagination is not yet working!
from
- pagination startto
- pagination stop
ClientException
String[] listGroups(String sid, int from, int to) throws ClientException
This method supports pagination in case of large user dbs
Pagination is not yet working!
from
- pagination startto
- pagination stop
ClientException
String[] getUsers(String sid, String parentGroup) throws ClientException
sid
- the session idparentGroup
- the parent group
ClientException
- if any error occursString[] getGroups(String sid, String parentGroup) throws ClientException
sid
- the session idparentGroup
- the parent group
ClientException
String uploadDocument(String sid, String path, String type, String[] properties) throws ClientException
ClientException
DocumentSnapshot getDocumentSnapshot(String sid, String uuid) throws ClientException
sid
- the session iduuid
- the doc uuid
ClientException
DocumentSnapshot getDocumentSnapshotExt(String sid, String uuid, boolean useDownloadUrl) throws ClientException
sid
- the session iduuid
- the doc uuiduseDownloadUrl
- define blob export format
ClientException
|
Nuxeo ECM Projects 5.4.3-SNAPSHOT | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |