uk.ac.ed.epcc.webapp.model.data

Class RemoteAccessRoleProvider<U extends AppUser,T extends DataObject,R extends DataObject>

java.lang.Object

uk.ac.ed.epcc.webapp.model.data.RemoteAccessRoleProvider<U,T,R>

Type Parameters:

U - Type of AppUser

T - Type of hosting table

R - Type of remote table

All Implemented Interfaces:

AccessRoleProvider<U,T>

public class RemoteAccessRoleProvider<U extends AppUser,T extends DataObject,R extends DataObject>
extends java.lang.Object
implements AccessRoleProvider<U,T>

A wrapper round a DataObjectFactory that forwards role relationships from a remote object The AppUser has the role with the target object if the user has the same named role with the remote object the target references.

Constructor Summary

Constructors

Constructor and Description
RemoteAccessRoleProvider(SessionService<U> sess, DataObjectFactory<T> home_fac, java.lang.String link_field)

Method Summary

Modifier and Type	Method and Description
void	addRelationships(java.util.Set<java.lang.String> roles) Add known roles to a set.
BaseFilter<T>	hasRelationFilter(java.lang.String role, U user) Get a BaseFilter corresponding to target objects where the given user has the specified relation.
BaseFilter<U>	personInRelationFilter(SessionService<U> sess, java.lang.String role, T target) Get a BaseFilter for AppUsers that are in the specified relationship with the target object.
boolean	providesRelationship(java.lang.String role) Does this class provide the named relationship.

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteAccessRoleProvider

public RemoteAccessRoleProvider(SessionService<U> sess,
                                DataObjectFactory<T> home_fac,
                                java.lang.String link_field)
                         throws UnknownRelationshipException

Throws:

UnknownRelationshipException

Method Detail

hasRelationFilter

public BaseFilter<T> hasRelationFilter(java.lang.String role,
                                       U user)

Description copied from interface: AccessRoleProvider

Get a BaseFilter corresponding to target objects where the given user has the specified relation. If the method returns null then the role is not recognised by the provider. A non-null result means the role is recognised but does not imply that any target will match. The relation with a specific target object can be tested using DataObjectFactory.matches(BaseFilter, DataObject) This method should not be called directly only via a call to SessionService.getRelationshipRoleFilter(DataObjectFactory, String) to allow the SessionService to combine and customise access rules.

Specified by:

hasRelationFilter in interface AccessRoleProvider<U extends AppUser,T extends DataObject>

Returns:

BaseFilter or null

personInRelationFilter

public BaseFilter<U> personInRelationFilter(SessionService<U> sess,
                                            java.lang.String role,
                                            T target)

Description copied from interface: AccessRoleProvider

Get a BaseFilter for AppUsers that are in the specified relationship with the target object. This is the inverse of #hasRelationFilter(SessionService, String) used to generate a list of AppUser with the relation. It can always be implemented (inefficiently) by creating an AcceptFilter that uses AccessRoleProvider.hasRelationFilter(String, AppUser) to check each person in turn but though it is usually possible to find some SQLFilter to narrow the selection first even if a full SQL implementation is not possible. If the target is null it should generate a filter for any user in relation with targets selected by DataObjectFactory.getDefaultRelationshipFilter(). If this is not possible it should return null;

Specified by:

personInRelationFilter in interface AccessRoleProvider<U extends AppUser,T extends DataObject>

Returns:

BaseFilter or null

providesRelationship

public boolean providesRelationship(java.lang.String role)

Description copied from interface: AccessRoleProvider

Does this class provide the named relationship.

Specified by:

providesRelationship in interface AccessRoleProvider<U extends AppUser,T extends DataObject>

Returns:

true if relationship provided by this class.

addRelationships

public void addRelationships(java.util.Set<java.lang.String> roles)

Description copied from interface: AccessRoleProvider

Add known roles to a set. This can be roles provided or consumed by the class. This is only used as auto-complete suggestions so should be a useful subset rather than an exhaustive list

Specified by:

addRelationships in interface AccessRoleProvider<U extends AppUser,T extends DataObject>