io.realm.sync.permissions

Class Permission.Builder

java.lang.Object

io.realm.sync.permissions.Permission.Builder

Enclosing class:

Permission

public static class Permission.Builder
extends Object

Creates a Permission object in a fluid manner.

Constructor Summary

Constructors

Constructor and Description
Builder(Role role) Creates the builder.

Method Summary

Modifier and Type	Method and Description
Permission.Builder	allPrivileges() Enables all privileges.
Permission	build() Creates the unmanaged Permission object.
Permission.Builder	canCreate(boolean canCreate) Defines if this role is allowed to create objects of this type.
Permission.Builder	canDelete(boolean canDelete) Defines if this role can delete the given resource or not.
Permission.Builder	canModifySchema(boolean canModifySchema) Defines if this role is allowed to modify the schema of this resource.
Permission.Builder	canQuery(boolean canQuery) Defines if this role is allowed to query the resource or not.
Permission.Builder	canRead(boolean canRead) Defines if this role can read from given resource or not.
Permission.Builder	canSetPermissions(boolean canSetPermissions) Defines if this role is allowed to change permissions on the given resource.
Permission.Builder	canUpdate(boolean canUpdate) Defines if this role can update the given resource or not.
Permission.Builder	noPrivileges() Disables all privileges.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(Role role)

Creates the builder. The default state is that no privileges are enabled.

Parameters:

role - Role for which these privileges apply.

Method Detail

allPrivileges

public Permission.Builder allPrivileges()

Enables all privileges.

noPrivileges

public Permission.Builder noPrivileges()

Disables all privileges.

canRead

public Permission.Builder canRead(boolean canRead)

Defines if this role can read from given resource or not.

1. Realm: The role is allowed to read all objects from the Realm. If false, the Realm will appear completely empty to the role, effectively making it inaccessible.
2. Class: The role is allowed to read the objects of this type and all referenced objects, even if those objects themselves have set this to false. If false, the role cannot see any object of this type and all queries against the type will return no results.
3. Object: Determines if a role is allowed to see the individual object or not.

Parameters:

canRead - true if the role is allowed to read this resource, false if not.

canUpdate

public Permission.Builder canUpdate(boolean canUpdate)

Defines if this role can update the given resource or not.

1. Realm: If true, the role is allowed update properties on all objects in the Realm. This does not include updating permissions nor creating or deleting objects.
2. Class: If true, the role is allowed update properties on all objects of this type in the Realm. This does not include updating permissions nor creating or deleting objects.
3. Object: If true, the role is allowed to update properties on the object. This does not cover updating permissions or deleting the object.

Parameters:

canUpdate - true if the role is allowed to update this resource, false if not.

canDelete

public Permission.Builder canDelete(boolean canDelete)

Defines if this role can delete the given resource or not.

1. Realm: Not applicable.
2. Class: Not applicable.
3. Object: If true, the role is allowed to delete the object.

Parameters:

canDelete - true if the role is allowed to delete this resource, false if not.

canSetPermissions

public Permission.Builder canSetPermissions(boolean canSetPermissions)

Defines if this role is allowed to change permissions on the given resource. Permissions can only be granted at the same permission level or below. E.g. if set on a Class, it is not possible to change Realm level permissions, but does allow the role to change object level permissions for objects of that type.

1. Realm: The role is allowed to modify the RealmPermissions object.
2. Class: The role is allowed the change the ClassPermissions object.
3. Object: The role is allowed to change the permissions on this object.

Parameters:

canSetPermissions - true if the role is allowed to change the permissions for this resource.

canQuery

public Permission.Builder canQuery(boolean canQuery)

Defines if this role is allowed to query the resource or not.

Note, that local queries are always possible, but the query result will just be empty.

1. Realm: Not applicable.
2. Class: The role is allowed to query objects of this type.
3. Object: Not applicable.

Parameters:

canQuery - true if the role is allowed to query objects of this type.

canCreate

public Permission.Builder canCreate(boolean canCreate)

Defines if this role is allowed to create objects of this type.

1. Realm: Not applicable.
2. Class: If true, the role is allowed to create objects of this type.
3. Object: Not applicable.

Parameters:

canCreate - true if the role is allowed to create objects of this type.

canModifySchema

public Permission.Builder canModifySchema(boolean canModifySchema)

Defines if this role is allowed to modify the schema of this resource.

1. Realm: If true the role is allowed to create classes in the Realm.
2. Class: If true, the role is allowed to add properties to the specified class.
3. Object: Not applicable.

Parameters:

canModifySchema - true if the role is allowed to modify the schema of this resource.

build

public Permission build()

Creates the unmanaged Permission object.