Class jabberwerx.cisco.DirectoryGroupsController

Controller class for dealing with Group Presence - LDAP Integration(IJEP-070) functionality.

Class Summary
Constructor Attributes	Constructor Name and Description
	jabberwerx.cisco.DirectoryGroupsController(client) Creates a new DirectoryGroupsController with the given client.

Field Summary
Field Attributes	Field Name and Description
	errors Errors of directory group controller.
	searchID Serial number for each search.

Method Summary
Method Attributes	Method Name and Description
	activateSubscriptions() Active subscribed groups
	destroy() Destroy directory groups controller and unbind client events
	isLDAPContact(jid) Check the contact whether belong to LDAP groups.
	searchGroup(groupName, count) Search directory groups.
	searchUsersByFields(searchFields, count) Search LDAP users by custom field.
	subscribeGroup(groupId) Subscribe an LDAP group
	unsubscribeGroup(groupId) Remove the subscription of an LDAP group.

Methods borrowed from class jabberwerx.Controller:: cleanupEntity, removeEntity, updateEntity
Methods borrowed from class jabberwerx.JWModel:: applyEvent, event, shouldBeSavedWithGraph
Methods borrowed from class jabberwerx.JWBase:: getClassName, graphUnserialized, init, invocation, shouldBeSerializedInline, toString, wasUnserialized, willBeSerialized

Class Detail

jabberwerx.cisco.DirectoryGroupsController(client)

Creates a new DirectoryGroupsController with the given client.

Parameters:
{jabberwerx.Client} client: The client object to use for communicating to the server

Field Detail

errors

Errors of directory group controller.

ActiveGroupServerFailedError : Can't active group subscription.
NoGroupAddressError : Can't get group server address.

searchID

Serial number for each search.

Method Detail

activateSubscriptions()

Active subscribed groups

Throws:
{jabberwerx.DirectoryGroupsController.errors.ActiveGroupServerFailedError}: CANT_ACTIVE_LDAP_SUBSCRIPTION error if an LDAP component does not exist on the connected server

destroy()

Destroy directory groups controller and unbind client events

{Boolean} isLDAPContact(jid)

Check the contact whether belong to LDAP groups.

{Number} searchGroup(groupName, count)

Search directory groups.

{Number} searchUsersByFields(searchFields, count)

Search LDAP users by custom field.

Parameters:
{Object} searchFields: An object contains field name and value. For example: {'userid' : '007', 'displayname' : 'James Bond', 'firstname': 'James', 'lastname': 'Bond', 'ssoid_searchuser': 'ssoid'}
{Number} count: Optional, limit search result number.

subscribeGroup(groupId)

Subscribe an LDAP group

unsubscribeGroup(groupId)

Remove the subscription of an LDAP group.

Classes