<?xml version="1.0" encoding="utf-8"?>
|
<!--
|
! CDDL HEADER START
|
!
|
! The contents of this file are subject to the terms of the
|
! Common Development and Distribution License, Version 1.0 only
|
! (the "License"). You may not use this file except in compliance
|
! with the License.
|
!
|
! You can obtain a copy of the license at
|
! trunk/opends/resource/legal-notices/OpenDS.LICENSE
|
! or https://OpenDS.dev.java.net/OpenDS.LICENSE.
|
! See the License for the specific language governing permissions
|
! and limitations under the License.
|
!
|
! When distributing Covered Code, include this CDDL HEADER in each
|
! file and include the License file at
|
! trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable,
|
! add the following below this CDDL HEADER, with the fields enclosed
|
! by brackets "[]" replaced with your own identifying information:
|
! Portions Copyright [yyyy] [name of copyright owner]
|
!
|
! CDDL HEADER END
|
!
|
!
|
! Copyright 2007-2009 Sun Microsystems, Inc.
|
! -->
|
<adm:managed-object name="network-group" plural-name="network-groups"
|
package="org.opends.server.admin.std"
|
xmlns:adm="http://www.opends.org/admin"
|
xmlns:ldap="http://www.opends.org/admin-ldap">
|
<adm:synopsis>
|
The
|
<adm:user-friendly-name />
|
is used to classify incoming connections and route requests to
|
workflows.
|
</adm:synopsis>
|
<adm:tag name="core-server" />
|
<adm:profile name="ldap">
|
<ldap:object-class>
|
<ldap:name>ds-cfg-network-group</ldap:name>
|
<ldap:superior>top</ldap:superior>
|
</ldap:object-class>
|
</adm:profile>
|
|
<adm:relation name="network-group-criteria"
|
managed-object-name="network-group-criteria">
|
<adm:synopsis>
|
Specifies the set of criteria associated to this network group.
|
</adm:synopsis>
|
<adm:description>
|
A client connection can belong to a <adm:user-friendly-name /> only
|
if it matches all the criteria defined for this
|
<adm:user-friendly-name />.
|
</adm:description>
|
<adm:one-to-zero-or-one />
|
<adm:profile name="ldap">
|
<ldap:rdn-sequence>cn=Criteria</ldap:rdn-sequence>
|
</adm:profile>
|
</adm:relation>
|
|
<adm:relation name="network-group-resource-limits"
|
managed-object-name="network-group-resource-limits">
|
<adm:synopsis>
|
Specifies the set of resource limits enforced by this
|
<adm:user-friendly-name />.
|
</adm:synopsis>
|
<adm:description>
|
All client connections belonging to a <adm:user-friendly-name />
|
must comply with the resource limits policy.
|
</adm:description>
|
<adm:one-to-zero-or-one />
|
<adm:profile name="ldap">
|
<ldap:rdn-sequence>cn=ResourceLimits</ldap:rdn-sequence>
|
</adm:profile>
|
</adm:relation>
|
|
<adm:relation name="network-group-request-filtering-policy"
|
managed-object-name="network-group-request-filtering-policy">
|
<adm:synopsis>
|
Specifies the request filtering policy enforced by this
|
<adm:user-friendly-name />.
|
</adm:synopsis>
|
<adm:description>
|
All client connections belonging to a <adm:user-friendly-name />
|
must comply with the request filtering policy.
|
</adm:description>
|
<adm:one-to-zero-or-one />
|
<adm:profile name="ldap">
|
<ldap:rdn-sequence>cn=RequestFilteringPolicy</ldap:rdn-sequence>
|
</adm:profile>
|
</adm:relation>
|
|
<adm:property name="enabled" mandatory="true">
|
<adm:synopsis>
|
Indicates whether the
|
<adm:user-friendly-name />
|
is enabled for use in the server.
|
</adm:synopsis>
|
<adm:description>
|
If a network group is not enabled, its workflows will not be
|
accessible when processing operations.
|
</adm:description>
|
<adm:syntax>
|
<adm:boolean />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-enabled</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="network-group-id" mandatory="true"
|
read-only="true">
|
<adm:synopsis>
|
Specifies the name that is used to identify the associated
|
<adm:user-friendly-name />
|
.
|
</adm:synopsis>
|
<adm:description>
|
The name must be unique among all the
|
<adm:user-friendly-plural-name />
|
in the server.
|
</adm:description>
|
<adm:syntax>
|
<adm:string />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-network-group-id</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="priority" mandatory="true">
|
<adm:synopsis>
|
Specifies the order in which the network groups are evaluated.
|
</adm:synopsis>
|
<adm:description>
|
A client connection is first compared against network group with
|
priority 1. If the client connection does not match the network group
|
criteria, the client connection is compared against network group
|
with priority 2 etc...
|
</adm:description>
|
<adm:syntax>
|
<adm:integer lower-limit="0"/>
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-priority</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="workflow" multi-valued="true">
|
<adm:synopsis>
|
Identifies the workflows in the network group.
|
</adm:synopsis>
|
<adm:default-behavior>
|
<adm:undefined />
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:aggregation relation-name="workflow" parent-path="/">
|
<adm:constraint>
|
<adm:synopsis>
|
The referenced workflows must be enabled.
|
</adm:synopsis>
|
<adm:target-is-enabled-condition>
|
<adm:contains property="enabled" value="true" />
|
</adm:target-is-enabled-condition>
|
</adm:constraint>
|
</adm:aggregation>
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-workflow</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="affinity-policy" mandatory="true" advanced="true">
|
<adm:synopsis>
|
Defines the client connection affinity policy.
|
</adm:synopsis>
|
<adm:description>
|
A client connection affinity allows some requests to be routed
|
to a specific data source regardless the regular routing
|
process. For example, we can requires all the requests to be
|
routed to a data source after a write has been complete on
|
that data source. That way, a read request would return data
|
that are consistent with a previous write request. By default,
|
the client connection affinity is disabled.
|
</adm:description>
|
<adm:default-behavior>
|
<adm:defined>
|
<adm:value>none</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:enumeration>
|
<adm:value name="none">
|
<adm:synopsis>
|
Disables the client connection affinity.
|
</adm:synopsis>
|
</adm:value>
|
<adm:value name="first-read-request-after-write-request">
|
<adm:synopsis>
|
Routes the first read request to the data source to which
|
a previous write request has been routed to. This affinity
|
is useful when a client application performs a read request
|
after a write request and the read request should return
|
consistent data.
|
</adm:synopsis>
|
</adm:value>
|
<adm:value name="all-requests-after-first-write-request">
|
<adm:synopsis>
|
Routes all the requests to the data source to which a
|
previous write request has been routed to.
|
</adm:synopsis>
|
</adm:value>
|
<adm:value name="all-write-requests-after-first-write-request">
|
<adm:synopsis>
|
Routes all the write requests to the data source to which
|
a previous write request has been routed to. This affinity
|
policy is useful for batch update where a parent entry and
|
its subordinates must be sent to the same data source.
|
</adm:synopsis>
|
</adm:value>
|
<adm:value name="all-requests-after-first-request">
|
<adm:synopsis>
|
Routes all the requests to the data source to which a
|
previous request has been routed to. This affinity policy
|
allows to create a kind of tunnel between a client application
|
and a data source.
|
</adm:synopsis>
|
</adm:value>
|
</adm:enumeration>
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-affinity-policy</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="affinity-timeout" mandatory="true" advanced="true">
|
<adm:synopsis>
|
The period of time by which an affinity route remains active.
|
The timeout value is a number of seconds and when the value is
|
set to 0 (default value) then the route remains active forever.
|
</adm:synopsis>
|
<adm:description>
|
When the client connection affinity is enabled, an affinity route
|
might be elected in accordance with the affinity policy. The affinity
|
route is then used until the timeout value expires unless the timeout
|
value is 0 in which case the route remains active forever.
|
</adm:description>
|
<adm:default-behavior>
|
<adm:defined>
|
<adm:value>0</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:duration base-unit="s" lower-limit="0" />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-affinity-timeout</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
</adm:managed-object>
|
