Package org.bonitasoft.engine.page.impl

Class PageServiceImpl

java.lang.Object

org.bonitasoft.engine.page.impl.PageServiceImpl

All Implemented Interfaces:

PageService

@Service("pageService")
public class PageServiceImpl
extends Object
implements PageService

Author:

Baptiste Mesta, Matthieu Chaffotte

Field Summary

Fields

Modifier and Type	Field	Description
static final String	INDEX_GROOVY
static final String	INDEX_HTML
static final String	PAGE_TOKEN_PREFIX
static final String	RESOURCES_INDEX_HTML

Fields inherited from interface org.bonitasoft.engine.page.PageService

PAGE, PROPERTIES_CONTENT_TYPE, PROPERTIES_DESCRIPTION, PROPERTIES_DISPLAY_NAME, PROPERTIES_FILE_NAME, PROPERTIES_NAME

Constructor Summary

Constructors

Constructor	Description
PageServiceImpl(ReadPersistenceService persistenceService, Recorder recorder, QueriableLoggerService queriableLoggerService, ReadSessionAccessor sessionAccessor, SessionService sessionService, PermissionService permissionService)

Method Summary

Modifier and Type	Method	Description
SPage	addPage(byte[] content, String contentName, long userId)	add a page using the zip in parameters, it get all informations from the page.properties file contain inside the zip
SPage	addPage(SPage page, byte[] content)	add a page using the zip in parameters and the given properties
SPage	buildPage(byte[] content, String contentName, long userId, boolean provided, boolean removable, boolean editable)
SPage	checkIfPageAlreadyExists(SPage page)
protected void	checkPageDuplicateForProcessDefinition(AbstractSPage sPage, SPageLogBuilder logBuilder, long sPageProcessDefinitionId)
void	deletePage(long pageId)
long	getNumberOfPages(QueryOptions options)
SPage	getPage(long pageId)
SPage	getPageByName(String pageName)
SPage	getPageByNameAndProcessDefinitionId(String name, long processDefinitionId)	get a page attached to a process
List<SPage>	getPageByProcessDefinitionId(long processDefinitionId, int fromIndex, int numberOfResults)	get a list of page attached to a process
byte[]	getPageContent(long pageId)
SPage	insertPage(SPage page, byte[] content)
protected boolean	isSystemSession()
Properties	readPageZip(byte[] content)	Read the content of a page in a zip
List<SPage>	searchPages(QueryOptions options)
void	setPageServiceListeners(List<PageServiceListener> pageServiceListeners)
SPage	updatePage(long pageId, EntityUpdateDescriptor entityUpdateDescriptor)
void	updatePageContent(long pageId, byte[] content, String contentName)
void	updatePageContent(long pageId, byte[] content, String contentName, SPageUpdateBuilder pageUpdateBuilder)

Methods inherited from class java.lang.Object

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

Field Details

PAGE_TOKEN_PREFIX

public static final String PAGE_TOKEN_PREFIX

See Also:

• Constant Field Values

INDEX_GROOVY

public static final String INDEX_GROOVY

See Also:

• Constant Field Values

INDEX_HTML

public static final String INDEX_HTML

See Also:

• Constant Field Values

RESOURCES_INDEX_HTML

public static final String RESOURCES_INDEX_HTML

See Also:

• Constant Field Values

Constructor Details

PageServiceImpl

public PageServiceImpl(ReadPersistenceService persistenceService,
 Recorder recorder,
 QueriableLoggerService queriableLoggerService,
 ReadSessionAccessor sessionAccessor,
 SessionService sessionService,
 PermissionService permissionService)

Method Details

addPage

public SPage addPage(SPage page,
 byte[] content)
              throws SObjectCreationException,
SObjectAlreadyExistsException,
SInvalidPageZipException,
SInvalidPageTokenException

Description copied from interface: PageService

add a page using the zip in parameters and the given properties

Specified by:

addPage in interface PageService

Returns:

Throws:

SObjectCreationException

SObjectAlreadyExistsException

SInvalidPageZipException

SInvalidPageTokenException

addPage

public SPage addPage(byte[] content,
 String contentName,
 long userId)
              throws SObjectCreationException,
SObjectAlreadyExistsException,
SInvalidPageZipException,
SInvalidPageTokenException

Description copied from interface: PageService

add a page using the zip in parameters, it get all informations from the page.properties file contain inside the zip

Specified by:

addPage in interface PageService

Returns:

Throws:

SObjectCreationException

SObjectAlreadyExistsException

SInvalidPageZipException

SInvalidPageTokenException

getPageByNameAndProcessDefinitionId

public SPage getPageByNameAndProcessDefinitionId(String name,
 long processDefinitionId)
                                          throws SBonitaReadException

Description copied from interface: PageService

get a page attached to a process

Specified by:

getPageByNameAndProcessDefinitionId in interface PageService

Returns:

Throws:

SBonitaReadException

getPageByProcessDefinitionId

public List<SPage> getPageByProcessDefinitionId(long processDefinitionId,
 int fromIndex,
 int numberOfResults)
                                         throws SBonitaReadException

Description copied from interface: PageService

get a list of page attached to a process

Specified by:

getPageByProcessDefinitionId in interface PageService

Returns:

Throws:

SBonitaReadException

buildPage

public SPage buildPage(byte[] content,
 String contentName,
 long userId,
 boolean provided,
 boolean removable,
 boolean editable)
                throws SInvalidPageZipException,
SInvalidPageTokenException

Specified by:

buildPage in interface PageService

Throws:

SInvalidPageZipException

SInvalidPageTokenException

readPageZip

public Properties readPageZip(byte[] content)
                       throws SInvalidPageZipMissingIndexException,
SInvalidPageZipMissingAPropertyException,
SInvalidPageZipInconsistentException,
SInvalidPageZipMissingPropertiesException,
SInvalidPageTokenException

Description copied from interface: PageService

Read the content of a page in a zip

Specified by:

readPageZip in interface PageService

Parameters:

content - the page content

Returns:

the properties of the page stored in the page.properties

Throws:

SInvalidPageZipMissingIndexException - if the page is missing an index.html or Index.groovy

SInvalidPageZipMissingAPropertyException - if the page is missing mandatory field in the page.properties

SInvalidPageZipInconsistentException - if the zip is not a valid zip file or unreadable

SInvalidPageZipMissingPropertiesException

SInvalidPageTokenException

insertPage

public SPage insertPage(SPage page,
 byte[] content)
                 throws SObjectAlreadyExistsException,
SObjectCreationException

Specified by:

insertPage in interface PageService

Throws:

SObjectAlreadyExistsException

SObjectCreationException

checkIfPageAlreadyExists

public SPage checkIfPageAlreadyExists(SPage page)
                               throws SBonitaReadException

Specified by:

checkIfPageAlreadyExists in interface PageService

Throws:

SBonitaReadException

getPage

public SPage getPage(long pageId)
              throws SBonitaReadException,
SObjectNotFoundException

Specified by:

getPage in interface PageService

Throws:

SBonitaReadException

SObjectNotFoundException

getPageByName

public SPage getPageByName(String pageName)
                    throws SBonitaReadException

Specified by:

getPageByName in interface PageService

Throws:

SBonitaReadException

getNumberOfPages

public long getNumberOfPages(QueryOptions options)
                      throws SBonitaReadException

Specified by:

getNumberOfPages in interface PageService

Throws:

SBonitaReadException

searchPages

public List<SPage> searchPages(QueryOptions options)
                        throws SBonitaReadException

Specified by:

searchPages in interface PageService

Throws:

SBonitaReadException

deletePage

public void deletePage(long pageId)
                throws SObjectModificationException,
SObjectNotFoundException

Specified by:

deletePage in interface PageService

Throws:

SObjectModificationException

SObjectNotFoundException

getPageContent

public byte[] getPageContent(long pageId)
                      throws SBonitaReadException,
SObjectNotFoundException

Specified by:

getPageContent in interface PageService

Throws:

SBonitaReadException

SObjectNotFoundException

updatePage

public SPage updatePage(long pageId,
 EntityUpdateDescriptor entityUpdateDescriptor)
                 throws SObjectModificationException,
SObjectAlreadyExistsException,
SInvalidPageTokenException

Specified by:

updatePage in interface PageService

Throws:

SObjectModificationException

SObjectAlreadyExistsException

SInvalidPageTokenException

isSystemSession

protected boolean isSystemSession()

checkPageDuplicateForProcessDefinition

protected void checkPageDuplicateForProcessDefinition(AbstractSPage sPage,
 SPageLogBuilder logBuilder,
 long sPageProcessDefinitionId)
                                               throws SBonitaReadException,
SObjectAlreadyExistsException

Throws:

SBonitaReadException

SObjectAlreadyExistsException

updatePageContent

public void updatePageContent(long pageId,
 byte[] content,
 String contentName)
                       throws SObjectModificationException,
SInvalidPageZipException,
SInvalidPageTokenException,
SObjectAlreadyExistsException

Specified by:

updatePageContent in interface PageService

Throws:

SObjectModificationException

SInvalidPageZipException

SInvalidPageTokenException

SObjectAlreadyExistsException

updatePageContent

public void updatePageContent(long pageId,
 byte[] content,
 String contentName,
 SPageUpdateBuilder pageUpdateBuilder)
                       throws SObjectModificationException,
SInvalidPageZipException,
SInvalidPageTokenException,
SObjectAlreadyExistsException

Specified by:

updatePageContent in interface PageService

Throws:

SObjectModificationException

SInvalidPageZipException

SInvalidPageTokenException

SObjectAlreadyExistsException

setPageServiceListeners

@Autowired
public void setPageServiceListeners(List<PageServiceListener> pageServiceListeners)