org.dataone.service.types.v1

Class AccessRule

java.lang.Object

org.dataone.service.types.v1.AccessRule

All Implemented Interfaces:

Serializable

public class AccessRule
extends Object
implements Serializable

A rule that is used to allow a :term:`subject` to perform an action (such as read or write) on an object in DataONE. Rules are tuples (subject, permission) specifying which permissions are allowed for the subjects(s). If a subject is granted multiple permissions, the highest level of access applies. The resource on which the access control rules are being applied is determined by the containing :term:`SystemMetadata` document, or in the case of methods such as :func:`CNAuthorization.setAccessPolicy`, by the :term:`pid` in the method parameters.Access control rules are specified by the :term:`Origin Member Node` when the object is first registered in DataONE. If no rules are specified at that time, then the object is deemed to be private and the only user with access to the object (read, write, or otherwise) is the :term:`Rights Holder`. Schema fragment(s) for this class:

 <xs:complexType xmlns:ns="http://ns.dataone.org/service/types/v1" xmlns:xs="http://www.w3.org/2001/XMLSchema" name="AccessRule">
   <xs:sequence>
     <xs:element type="ns:Subject" name="subject" minOccurs="1" maxOccurs="unbounded"/>
     <xs:element type="ns:Permission" name="permission" minOccurs="1" maxOccurs="unbounded"/>
   </xs:sequence>
 </xs:complexType>
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Permission>	permission
protected List<Subject>	subject

Constructor Summary

Constructors

Constructor and Description
AccessRule()

Method Summary

Methods

Modifier and Type	Method and Description
void	addPermission(Permission item) Add a 'permission' element item.
void	addSubject(Subject item) Add a 'subject' element item.
void	clearPermissionList() Remove all 'permission' element items.
void	clearSubjectList() Remove all 'subject' element items.
Permission	getPermission(int index) Get 'permission' element item by position.
List<Permission>	getPermissionList() Get the list of 'permission' element items.
Subject	getSubject(int index) Get 'subject' element item by position.
List<Subject>	getSubjectList() Get the list of 'subject' element items.
List<Permission>	grabPermissionListNullIfEmpty()
List<Subject>	grabSubjectListNullIfEmpty()
void	setPermissionList(List<Permission> list) Set the list of 'permission' element items.
void	setSubjectList(List<Subject> list) Set the list of 'subject' element items.
int	sizePermissionList() Get the number of 'permission' element items.
int	sizeSubjectList() Get the number of 'subject' element items.

Methods inherited from class java.lang.Object

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

Field Detail

subject

protected List<Subject> subject

permission

protected List<Permission> permission

Constructor Detail

AccessRule

public AccessRule()

Method Detail

getSubjectList

public List<Subject> getSubjectList()

Get the list of 'subject' element items.

Returns:

list

grabSubjectListNullIfEmpty

public List<Subject> grabSubjectListNullIfEmpty()

setSubjectList

public void setSubjectList(List<Subject> list)

Set the list of 'subject' element items.

Parameters:

list -

sizeSubjectList

public int sizeSubjectList()

Get the number of 'subject' element items.

Returns:

count

addSubject

public void addSubject(Subject item)

Add a 'subject' element item.

Parameters:

item -

getSubject

public Subject getSubject(int index)

Get 'subject' element item by position.

Parameters:

index -

Returns:

item

clearSubjectList

public void clearSubjectList()

Remove all 'subject' element items.

getPermissionList

public List<Permission> getPermissionList()

Get the list of 'permission' element items.

Returns:

list

grabPermissionListNullIfEmpty

public List<Permission> grabPermissionListNullIfEmpty()

setPermissionList

public void setPermissionList(List<Permission> list)

Set the list of 'permission' element items.

Parameters:

list -

sizePermissionList

public int sizePermissionList()

Get the number of 'permission' element items.

Returns:

count

addPermission

public void addPermission(Permission item)

Add a 'permission' element item.

Parameters:

item -

getPermission

public Permission getPermission(int index)

Get 'permission' element item by position.

Parameters:

index -

Returns:

item

clearPermissionList

public void clearPermissionList()

Remove all 'permission' element items.