de.tif.jacob.security
Class IUserFactory

java.lang.Object
  de.tif.jacob.security.IUserFactory

public abstract class IUserFactory
extends java.lang.Object

Abstract user factory class, which has to be implemented (i.e. extended) by an application developer to provide application specific concerns regarding authentifikation and authorization.

Field Summary

static java.lang.String	RCS_ID The internal revision control system id.
static java.lang.String	RCS_REV The internal revision control system id in short form.

Constructor Summary

IUserFactory()

Method Summary

abstract java.util.List	findByFullName(java.lang.String fullNamePart) Searchs all users which will match to the given fullname part.
abstract IUser	findUser(java.lang.String userLoginId) Returns the user object to the given user login id.
IApplicationDefinition	getApplicationDefinition() Returns the application definition bound to this user factory
abstract IUser	getValid(java.lang.String userLoginId, java.lang.String passwd) Returns the corresponding user with the user login id if the password to the user matches.
IDataAccessor	newDataAccessor() Creates a new data accessor for accessing data of the application bound to this user factory

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RCS_ID

public static final transient java.lang.String RCS_ID

The internal revision control system id.

See Also:

Constant Field Values

RCS_REV

public static final transient java.lang.String RCS_REV

The internal revision control system id in short form.

See Also:

Constant Field Values

Constructor Detail

IUserFactory

public IUserFactory()

Method Detail

findUser

public abstract IUser findUser(java.lang.String userLoginId)
                        throws UserNotExistingException,
                               java.security.GeneralSecurityException

Returns the user object to the given user login id.

Parameters:

userLoginId - The user login ID of the user

Returns:

The user which matches to the given user login ID

Throws:

UserNotExistingException - will be thrown if no such user exists

java.security.GeneralSecurityException - on any other security related problem

findByFullName

public abstract java.util.List findByFullName(java.lang.String fullNamePart)
                                       throws java.lang.Exception

Searchs all users which will match to the given fullname part.

Example: If 'Müller' is given, you will retrieve:
Martin Müller
A. Müller
Müller, Gert
. .

Parameters:

fullNamePart - A part of the fullname of a user

Returns:

List of IUser of all matching users.

Throws:

java.lang.Exception - on any problem

getValid

public abstract IUser getValid(java.lang.String userLoginId,
                               java.lang.String passwd)
                        throws AuthenticationException,
                               java.security.GeneralSecurityException

Returns the corresponding user with the user login id if the password to the user matches.

Parameters:

userLoginId - The user login id of the user

passwd - The corresponding password of the user

Returns:

The valid user object to the user login id

Throws:

AuthenticationException - if login id and/or password are not valid

java.security.GeneralSecurityException - any other security concern

See Also:

IUser.getLoginId()

getApplicationDefinition

public final IApplicationDefinition getApplicationDefinition()

Returns the application definition bound to this user factory

Returns:

the application definition bound.

newDataAccessor

public final IDataAccessor newDataAccessor()

Creates a new data accessor for accessing data of the application bound to this user factory

Returns:

the created data accessor