io.realm

Class PermissionManager

java.lang.Object

io.realm.PermissionManager

All Implemented Interfaces:

Closeable, AutoCloseable

public class PermissionManager
extends Object
implements Closeable

Helper class for interacting with Realm Object Server permissions for a SyncUser.

Current functionality supported by this class:

• List users existing permissions.
• List default permissions.
• Modify permissions for a Realm.
• Create a permission offer that can be sent to others.
• Accept permission offers sent by other users.

This class depends on underlying Realms, so all data coming from this class is thread-confined and must be closed after use to avoid leaking resources.

See Also:

How to work with Access Controls

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PermissionManager.AcceptOfferCallback Callback used when accepting a permission offer.
static interface	PermissionManager.ApplyPermissionsCallback Callback used when modifying or creating new permissions.
static interface	PermissionManager.MakeOfferCallback Callback used when making a permission offer for other users.
static interface	PermissionManager.OffersCallback Callback used when loading the list of PermissionOffer's created by the user.
static interface	PermissionManager.PermissionsCallback Callback used when loading a set of permissions.
static interface	PermissionManager.RevokeOfferCallback Callback used when revoking an existing offer.

Method Summary

Modifier and Type	Method and Description
RealmAsyncTask	acceptOffer(String offerToken, PermissionManager.AcceptOfferCallback callback) Accepts a permission offer sent by another user.
RealmAsyncTask	applyPermissions(PermissionRequest request, PermissionManager.ApplyPermissionsCallback callback) Applies a given set of permissions to a Realm.
void	close() Closes the PermissionManager as well as any underlying Realms.
RealmAsyncTask	getCreatedOffers(PermissionManager.OffersCallback callback) Returns the list of offers created by this user.
RealmAsyncTask	getDefaultPermissions(PermissionManager.PermissionsCallback callback) NOTE: Moved out of the public API until we know for sure how this is going to work.
RealmAsyncTask	getPermissions(PermissionManager.PermissionsCallback callback) Retrieves the list of permissions for all Realms available to this user.
boolean	isClosed() Checks if this PermissionManager is closed or not.
RealmAsyncTask	makeOffer(PermissionOffer offer, PermissionManager.MakeOfferCallback callback) Makes a permission offer to users.
RealmAsyncTask	revokeOffer(String offerToken, PermissionManager.RevokeOfferCallback callback) Revokes an existing offer.

Methods inherited from class java.lang.Object

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

Method Detail

getPermissions

public RealmAsyncTask getPermissions(PermissionManager.PermissionsCallback callback)

Retrieves the list of permissions for all Realms available to this user.

Parameters:

callback - callback notified when the permissions are ready. The returned RealmResults is a fully live query result, that will be auto-updated like any other RealmResults.

Returns:

RealmAsyncTask that can be used to cancel the task if needed.

getDefaultPermissions

public RealmAsyncTask getDefaultPermissions(PermissionManager.PermissionsCallback callback)

NOTE: Moved out of the public API until we know for sure how this is going to work. Returns default permissions for all Realms. The default permissions are the ones that will be used if no user specific permissions is in effect.

Parameters:

callback - callback notified when the permissions are ready. The returned RealmResults is a fully live query result, that will be auto-updated like any other RealmResults.

Returns:

RealmAsyncTask that can be used to cancel the task if needed.

applyPermissions

public RealmAsyncTask applyPermissions(PermissionRequest request,
                                       PermissionManager.ApplyPermissionsCallback callback)

Applies a given set of permissions to a Realm.

A PermissionRequest object encapsulates a description of which users are granted what AccessLevels for which Realm(s).

Once the request is successfully handled, a Permission entry is created in each user's PermissionManager and can be found using getPermissions(PermissionsCallback).

Parameters:

request - request object describing which permissions to grant and to what Realm(s).

callback - callback when the request either succeeded or failed.

Returns:

async task representing the request. This can be used to cancel it if needed.

makeOffer

public RealmAsyncTask makeOffer(PermissionOffer offer,
                                PermissionManager.MakeOfferCallback callback)

Makes a permission offer to users. The offer is represented by an offer token and the permission changes described in the PermissionOffer do not take effect until the offer has been accepted by a user calling acceptOffer(String, AcceptOfferCallback).

A permission offer can be used as a flexible way of sharing Realms with other users that might not be known at the time of making the offer as well as enabling sharing across other channels like e-mail. If a specific user should be granted access, using applyPermissions(PermissionRequest, ApplyPermissionsCallback) will be faster and quicker.

An offer can be accepted by multiple users.

Parameters:

callback - callback to be notified with the offer token once it is ready.

Returns:

RealmAsyncTask that can be used to cancel the task if needed.

See Also:

Permissions description for general documentation., Modifying permissions for a more high level description.

acceptOffer

public RealmAsyncTask acceptOffer(String offerToken,
                                  PermissionManager.AcceptOfferCallback callback)

Accepts a permission offer sent by another user. Once this offer is accepted successfully, the permissions described by the token will be granted.

Parameters:

offerToken - token representing the permission offer.

callback - with the permission details that were accepted.

Returns:

RealmAsyncTask that can be used to cancel the task if needed.

revokeOffer

public RealmAsyncTask revokeOffer(String offerToken,
                                  PermissionManager.RevokeOfferCallback callback)

Revokes an existing offer. This will prevent any other users from accepting it. Users that already accepted it, will not be affected. Revocation cannot happen until the device has talked to the server. The callback will not be notified until this has happened.

Parameters:

offerToken - token that should be revoked.

Returns:

RealmAsyncTask that can be used to cancel the task if needed.

getCreatedOffers

public RealmAsyncTask getCreatedOffers(PermissionManager.OffersCallback callback)

Returns the list of offers created by this user. These offers can be revoked again by calling revokeOffer(String, RevokeOfferCallback) or sent to other users by sending the PermissionOffer.getToken().

Returns:

RealmAsyncTask that can be used to cancel the task if needed.

close

public void close()

Closes the PermissionManager as well as any underlying Realms. Any active tasks in progress will be canceled.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

isClosed

public boolean isClosed()

Checks if this PermissionManager is closed or not. If it is closed, all methods will report back an error.

Returns:

true if the PermissionManager is closed, false if it is still open.