org.mmbase.security.implementation.cloudcontext

Interface UserProvider

All Known Implementing Classes:

BasicUserProvider

public interface UserProvider

The implemention of 'users' is pluggable, and should be returned by CloudContextAuthentication.getUserProvider(). Implementation defines what is a user, and how some of the esential properties of them are acquired.

Version:

$Id$ MMBase-1.9.1

Author:

Michiel Meeuwissen

Method Summary

Modifier and Type	Method and Description
String	encode(String password)
MMObjectNode	getAnonymousUser() Returns the node representing the anonymous node.
String	getDefaultContext(MMObjectNode user)
Rank	getRank(MMObjectNode userNode)
MMObjectNode	getUser(String user) Returns the node associated with a certain username or null
MMObjectNode	getUser(String user, String pw, boolean encoded) Returns the node associated with a certain username/password combination, or null
MMObjectBuilder	getUserBuilder()
MMObjectNode	getUserByRank(String userName, String rank) Returns the node associated with a certain username/rank combination or null
boolean	isOwnNode(User user, MMObjectNode node) Returns whether the given node is an 'own' node.
boolean	isValid(MMObjectNode userNode)

Method Detail

getAnonymousUser

MMObjectNode getAnonymousUser()

Returns the node representing the anonymous node.

To Do:

Can this be null?

getUser

MMObjectNode getUser(String user,
                     String pw,
                     boolean encoded)

Returns the node associated with a certain username/password combination, or null

Parameters:

encoded - Whether or not the user is requested usering the username/encodedpassword login 'type' see Authenticate.login(java.lang.String, java.util.Map<java.lang.String, ?>, java.lang.Object[]).

getUser

MMObjectNode getUser(String user)

Returns the node associated with a certain username or null

getUserByRank

MMObjectNode getUserByRank(String userName,
                           String rank)

Returns the node associated with a certain username/rank combination or null

getDefaultContext

String getDefaultContext(MMObjectNode user)

getRank

Rank getRank(MMObjectNode userNode)

isValid

boolean isValid(MMObjectNode userNode)

getUserBuilder

MMObjectBuilder getUserBuilder()

encode

String encode(String password)

isOwnNode

boolean isOwnNode(User user,
                  MMObjectNode node)

Returns whether the given node is an 'own' node. It should return true if the node is representing the mmbaseusers object which represents the current user. Extensions could e.g. also implement returning true for the associated people node.