Qizx fe-4.4p2 API

com.qizx.api
Interface AccessControl


public interface AccessControl

Abstract access control to the members of a Library. Checks whether a User may read or modify contents or properties of Documents and Collections.

An object implementing this interface can be set when opening a Library session.

Attention: AccessControl is not in charge of authenticating the User. This is the responsibility of the application.

Implementation constraints:


Method Summary
 boolean mayChangeContent(User user, LibraryMember member)
          Checks if a User has the permission to modify the contents of a Library Object.
 boolean mayChangeProperty(User user, LibraryMember member, String propertyName)
          Checks if a User has the permission to modify the value of a property of a Library member.
 boolean mayReadContent(User user, LibraryMember member)
          Checks if a User has the permission to get the contents of a Library member.
 boolean mayReadProperty(User user, LibraryMember member, String propertyName)
          Checks if a User has the permission to get the value of a property of a Library member.
 

Method Detail

mayReadContent

boolean mayReadContent(User user,
                       LibraryMember member)
Checks if a User has the permission to get the contents of a Library member.

Parameters:
user - an implementation of a User, suitable for this AccessControl
member - Library object to check for permission
Returns:
true if the permission is granted.

mayChangeContent

boolean mayChangeContent(User user,
                         LibraryMember member)
Checks if a User has the permission to modify the contents of a Library Object.

Parameters:
user - an implementation of a User, suitable for this AccessControl
member - Library object to check for permission
Returns:
true if the permission is granted.

mayReadProperty

boolean mayReadProperty(User user,
                        LibraryMember member,
                        String propertyName)
Checks if a User has the permission to get the value of a property of a Library member.

Parameters:
user - an implementation of a User, suitable for this AccessControl
member - Library Object to check for permission
propertyName - name of the property to get. Attention: it may be null, meaning 'any property' (for example when controlling for the method getPropertyNames() of LibraryMember).
Returns:
true if the permission is granted.

mayChangeProperty

boolean mayChangeProperty(User user,
                          LibraryMember member,
                          String propertyName)
Checks if a User has the permission to modify the value of a property of a Library member.

Parameters:
user - an implementation of a User, suitable for this AccessControl
member - Library Object to check for permission
propertyName - name of the property to set. Never null
Returns:
true if the permission is granted.

© 2010 Axyana Software