com.centrasite.jaxr.security
Interface InstanceLevelPermissionSet


public interface InstanceLevelPermissionSet

An InstanceLevelPermissionSet maintains all InstanceLevelPermissionEntries that apply to one RegistryObject.


Method Summary
 void add(InstanceLevelPermissionEntry permissionEntry)
          Add the InstanceLevelPermissionEntry to this set.
 void applyToWebdavResource(java.lang.String relativeUrl)
          Apply this InstanceLevelPermissionSet to the given WebDAV resource.
 InstanceLevelPermissionEntry getInstanceLevelPermissionEntry(CentraSitePrincipal principal)
          Get the InstanceLevelPermissionEntry for the given principal.
 java.util.List<InstanceLevelPermissionSetUpdate> getUpdates()
          Get the updates that have transformed the permission set to its current state.
 boolean isEmpty()
          Check whether this InstanceLevelPermissionSet is empty.
 java.util.Iterator<InstanceLevelPermissionEntry> iterator()
          Return an iterator delivering all InstanceLevelPermissionEntries in this set.
 void remove(InstanceLevelPermissionEntry permissionEntry)
          Remove the InstanceLevelPermissionEntry from this set.
 void update(java.util.List<InstanceLevelPermissionSetUpdate> updates)
          Apply the given list of updates to this permission set.
 

Method Detail

iterator

java.util.Iterator<InstanceLevelPermissionEntry> iterator()
                                                          throws javax.xml.registry.JAXRException
Return an iterator delivering all InstanceLevelPermissionEntries in this set.

Returns:
an iterator delivering all InstanceLevelPermissionEntries in this set.
Throws:
javax.xml.registry.JAXRException

isEmpty

boolean isEmpty()
                throws javax.xml.registry.JAXRException
Check whether this InstanceLevelPermissionSet is empty.

Returns:
true if this InstanceLevelPermissionSet is empty
Throws:
javax.xml.registry.JAXRException

getInstanceLevelPermissionEntry

InstanceLevelPermissionEntry getInstanceLevelPermissionEntry(CentraSitePrincipal principal)
                                                             throws javax.xml.registry.JAXRException
Get the InstanceLevelPermissionEntry for the given principal.

Parameters:
principal - the principal.
Returns:
the InstanceLevelPermissionEntry for the given principal, or null if there is no such principal.
Throws:
javax.xml.registry.JAXRException

add

void add(InstanceLevelPermissionEntry permissionEntry)
         throws javax.xml.registry.JAXRException
Add the InstanceLevelPermissionEntry to this set.

Parameters:
permissionEntry - the InstanceLevelPermissionEntry to be added
Throws:
javax.xml.registry.JAXRException

remove

void remove(InstanceLevelPermissionEntry permissionEntry)
            throws javax.xml.registry.JAXRException
Remove the InstanceLevelPermissionEntry from this set.

Parameters:
permissionEntry - the InstanceLevelPermissionEntry to be removed
Throws:
javax.xml.registry.JAXRException

applyToWebdavResource

void applyToWebdavResource(java.lang.String relativeUrl)
                           throws javax.xml.registry.JAXRException
Apply this InstanceLevelPermissionSet to the given WebDAV resource.

Parameters:
relativeUrl - the relative URL of the WebDAV resource
Throws:
javax.xml.registry.JAXRException

getUpdates

java.util.List<InstanceLevelPermissionSetUpdate> getUpdates()
                                                            throws javax.xml.registry.JAXRException
Get the updates that have transformed the permission set to its current state.

Returns:
the list of updates of this permission set
Throws:
javax.xml.registry.JAXRException

update

void update(java.util.List<InstanceLevelPermissionSetUpdate> updates)
            throws javax.xml.registry.JAXRException
Apply the given list of updates to this permission set.

Parameters:
updates - the list of updates
Throws:
javax.xml.registry.JAXRException