org.nuxeo.ecm.platform.indexing.gateway.ws

Class WSIndexingGatewayBean

java.lang.Object

org.nuxeo.ecm.platform.ws.AbstractNuxeoWebService

org.nuxeo.ecm.platform.indexing.gateway.ws.WSIndexingGatewayBean

All Implemented Interfaces:

Serializable, BaseNuxeoWebService, NuxeoRemoting, WSAudit, WSIndexingGateway

Direct Known Subclasses:

WSExaleadBean

public class WSIndexingGatewayBean
extends AbstractNuxeoWebService
implements WSIndexingGateway

Base class for WS beans used for external indexers. Implements most of NuxeoRemotingBean trying as hard as possible no to throw ClientException when a requested document is missing but returning empty descriptions instead so as to make external indexers not view recently deleted documents as applicative errors.

Author:

tiry

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
WSIndexingGatewayBean()

Method Summary

Methods

Modifier and Type	Method and Description
String	connect(String username, String password) Connects to the default nuxeo core repository.
void	disconnect(String sid) Disconnect the Nuxeo core given the session id.
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.
DocumentDescriptor	getDocumentFromPath(String sessionId, String path)
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 NuxeoRemoting.getDocumentProperties(String, String) but skips blobs.
DocumentProperty[]	getDocumentProperties(String sid, String uuid) Returns the document properties.
DocumentSnapshot	getDocumentSnapshot(String sessionId, String uuid) Gets all properties and ACLs from a document uses byte[] format to export blob
DocumentSnapshot	getDocumentSnapshotExt(String sessionId, 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[]	getRecursiveChildrenUUIDs(String sid, String uuid)
UUIDPage	getRecursiveChildrenUUIDsByPage(String sid, String uuid, int page, int pageSize)
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.
DocumentTypeDescriptor[]	getTypeDefinitions()
String[]	getUserGroups(String sessionId, String username)
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.
ModifiedDocumentDescriptorPage	listDeletedDocumentsByPage(String sessionId, String dateRangeQuery, String path, int page, int pageSize) Returns the list of deleted documents within a timestamp.
EventDescriptorPage	listDocumentEventsByPage(String sessionId, String dateRangeQuery, String startDate, String path, int page, int pageSize) Gets a filtered list of document events.
EventDescriptorPage	listEventsByPage(String sessionId, String dateRangeQuery, int page, int pageSize)
String[]	listGroups(String sid, int from, int to) Return the list of all groups.
ModifiedDocumentDescriptor[]	listModifiedDocuments(String sessionId, String dateRangeQuery) Returns the list of modified document within a timestamp.
ModifiedDocumentDescriptorPage	listModifiedDocumentsByPage(String sessionId, String dateRangeQuery, String path, int page, int pageSize)
String[]	listUsers(String sid, int from, int to) Returns the list of all users.
EventDescriptorPage	queryEventsByPage(String sessionId, String whereClause, int page, int pageSize)
String	resolvePathToUUID(String sessionId, String path)
String	uploadDocument(String sid, String path, String type, String[] properties)
boolean	validateUserPassword(String sessionId, String username, String password)

Methods inherited from class org.nuxeo.ecm.platform.ws.AbstractNuxeoWebService

connectOnRepository

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WSIndexingGatewayBean

public WSIndexingGatewayBean()

Method Detail

getChildren

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

Description copied from interface: NuxeoRemoting

Gets the children of the given document.

Specified by:

getChildren in interface NuxeoRemoting

Parameters:

sessionId - the session id

uuid - the doc uuid

Returns:

the children descriptors

Throws:

ClientException

getCurrentVersion

public DocumentDescriptor getCurrentVersion(String sid,
                                   String uid)
                                     throws ClientException

Description copied from interface: NuxeoRemoting

Gets the current version of the given document.

Specified by:

getCurrentVersion in interface NuxeoRemoting

Returns:

Throws:

ClientException

getDocument

public DocumentDescriptor getDocument(String sessionId,
                             String uuid)
                               throws ClientException

Description copied from interface: NuxeoRemoting

Gets the doc descriptor given the doc UUID.

Specified by:

getDocument in interface NuxeoRemoting

Parameters:

sessionId - the session id

uuid - the doc uuid

Returns:

the descriptor

Throws:

ClientException

getDocumentACL

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

Description copied from interface: NuxeoRemoting

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

It includes all ACLs for each ACP.

Specified by:

getDocumentACL in interface NuxeoRemoting

uuid - the uuid of the document

Returns:

the ordered list of ACLs

Throws:

ClientException

getDocumentLocalACL

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

Description copied from interface: NuxeoRemoting

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.

Specified by:

getDocumentLocalACL in interface NuxeoRemoting

uuid - the uuid of the document

Returns:

the ordered list of ACLs

Throws:

ClientException

getDocumentBlobsExt

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

Description copied from interface: NuxeoRemoting

Returns the document blobs only.

Specified by:

getDocumentBlobsExt in interface NuxeoRemoting

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

getDocumentBlobs

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

Description copied from interface: NuxeoRemoting

Returns the document blobs only using byte[] format

Specified by:

getDocumentBlobs in interface NuxeoRemoting

uuid - the uuid of the document.

Returns:

an array of document blob instances.

Throws:

ClientException

getDocumentNoBlobProperties

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

Description copied from interface: NuxeoRemoting

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

Specified by:

getDocumentNoBlobProperties in interface NuxeoRemoting

Returns:

Throws:

ClientException

getDocumentProperties

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

Description copied from interface: NuxeoRemoting

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.

Specified by:

getDocumentProperties in interface NuxeoRemoting

uuid - uuid of the document.

Returns:

a map from name of the property to its value

Throws:

ClientException

getGroups

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

Description copied from interface: NuxeoRemoting

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

Specified by:

getGroups in interface NuxeoRemoting

Parameters:

sid - the session id

parentGroup - the parent group

Returns:

Throws:

ClientException

getRepositoryName

public String getRepositoryName(String sid)
                         throws ClientException

Description copied from interface: NuxeoRemoting

Gets the current repository name.

Specified by:

getRepositoryName in interface NuxeoRemoting

Parameters:

sid - the session id

Returns:

the repository name

Throws:

ClientException

getRootDocument

public DocumentDescriptor getRootDocument(String sessionId)
                                   throws ClientException

Description copied from interface: NuxeoRemoting

Gets the root document descriptor.

Specified by:

getRootDocument in interface NuxeoRemoting

Returns:

the root document

Throws:

ClientException

resolvePathToUUID

public String resolvePathToUUID(String sessionId,
                       String path)
                         throws ClientException

Specified by:

resolvePathToUUID in interface WSIndexingGateway

Throws:

ClientException

getRecursiveChildrenUUIDsByPage

public UUIDPage getRecursiveChildrenUUIDsByPage(String sid,
                                       String uuid,
                                       int page,
                                       int pageSize)
                                         throws ClientException

Specified by:

getRecursiveChildrenUUIDsByPage in interface WSIndexingGateway

Throws:

ClientException

getRecursiveChildrenUUIDs

public String[] getRecursiveChildrenUUIDs(String sid,
                                 String uuid)
                                   throws ClientException

Specified by:

getRecursiveChildrenUUIDs in interface WSIndexingGateway

Throws:

ClientException

getTypeDefinitions

public DocumentTypeDescriptor[] getTypeDefinitions()
                                            throws ClientException

Specified by:

getTypeDefinitions in interface WSIndexingGateway

Throws:

ClientException

getDocumentFromPath

public DocumentDescriptor getDocumentFromPath(String sessionId,
                                     String path)
                                       throws ClientException

Specified by:

getDocumentFromPath in interface WSIndexingGateway

Throws:

ClientException

getSourceDocument

public DocumentDescriptor getSourceDocument(String sid,
                                   String uid)
                                     throws ClientException

Description copied from interface: NuxeoRemoting

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

Specified by:

getSourceDocument in interface NuxeoRemoting

Returns:

Throws:

ClientException

getUsers

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

Description copied from interface: NuxeoRemoting

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

Specified by:

getUsers in interface NuxeoRemoting

Parameters:

sid - the session id

parentGroup - the parent group

Throws:

ClientException - if any error occurs

getVersions

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

Description copied from interface: NuxeoRemoting

Gets the versions of the given document.

Specified by:

getVersions in interface NuxeoRemoting

Returns:

Throws:

ClientException

listGroups

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

Description copied from interface: NuxeoRemoting

Return the list of all groups.

This method supports pagination in case of large user dbs

Pagination is not yet working!

Specified by:

listGroups in interface NuxeoRemoting

from - pagination start

to - pagination stop

Returns:

an array of group names

Throws:

ClientException

listUsers

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

Description copied from interface: NuxeoRemoting

Returns the list of all users.

This method supports pagination in case of large user dbs.

Pagination is not yet working!

Specified by:

listUsers in interface NuxeoRemoting

from - pagination start

to - pagination stop

Returns:

an array of principal names

Throws:

ClientException

listModifiedDocuments

public ModifiedDocumentDescriptor[] listModifiedDocuments(String sessionId,
                                                 String dateRangeQuery)
                                                   throws AuditException

Description copied from interface: WSAudit

Returns the list of modified document within a timestamp.

Specified by:

listModifiedDocuments in interface WSAudit

Parameters:

sessionId - the Nuxeo core session id.

dateRangeQuery - the date range query.

Returns:

a list of modified document descriptors.

Throws:

AuditException

listModifiedDocumentsByPage

public ModifiedDocumentDescriptorPage listModifiedDocumentsByPage(String sessionId,
                                                         String dateRangeQuery,
                                                         String path,
                                                         int page,
                                                         int pageSize)
                                                           throws AuditException

Specified by:

listModifiedDocumentsByPage in interface WSAudit

Throws:

AuditException

listEventsByPage

public EventDescriptorPage listEventsByPage(String sessionId,
                                   String dateRangeQuery,
                                   int page,
                                   int pageSize)
                                     throws AuditException

Specified by:

listEventsByPage in interface WSAudit

Throws:

AuditException

listDocumentEventsByPage

public EventDescriptorPage listDocumentEventsByPage(String sessionId,
                                           String dateRangeQuery,
                                           String startDate,
                                           String path,
                                           int page,
                                           int pageSize)
                                             throws AuditException

Description copied from interface: WSAudit

Gets a filtered list of document events.

Expecting either a dateRangeQuery or a startDate.

Specified by:

listDocumentEventsByPage in interface WSAudit

Parameters:

sessionId - the Nuxeo core session id.

dateRangeQuery - the date range query like "24h" for the last 24 hours, may be null if startDate is set.

startDate - return events that occurs after startDate, expecting W3C date time format. May be null if dateRangeQuery is set. Will be ignored if dateRangeQuery is set.

path - filter events for documents starting with this path.

page - page number starting with page 1.

pageSize - number of items in a page.

Returns:

a list of events descriptors..

Throws:

AuditException

getRelativePathAsString

public String getRelativePathAsString(String sessionId,
                             String uuid)
                               throws ClientException

Description copied from interface: NuxeoRemoting

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

Example: /Workspaces/My Workspaces/Nice Document

Specified by:

getRelativePathAsString in interface NuxeoRemoting

Parameters:

sessionId - : the session id

uuid - : the document uuid

Returns:

a relative path

Throws:

ClientException

hasPermission

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

Description copied from interface: NuxeoRemoting

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

Specified by:

hasPermission in interface NuxeoRemoting

Returns:

Throws:

ClientException

uploadDocument

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

Specified by:

uploadDocument in interface NuxeoRemoting

Throws:

ClientException

connect

public String connect(String username,
             String password)
               throws ClientException

Description copied from interface: BaseNuxeoWebService

Connects to the default nuxeo core repository.

Specified by:

connect in interface BaseNuxeoWebService

Overrides:

connect in class AbstractNuxeoWebService

Parameters:

username - the user name

password - the user password

Returns:

a Nuxeo core session identifier.

Throws:

ClientException

disconnect

public void disconnect(String sid)
                throws ClientException

Description copied from interface: BaseNuxeoWebService

Disconnect the Nuxeo core given the session id.

Specified by:

disconnect in interface BaseNuxeoWebService

Overrides:

disconnect in class AbstractNuxeoWebService

Parameters:

sid - the Nuxeo core session id.

Throws:

ClientException

queryEventsByPage

public EventDescriptorPage queryEventsByPage(String sessionId,
                                    String whereClause,
                                    int page,
                                    int pageSize)
                                      throws AuditException

Specified by:

queryEventsByPage in interface WSAudit

Throws:

AuditException

validateUserPassword

public boolean validateUserPassword(String sessionId,
                           String username,
                           String password)
                             throws ClientException

Specified by:

validateUserPassword in interface WSIndexingGateway

Throws:

ClientException

getUserGroups

public String[] getUserGroups(String sessionId,
                     String username)
                       throws ClientException

Specified by:

getUserGroups in interface WSIndexingGateway

Throws:

ClientException

getDocumentSnapshotExt

public DocumentSnapshot getDocumentSnapshotExt(String sessionId,
                                      String uuid,
                                      boolean useDownloadUrl)
                                        throws ClientException

Description copied from interface: NuxeoRemoting

Gets all properties and ACLs from a document

Specified by:

getDocumentSnapshotExt in interface NuxeoRemoting

Parameters:

sessionId - the session id

uuid - the doc uuid

useDownloadUrl - define blob export format

Returns:

Throws:

ClientException

getDocumentSnapshot

public DocumentSnapshot getDocumentSnapshot(String sessionId,
                                   String uuid)
                                     throws ClientException

Description copied from interface: NuxeoRemoting

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

Specified by:

getDocumentSnapshot in interface NuxeoRemoting

Parameters:

sessionId - the session id

uuid - the doc uuid

Returns:

Throws:

ClientException

listDeletedDocumentsByPage

public ModifiedDocumentDescriptorPage listDeletedDocumentsByPage(String sessionId,
                                                        String dateRangeQuery,
                                                        String path,
                                                        int page,
                                                        int pageSize)
                                                          throws AuditException

Description copied from interface: WSAudit

Returns the list of deleted documents within a timestamp.

Specified by:

listDeletedDocumentsByPage in interface WSAudit

Throws:

AuditException