Package org.cyclos.impl.system

Interface CustomWizardServiceLocal

All Superinterfaces:

CRUDService<CustomWizardDTO,CustomWizardData,CustomWizardNature>, CRUDServiceLocal<CustomWizard,CustomWizardDTO,CustomWizardData,CustomWizardNature>, CustomWizardService, Service

All Known Implementing Classes:

CustomWizardServiceImpl

public interface CustomWizardServiceLocal
extends CRUDServiceLocal<CustomWizard,CustomWizardDTO,CustomWizardData,CustomWizardNature>, CustomWizardService

Local interface for CustomWizardService

Field Summary

Fields

Modifier and Type	Field	Description
static String	ATTR_CUSTOM_VALUES	Scripting attribute: the map of custom values
static String	ATTR_EXECUTION	Scripting attribute: the wizard execution
static String	ATTR_PREVIOUS_STEP	Scripting attribute: the previous wizard step
static String	ATTR_REGISTRATION	Scripting attribute: the PublicRegistrationDTO
static String	ATTR_REQUEST	Scripting attribute: the request as received from the external system after a callback
static String	ATTR_RETURN_URL	Scripting attribute: the URL the external system should use to redirect back to Cyclos
static String	ATTR_STEP	Scripting attribute: the current wizard step
static String	ATTR_STEPS	Scripting attribute: all steps with transitions, including the current one
static String	ATTR_STORAGE	Scripting attribute: the storage to save data for the execution
static String	ATTR_TRANSITION	Scripting attribute: the transition being executed
static String	ATTR_USER	Scripting attribute: the registered user
static String	ATTR_WIZARD	Scripting attribute: the wizard being executed
static String	NEXT	The 'internal name' that represents the next step

Method Summary

Modifier and Type	Method	Description
CustomWizardExecution	findExecution(String key)	Returns an execution by key
UserGroup	getGroup(CustomWizardExecution execution)	Returns the registration group for the given wizard execution
List<MenuItemWizard>	getRunnableWizardsForMenu()	Returns all menu wizards that can be executed by the currently authenticated user (or guest)
CustomWizardExecutionStorage	getStorage(PublicRegistrationDTO dto)	Returns the storage from an attribute of the given DTO
CustomWizardExecutionData	identityProviderCallback(CustomWizardExecution execution, org.pac4j.core.profile.CommonProfile profile, IdentityProviderCallbackResult result)	A callback from identity provider request.
List<UserWizard>	listForRun(User user)	Returns the wizards the logged user can run over the given user
List<MenuItemWizard>	listMenuWizards()	Returns all guest wizards
List<RegistrationWizard>	listRegistrationWizards()	Returns all wizards for registration
Collection<SystemWizard>	listSystemForRun()	Returns the system wizards the logged user can run
List<SystemWizard>	listSystemWizards()	Returns all system wizards
List<UserWizard>	listUserWizards()	Returns all user wizards

Methods inherited from interface org.cyclos.services.CRUDService

getData, getDataForNew, load, remove, removeAll, save

Methods inherited from interface org.cyclos.impl.CRUDServiceLocal

find, findAll, getEntityClass, newEntity, remove, removeAll, saveEntity, saveSkippingEntityLog, toDTO, toEntity, validate

Methods inherited from interface org.cyclos.services.system.CustomWizardService

back, cancel, current, externalRedirect, list, runExternalRedirectCallback, saveOrder, sendVerificationCode, start, transition

Field Detail

NEXT

static final String NEXT

The 'internal name' that represents the next step

See Also:

Constant Field Values

ATTR_WIZARD

static final String ATTR_WIZARD

Scripting attribute: the wizard being executed

See Also:

Constant Field Values

ATTR_STEP

static final String ATTR_STEP

Scripting attribute: the current wizard step

See Also:

Constant Field Values

ATTR_PREVIOUS_STEP

static final String ATTR_PREVIOUS_STEP

Scripting attribute: the previous wizard step

See Also:

Constant Field Values

ATTR_STEPS

static final String ATTR_STEPS

Scripting attribute: all steps with transitions, including the current one

See Also:

Constant Field Values

ATTR_TRANSITION

static final String ATTR_TRANSITION

Scripting attribute: the transition being executed

See Also:

Constant Field Values

ATTR_EXECUTION

static final String ATTR_EXECUTION

Scripting attribute: the wizard execution

See Also:

Constant Field Values

ATTR_USER

static final String ATTR_USER

Scripting attribute: the registered user

See Also:

Constant Field Values

ATTR_REGISTRATION

static final String ATTR_REGISTRATION

Scripting attribute: the PublicRegistrationDTO

See Also:

Constant Field Values

ATTR_CUSTOM_VALUES

static final String ATTR_CUSTOM_VALUES

Scripting attribute: the map of custom values

See Also:

Constant Field Values

ATTR_STORAGE

static final String ATTR_STORAGE

Scripting attribute: the storage to save data for the execution

See Also:

Constant Field Values

ATTR_RETURN_URL

static final String ATTR_RETURN_URL

Scripting attribute: the URL the external system should use to redirect back to Cyclos

See Also:

Constant Field Values

ATTR_REQUEST

static final String ATTR_REQUEST

Scripting attribute: the request as received from the external system after a callback

See Also:

Constant Field Values

Method Detail

findExecution

CustomWizardExecution findExecution(String key)

Returns an execution by key

getGroup

UserGroup getGroup(CustomWizardExecution execution)

Returns the registration group for the given wizard execution

getRunnableWizardsForMenu

List<MenuItemWizard> getRunnableWizardsForMenu()

Returns all menu wizards that can be executed by the currently authenticated user (or guest)

getStorage

CustomWizardExecutionStorage getStorage(PublicRegistrationDTO dto)

Returns the storage from an attribute of the given DTO

identityProviderCallback

CustomWizardExecutionData identityProviderCallback(CustomWizardExecution execution,
                                                   org.pac4j.core.profile.CommonProfile profile,
                                                   IdentityProviderCallbackResult result)

A callback from identity provider request. Stores all data which was read from the provider in the current user registration. Also stores the identity provider identifier, so the new user will be linked with the IdP.

listForRun

List<UserWizard> listForRun(User user)

Returns the wizards the logged user can run over the given user

listMenuWizards

List<MenuItemWizard> listMenuWizards()

Returns all guest wizards

listRegistrationWizards

List<RegistrationWizard> listRegistrationWizards()

Returns all wizards for registration

listSystemForRun

Collection<SystemWizard> listSystemForRun()

Returns the system wizards the logged user can run

listSystemWizards

List<SystemWizard> listSystemWizards()

Returns all system wizards

listUserWizards

List<UserWizard> listUserWizards()

Returns all user wizards