Package de.xima.fc.plugin.gui

Interface IPluginAuthenticatorCustomGUIBean

All Superinterfaces:

IPluginGenericCustomGUIBean, Serializable

public interface IPluginAuthenticatorCustomGUIBean
extends IPluginGenericCustomGUIBean

Interface for the bean of a IAuthenticator. The bean must be view scoped, i.e. have the ViewScoped annotation set. The bean is created when the user selects an authenticator of the given type.

The annotations PostConstruct, PreDestroy and ManagedProperty are supported.

Since:

7.2.1

Author:

XIMA MEDIA GmbH

See Also:

IPluginGenericCustomGUI

Method Summary

Modifier and Type	Method	Description
default boolean	onAuthenticatorBeforeSave(AAuthenticator<?> authenticator)	Lifecycle callback invoked when an existing authenticator is about to be saved.
default void	onAuthenticatorSelected(AAuthenticator<?> authenticator)	Lifecycle callback invoked when an existing authenticator was selected.

Methods inherited from interface de.xima.fc.plugin.gui.IPluginGenericCustomGUIBean

destroy, getFileHelper, getProperties, getResourceHelper, initialize

Method Detail

onAuthenticatorSelected

default void onAuthenticatorSelected(AAuthenticator<?> authenticator)

Lifecycle callback invoked when an existing authenticator was selected. Can be used for initialization etc. The default implementation is a no-op, implement this method if you need the callback.

Parameters:

authenticator - The newly selected authenticator, either a SystemAuthenticator or a ClientAuthenticator.

onAuthenticatorBeforeSave

default boolean onAuthenticatorBeforeSave(AAuthenticator<?> authenticator)

Lifecycle callback invoked when an existing authenticator is about to be saved. Can be used for additional validation or sanitization. Messages can be added FacesContext. Return false to prevent the authenticator from getting saved. The default implementation is a no-op that simply returns true, implement this method if you need the callback.

Parameters:

authenticator - The newly selected authenticator, either a SystemAuthenticator or a ClientAuthenticator.

Returns:

true to save the authenticator, false to not save it.