Package ch.tocco.nice2.rest.action.spi

Class AbstractActionResource

java.lang.Object

ch.tocco.nice2.rest.core.spi.AbstractRestResource

ch.tocco.nice2.rest.action.spi.AbstractPreActionResource

ch.tocco.nice2.rest.action.spi.AbstractActionResource

All Implemented Interfaces:

RestResource

Direct Known Subclasses:

AbacusExportActionResource, AbstractCreateVoucherActionResource, AbstractDmsActionResource, AbstractInvoiceActionResource, AbstractMassWageResource, AbstractOrderMailActionResource, AbstractSetLookupEntityActionResource, AccomplishmentDeletionResource, AccomplishmentUpdateResource, AccrualPostingResource, ActivateDuplicateConfigActionResource, AddCandidateNumbersActionResource, AdjustArchiveTypeAction, AnonymizeActionResource, AvailabilityCreateCalendarSeriesActionResource, AvailabilityDeleteCalendarSeriesActionResource, BookIncomingPaymentActionResource, BookOrderActionResource, CancelMembershipActionResource, CancelTaskActionResource, ChangeBatchJobOwnerResource, ChangeMembershipTypeActionResource, ConnectInputNodeActionResource, CopyLicenceResource, CostDelimitationActionResource, CreateClassroomActionResource, CreateDebitorExportResource, CreateDonationResource, CreateFinancialYearResource, CreatePrepaymentVoucherActionResource, CreateScheduleActionResource, DeactivateDuplicateConfigActionResource, DebitorIncomingPaymentActionResource, DeleteCandidateNumberActionResource, DeleteClassroomActionResource, DeleteTaskActionResource, DisconnectPrincipalResource, DonationIncomingPaymentActionResource, EditUrlActionResource, EducationScheduleLogicCopyActionResource, EmploymentActionServiceResource, EntityModelExportActionResource, EsrImportActionResource, EvaluationActionResource, ExcelExportActionResource, ExportActionResource, FileUploadActionResource, FindMissingTranslationsResource, FulltextIndexBuildResource, FulltextIndexCheckActionResource, FulltextIndexClearResource, FulltextIndexEntityBuildResource, FulltextIndexEntityCheckActionResource, FulltextIndexFixResource, FulltextIndexSetupResource, GenerateEvaluationExecutionActionResource, InputEditFinishResource, InstanceDeleteActionResource, LogicCopySurveyQuestionActionResource, LowerDunningLevelResource, MassContactActionResource, MassLecturerBookingActionResource, MassMembershipActionResource, MassRegistrationActionResource, MembershipQuestionResource, OrderLogicCopyActionResource, PayrexxAccountCredentialsAction, PayrexxPaymentMethodsAction, PlanningOverviewResource, RegistrationAccomplishmentStatusResource, RegistrationCancellationResource, RemoveDebitorExportActionResource, RemoveQuestionnaireLockActionResource, RemoveWagesFromExportResource, RepeatAndUpdateLastDunningActionResource, ReportGenerationResource, ReportingLogicCopyActionResource, RequirementCheckActionResource, RequirementRuleCompileActionResource, ResendMessageActionResource, ReservationExportActionResource, ReservationLecturerBookingAccomplishmentStatusResource, ReservationLecturerBookingPlanningStatusResource, ReservationRegistrationPresenceRateResource, ResetUrlActionResource, SalaryExportResource, SchoolingCreateActionResource, SeminarLowerActionResource, SetDonationActionService, SetGenericTextResource, SetParentActionResource, SetSmsPasswordResource, SetWidgetDomainSecretActionResource, StintAuctionRegisterLecturerResource, SurveyExportActionResource, TimereportInfoResource, TimereportNewResource, TimereportUpdateResource, TodoActionResource, TransferAvailabilityActionResource, TriggerBatchJobActionResource, UpdateClientSecretActionResource, UpdateDueTimeActionResource, VCardExportActionResource, VCardImportActionResource, WageSimulationActionResource

public abstract class AbstractActionResource
extends AbstractPreActionResource

