|
2.17.2: 2011-06-17 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.basedb.core.authentication.AuthenticationInformation
public class AuthenticationInformation
Objects of this class are returned by the
Authenticator.authenticate(String,String)
method and contains information about the authenticated
user. The only required fields are id
and login
.
The id
may or may not be the same as the login
,
but must be a unique string identifying the user.
If the implementation supports extra information, ie. the call to
Authenticator.supportsExtraInformation()
returns TRUE, the other fields may also contain information.
Field Summary | |
---|---|
String |
address
The postal address to the user. |
String |
description
A description of the user. |
String |
email
The email address to the user. |
String |
fax
The fax number to the user. |
String |
id
A unique id for the user in the authentication system. |
String |
login
The login for the user. |
String |
name
The full name of the user. |
String |
organisation
The organisation of the user. |
String |
phone
The phone number to the user. |
String |
url
An URL to the user homepage (or similar). |
Constructor Summary | |
---|---|
AuthenticationInformation(String login,
String id)
Creates a new AuthenticationInformation object without
extra information. |
|
AuthenticationInformation(String login,
String id,
String name,
String organisation,
String address,
String phone,
String fax,
String email,
String url,
String description)
Creates a new AuthenticationInformation object with extra
information. |
Method Summary |
---|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public final String id
public final String login
id
.
public final String name
public final String organisation
public final String address
public final String phone
public final String fax
public final String email
public final String url
public final String description
Constructor Detail |
---|
public AuthenticationInformation(String login, String id)
AuthenticationInformation
object without
extra information.
login
- The login
nameid
- The unique id
of the userpublic AuthenticationInformation(String login, String id, String name, String organisation, String address, String phone, String fax, String email, String url, String description)
AuthenticationInformation
object with extra
information.
login
- The login
nameid
- The unique id
of the username
- The name
of the userorganisation
- The organisation
of the useraddress
- The address
of the userphone
- The phone
of the userfax
- The fax
of the useremail
- The email
of the userurl
- The url
of the userdescription
- The description
of the user
NullPointerException
- If the login or id is null
|
2.17.2: 2011-06-17 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |