org.nuxeo.ecm.platform.sync.server.webservices

Class WSSynchroServerModule

java.lang.Object

org.nuxeo.ecm.platform.sync.server.webservices.WSSynchroServerModule

All Implemented Interfaces:

StatefulWebServiceManagement

@Stateful
@Addressing
public class WSSynchroServerModule
extends Object
implements StatefulWebServiceManagement

Author:

mcedica

Field Summary

Fields

Modifier and Type	Field and Description
static com.sun.xml.ws.developer.StatefulWebServiceManager<WSSynchroServerModule>	manager

Constructor Summary

Constructors

Constructor and Description
WSSynchroServerModule()
WSSynchroServerModule(BasicSession _session)

Method Summary

Methods

Modifier and Type	Method and Description
void	destroySession() Destroys the service.
NuxeoSynchroTuple[]	getAvailableDocumentList() Lists the Nuxeo domain tree filtering the visible to user branches.
NuxeoSynchroTuple[]	getAvailableDocumentListWithQuery(String queryName)
FlagedDocumentSnapshot	getDocumentByIdWithoutBlob(String uuid) Returns a DocumentSnapshot for a given document id ; this describes a documentModel without blob properties
String	getQueryAvailableDocumentList() Gets the query used to find all available documents for synchronization
String	getQueryAvailableDocumentListWithQuery(String queryName)
void	keepAlive() Keeps alive the session.

Methods inherited from class java.lang.Object

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

Field Detail

manager

public static com.sun.xml.ws.developer.StatefulWebServiceManager<WSSynchroServerModule> manager

Constructor Detail

WSSynchroServerModule

public WSSynchroServerModule()

WSSynchroServerModule

public WSSynchroServerModule(BasicSession _session)

Method Detail

getAvailableDocumentListWithQuery

public NuxeoSynchroTuple[] getAvailableDocumentListWithQuery(String queryName)
                                                      throws ClientException

Throws:

ClientException

getAvailableDocumentList

public NuxeoSynchroTuple[] getAvailableDocumentList()
                                             throws ClientException

Lists the Nuxeo domain tree filtering the visible to user branches. It includes Comments and Tags. The representation offers enough data to client to decide what more needed for full synchronization.

Returns:

Throws:

ClientException

getQueryAvailableDocumentListWithQuery

public String getQueryAvailableDocumentListWithQuery(String queryName)
                                              throws ClientException

Throws:

ClientException

getQueryAvailableDocumentList

public String getQueryAvailableDocumentList()
                                     throws ClientException

Gets the query used to find all available documents for synchronization

Returns:

a string query

Throws:

ClientException

getDocumentByIdWithoutBlob

public FlagedDocumentSnapshot getDocumentByIdWithoutBlob(String uuid)

Returns a DocumentSnapshot for a given document id ; this describes a documentModel without blob properties

Returns:

DocumentSnapshot

Throws:

ClientException

destroySession

public void destroySession()

Description copied from interface: StatefulWebServiceManagement

Destroys the service. It is called from the timeout callback, allowing the service to gracefully clean up.

Specified by:

destroySession in interface StatefulWebServiceManagement

keepAlive

public void keepAlive()

Description copied from interface: StatefulWebServiceManagement

Keeps alive the session. The Client can call this method to touch the instance. That way it is prevented the destruction of the Stateful Web Service even if the Client has nothing really to communicate with the Server.

Specified by:

keepAlive in interface StatefulWebServiceManagement