com.logicaldoc.webservice

Class AbstractService

java.lang.Object

com.logicaldoc.webservice.AbstractService

Direct Known Subclasses:

AuthServiceImpl, DocumentServiceImpl, FolderServiceImpl, SearchServiceImpl, SecurityServiceImpl, SystemServiceImpl

public class AbstractService
extends Object

Basepoint for creating webservices implementations

Since:

5.2

Author:

Matteo Caruso - Logical Objects

Field Summary

Fields

Modifier and Type	Field and Description
protected WebServiceContext	context
protected static org.slf4j.Logger	log

Constructor Summary

Constructors

Constructor and Description
AbstractService()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkAdministrator(String sid) Checks if the current user is an administrator (group admin).
protected void	checkDownloadEnable(User user, long folderId)
protected void	checkGroup(String sid, String group) Checks if the current user belongs to a group
protected void	checkPermission(Permission permission, User user, long folderId)
protected void	checkPublished(User user, Document doc)
protected void	checkReadEnable(User user, long folderId)
protected void	checkWriteEnable(User user, long folderId)
static String	convertDateToString(Date date)
static Date	convertStringToDate(String date)
protected ContextProperties	getSettings()
protected boolean	isWebserviceEnabled()
void	setValidateSession(boolean validateSession)
protected User	validateSession(String sid) Utility method that validates the session and retrieve the associated user

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static org.slf4j.Logger log

context

protected WebServiceContext context

Constructor Detail

AbstractService

public AbstractService()

Method Detail

setValidateSession

public void setValidateSession(boolean validateSession)

validateSession

protected User validateSession(String sid)
                        throws Exception

Utility method that validates the session and retrieve the associated user

Parameters:

sid - The session identifier

Returns:

Throws:

Exception

checkGroup

protected void checkGroup(String sid,
              String group)
                   throws Exception

Checks if the current user belongs to a group

Throws:

Exception

checkAdministrator

protected void checkAdministrator(String sid)
                           throws Exception

Checks if the current user is an administrator (group admin).

Throws:

Exception

checkPermission

protected void checkPermission(Permission permission,
                   User user,
                   long folderId)
                        throws Exception

Throws:

Exception

checkWriteEnable

protected void checkWriteEnable(User user,
                    long folderId)
                         throws Exception

Throws:

Exception

checkReadEnable

protected void checkReadEnable(User user,
                   long folderId)
                        throws Exception

Throws:

Exception

checkDownloadEnable

protected void checkDownloadEnable(User user,
                       long folderId)
                            throws Exception

Throws:

Exception

checkPublished

protected void checkPublished(User user,
                  Document doc)
                       throws Exception

Throws:

Exception

convertDateToString

public static String convertDateToString(Date date)

convertStringToDate

public static Date convertStringToDate(String date)

getSettings

protected ContextProperties getSettings()

isWebserviceEnabled

protected boolean isWebserviceEnabled()