Package org.jdesktop.swingx.auth
Class LoginService
java.lang.Object
org.jdesktop.beans.AbstractBean
org.jdesktop.swingx.auth.LoginService
- Direct Known Subclasses:
JAASLoginService
,JDBCLoginService
,JXLoginPane.NullLoginService
,SimpleLoginService
LoginService is the abstract base class for all classes implementing
a login mechanism. It allows you to customize the threading behaviour used to
perform the login. Subclasses need to override the authenticate
method. Subclasses may implement the getUserRoles() method to return a
meaningful value this method will be called once upon a successful login to
determine the user roles. It is not defined as abstract to simplify the task
of implementing a login service for those who do not require this
functionality.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate EventListenerList
private Logger
private SwingWorker
<Boolean, Void> private String
private boolean
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addLoginListener
(LoginListener listener) Adds a LoginListener to the list of listenersabstract boolean
authenticate
(String name, char[] password, String server) This method is intended to be implemented by clients wishing to authenticate a user with a given password.void
Notifies the LoginService that an already running authentication request should be cancelled.(package private) void
fireLoginCanceled
(LoginEvent source) (package private) void
fireLoginFailed
(LoginEvent source) (package private) void
fireLoginStarted
(LoginEvent source) (package private) void
fireLoginSucceeded
(LoginEvent source) boolean
Get the synchronous propertyString[]
Called immediately after a successful authentication.void
removeLoginListener
(LoginListener listener) Removes a LoginListener from the list of listenersvoid
void
setSynchronous
(boolean synchronous) Sets the synchronous propertyvoid
startAuthentication
(String user, char[] password, String server) This method starts the authentication process and is either synchronous or asynchronous based on the synchronous propertyMethods inherited from class org.jdesktop.beans.AbstractBean
addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, addVetoableChangeListener, clone, fireIndexedPropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, fireVetoableChange, getPropertyChangeListeners, getPropertyChangeListeners, getVetoableChangeListeners, getVetoableChangeListeners, hasPropertyChangeListeners, hasVetoableChangeListeners, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, removeVetoableChangeListener
-
Field Details
-
LOG
-
listenerList
-
loginWorker
-
synchronous
private boolean synchronous -
server
-
-
Constructor Details
-
LoginService
public LoginService() -
LoginService
-
-
Method Details
-
authenticate
This method is intended to be implemented by clients wishing to authenticate a user with a given password. Clients should implement the authentication in a manner that the authentication can be cancelled at any time.- Parameters:
name
- usernamepassword
- passwordserver
- server (optional)- Returns:
true
on authentication success- Throws:
Exception
-
getUserRoles
Called immediately after a successful authentication. This method should return an array of user roles or null if role based permissions are not used.- Returns:
- per default
null
-
cancelAuthentication
public void cancelAuthentication()Notifies the LoginService that an already running authentication request should be cancelled. This method is intended to be used by clients who want to provide user with control over cancelling a long running authentication request. -
startAuthentication
This method starts the authentication process and is either synchronous or asynchronous based on the synchronous property- Parameters:
user
- userpassword
- passwordserver
- server- Throws:
Exception
-
getSynchronous
public boolean getSynchronous()Get the synchronous property- Returns:
- the synchronous property
-
setSynchronous
public void setSynchronous(boolean synchronous) Sets the synchronous property- Parameters:
synchronous
- synchronous property
-
addLoginListener
Adds a LoginListener to the list of listeners- Parameters:
listener
- listener
-
removeLoginListener
Removes a LoginListener from the list of listeners- Parameters:
listener
- listener
-
fireLoginStarted
-
fireLoginSucceeded
-
fireLoginFailed
-
fireLoginCanceled
-
getServer
- Returns:
- Returns the server.
-
setServer
- Parameters:
server
- The server to set.
-