Package org.jdesktop.swingx

Class JXLoginPane

java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JPanel
org.jdesktop.swingx.JXPanel
org.jdesktop.swingx.JXLoginPane
All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible, Scrollable
@JavaBean public class JXLoginPane extends JXPanel

JXLoginPane is a specialized JPanel that implements a Login dialog with support for saving passwords supplied for future use in a secure manner. LoginService is invoked to perform authentication and optional PasswordStore can be provided to store the user login information.

In order to perform the authentication, JXLoginPane calls the authenticate method of the LoginService . In order to perform the persistence of the password, JXLoginPane calls the put method of the PasswordStore object that is supplied. If the PasswordStore is null, then the password is not saved. Similarly, if a PasswordStore is supplied and the password is null, then the PasswordStore will be queried for the password using the get method. Example: 


         final JXLoginPane panel = new JXLoginPane(new LoginService() {
                      public boolean authenticate(String name, char[] password,
                                      String server) throws Exception {
                              // perform authentication and return true on success.
                              return false;
                      }});
      final JFrame frame = JXLoginPane.showLoginFrame(panel);
Author:
Bino George, Shai Almog, rbair, Karl Schaefer, rah003, Jonathan Giles, EUG https://github.com/homebeaver (banner as CompoundPainter: ImagePainter + TextPainter)
See Also:

  • Field Details

    • uiClassID

      public static final String uiClassID
      UI Class ID
      See Also:

    • LOGIN_ACTION_COMMAND

      public static final String LOGIN_ACTION_COMMAND
      Action key for an Action in the ActionMap that initiates the Login procedure
      See Also:

    • CANCEL_LOGIN_ACTION_COMMAND

      public static final String CANCEL_LOGIN_ACTION_COMMAND
      Action key for an Action in the ActionMap that cancels the Login procedure
      See Also:

  • Constructor Details

    • JXLoginPane

      public JXLoginPane()
      Create a JXLoginPane that always accepts the user, never stores passwords or user ids, and has no target servers.

      This constructor should NOT be used in a real application. It is provided for compliance to the bean specification and for use with visual editors.

    • JXLoginPane

      public JXLoginPane(LoginService service)
      Create a JXLoginPane with the specified LoginService that does not store user ids or passwords and has no target servers.
      Parameters:
      service - the LoginService to use for logging in

    • JXLoginPane

      public JXLoginPane(LoginService service, PasswordStore passwordStore, UserNameStore userStore)
      Create a JXLoginPane with the specified LoginService, PasswordStore, and UserNameStore, but without a server list.

      If you do not want to store passwords or user ids, those parameters can be null. SaveMode is autoconfigured from passed in store parameters.

      Parameters:
      service - the LoginService to use for logging in
      passwordStore - the PasswordStore to use for storing password information
      userStore - the UserNameStore to use for storing user information

    • JXLoginPane

      public JXLoginPane(LoginService service, PasswordStore passwordStore, UserNameStore userStore, List<String> servers)
      Create a JXLoginPane with the specified LoginService, PasswordStore, UserNameStore, and server list.

      If you do not want to store passwords or user ids, those parameters can be null. SaveMode is autoconfigured from passed in store parameters.

      Setting the server list to null will unset all of the servers. The server list is guaranteed to be non-null.

      Parameters:
      service - the LoginService to use for logging in
      passwordStore - the PasswordStore to use for storing password information
      userStore - the UserNameStore to use for storing user information
      servers - a list of servers to authenticate against

  • Method Details

    • isCapsLockOn

      public boolean isCapsLockOn()
      Gets current state of the caps lock as seen by the login panel. The state seen by the login panel and therefore returned by this method can be delayed in comparison to the real caps lock state and displayed by the keyboard light. This is usually the case when component or its text fields are not focused.
      Returns:
      True when caps lock is on, false otherwise. Returns always false when isCapsLockDetectionSupported() returns false.

    • isCustomizedBanner

      public boolean isCustomizedBanner()
      indicator for customized Banner
      Returns:
      boolean

    • getUI

      public LoginPaneUI getUI()
      Overrides:
      getUI in class JPanel

    • updateUI

      public void updateUI()
      Notification from the UIManager that the LaF has changed. Replaces the current UI object with the latest version from the UIManager.
      Overrides:
      updateUI in class JPanel
      See Also:

    • getUIClassID

      public String getUIClassID()
      Returns the name of the LaF class that renders this component.
      Overrides:
      getUIClassID in class JPanel
      Returns:
      the string uiClassID
      See Also:

    • recreateLoginPanel

      protected void recreateLoginPanel()
      Recreates the login panel, and replaces the current one with the new one

    • setComponentOrientation

      public void setComponentOrientation(ComponentOrientation orient)
      This method adds functionality to support bidi languages within this component
      Overrides:
      setComponentOrientation in class Component

    • createLoginBanner

      protected Image createLoginBanner()
      Create and return an image to use for the Banner. This may be overridden to return any image you like
      Returns:
      Image to use for the Banner

    • createLoginAction

      protected Action createLoginAction()
      Create and return an Action for logging in
      Returns:
      Action to log in

    • createCancelAction

      protected Action createCancelAction()
      Create and return an Action for canceling login
      Returns:
      Action to cancel log in

    • getSaveMode

      public JXLoginPane.SaveMode getSaveMode()
      Returns:
      Returns the saveMode.

    • setSaveMode

      public void setSaveMode(JXLoginPane.SaveMode saveMode)
      The save mode indicates whether the "save" password is checked by default. This method makes no difference if the passwordStore is null.
      Parameters:
      saveMode - The saveMode to set either SAVE_NONE, SAVE_PASSWORD or SAVE_USERNAME

    • isRememberPassword

      public boolean isRememberPassword()
      Returns:
      true if isRememberPassword is selected

    • getServers

      public List<String> getServers()
      Returns:
      the List of servers

    • setServers

      public void setServers(List<String> servers)
      Sets the list of servers. See the servers field javadoc for more info.
      Parameters:
      servers - list of servers

    • setLoginService

      public void setLoginService(LoginService service)
      Sets the LoginService for this panel. Setting the login service to null will actually set the service to use NullLoginService.
      Parameters:
      service - the service to set. If service == null, then a NullLoginService is used.

    • getLoginService

      public LoginService getLoginService()
      Gets the LoginService for this panel.
      Returns:
      service service

    • setPasswordStore

      public void setPasswordStore(PasswordStore store)
      Sets the PasswordStore for this panel.
      Parameters:
      store - PasswordStore

    • getUserNameStore

      public UserNameStore getUserNameStore()
      Gets the UserNameStore for this panel.
      Returns:
      the UserNameStore

    • setUserNameStore

      public void setUserNameStore(UserNameStore store)
      Sets the user name store for this panel.
      Parameters:
      store - UserNameStore

    • getPasswordStore

      public PasswordStore getPasswordStore()
      Gets the PasswordStore for this panel.
      Returns:
      store PasswordStore

    • setUserName

      public void setUserName(String username)
      Sets the User name for this panel.
      Parameters:
      username - User name

    • setUserNameEnabled

      public void setUserNameEnabled(boolean enabled)
      Enables or disables User name for this panel.
      Parameters:
      enabled - flag

    • isUserNameEnabled

      public boolean isUserNameEnabled()
      Gets current state of the user name field. Field can be either disabled (false) for editing or enabled (true).
      Returns:
      True when user name field is enabled and editable, false otherwise.

    • getUserName

      public String getUserName()
      Gets the User name for this panel.
      Returns:
      the user name

    • setPassword

      public void setPassword(char[] password)
      Sets the Password for this panel.
      Parameters:
      password - Password

    • getPassword

      public char[] getPassword()
      Gets the Password for this panel.
      Returns:
      password Password

    • getBanner

      public Image getBanner()
      Return the image used as the banner
      Returns:
      Image banner

    • setBanner

      public void setBanner(Image img)
      Set the image to use for the banner. If the img is null, then no image will be displayed.
      Parameters:
      img - the image to display

    • setBannerText

      public void setBannerText(String text)
      Set the text to use when creating the banner. If a custom banner image is specified, then this is ignored. If text is null, then no text is displayed.
      Parameters:
      text - the text to display

    • getBannerText

      public String getBannerText()
      Returns text shown in the banner
      Returns:
      banner text

    • getMessage

      public String getMessage()
      Returns the custom message for this login panel
      Returns:
      message text

    • setMessage

      public void setMessage(String message)
      Sets a custom message for this login panel
      Parameters:
      message - text

    • getErrorMessage

      public String getErrorMessage()
      Returns the error message for this login panel
      Returns:
      error message

    • setErrorMessage

      public void setErrorMessage(String errorMessage)
      Sets the error message for this login panel
      Parameters:
      errorMessage - the error message

    • getStatus

      public JXLoginPane.Status getStatus()
      Returns the panel's status
      Returns:
      Status

    • setStatus

      protected void setStatus(JXLoginPane.Status newStatus)
      Change the status
      Parameters:
      newStatus - Status

    • setLocale

      public void setLocale(Locale l)
      Overrides:
      setLocale in class Component

    • startLogin

      protected void startLogin()
      Initiates the login procedure. This method is called internally by the LoginAction. This method handles cursor management, and actually calling the LoginService's startAuthentication method. Method will return immediately if asynchronous login is enabled or will block until authentication finishes if getSynchronous() returns true.

    • cancelLogin

      protected void cancelLogin()
      Cancels the login procedure. Handles cursor management and interfacing with the LoginService's cancelAuthentication method. Calling this method has an effect only when authentication is still in progress (i.e. after previous call to startAuthentications() and only when authentication is performed asynchronously (getSynchronous() returns false).

    • savePassword

      protected void savePassword()
      Puts the password into the password store. If password store is not set, method will do nothing.

    • showLoginDialog

      public static JXLoginPane.Status showLoginDialog(Component parent, LoginService svc)
      Shows a login dialog. This method blocks.
      Parameters:
      parent - Component
      svc - LoginService
      Returns:
      The status of the login operation

    • showLoginDialog

      public static JXLoginPane.Status showLoginDialog(Component parent, LoginService svc, PasswordStore ps, UserNameStore us)
      Shows a login dialog. This method blocks.
      Parameters:
      parent - Component
      svc - LoginService
      ps - PasswordStore
      us - UserNameStore
      Returns:
      The status of the login operation

    • showLoginDialog

      public static JXLoginPane.Status showLoginDialog(Component parent, LoginService svc, PasswordStore ps, UserNameStore us, List<String> servers)
      Shows a login dialog. This method blocks.
      Parameters:
      parent - Component
      svc - LoginService
      ps - PasswordStore
      us - UserNameStore
      servers - list of servers
      Returns:
      The status of the login operation

    • showLoginDialog

      public static JXLoginPane.Status showLoginDialog(Component parent, JXLoginPane panel)
      Shows a login dialog. This method blocks.
      Parameters:
      parent - Component
      panel - JXLoginPane to show
      Returns:
      The status of the login operation

    • showLoginFrame

      public static JXLoginPane.JXLoginFrame showLoginFrame(LoginService svc)
      Shows a login frame. A JFrame is not modal, and thus does not block
      Parameters:
      svc - LoginService
      Returns:
      JXLoginFrame to show

    • showLoginFrame

      public static JXLoginPane.JXLoginFrame showLoginFrame(LoginService svc, PasswordStore ps, UserNameStore us)
      Shows a login frame.
      Parameters:
      svc - LoginService
      ps - PasswordStore
      us - UserNameStore
      Returns:
      JXLoginFrame to show

    • showLoginFrame

      public static JXLoginPane.JXLoginFrame showLoginFrame(LoginService svc, PasswordStore ps, UserNameStore us, List<String> servers)
      Shows a login frame.
      Parameters:
      svc - LoginService
      ps - PasswordStore
      us - UserNameStore
      servers - list of servers
      Returns:
      JXLoginFrame to show

    • showLoginFrame

      public static JXLoginPane.JXLoginFrame showLoginFrame(JXLoginPane panel)
      Shows a login frame.
      Parameters:
      panel - JXLoginPane panel to show
      Returns:
      JXLoginFrame to show