Skip navigation links

waggle.common.modules.realm
Interface XRealmModule.Server

All Superinterfaces:

XAPIInterface, XAPIInterface.Server

Enclosing interface:

XRealmModule

public static interface XRealmModule.Server

extends XAPIInterface.Server

Server interface for the Realm Module API.

Nested Class Summary

Nested classes/interfaces inherited from interface waggle.core.api.XAPIInterface

XAPIInterface.Client, XAPIInterface.Server

Method Summary

XRealmInfo	createLDAPRealm(String realmName, XUpdater updater) Create an LDAP Realm.
XRealmInfo	getRealm(XObjectID realmID) Get Realm.
List<XRealmNotificationInfo>	getRealmNotificationSettings(XObjectID realmID) Get all notification settings for the specified Realm.
XRealmPasswordPolicyInfo	getRealmPasswordPolicy() Return the password policy for the current user's Realm.
List<XRealmInfo>	getRealms() Return a list of all Realms.
void	setRealmName(XObjectID realmID, String name) Change a Realm's name.
void	setRealmNotificationSettings(XObjectID realmID, List<XRealmNotificationInfo> notificationInfos) Set all notification settings for the specified Realm.
void	testRealm(XObjectID realmID) Test a Realm.
XRealmInfo	updateRealm(XObjectID realmID, XUpdater updater) Update the Realm.

Method Detail

createLDAPRealm

XRealmInfo createLDAPRealm(String realmName,
                           XUpdater updater)

Create an LDAP Realm.

Parameters:

realmName - The name.

updater - The attributes to set.

Returns:

Info about the Realm.

getRealm

XRealmInfo getRealm(XObjectID realmID)

Get Realm.

Parameters:

realmID - The Realm.

Returns:

The Realm Information DTO.

setRealmName

void setRealmName(XObjectID realmID,
                  String name)

Change a Realm's name.

Parameters:

realmID - The Realm.

name - The new name.

updateRealm

XRealmInfo updateRealm(XObjectID realmID,
                       XUpdater updater)

Update the Realm. Non null values are changed.

Parameters:

realmID - The Realm.

updater - The attributes to change.

Returns:

Info about the Realm.

testRealm

void testRealm(XObjectID realmID)

Test a Realm. Throws exceptions on failure.

Parameters:

realmID - The Realm.

getRealms

List<XRealmInfo> getRealms()

Return a list of all Realms.

Returns:

The list of Realms.

getRealmPasswordPolicy

XRealmPasswordPolicyInfo getRealmPasswordPolicy()

Return the password policy for the current user's Realm.

Returns:

The password policy for the current user's Realm.

getRealmNotificationSettings

List<XRealmNotificationInfo> getRealmNotificationSettings(XObjectID realmID)

Get all notification settings for the specified Realm.

Parameters:

realmID - The Realm.

Returns:

The notification settings for the specified Realm.

setRealmNotificationSettings

void setRealmNotificationSettings(XObjectID realmID,
                                  List<XRealmNotificationInfo> notificationInfos)

Set all notification settings for the specified Realm.

Parameters:

realmID - The Realm.

notificationInfos - The new notification settings for the specified Realm.

Skip navigation links