Package org.cyclos.impl.system

Class CustomWizardServiceImpl

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.impl.BaseServiceImpl

org.cyclos.impl.CRUDServiceImpl<CustomWizard,QCustomWizard,CustomWizardDTO,CustomWizardData,CustomWizardNature>

org.cyclos.impl.system.CustomWizardServiceImpl

All Implemented Interfaces:

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

@Service
public class CustomWizardServiceImpl
extends CRUDServiceImpl<CustomWizard,QCustomWizard,CustomWizardDTO,CustomWizardData,CustomWizardNature>
implements CustomWizardServiceLocal

Implementation for CustomWizardService

Field Summary

Fields

Modifier and Type	Field	Description
protected StoredFileHandler	storedFileHandler

Fields inherited from class org.cyclos.impl.CRUDServiceImpl

$, ATTR_CURRENT_COPY, cacheHandler, dtoClass, entityClass, extensionPointService, idPath, internalNamePath, namePath, ownerEntityIdPath, ownerEntityPath, ownerEntityPropertyName, passwordHandler, richTextHandler, withConfirmationPassword

Fields inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

authHandler, conversionHandler, customFieldValueHandler, entityManagerHandler, groupsHandler, productsHandler, restBeanPropertyMapping, userLocatorHandler

Fields inherited from class org.cyclos.impl.AbstractServerComponent

accountHandler, configurationHandler, dataTranslationHandler, notificationHandler, profileFieldHandler, transactionHandler, translationHandler

Fields inherited from interface org.cyclos.impl.system.CustomWizardServiceLocal

ATTR_CUSTOM_VALUES, ATTR_EXECUTION, ATTR_PREVIOUS_STEP, ATTR_REGISTRATION, ATTR_REQUEST, ATTR_RETURN_URL, ATTR_STEP, ATTR_STEPS, ATTR_STORAGE, ATTR_TRANSITION, ATTR_USER, ATTR_WIZARD, NEXT

Constructor Summary

Constructors

Constructor	Description
CustomWizardServiceImpl()

Method Summary

Modifier and Type	Method	Description
CustomWizardExecutionData	back(@NotNull CustomWizardBackParams params)	Backs one or more steps
void	cancel(String key)	Cancels the execution with the given key
CustomWizardExecutionData	current(@NotNull String key)	Returns the execution data for the current wizard step
String	externalRedirect(@NotNull CustomWizardTransitionParams params)	Prepares the redirection of the user to an external system.
CustomWizardExecution	findExecution(String key)	Returns an execution by key
protected CustomWizardData	getData(CustomWizard wizard)	Returns details data for the given entity
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<CustomWizardResultVO>	list()	Lists all available custom wizards
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
CustomWizard	newEntity(CustomWizardNature nature)	Should be implemented in order to instantiate a new entity based on the given context parameters
protected void	registerNetworkMappings(NetworkPathRegistry networkPathRegistry)	Needs to be overridden by subclasses to register the path up to the network
protected void	remove(IEntity entity)
protected Validator	resolveValidator(CustomWizardDTO dto)
CustomWizardExecutionData	runExternalRedirectCallback(@NotNull RunExternalRedirectCallbackParams params)	Runs the callback for a step which performs such operation
void	sendVerificationCode(@NotNull CustomWizardVerificationCodeParams params)	Sends the verification code to either via email or by SMS, in order to verify the given data.
CustomWizardExecutionData	start(StartCustomWizardParams params)	Starts the execution of a given wizard
protected org.apache.commons.collections4.BidiMap<Class<? extends CustomWizard>,Class<? extends CustomWizardDTO>>	subClassMappings()	Should be overridden by subclasses which handle entity / dto hierarchies.
CustomWizardExecutionData	transition(CustomWizardTransitionParams params)	Transition a wizard between steps or finishes the wizard

Methods inherited from class org.cyclos.impl.CRUDServiceImpl

addCustomInternalNameValidations, addCustomNameValidations, checkConfirmationPassword, doRemove, find, findAll, from, getConfirmationPasswordInput, getConfirmationPasswordInputForRemove, getData, getDataForNew, getDeviceConfirmationParams, getEntityClass, getEntityInternalNameKey, getExcludedPropertiesToDTO, getExcludedPropertiesToEntity, getNameLabel, getUniqueInternalNameQuery, getUniqueNameQuery, isEntityInternalNameRequired, isNameRequired, load, logEntity, onAfterRemove, onAfterSave, onBeforeRemove, onBeforeSave, preProcessCurrentCopy, remove, remove, removeAll, removeAll, removeAllWithConfirmationPassword, removeWithConfirmationPassword, resolveDTOType, resolveEntityType, resolveExtensionPointAccessor, save, saveOrder, saveSkippingEntityLog, saveWithConfirmationPassword, shouldCheckConfirmationPassword, toDTO, toEntity, validate

