directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From elecha...@apache.org
Subject svn commit: r1508792 - in /directory/site/trunk/content/api/user-guide: 6-ldap-data-structures.mdtext 6.1-administrative-point.mdtext 6.4-attribute-type.mdtext
Date Wed, 31 Jul 2013 09:58:23 GMT
Author: elecharny
Date: Wed Jul 31 09:58:23 2013
New Revision: 1508792

URL: http://svn.apache.org/r1508792
Log:
Added a page, fixing some links

Added:
    directory/site/trunk/content/api/user-guide/6.4-attribute-type.mdtext
Modified:
    directory/site/trunk/content/api/user-guide/6-ldap-data-structures.mdtext
    directory/site/trunk/content/api/user-guide/6.1-administrative-point.mdtext

Modified: directory/site/trunk/content/api/user-guide/6-ldap-data-structures.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/api/user-guide/6-ldap-data-structures.mdtext?rev=1508792&r1=1508791&r2=1508792&view=diff
==============================================================================
--- directory/site/trunk/content/api/user-guide/6-ldap-data-structures.mdtext (original)
+++ directory/site/trunk/content/api/user-guide/6-ldap-data-structures.mdtext Wed Jul 31 09:58:23
2013
@@ -26,8 +26,8 @@ Notice: Licensed to the Apache Software 
 
 ## Contents
 
-*  [6.1 - AdministrativePoint (...)](6.1-administrative-point.html)
-*  [6.2 - AdministrativeRole (e)](6.2-administrative-role.html)
+*  [6.1 - AdministrativePoint](6.1-administrative-point.html)
+*  [6.2 - AdministrativeRole](6.2-administrative-role.html)
 *  [6.3 - Attribute](6.3-attribute.html)
 *  [6.4 - AttributeType (...)](6.4-attribute-type.html)
 *  [6.5 - Ava](6.5-ava.html)

Modified: directory/site/trunk/content/api/user-guide/6.1-administrative-point.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/api/user-guide/6.1-administrative-point.mdtext?rev=1508792&r1=1508791&r2=1508792&view=diff
==============================================================================
--- directory/site/trunk/content/api/user-guide/6.1-administrative-point.mdtext (original)
+++ directory/site/trunk/content/api/user-guide/6.1-administrative-point.mdtext Wed Jul 31
09:58:23 2013
@@ -28,7 +28,7 @@ Notice: Licensed to the Apache Software 
 Those classes are currently only used by the server. It will be available on the client side
later on.
 </DIV>
 
-And _AdministrativePoint_ is an _entry_ in the _DIT_ which is associated with some _AdministrativeArea_.
In **ApacheDS** we support 4 different kind of roles :
+An _AdministrativePoint_ is an _entry_ in the _DIT_ which is associated with some _AdministrativeArea_.
In **ApacheDS** we support 4 different kind of roles :
     * ACI
     * Collective Attributes
     * SubSchema

Added: directory/site/trunk/content/api/user-guide/6.4-attribute-type.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/api/user-guide/6.4-attribute-type.mdtext?rev=1508792&view=auto
==============================================================================
--- directory/site/trunk/content/api/user-guide/6.4-attribute-type.mdtext (added)
+++ directory/site/trunk/content/api/user-guide/6.4-attribute-type.mdtext Wed Jul 31 09:58:23
2013
@@ -0,0 +1,68 @@
+Title: 6.4 - AttributeType
+NavPrev: 6.3-attribute.html
+NavPrevText: 6.3 - Attribute
+NavUp: 6-ldap-data-structures.html
+NavUpText: 6 - LDAP data structures
+NavNext: 6.5-ava.html
+NavNextText: 6.5 - Ava
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+    .
+    http://www.apache.org/licenses/LICENSE-2.0
+    .
+    Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+
+# 6.4 - AttributeType
+
+<DIV class="note" markdown="1">
+Those classes are currently only used by the server. It will be available on the client side
later on.
+</DIV>
+
+The _AttributeType_ is one of the most important schema element. It describes what can be
stored into an _Entry_, its syntax, and the various rules that are to be followed when searching
for an associated value.
+
+_AttributeType_ are immutable objects, created from the schema, and never changed. One can
add a new _AttributeType_, or delete itfrom the schema, but once it's added to the schema,
it can't be modified.
+
+Usually, we just use them. 
+
+## Description
+
+An _AttributeType_ contains the following informations :
+
+| Value | Description | optional |
+|---|---|---|
+| OID | An unique _Oid_ for the _AttributeType_ | no |
+| NAME | some names, the fist one being considered as the _short name_. | yes |
+| DESCR | A textual description describing the _AttributeType_ role. | yes |
+| OBSOLETE | A flag indicating if the _AttributeType_ is deprecated | yes|
+| SUP | The _AttributeType_ it inherit from | yes (If SYNTAX is null, can't be null) |
+| EQUALITY | The EQUALITY _MatchingRule_ | yes (if null, and if SUP is not null, takes its
SUP's value) |
+| ORDERING | The ORDERING _MatchingRule_ | yes (if null, and if SUP is not null, takes its
SUP's value) |
+| SUBSTR | The SUBSTR _MatchingRule_ | yes (if null, and if SUP is not null, takes its SUP's
value) |
+| SYNTAX | The Syntax to follow | yes (If SUP is null, can't be null) |
+| SINGLE-VALUE| Tells that the _AttributeType_ does not allow more than one value | yes |
+| COLLECTIVE | Define a collective attribute. The _AttributeType_ USAGE must be _userApplications_
| yes |
+| NO-USER-MODIFICATION | Tells that the values can't be modified by the user. The _AttributeType_
USAGE must be operational | yes |
+| USAGE | The kind of _AttributeType_ : one of {_userApplications_, _directoryOperation_,
_directoryOperation_, _directoryOperation_}| yes |
+| extensions | Server specific parameters | yes |
+
+An _AttributeType_ has some default elements : it's not OBSOLETE, has no SUP, is not SINGLE-VALUE,
is not COLLECTIVE, can be modified by the user, and has an _userApplications_ USAGE.
+
+You can check some of those elements using the following methods :
+
+    * isAncestorOf( AttrbuteType ) : tells if the current _AttributeType_ is the ancestor
of another one
+    * isCollective() : tells if the current _AttributeType_ is a collective attribute
+    * isDescendantOf( AttributeType ) : tells if the current _AttributeType_ inherits from
another one
+    * isOperational() : tells if the current _AttributeType_ is an Operational Attribute
+    * isSingleValued() : tells if the current _AttributeType_ does not allow more than one
value
+    * isUser() : tells if the current _AttributeType_ is a User Application _AttributeType_
+    * isUserModifiable() : tells if the _Attributes_ usng this _AttributeType_ can be modified
on the server



Mime
View raw message