Interface IPluginAuthenticatorType

    • Method Detail

      • 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.
        locale - The locale for which to show the help text.
        An HTML snippet with an explanation for the user.
      • getXhtmlView

        default URL getXhtmlView()
        Description copied from interface: IPluginGenericCustomGUI
        This method must return the path to the XHTML page for the custom user interface. Usually the XHTML file is part of the JAR resources of the plugin. In this case, you should return an URL to a JAR file resource (jar:file:/...) like so:
         public URL getXhtmlView() {
           return getClass().getResource("/path/to/view.xhtml");
        Specified by:
        getXhtmlView in interface IPluginGenericCustomGUI<IPluginAuthenticatorCustomGUIBean>
        Path to the XHTML view. Must not return null. If you do return null, it will be treated as an error.
      • getUnmanagedBeans

        default Iterable<Class<? extends IPluginAuthenticatorCustomGUIBean>> getUnmanagedBeans()
        Description copied from interface: IPluginGenericCustomGUI
        This must return a list of backing bean classes that control the user interface and are required by the IPluginGenericCustomGUI.getXhtmlView(). A new instance of the bean will be created automatically when the view is opened. Make sure each bean has got a no-argument constructor or it cannot be instantiated.

        Please note that the beans are unmanaged - functionality specific to managed bean is not available. This means, for example, that annotations such as PostConstruct and ManagedProperty are not supported and will not work:

        Each bean should be annotated with ManagedBean and specify a If this annotation is not present or no name is specified, the name defaults to the simple name of the bean class.

        Also, each bean needs to be annotated one of the following scopes: RequestScoped, ViewScoped, SessionScoped or ApplicationScoped. Note that it depends on the type of plugin which scopes are actually supported. In case you do not specify a scope, an appropriate scope will be determined automatically.

        Certain features of managed beans may be supported partially, depending on the type of plugin, but may work differently. This includes, but is not limited to:

        • The exact timing at which PostConstruct and PreDestroy are called may differ.
        • A ManagedProperty may not work with all values allowed by the Java Beans specification, and may not perform checks such as the check for circular dependencies. It will also not create new beans when those beans have not been created yet as part of the current page.
        Specified by:
        getUnmanagedBeans in interface IPluginGenericCustomGUI<IPluginAuthenticatorCustomGUIBean>
        An Iterable over the unmanaged bean classes required by the view