Methods inherited from class org.cyclos.impl.BaseServiceImpl

initializeNetworkMappings

Methods inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

canManage, checkManagesUser, checkPermission, checkRelatesToUser, checkValue, clearAlreadyValidated, getBaseEntityManagerHandler, getConfiguration, getLoggedBasicUser, getLoggedUser, getProducts, getTranslatedName, getTranslatedValue, hasPermission, hasValue, inSameNetwork, inSameNetworkOrGlobal, isAdmin, isAlreadyValidated, isBroker, isGlobalAdmin, isGlobalAdminInNetwork, isGuest, isLoggedIn, isMember, isMemberOnly, isNetworkAdmin, isOperator, isRelatedToUser, isSystem, isUserManager, isUserManagerOf, message, message, permission, permission, permissionOptionalValue, permissionOptionalValue, setAlreadyValidated, toDate, toDateTime, validate

Methods inherited from class org.cyclos.impl.AbstractServerComponent

dataTranslationProxy, dataTranslationProxy, delete, detach, doDataTranslationProxy, find, flush, from, getApplicationContext, getFormatter, getFormatter, getFormatter, getLogger, getRemoteAddress, getSessionData, mailContentBuilder, message, message, persist, processBatch, processBatch, refresh, selectFrom, subQuery, update

Methods inherited from class java.lang.Object

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

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, remove, removeAll, saveEntity, saveSkippingEntityLog, toDTO, toEntity, validate

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

saveOrder

Field Detail

storedFileHandler

@Autowired
protected StoredFileHandler storedFileHandler

Constructor Detail

CustomWizardServiceImpl

public CustomWizardServiceImpl()

Method Detail

back

public CustomWizardExecutionData back(@NotNull
                                      @NotNull CustomWizardBackParams params)
                               throws FrameworkException

Description copied from interface: CustomWizardService

Backs one or more steps

Specified by:

back in interface CustomWizardService

Throws:

FrameworkException

cancel

public void cancel(String key)
            throws FrameworkException

Description copied from interface: CustomWizardService

Cancels the execution with the given key

Specified by:

cancel in interface CustomWizardService

Throws:

FrameworkException

current

public CustomWizardExecutionData current(@NotNull
                                         @NotNull String key)
                                  throws FrameworkException

Description copied from interface: CustomWizardService

Returns the execution data for the current wizard step

Specified by:

current in interface CustomWizardService

Throws:

FrameworkException

externalRedirect

public String externalRedirect(@NotNull
                               @NotNull CustomWizardTransitionParams params)
                        throws FrameworkException

Description copied from interface: CustomWizardService

Prepares the redirection of the user to an external system.

Specified by:

externalRedirect in interface CustomWizardService

Throws:

FrameworkException

findExecution

public CustomWizardExecution findExecution(String key)

Description copied from interface: CustomWizardServiceLocal

Returns an execution by key

Specified by:

findExecution in interface CustomWizardServiceLocal

getGroup

public UserGroup getGroup(CustomWizardExecution execution)

Description copied from interface: CustomWizardServiceLocal

Returns the registration group for the given wizard execution

Specified by:

getGroup in interface CustomWizardServiceLocal

getRunnableWizardsForMenu

public List<MenuItemWizard> getRunnableWizardsForMenu()

Description copied from interface: CustomWizardServiceLocal

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

Specified by:

getRunnableWizardsForMenu in interface CustomWizardServiceLocal

getStorage

public CustomWizardExecutionStorage getStorage(PublicRegistrationDTO dto)

Description copied from interface: CustomWizardServiceLocal

Returns the storage from an attribute of the given DTO

Specified by:

getStorage in interface CustomWizardServiceLocal

identityProviderCallback

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

Description copied from interface: CustomWizardServiceLocal

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.

Specified by:

identityProviderCallback in interface CustomWizardServiceLocal

list

public List<CustomWizardResultVO> list()
                                throws FrameworkException

Description copied from interface: CustomWizardService

Lists all available custom wizards

Specified by:

list in interface CustomWizardService

Throws:

FrameworkException

listForRun

public List<UserWizard> listForRun(User user)

Description copied from interface: CustomWizardServiceLocal

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

