Package org.ametys.web.cache

Class FOCommHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.web.cache.FOCommHelper

All Implemented Interfaces:

DeferredServiceable, LogEnabled, Disposable, Initializable, Component

public final class FOCommHelper
extends AbstractLogEnabled
implements Component, DeferredServiceable, Initializable, Disposable

Helper for dealing with front-office cache.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	FOCommHelper.FOResult	Result of a request to a front-office

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ROLE	Avalon Role

Constructor Summary

Constructors

Constructor	Description
FOCommHelper()

Method Summary

Modifier and Type	Method	Description
List<FOCommHelper.FOResult>	callWS(String url)	Request the given URL on each configured front-office.
List<FOCommHelper.FOResult>	callWS(String url, List<Pair<String,String>> postParameters)	Request the given URL on each configured front-office.
void	deferredService(ServiceManager manager)	Pass the ServiceManager used to access other components.
void	dispose()
String[]	getFrontURLS()	Get front office applications urls
void	initialize()
void	invalidateFOCache(Page page)	Invalidates the front-office from the event observed.
void	invalidateFOCache(Page page, boolean recursively)	Invalidates the front-office from the event observed.
void	invalidateFOCache(Site site)	Invalidates the front-office cache, a delay may be apply to comply with the minimum refresh period configured in the site.
void	invalidateFOCache(Sitemap sitemap)	Invalidates the front-office from the event observed.
void	invalidateFOCacheImmediately(String siteName)	Invalidate the site caches without delay.
void	testWS(String url)	Request the given URL on each configured front-office.
void	testWS(String url, List<Pair<String,String>> postParameters)	Request the given URL on each configured front-office.

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Details

ROLE

public static final String ROLE

Avalon Role

Constructor Details

FOCommHelper

public FOCommHelper()

Method Details

deferredService

public void deferredService(ServiceManager manager)
                     throws ServiceException

Description copied from interface: DeferredServiceable

Pass the ServiceManager used to access other components.

Specified by:

deferredService in interface DeferredServiceable

Parameters:

manager - The ServiceManager which this DeferredServiceable uses. Must not be null.

Throws:

ServiceException - if an error occurs

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

dispose

public void dispose()

Specified by:

dispose in interface Disposable

testWS

public void testWS(String url)
            throws Exception

Request the given URL on each configured front-office.

Parameters:

url - the url to be called.

Throws:

Exception - if an error occurred.

testWS

public void testWS(String url,
 List<Pair<String,String>> postParameters)
            throws Exception

Request the given URL on each configured front-office.

Parameters:

url - the url to be called.

postParameters - submited values

Throws:

Exception - if an error occurred.

callWS

public List<FOCommHelper.FOResult> callWS(String url)
                                   throws Exception

Request the given URL on each configured front-office.

Parameters:

url - the url to be called.

Returns:

The streams

Throws:

Exception - if an error occurred.

getFrontURLS

public String[] getFrontURLS()

Get front office applications urls

Returns:

The non null list of url configured. Can be empty.

callWS

public List<FOCommHelper.FOResult> callWS(String url,
 List<Pair<String,String>> postParameters)
                                   throws Exception

Request the given URL on each configured front-office.

Parameters:

url - the url to be called.

postParameters - submitted values

Returns:

The streams

Throws:

Exception - if an error occurred.

invalidateFOCache

public void invalidateFOCache(Site site)
                       throws Exception

Invalidates the front-office cache, a delay may be apply to comply with the minimum refresh period configured in the site.

Parameters:

site - the site.

Throws:

Exception - if an error occurs.

invalidateFOCacheImmediately

public void invalidateFOCacheImmediately(String siteName)
                                  throws Exception

Invalidate the site caches without delay.

Parameters:

siteName - The site name

Throws:

Exception - if an error occurs

invalidateFOCache

public void invalidateFOCache(Sitemap sitemap)
                       throws Exception

Invalidates the front-office from the event observed.

Parameters:

sitemap - the sitemap.

Throws:

Exception - if an error occurs.

invalidateFOCache

public void invalidateFOCache(Page page,
 boolean recursively)
                       throws Exception

Invalidates the front-office from the event observed.

Parameters:

page - the page.

recursively - true to invalidate the sub-pages

Throws:

Exception - if an error occurs.

invalidateFOCache

public void invalidateFOCache(Page page)
                       throws Exception

Invalidates the front-office from the event observed.

Parameters:

page - the page.

Throws:

Exception - if an error occurs.