Abstract base class for action resources. This class provides data binding functionality and can wrap the actual action in a task job so that it can be executed asynchronously.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	AbstractActionResource.AbstractActionJob
protected class	AbstractActionResource.AbstractInterruptableActionJob
static class	AbstractActionResource.ActionResultBean
class	AbstractActionResource.ActionResultBeanBuilder
static final record	AbstractActionResource.ActionResultFlags
protected static class	AbstractActionResource.GetFormEntityTask

Nested classes/interfaces inherited from class ch.tocco.nice2.rest.action.spi.AbstractPreActionResource

AbstractPreActionResource.SelectionType

Field Summary

Fields

Modifier and Type	Field	Description
protected CommandExecutor	commandExecutor
protected EntityBeanRebinder	entityBeanRebinder
protected NotificationService	notificationService
protected TaskSchedulingService	taskSchedulingService

Fields inherited from class ch.tocco.nice2.rest.action.spi.AbstractPreActionResource

businessUnitManager, context, defaultDisplayService, defaultValueService, formBeanService, initialFormEntityName, initialFormName, l10n, log, requiresFormEntity, securityManager, textResources

Fields inherited from class ch.tocco.nice2.rest.core.spi.AbstractRestResource

uriInfo

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractActionResource(AbstractPreActionResource.SelectionType selectionType)
protected	AbstractActionResource(AbstractPreActionResource.SelectionType selectionType, @Nullable String initialFormEntityName)
protected	AbstractActionResource(AbstractPreActionResource.SelectionType selectionType, @Nullable String initialFormEntityName, @Nullable String initialFormName)

Method Summary

Modifier and Type	Method	Description
protected abstract TextMessage	actionName()	name of the action displayed in the notification center if no specific text is set
protected abstract AbstractActionResource.ActionResultBean	doPerformAction(ActionDataBean actionDataBean, ActionResourceBean actionResourceBean, TaskContext taskContext)
protected PreActionResponseBean	doValidate(ActionResourceBean actionResourceBean, ActionDataBean actionDataBean)
protected CallableType	getCallableType()	per default the callable type (persisted as Task_execution) is DATA_PROCESSING.
protected String	getCurrentUsername()
protected abstract Class<? extends AbstractJob>	getJobClass()	each action resource needs an empty job class as inner class which either implements AbstractActionJob or AbstractInterruptableActionJob.
protected @Nullable Entity	getParentEntity(@Nullable ActionParentEntityBean parent)
protected JobDataMapBuilder	getTaskData(String taskId, ActionResourceBean actionResourceBean)
ActionResponseBean	performAction(ActionResourceBean actionResourceBean)
protected boolean	recoveryEnabled()	Override to disable recovery for a particular action resource.
void	setCommandExecutor(CommandExecutor commandExecutor)
void	setEntityBeanRebinder(EntityBeanRebinder entityBeanRebinder)
void	setNotificationService(NotificationService notificationService)
void	setTaskContextBuilder(Supplier<TaskContext> taskContextBuilder)
void	setTaskSchedulingService(TaskSchedulingService taskSchedulingService)
protected TextMessage	taskCancelledMessage()
protected TextMessage	taskFailedMessage()
protected @Nullable TextMessage	taskFailedTitle()
protected TextMessage	taskFinishedMessage()
protected TextMessage	taskSchedulingMessage()
protected TextMessage	taskStartedMessage()
final PreActionResponseBean	validate(ActionResourceBean actionResourceBean)	If a form is shown in the pre-action, an (optional) validation can be implemented in doValidate(ActionResourceBean, ActionDataBean).
protected boolean	verifyFormEntityBean(EntityBean formEntityBean)

Methods inherited from class ch.tocco.nice2.rest.action.spi.AbstractPreActionResource

getInitialFormValueResponseBean, getSelectedEntities, getSelectedEntity, loadInitialForm, preAction, setBusinessUnitManager, setContext, setDefaultDisplayService, setDefaultValueService, setFormBeanService, setL10n, setLog, setSecurityManager, setSelectionService, setTextResources

