Interface IPluginAuthenticatorType
-
- All Superinterfaces:
IFCPlugin
,INamedUiElement
,INameProviding
,ITransferable
,Serializable
public interface IPluginAuthenticatorType extends IFCPlugin
Interface for custom authenticator types. The user can select this plugin type when they create new authenticators in the external user menu.Please note that the user may create multiple authenticator of this type. For each created authenticator, the user can configure a list of key-value pairs (such as the username or token needed to perform the authentication). You can access the configuration via
IPluginFormAuthenticatorParams.getAuthenticator()
andIAuthenticator.getAttributes()
.Optionally, the user may also upload one or more files (such as SSL certificates), you can access these via
IAuthenticator.getFileMap()
.- Author:
- XIMA MEDIA GmbH
-
-
Field Summary
-
Fields inherited from interface de.xima.fc.plugin.interfaces.IFCPlugin
CONFIG_FILENAME
-
Fields inherited from interface de.xima.fc.interfaces.INamedUiElement
ATTR_DISPLAY_NAME
-
Fields inherited from interface de.xima.fc.entities.interfaces.INameProviding
ATTR_NAME, COL_NAME
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description IPluginFormAuthenticatorRetVal
buildFormAuthClient(IPluginFormAuthenticatorParams<? extends IAuthenticator<? extends IFileEntity<? extends de.xima.cmn.dao.interfaces.IEntity<Long>,? extends IFileDataEntity<?>>>> IPluginClientParams)
Method to build an client for the authentication for the request of a protected form.default IPluginAuthenticatorConfigGuiDetails
getConfigGuiDetails(IPluginAuthenticatorConfigGuiDetailsParam params)
Optional.default String
getHtmlHelpSnippet(Locale locale)
This method may optionally return a help text that is displayed when the user creates a new authenticator of this type.-
Methods inherited from interface de.xima.fc.plugin.interfaces.IFCPlugin
getDescription, getDescription, getDisplayName, getName, initialize, initPlugin, install, shutdown, shutdown, uninstall
-
-
-
-
Method Detail
-
buildFormAuthClient
IPluginFormAuthenticatorRetVal buildFormAuthClient(IPluginFormAuthenticatorParams<? extends IAuthenticator<? extends IFileEntity<? extends de.xima.cmn.dao.interfaces.IEntity<Long>,? extends IFileDataEntity<?>>>> IPluginClientParams)
Method to build an client for the authentication for the request of a protected form.- Parameters:
IPluginClientParams
- the parameters to create an client wrapped in aIPluginFormAuthenticatorParams
instance- Returns:
- the created client wrapped in a
IPluginFormAuthenticatorRetVal
instance
-
getHtmlHelpSnippet
default String getHtmlHelpSnippet(Locale locale)
This method may optionally return a help text that is displayed when the user creates a new authenticator of this type. This must be valid HTML snippet. May be used, for example, to explain which properties the user must enter.- Parameters:
locale
- The locale for which to show the help text.- Returns:
- An HTML snippet with an explanation for the user.
-
getConfigGuiDetails
default IPluginAuthenticatorConfigGuiDetails getConfigGuiDetails(IPluginAuthenticatorConfigGuiDetailsParam params)
Optional. Returns detail information about how the parts of the plugin authenticator config GUI should be rendered- Parameters:
params
- parameters for requesting the custom config dietails- Returns:
- the config GUI details
-
-