Group Expansion Client (Aspire 2)

From wiki.searchtechnologies.com
Jump to: navigation, search

For Information on Aspire 3.1 Click Here


Group Expansion Client (Aspire 2)
Factory Name  com.searchtechnologies.aspire:aspire-simple-group-expander
subType  expansionClient
Inputs  A Job containing a group expansion request
Outputs  A Job containing a group expansion result
Feature only available with Aspire Enterprise

The Group Expansion Client component is configured as a pipeline stage and is responsible for receiving a group expansion request and querying a group expansion server (such as a connector or LDAP Cache (Aspire 2)) and taking the returned groups and constructing a group expansion result message.

This component is typically used inside connectors which perform group expansion and is typically sent the group expansion request by the Group Expansion Router (Aspire 2) in the Group Expansion Service (Aspire 2).

However, this generic client can connect to any other Aspire component that implements the GroupExpansionServer interface.

Configuration

The following options are supported in the Group Expansion Client

Element Type Default Description
server String The path to the group expansion server (for example /ConnectorName/Main/Scanner)
domain/request/@strip boolean false If true, any domain on the user given in the group expansion request will be removed before the request is made to the server
domain/request/@add String If given, the given domain will be added to the user given in the group expansion request (overwriting any existing domain) before the request is made to the server
domain/response/@strip boolean false If true, any domain on the groups returned from the group expansion server will be removed before the group expansion request is returned
domain/response/@add String If given, the given domain will be added to the groups returned from the group expansion server will be removed before the group expansion request is returned
staticGroups/group (multiples allowed) String Any groups added here will be added (exactly as specified here) to the group expansion request before it is returned
addPublic boolean false If true, the generic public:all group will be added to the group expansion request before it is returned
aclPrefix String If specified, the given prefix will be added to all groups returned from the group expansion server

Example Configuration

    <component name="LDAPExpansionClient" subType="expansionClient" factoryName="aspire-simple-group-expander">
    <debug>true</debug>
    <server>/LDAPService/Main/LdapCache</server>
    <domain>
      <request add="someQueryDomain"/>
      <response add="someResponseDomain"/>
    </domain>
  </component>