Package com.logicaldoc.audit.webservice.soap.client

Class SoapAuditClient

java.lang.Object

com.logicaldoc.webservice.soap.client.SoapClient<AuditService>

com.logicaldoc.audit.webservice.soap.client.SoapAuditClient

All Implemented Interfaces:

AuditService

public class SoapAuditClient
extends com.logicaldoc.webservice.soap.client.SoapClient<AuditService>
implements AuditService

Simple client for the Audit webservice

Since:

6.6

Author:

Marco Meschieri - LogicalDOC

Constructor Summary

Constructors

Constructor	Description
SoapAuditClient(String endpoint)
SoapAuditClient(String endpoint, int timeout)
SoapAuditClient(String endpoint, int gzipThreshold, boolean log, int timeout)

Method Summary

Modifier and Type	Method	Description
List<WSHistory>	getDocumentHistory(String sid, long docId)	Gets the history of a given document
List<WSHistory>	getHistories(String sid, String path, String sidFilter, Long userId, String dateStart, String dateEnd, List<String> events, Integer max)	Lists all the histories by the given criteria.
List<WSHistory>	getHistory(String sid, long folderId, String oldestDate, List<String> events, Integer max)	Lists all the document and folder histories in the given tree
List<WSHistory>	getLatestHistory(String sid, long folderId, String oldestDate, List<String> events, Integer max)	Lists all the document and folder histories in the given tree but just the more recent entry for each object(document or folder)
List<WSMessage>	getMessages(String sid)	Lists messages routed to the current user
List<WSSubscription>	getSubscriptions(String sid)	Lists all the subscriptions of the current user
List<WSHistory>	getUserHistories(String sid, String username, Long userId, String oldestDate, List<String> events, Integer max)	Retrieves the user histories.
void	markAsRead(String sid, List<Long> ids)	Marks a set of messages as read by the current user
WSHistory	saveDocumentHistory(String sid, WSHistory history)	Saves a document history
void	subscribe(String sid, List<Long> ids, String type, String events)	Subscribes the current user to notifications emitted by documents or folders
void	unsubscribe(String sid, List<Long> ids, String type)	Unsubscribes the current user to notifications emitted by documents or folders

Methods inherited from class java.lang.Object

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

Constructor Details

SoapAuditClient

public SoapAuditClient(String endpoint,
 int timeout)

SoapAuditClient

public SoapAuditClient(String endpoint,
 int gzipThreshold,
 boolean log,
 int timeout)

SoapAuditClient

public SoapAuditClient(String endpoint)

Method Details

subscribe

public void subscribe(String sid,
 List<Long> ids,
 String type,
 String events)
               throws com.logicaldoc.core.security.authentication.AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException

Description copied from interface: AuditService

Subscribes the current user to notifications emitted by documents or folders

Specified by:

subscribe in interface AuditService

Parameters:

sid - The session identifier

ids - The ids of documents or folders

type - one of Subscription.TYPE_x

events - Optional list of event codes separated by comma

Throws:

com.logicaldoc.core.security.authentication.AuthenticationException - Invalid session

com.logicaldoc.webservice.WebserviceException - Error in the webservice

com.logicaldoc.core.PersistenceException - Error in the database

unsubscribe

public void unsubscribe(String sid,
 List<Long> ids,
 String type)
                 throws com.logicaldoc.core.security.authentication.AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException

Description copied from interface: AuditService

Unsubscribes the current user to notifications emitted by documents or folders

Specified by:

unsubscribe in interface AuditService

Parameters:

sid - The session identifier

ids - The ids of documents or folders

type - one of Subscription.TYPE_x

Throws:

com.logicaldoc.core.security.authentication.AuthenticationException - Invalid session

com.logicaldoc.webservice.WebserviceException - Error in the webservice

com.logicaldoc.core.PersistenceException - Error in the database

getSubscriptions

public List<WSSubscription> getSubscriptions(String sid)
                                      throws com.logicaldoc.core.security.authentication.AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException

Description copied from interface: AuditService

Lists all the subscriptions of the current user

Specified by:

getSubscriptions in interface AuditService

Parameters:

sid - identifier of the session

Returns:

array of subscriptions

Throws:

com.logicaldoc.core.security.authentication.AuthenticationException - Invalid session

com.logicaldoc.webservice.WebserviceException - Error in the webservice

com.logicaldoc.core.PersistenceException - Error in the database

getMessages

public List<WSMessage> getMessages(String sid)
                            throws com.logicaldoc.core.security.authentication.AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException

Description copied from interface: AuditService

Lists messages routed to the current user

Specified by:

getMessages in interface AuditService

Parameters:

sid - identifier of the session

Returns:

array of messages

Throws:

com.logicaldoc.core.security.authentication.AuthenticationException - Invalid session

com.logicaldoc.webservice.WebserviceException - Error in the webservice

com.logicaldoc.core.PersistenceException - Error in the database

markAsRead

public void markAsRead(String sid,
 List<Long> ids)
                throws com.logicaldoc.core.security.authentication.AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException

Description copied from interface: AuditService

Marks a set of messages as read by the current user

Specified by:

markAsRead in interface AuditService

Parameters:

sid - identifier of the session

ids - identifiers of messages