Methods inherited from class ch.tocco.nice2.rest.core.spi.AbstractRestResource

getPathParameter, setUriInfo, tryGetInt

Methods inherited from class java.lang.Object

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

Field Details

entityBeanRebinder

protected EntityBeanRebinder entityBeanRebinder

commandExecutor

protected CommandExecutor commandExecutor

taskSchedulingService

protected TaskSchedulingService taskSchedulingService

notificationService

protected NotificationService notificationService

Constructor Details

AbstractActionResource

protected AbstractActionResource(AbstractPreActionResource.SelectionType selectionType)

AbstractActionResource

protected AbstractActionResource(AbstractPreActionResource.SelectionType selectionType,
 @Nullable
 @Nullable String initialFormEntityName)

AbstractActionResource

protected AbstractActionResource(AbstractPreActionResource.SelectionType selectionType,
 @Nullable
 @Nullable String initialFormEntityName,
 @Nullable
 @Nullable String initialFormName)

Method Details

doPerformAction

protected abstract AbstractActionResource.ActionResultBean doPerformAction(ActionDataBean actionDataBean,
 ActionResourceBean actionResourceBean,
 TaskContext taskContext)

validate

@POST
@Path("/validate")
@Consumes("application/json")
@Produces("application/json")
public final PreActionResponseBean validate(ActionResourceBean actionResourceBean)

If a form is shown in the pre-action, an (optional) validation can be implemented in doValidate(ActionResourceBean, ActionDataBean).

doValidate

protected PreActionResponseBean doValidate(ActionResourceBean actionResourceBean,
 ActionDataBean actionDataBean)

performAction

@POST
@Consumes("application/json")
@Produces("application/json")
public ActionResponseBean performAction(ActionResourceBean actionResourceBean)

getCallableType

protected CallableType getCallableType()

per default the callable type (persisted as Task_execution) is DATA_PROCESSING. however for some action a more specific type can be set

actionName

protected abstract TextMessage actionName()

name of the action displayed in the notification center if no specific text is set

taskSchedulingMessage

protected TextMessage taskSchedulingMessage()

taskStartedMessage

protected TextMessage taskStartedMessage()

taskFinishedMessage

protected TextMessage taskFinishedMessage()

taskFailedTitle

@Nullable
protected @Nullable TextMessage taskFailedTitle()

taskFailedMessage

protected TextMessage taskFailedMessage()

taskCancelledMessage

protected TextMessage taskCancelledMessage()

getTaskData

protected JobDataMapBuilder getTaskData(String taskId,
 ActionResourceBean actionResourceBean)

getCurrentUsername

protected String getCurrentUsername()

verifyFormEntityBean

protected boolean verifyFormEntityBean(EntityBean formEntityBean)

getParentEntity

@Nullable
protected @Nullable Entity getParentEntity(@Nullable
 @Nullable ActionParentEntityBean parent)

getJobClass

protected abstract Class<? extends AbstractJob> getJobClass()

each action resource needs an empty job class as inner class which either implements AbstractActionJob or AbstractInterruptableActionJob. the class is needed to run the job in the task scheduler. if AbstractInterruptableActionJob is used the doPerformAction must implement a cancellation handling

recoveryEnabled

protected boolean recoveryEnabled()

Override to disable recovery for a particular action resource.

Returns:

true if the job should be recovered after Nice restart, else false (default: true)

setEntityBeanRebinder

@Autowired
public void setEntityBeanRebinder(EntityBeanRebinder entityBeanRebinder)

setCommandExecutor

@Autowired
public void setCommandExecutor(CommandExecutor commandExecutor)

setTaskSchedulingService

@Autowired
public void setTaskSchedulingService(TaskSchedulingService taskSchedulingService)

setNotificationService

@Autowired
public void setNotificationService(NotificationService notificationService)

setTaskContextBuilder

@VisibleForTesting
public void setTaskContextBuilder(Supplier<TaskContext> taskContextBuilder)