Package org.apache.syncope.client.ui.commons.wizards

Class AjaxWizardBuilder<T extends Serializable>

java.lang.Object

org.apache.syncope.client.ui.commons.wizards.AbstractModalPanelBuilder<T>

org.apache.syncope.client.ui.commons.wizards.AjaxWizardBuilder<T>

All Implemented Interfaces:

Serializable, ModalPanelBuilder<T>

Direct Known Subclasses:

AbstractAnyWizardBuilder, BaseAjaxWizardBuilder, OIDCProviderWizardBuilder, SAML2IdPWizardBuilder

public abstract class AjaxWizardBuilder<T extends Serializable>
extends AbstractModalPanelBuilder<T>

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected static Logger	LOG
protected AjaxWizard.Mode	mode
protected List<Component>	outerObjects

Fields inherited from class org.apache.syncope.client.ui.commons.wizards.AbstractModalPanelBuilder

eventSink, pageRef

Constructor Summary

Constructors

Constructor	Description
AjaxWizardBuilder(T defaultItem, PageReference pageRef)	Construct.

Method Summary

Modifier and Type	Method	Description
AjaxWizardBuilder<T>	addOuterObject(Component... childs)
AjaxWizard<T>	build(String id, int index, AjaxWizard.Mode mode)	Build the wizard.
AjaxWizard<T>	build(String id, AjaxWizard.Mode mode)	Build the wizard.
AjaxWizard<T>	build(AjaxWizard.Mode mode)	Build the wizard with a default wizard id.
protected abstract WizardModel	buildModelSteps(T modelObject, WizardModel wizardModel)
protected abstract Future<Pair<Serializable,Serializable>>	execute(Callable<Pair<Serializable,Serializable>> future)
protected Serializable	getCreateCustomPayloadEvent(Serializable afterObject, AjaxRequestTarget target)	Override to send custom events after create.
protected Serializable	getEditCustomPayloadEvent(Serializable afterObject, AjaxRequestTarget target)	Override to send custom events after edit.
protected abstract long	getMaxWaitTimeInSeconds()
protected abstract void	sendError(Exception exception)
protected abstract void	sendWarning(String message)

Methods inherited from class org.apache.syncope.client.ui.commons.wizards.AbstractModalPanelBuilder

getDefaultItem, getEventSink, getOriginalItem, getPageReference, newModelObject, onApplyInternal, onCancelInternal, setEventSink, setItem

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final Logger LOG

mode

protected AjaxWizard.Mode mode

outerObjects

protected final List<Component> outerObjects

Constructor Detail

AjaxWizardBuilder

public AjaxWizardBuilder(T defaultItem,
                         PageReference pageRef)

Construct.

Parameters:

defaultItem - default item.

pageRef - Caller page reference.

Method Detail

addOuterObject

public AjaxWizardBuilder<T> addOuterObject(Component... childs)

build

public AjaxWizard<T> build(String id,
                           int index,
                           AjaxWizard.Mode mode)

Description copied from interface: ModalPanelBuilder

Build the wizard.

Parameters:

id - component id.

index - step index.

mode - mode.

Returns:

wizard.

build

public AjaxWizard<T> build(AjaxWizard.Mode mode)

Build the wizard with a default wizard id.

Parameters:

mode - wizard mode.

Returns:

wizard.

build

public AjaxWizard<T> build(String id,
                           AjaxWizard.Mode mode)

Build the wizard.

Parameters:

id - component id.

mode - wizard mode.

Returns:

wizard.

buildModelSteps

protected abstract WizardModel buildModelSteps(T modelObject,
                                               WizardModel wizardModel)

getCreateCustomPayloadEvent

protected Serializable getCreateCustomPayloadEvent(Serializable afterObject,
                                                   AjaxRequestTarget target)

Override to send custom events after create.

Parameters:

afterObject - after applied changes object.

target - ajax request target

Returns:

payload to be sent.

getMaxWaitTimeInSeconds

protected abstract long getMaxWaitTimeInSeconds()

sendError

protected abstract void sendError(Exception exception)

sendWarning

protected abstract void sendWarning(String message)

execute

protected abstract Future<Pair<Serializable,Serializable>> execute(Callable<Pair<Serializable,Serializable>> future)

getEditCustomPayloadEvent

protected Serializable getEditCustomPayloadEvent(Serializable afterObject,
                                                 AjaxRequestTarget target)

Override to send custom events after edit.

Parameters:

afterObject - after applied changes object.

target - ajax request target

Returns:

payload to be sent.