org.eaglei.repository.auth
Interface AuthUserFactory

All Known Implementing Classes:

AuthUserTomcatFactory

public interface AuthUserFactory

Outline of factory for pluggable authentication user database. It is a singleton that manages DB-wide operations

Author:

Larry Stone Started March 2011

See Also:

AuthUserTomcatFactory

Method Summary

void	commitMultiple(javax.servlet.http.HttpServletRequest request, java.util.Collection<? extends AuthUser> authUsers) Commit a group of modified (or created) entries, more efficient for use by import.
AuthUser	create(java.lang.String username) Create a new auth user in the DB with indicated username.
AuthUser	find(java.lang.String username) Get the auth-db description of the indicated user, if present.
java.util.Map<java.lang.String,? extends AuthUser>	findAllAsMap() Get a Map of each username key to AuthUserTomcat object.
org.openrdf.model.URI	getType() get the URI identifying this AuthUser implementation.

Method Detail

getType

org.openrdf.model.URI getType()

get the URI identifying this AuthUser implementation.

Returns:

the identifying URI

create

AuthUser create(java.lang.String username)

Create a new auth user in the DB with indicated username.

Parameters:

username - the username to look up

Returns:

the new AuthUser that was created

find

AuthUser find(java.lang.String username)
              throws javax.servlet.ServletException

Get the auth-db description of the indicated user, if present.

Parameters:

targetUsername - the username to look up

Returns:

a new AuthUserTomcat object or null if not found.

Throws:

javax.servlet.ServletException

findAllAsMap

java.util.Map<java.lang.String,? extends AuthUser> findAllAsMap()
                                                                throws javax.servlet.ServletException

Get a Map of each username key to AuthUserTomcat object.

Returns:

Map from username to AuthUser object, never null but maybe empty

Throws:

javax.servlet.ServletException

commitMultiple

void commitMultiple(javax.servlet.http.HttpServletRequest request,
                    java.util.Collection<? extends AuthUser> authUsers)
                    throws javax.servlet.ServletException

Commit a group of modified (or created) entries, more efficient for use by import.

Parameters:

request - the servlet request

authUsers - the users to commit

Throws:

javax.servlet.ServletException