Package org.ametys.web.publication

Class AbstractPublishOrUnpublishPageRunnable

java.lang.Object

org.ametys.web.publication.AbstractPublishOrUnpublishPageRunnable

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

PublishPageRunnable, UnpublishPageRunnable

public abstract class AbstractPublishOrUnpublishPageRunnable
extends Object
implements Runnable

A Runnable which schedules a PublishOrUnpublishPageSchedulable task for (un)publishing a page.

Nested Class Summary

Nested classes/interfaces inherited from interface org.ametys.core.schedule.Runnable

Runnable.FireProcess, Runnable.MisfirePolicy

Field Summary

Fields

Modifier and Type	Field	Description
protected ZonedDateTime	_date	The date when to (un)publish the page
protected String	_pageId	The id of the page to (un)publish
protected String	_pageName	The name of the page to (un)publish
protected UserIdentity	_userIdentity	The UserIdentity to launch the runnable task

Constructor Summary

Constructors

Constructor	Description
AbstractPublishOrUnpublishPageRunnable(String pageId, String pageName, UserIdentity userIdentity, ZonedDateTime date)	Constructor

Method Summary

Modifier and Type	Method	Description
String	getCronExpression()	Returns the cron expression to base the schedule on.
Runnable.FireProcess	getFireProcess()	Gets the process of firing, i.e.
String	getId()	Returns the id
Runnable.MisfirePolicy	getMisfirePolicy()	Gets the misfire policy, i.e.
Map<String,Object>	getParameterValues()	Gets the values of the parameters (from the linked Schedulable)
String	getSchedulableId()	Gets the identifier of Schedulable to execute
UserIdentity	getUserIdentity()	Gets the user which should be used to launch the runnable task.
boolean	isDeactivatable()	Determines if this runnable can be activate or deactivate
boolean	isModifiable()	Determines if this runnable can be modified
boolean	isRemovable()	Determines if this runnable can be removed
boolean	isVolatile()	Determines if the runnable must not survive to a server restart

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.core.schedule.Runnable

getDescription, getLabel

Field Detail

_pageId

protected String _pageId

The id of the page to (un)publish

_pageName

protected String _pageName

The name of the page to (un)publish

_userIdentity

protected UserIdentity _userIdentity

The UserIdentity to launch the runnable task

_date

protected ZonedDateTime _date

The date when to (un)publish the page

Constructor Detail

AbstractPublishOrUnpublishPageRunnable

public AbstractPublishOrUnpublishPageRunnable(String pageId,
                                              String pageName,
                                              UserIdentity userIdentity,
                                              ZonedDateTime date)

Constructor

Parameters:

pageId - The id of the page to (un)publish

pageName - The name of the page to (un)publish

userIdentity - The UserIdentity to launch the runnable task

date - The date when to (un)publish the page

Method Detail

getId

public String getId()

Description copied from interface: Runnable

Returns the id

Specified by:

getId in interface Runnable

Returns:

the id

getFireProcess

public Runnable.FireProcess getFireProcess()

Description copied from interface: Runnable

Gets the process of firing, i.e. the way the task will be scheduled (fire now, fire at next stratup, schedule it based on a cron expression...).

Specified by:

getFireProcess in interface Runnable

Returns:

the fire process

getCronExpression

public String getCronExpression()

Description copied from interface: Runnable

Returns the cron expression to base the schedule on. Ignored if Runnable.getFireProcess() is different from Runnable.FireProcess.CRON.

Specified by:

getCronExpression in interface Runnable

Returns:

the cron expression

getSchedulableId

public String getSchedulableId()

Description copied from interface: Runnable

Gets the identifier of Schedulable to execute

Specified by:

getSchedulableId in interface Runnable

Returns:

the identifier of Schedulable

isRemovable

public boolean isRemovable()

Description copied from interface: Runnable

Determines if this runnable can be removed

Specified by:

isRemovable in interface Runnable

Returns:

true if this runnable is removable

isModifiable

public boolean isModifiable()

Description copied from interface: Runnable

Determines if this runnable can be modified

Specified by:

isModifiable in interface Runnable

Returns:

true if this runnable is modifiable

isDeactivatable

public boolean isDeactivatable()

Description copied from interface: Runnable

Determines if this runnable can be activate or deactivate

Specified by:

isDeactivatable in interface Runnable

Returns:

true if this runnable is deactivatable

getMisfirePolicy

public Runnable.MisfirePolicy getMisfirePolicy()

Description copied from interface: Runnable

Gets the misfire policy, i.e. what the runnable must do if it missed a trigger. Ignored if Runnable.getFireProcess() is different from Runnable.FireProcess.CRON.

Specified by:

getMisfirePolicy in interface Runnable

Returns:

The misfire policy

isVolatile

public boolean isVolatile()

Description copied from interface: Runnable

Determines if the runnable must not survive to a server restart

Specified by:

isVolatile in interface Runnable

Returns:

true if the runnable must not survive to a server restart

getParameterValues

public Map<String,Object> getParameterValues()

Description copied from interface: Runnable

Gets the values of the parameters (from the linked Schedulable)

Specified by:

getParameterValues in interface Runnable

Returns:

the parameter values

getUserIdentity

public UserIdentity getUserIdentity()

Description copied from interface: Runnable

Gets the user which should be used to launch the runnable task.

Specified by:

getUserIdentity in interface Runnable

Returns:

the UserIdentity of the user