com.ibm.mashups.enabler.model
Interface UserModel

All Superinterfaces:

Commitable, ListModel, Locator, Model

public UserModel
extends Commitable, ListModel, Locator

Interface for a user model used to search for user and groups

Method Summary

AnonymousMode	getAnonymousMode() Returns the mode in which the anonymous user is accessing the system.
Deferred	findCurrentUser() Returns the current user.
Deferred	findUsersByAttribute(String attributeName, String attributeValue) Returns a user array that matches the LDAP query attributeName=attributeValue
Deferred	findGroupByID(String id) Returns the group with the given id or null if no such group exists
Deferred	findGroupsByAttribute(String attributeName, String attributeValue) Returns a group array that matches the LDAP query attributeName=attributeValue
Attribute[]	findGroupAttributes() Returns an array of attributes for the searchable Group attributes in the user repository.
Attribute[]	findUserAttributes() Returns an array of attributes for the searchable User attributes in the user repository.
User[]	getVirtualUsers() Returns an array of Virtual Users (like Anonymous)
Group[]	getVirtualGroups() Returns an array of Virtual Groups (like All Authenticated)
String[]	getLookasideAttributeNames() Returns the attribute names for Lookaside properties as string array.

Methods inherited from interface com.ibm.mashups.enabler.Commitable

isDirty, commit

Methods inherited from interface com.ibm.mashups.enabler.ListModel

iterator

Methods inherited from interface com.ibm.mashups.enabler.model.Model

setStrategy, getStrategies, getStrategy, addStrategy, removeStrategy

Methods inherited from interface com.ibm.mashups.enabler.Locator

find

Methods inherited from interface com.ibm.mashups.enabler.Locator

find

Method Detail

getAnonymousMode

AnonymousMode getAnonymousMode()

Returns the mode in which the anonymous user is accessing the system.

Returns:

the mode in which the anonymous user is accessing the system. Never null.

findCurrentUser

Deferred findCurrentUser()

Returns the current user.

Returns:

a deferred object used to start this operation. The return value when executed through the deferred object is the current user or null.

findUsersByAttribute

Deferred findUsersByAttribute(String attributeName,
                              String attributeValue)

Returns a user array that matches the LDAP query attributeName=attributeValue

Parameters:

attributeName - name of the LDAP query

attributeValue - value of the LDAP query

Returns:

a deferred object used to start this operation. The return value when executed through the deferred object is an array of User objects. Never null.

findGroupByID

Deferred findGroupByID(String id)

Returns the group with the given id or null if no such group exists

Parameters:

id - the id

Returns:

a deferred object used to start this operation. The return value when executed through the deferred object is the group with the given id or null.

findGroupsByAttribute

Deferred findGroupsByAttribute(String attributeName,
                               String attributeValue)

Returns a group array that matches the LDAP query attributeName=attributeValue

Parameters:

attributeName - name of the LDAP query

attributeValue - value of the LDAP query

Returns:

a deferred object used to start this operation. The return value when executed through the deferred object is an array of Group objects. Never null.

findGroupAttributes

Attribute[] findGroupAttributes()

Returns an array of attributes for the searchable Group attributes in the user repository.

Returns:

an array of searchable group attributes. Never null.

findUserAttributes

Attribute[] findUserAttributes()

Returns an array of attributes for the searchable User attributes in the user repository.

Returns:

an array of searchable user attributes. Never null.

getVirtualUsers

User[] getVirtualUsers()

Returns an array of Virtual Users (like Anonymous)

Returns:

an array registered virtual users. Never null.

getVirtualGroups

Group[] getVirtualGroups()

Returns an array of Virtual Groups (like All Authenticated)

Returns:

an array registered virtual groups. Never null.

getLookasideAttributeNames

String[] getLookasideAttributeNames()

Returns the attribute names for Lookaside properties as string array. Does not include non-lookaside attribute names

Returns:

all lookaside attributes names as string array; never null.