|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.jdesktop.beans.AbstractBean
org.jdesktop.swingx.auth.LoginService
public abstract class LoginService
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.
| Constructor Summary | |
|---|---|
LoginService()
|
|
LoginService(java.lang.String server)
|
|
| Method Summary | |
|---|---|
void |
addLoginListener(LoginListener listener)
Adds a LoginListener to the list of listeners |
abstract boolean |
authenticate(java.lang.String name,
char[] password,
java.lang.String server)
This method is intended to be implemented by clients wishing to authenticate a user with a given password. |
void |
cancelAuthentication()
Notifies the LoginService that an already running authentication request should be cancelled. |
java.lang.String |
getServer()
|
boolean |
getSynchronous()
Get the synchronous property |
java.lang.String[] |
getUserRoles()
Called immediately after a successful authentication. |
void |
removeLoginListener(LoginListener listener)
Removes a LoginListener from the list of listeners |
void |
setServer(java.lang.String server)
|
void |
setSynchronous(boolean synchronous)
Sets the synchronous property |
void |
startAuthentication(java.lang.String user,
char[] password,
java.lang.String server)
This method starts the authentication process and is either synchronous or asynchronous based on the synchronous property |
| Methods inherited from class java.lang.Object |
|---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public LoginService()
public LoginService(java.lang.String server)
| Method Detail |
|---|
public abstract boolean authenticate(java.lang.String name,
char[] password,
java.lang.String server)
throws java.lang.Exception
name - usernamepassword - passwordserver - server (optional)
true on authentication success
java.lang.Exceptionpublic java.lang.String[] getUserRoles()
nullpublic void cancelAuthentication()
public void startAuthentication(java.lang.String user,
char[] password,
java.lang.String server)
throws java.lang.Exception
user - userpassword - passwordserver - server
java.lang.Exceptionpublic boolean getSynchronous()
public void setSynchronous(boolean synchronous)
synchronous - synchronous propertypublic void addLoginListener(LoginListener listener)
listener - listenerpublic void removeLoginListener(LoginListener listener)
listener - listenerpublic java.lang.String getServer()
public void setServer(java.lang.String server)
server - The server to set.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||