Throws:

com.logicaldoc.core.security.authentication.AuthenticationException - Invalid session

com.logicaldoc.webservice.WebserviceException - Error in the webservice

com.logicaldoc.core.PersistenceException - Error in the database

getDocumentHistory

public List<WSHistory> getDocumentHistory(String sid,
 long docId)
                                   throws com.logicaldoc.core.security.authentication.AuthenticationException,
com.logicaldoc.core.security.authorization.PermissionException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException

Description copied from interface: AuditService

Gets the history of a given document

Specified by:

getDocumentHistory in interface AuditService

Parameters:

sid - Session identifier

docId - The document id

Returns:

List of history records

Throws:

com.logicaldoc.core.security.authentication.AuthenticationException - Invalid session

com.logicaldoc.core.security.authorization.PermissionException - The user does not have the required permission

com.logicaldoc.webservice.WebserviceException - Error in the webservice

com.logicaldoc.core.PersistenceException - Error in the database

getHistory

public List<WSHistory> getHistory(String sid,
 long folderId,
 String oldestDate,
 List<String> events,
 Integer max)
                           throws com.logicaldoc.core.security.authentication.AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException

Description copied from interface: AuditService

Lists all the document and folder histories in the given tree

Specified by:

getHistory in interface AuditService

Parameters:

sid - The session identifier

folderId - The tree to inspect

oldestDate - Optional oldest date to use as filter

events - Optional list of event codes to use as filter

max - Optional hint on the maximum number of records for each history type(document, folder ...)

Returns:

The list of histories

Throws:

com.logicaldoc.core.security.authentication.AuthenticationException - Invalid session

com.logicaldoc.webservice.WebserviceException - Error in the webservice

com.logicaldoc.core.PersistenceException - Error in the database

getLatestHistory

public List<WSHistory> getLatestHistory(String sid,
 long folderId,
 String oldestDate,
 List<String> events,
 Integer max)
                                 throws com.logicaldoc.core.security.authentication.AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException

Description copied from interface: AuditService

Lists all the document and folder histories in the given tree but just the more recent entry for each object(document or folder)

Specified by:

getLatestHistory in interface AuditService

Parameters:

sid - The session identifier

folderId - The tree to inspect

oldestDate - Optional oldest date to use as filter

events - Optional list of event codes to use as filter

max - Optional hint on the maximum number of records for each history type(document, folder ...)

Returns:

The list of histories

Throws:

com.logicaldoc.core.security.authentication.AuthenticationException - Invalid session

com.logicaldoc.webservice.WebserviceException - Error in the webservice

com.logicaldoc.core.PersistenceException - Error in the database

saveDocumentHistory

public WSHistory saveDocumentHistory(String sid,
 WSHistory history)
                              throws com.logicaldoc.core.security.authentication.AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException

Description copied from interface: AuditService

Saves a document history

Specified by:

saveDocumentHistory in interface AuditService

Parameters:

sid - Session identifier

history - The history to save

Returns:

The saved History

Throws:

com.logicaldoc.core.security.authentication.AuthenticationException - Invalid session

com.logicaldoc.webservice.WebserviceException - Error in the webservice

com.logicaldoc.core.PersistenceException - Error in the database

getUserHistories

public List<WSHistory> getUserHistories(String sid,
 String username,
 Long userId,
 String oldestDate,
 List<String> events,
 Integer max)
                                 throws com.logicaldoc.core.PersistenceException,
com.logicaldoc.core.security.authentication.AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.security.authorization.PermissionException

Description copied from interface: AuditService

Retrieves the user histories. Only those users with access to Last Changes report can invoke this method.

Specified by:

getUserHistories in interface AuditService

Parameters:

sid - Session identifier

username - optional username to use as filter

userId - optional user id to use as filter

oldestDate - optional date id to use as filter

events - optional list of event names

max - maximum number of returned records

Returns:

the history records

Throws:

com.logicaldoc.core.PersistenceException - Error in the database

com.logicaldoc.core.security.authentication.AuthenticationException - Invalid session

com.logicaldoc.webservice.WebserviceException - Error in the webservice

com.logicaldoc.core.security.authorization.PermissionException - The user does not have the required permission

getHistories

public List<WSHistory> getHistories(String sid,
 String path,
 String sidFilter,
 Long userId,
 String dateStart,
 String dateEnd,
 List<String> events,
 Integer max)
                             throws com.logicaldoc.core.security.authentication.AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException,
com.logicaldoc.core.security.authorization.PermissionException

Description copied from interface: AuditService

Lists all the histories by the given criteria. Only those users with access to Last Changes report can invoke this method.

Specified by:

getHistories in interface AuditService

Parameters:

sid - The session identifier

path - A path expression to use as filter

sidFilter - A SID expression to use as filter

userId - user identifier

dateStart - oldest date

dateEnd - earliest date

events - list of events

max - maximum number of records

Returns:

the list of histories

Throws:

com.logicaldoc.core.security.authentication.AuthenticationException - Invalid session

com.logicaldoc.webservice.WebserviceException - Error in the webservice

com.logicaldoc.core.PersistenceException - Error in the database

com.logicaldoc.core.security.authorization.PermissionException - The user does not have the required permission