io.realm.sync.permissions

Class ClassPermissions

java.lang.Object

io.realm.RealmObject

io.realm.sync.permissions.ClassPermissions

All Implemented Interfaces:

RealmModel

public class ClassPermissions
extends RealmObject

Class describing all permissions related to a given Realm model class. These permissions will be inherited by any concrete objects of the given type.

If a class level permission grants a privilege, it is still possible for individual objects to revoke them again, i.e. it is possible for the class level permission to grant general read access, while the individual objects are still able to revoke them.

The opposite is not true, so if a privilege is not granted at the class level, it can never be granted at the object level, no matter what kind of permissions are set there.

See Also:

Object Level Permissions for an detailed description of the Realm Object Server permission system.

Constructor Summary

Constructors

Constructor and Description
ClassPermissions()
ClassPermissions(Class<? extends RealmModel> clazz) Creates permissions for the given Realm model class.

Method Summary

Modifier and Type	Method and Description
Permission	findOrCreate(String roleName) Finds the permissions associated with a given Role.
String	getName() Returns the name of the class these permissions apply to.
RealmList<Permission>	getPermissions() Returns all Class level permissions for the class defined by getName().

Methods inherited from class io.realm.RealmObject

addChangeListener, addChangeListener, addChangeListener, addChangeListener, asChangesetObservable, asChangesetObservable, asFlowable, asFlowable, deleteFromRealm, deleteFromRealm, getRealm, getRealm, isLoaded, isLoaded, isManaged, isManaged, isValid, isValid, load, load, removeAllChangeListeners, removeAllChangeListeners, removeChangeListener, removeChangeListener, removeChangeListener, removeChangeListener

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassPermissions

public ClassPermissions()

ClassPermissions

public ClassPermissions(Class<? extends RealmModel> clazz)

Creates permissions for the given Realm model class. Only one ClassPermissions object can exist pr Realm model class.

Parameters:

clazz - class to create permissions.

Method Detail

getName

public String getName()

Returns the name of the class these permissions apply to. If this object is unmanaged this name returned will be the simple name of the Java class. If the object is managed it will be the internal name Realm uses to represent the class.

Returns:

the name of the class these permissions apply to.

getPermissions

public RealmList<Permission> getPermissions()

Returns all Class level permissions for the class defined by getName(). This is the default set of permissions for the class unless otherwise re-defined by object level permissions.

Returns:

all Class level permissions

findOrCreate

public Permission findOrCreate(String roleName)

Finds the permissions associated with a given Role. If either the role or the permission object doesn't exists, it will be created.

If the Permission object is created because one didn't exist already, it will be created with all privileges disabled.

If the the Role object is created because one didn't exists, it will be created with no members.

Parameters:

roleName - name of the role to find.

Returns:

permission object for the given role.

Throws:

IllegalStateException - if this object is not managed by Realm.

IllegalStateException - if this method is not called inside a write transaction.

IllegalArgumentException - if a null or empty