2.17.2: 2011-06-17

net.sf.basedb.core.authentication
Class AuthenticationInformation

java.lang.Object
  extended by net.sf.basedb.core.authentication.AuthenticationInformation

public class AuthenticationInformation
extends Object

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.

Version:
2.0
Author:
Nicklas
Last modified
$Date: 2009-04-06 14:52:39 +0200 (Mon, 06 Apr 2009) $

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

id

public final String id
A unique id for the user in the authentication system.


login

public final String login
The login for the user. May be the same or different from the id.


name

public final String name
The full name of the user.


organisation

public final String organisation
The organisation of the user.


address

public final String address
The postal address to the user.


phone

public final String phone
The phone number to the user.


fax

public final String fax
The fax number to the user.


email

public final String email
The email address to the user.


url

public final String url
An URL to the user homepage (or similar).


description

public final String description
A description of the user.

Constructor Detail

AuthenticationInformation

public AuthenticationInformation(String login,
                                 String id)
Creates a new AuthenticationInformation object without extra information.

Parameters:
login - The login name
id - The unique id of the user

AuthenticationInformation

public 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.

Parameters:
login - The login name
id - The unique id of the user
name - The name of the user
organisation - The organisation of the user
address - The address of the user
phone - The phone of the user
fax - The fax of the user
email - The email of the user
url - The url of the user
description - The description of the user
Throws:
NullPointerException - If the login or id is null

2.17.2: 2011-06-17