org.bonitasoft.engine.page.impl

Class PageMappingServiceImpl

java.lang.Object

org.bonitasoft.engine.page.impl.PageMappingServiceImpl

All Implemented Interfaces:

PageMappingService

public class PageMappingServiceImpl
extends java.lang.Object
implements PageMappingService

Author:

Baptiste Mesta

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PAGE_MAPPING

Constructor Summary

Constructors

Constructor and Description
PageMappingServiceImpl(Recorder recorder, ReadPersistenceService persistenceService, SessionService sessionService, ReadSessionAccessor sessionAccessor)

Method Summary

Modifier and Type	Method and Description
SPageMapping	create(java.lang.String key, java.lang.Long pageId, java.util.List<java.lang.String> authorizationRules)
SPageMapping	create(java.lang.String key, java.lang.String url, java.lang.String urlAdapter, java.util.List<java.lang.String> authorizationRules)
void	delete(SPageMapping sPageMapping) delete this page mapping
java.util.List<SPageMapping>	get(long pageId, int startIndex, int maxResults) Gets the paginated mappings of the page.
SPageMapping	get(java.lang.String key)
protected boolean	isAllowedToAccess(SPageMapping pageMapping, java.util.Map<java.lang.String,java.io.Serializable> context, java.util.List<java.lang.String> pageAuthorizationRules)
SPageURL	resolvePageURL(SPageMapping pageMapping, java.util.Map<java.lang.String,java.io.Serializable> context, boolean executeAuthorizationRules)
void	setAuthorizationRules(java.util.List<AuthorizationRule> authorizationRules)
void	setURLAdapters(java.util.List<URLAdapter> urlAdapters)
void	update(SPageMapping pageMapping, java.lang.Long pageId) update the given page mapping
void	update(SPageMapping pageMapping, java.lang.String url, java.lang.String urlAdapter) update the given page mapping

Methods inherited from class java.lang.Object

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

Field Detail

PAGE_MAPPING

public static final java.lang.String PAGE_MAPPING

See Also:

Constant Field Values

Constructor Detail

PageMappingServiceImpl

public PageMappingServiceImpl(Recorder recorder,
                              ReadPersistenceService persistenceService,
                              SessionService sessionService,
                              ReadSessionAccessor sessionAccessor)

Method Detail

setURLAdapters

public void setURLAdapters(java.util.List<URLAdapter> urlAdapters)

setAuthorizationRules

public void setAuthorizationRules(java.util.List<AuthorizationRule> authorizationRules)

create

public SPageMapping create(java.lang.String key,
                           java.lang.Long pageId,
                           java.util.List<java.lang.String> authorizationRules)
                    throws SObjectCreationException

Specified by:

create in interface PageMappingService

Parameters:

key - the key used to retrieve the mapping

pageId - the id of the custom page

authorizationRules - the names of the authorization rules to execute

Returns:

the created page mapping

Throws:

SObjectCreationException - when there is an issue while creating this object

create

public SPageMapping create(java.lang.String key,
                           java.lang.String url,
                           java.lang.String urlAdapter,
                           java.util.List<java.lang.String> authorizationRules)
                    throws SObjectCreationException

Specified by:

create in interface PageMappingService

Parameters:

key - the key used to retrieve the mapping

url - the external URL the mapping points to

urlAdapter - the name of the URL adapter that transform the URL in case of an external URL. i.e. it can add parameters

authorizationRules - the names of the authorization rules to execute

Returns:

the created page mapping

Throws:

SObjectCreationException - when there is an issue while creating this object

get

public SPageMapping get(java.lang.String key)
                 throws SObjectNotFoundException,
                        SBonitaReadException

Specified by:

get in interface PageMappingService

Parameters:

key - the key of the page mapping to retrieve

Returns:

the page mapping having this key

Throws:

SObjectNotFoundException - when there is no mapping having this key

SBonitaReadException

resolvePageURL

public SPageURL resolvePageURL(SPageMapping pageMapping,
                               java.util.Map<java.lang.String,java.io.Serializable> context,
                               boolean executeAuthorizationRules)
                        throws SExecutionException,
                               SAuthorizationException

Specified by:

resolvePageURL in interface PageMappingService

Returns:

Throws:

SExecutionException

SAuthorizationException

isAllowedToAccess

protected boolean isAllowedToAccess(SPageMapping pageMapping,
                                    java.util.Map<java.lang.String,java.io.Serializable> context,
                                    java.util.List<java.lang.String> pageAuthorizationRules)
                             throws SExecutionException

Throws:

SExecutionException

delete

public void delete(SPageMapping sPageMapping)
            throws SDeletionException

Description copied from interface: PageMappingService

delete this page mapping

Specified by:

delete in interface PageMappingService

Parameters:

sPageMapping - the page mapping to delete

Throws:

SDeletionException

update

public void update(SPageMapping pageMapping,
                   java.lang.Long pageId)
            throws SObjectModificationException,
                   SObjectNotFoundException,
                   SBonitaReadException

Description copied from interface: PageMappingService

update the given page mapping

Specified by:

update in interface PageMappingService

Parameters:

pageMapping - the pageMapping to update

pageId - the id of the page or null

Throws:

SObjectModificationException

SObjectNotFoundException

SBonitaReadException

update

public void update(SPageMapping pageMapping,
                   java.lang.String url,
                   java.lang.String urlAdapter)
            throws SObjectModificationException,
                   SObjectNotFoundException,
                   SBonitaReadException

Description copied from interface: PageMappingService

update the given page mapping

Specified by:

update in interface PageMappingService

Parameters:

pageMapping - the pageMapping to update

url - the URL or null

urlAdapter - the new URL adapter to use

Throws:

SObjectModificationException

SObjectNotFoundException

SBonitaReadException

get

public java.util.List<SPageMapping> get(long pageId,
                                        int startIndex,
                                        int maxResults)
                                 throws SBonitaReadException

Description copied from interface: PageMappingService

Gets the paginated mappings of the page.

Specified by:

get in interface PageMappingService

Parameters:

pageId - the page identifier

startIndex - the start index

maxResults - the max results

Returns:

the paginated mappings of the page

Throws:

SBonitaReadException