Specified by:

listForRun in interface CustomWizardServiceLocal

listMenuWizards

public List<MenuItemWizard> listMenuWizards()

Description copied from interface: CustomWizardServiceLocal

Returns all guest wizards

Specified by:

listMenuWizards in interface CustomWizardServiceLocal

listRegistrationWizards

public List<RegistrationWizard> listRegistrationWizards()

Description copied from interface: CustomWizardServiceLocal

Returns all wizards for registration

Specified by:

listRegistrationWizards in interface CustomWizardServiceLocal

listSystemForRun

public Collection<SystemWizard> listSystemForRun()

Description copied from interface: CustomWizardServiceLocal

Returns the system wizards the logged user can run

Specified by:

listSystemForRun in interface CustomWizardServiceLocal

listSystemWizards

public List<SystemWizard> listSystemWizards()

Description copied from interface: CustomWizardServiceLocal

Returns all system wizards

Specified by:

listSystemWizards in interface CustomWizardServiceLocal

listUserWizards

public List<UserWizard> listUserWizards()

Description copied from interface: CustomWizardServiceLocal

Returns all user wizards

Specified by:

listUserWizards in interface CustomWizardServiceLocal

newEntity

public CustomWizard newEntity(CustomWizardNature nature)

Description copied from class: CRUDServiceImpl

Should be implemented in order to instantiate a new entity based on the given context parameters

Specified by:

newEntity in interface CRUDServiceLocal<CustomWizard,CustomWizardDTO,CustomWizardData,CustomWizardNature>

Specified by:

newEntity in class CRUDServiceImpl<CustomWizard,QCustomWizard,CustomWizardDTO,CustomWizardData,CustomWizardNature>

runExternalRedirectCallback

public CustomWizardExecutionData runExternalRedirectCallback(@NotNull
                                                             @NotNull RunExternalRedirectCallbackParams params)
                                                      throws FrameworkException

Description copied from interface: CustomWizardService

Runs the callback for a step which performs such operation

Specified by:

runExternalRedirectCallback in interface CustomWizardService

Throws:

FrameworkException

sendVerificationCode

public void sendVerificationCode(@NotNull
                                 @NotNull CustomWizardVerificationCodeParams params)
                          throws FrameworkException

Description copied from interface: CustomWizardService

Sends the verification code to either via email or by SMS, in order to verify the given data. Each send medium can only be used every 30 seconds.

Specified by:

sendVerificationCode in interface CustomWizardService

Throws:

FrameworkException

start

public CustomWizardExecutionData start(StartCustomWizardParams params)
                                throws FrameworkException

Description copied from interface: CustomWizardService

Starts the execution of a given wizard

Specified by:

start in interface CustomWizardService

Throws:

FrameworkException

transition

public CustomWizardExecutionData transition(CustomWizardTransitionParams params)
                                     throws FrameworkException

Description copied from interface: CustomWizardService

Transition a wizard between steps or finishes the wizard

Specified by:

transition in interface CustomWizardService

Throws:

FrameworkException

getData

protected CustomWizardData getData(CustomWizard wizard)

Description copied from class: CRUDServiceImpl

Returns details data for the given entity

Specified by:

getData in class CRUDServiceImpl<CustomWizard,QCustomWizard,CustomWizardDTO,CustomWizardData,CustomWizardNature>

registerNetworkMappings

protected void registerNetworkMappings(NetworkPathRegistry networkPathRegistry)

Description copied from class: BaseServiceImpl

Needs to be overridden by subclasses to register the path up to the network

Specified by:

registerNetworkMappings in class BaseServiceImpl

remove

protected void remove(IEntity entity)

Overrides:

remove in class AbstractServerComponent

See Also:

BaseEntityManagerHandler.remove(IEntity)

resolveValidator

protected Validator resolveValidator(CustomWizardDTO dto)

Specified by:

resolveValidator in class CRUDServiceImpl<CustomWizard,QCustomWizard,CustomWizardDTO,CustomWizardData,CustomWizardNature>

subClassMappings

protected org.apache.commons.collections4.BidiMap<Class<? extends CustomWizard>,Class<? extends CustomWizardDTO>> subClassMappings()

Description copied from class: CRUDServiceImpl

Should be overridden by subclasses which handle entity / dto hierarchies. The map key should be the entity class, while the map value, the DTO class

Overrides:

subClassMappings in class CRUDServiceImpl<CustomWizard,QCustomWizard,CustomWizardDTO,CustomWizardData,CustomWizardNature>