directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From build...@apache.org
Subject svn commit: r872079 - in /websites/staging/directory/trunk/content: ./ api/user-guide/6-ldap-data-structures.html api/user-guide/6.1-administrative-point.html api/user-guide/6.4-attribute-type.html
Date Wed, 31 Jul 2013 09:58:28 GMT
Author: buildbot
Date: Wed Jul 31 09:58:28 2013
New Revision: 872079

Log:
Staging update by buildbot for directory

Added:
    websites/staging/directory/trunk/content/api/user-guide/6.4-attribute-type.html
Modified:
    websites/staging/directory/trunk/content/   (props changed)
    websites/staging/directory/trunk/content/api/user-guide/6-ldap-data-structures.html
    websites/staging/directory/trunk/content/api/user-guide/6.1-administrative-point.html

Propchange: websites/staging/directory/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Wed Jul 31 09:58:28 2013
@@ -1 +1 @@
-1508775
+1508792

Modified: websites/staging/directory/trunk/content/api/user-guide/6-ldap-data-structures.html
==============================================================================
--- websites/staging/directory/trunk/content/api/user-guide/6-ldap-data-structures.html (original)
+++ websites/staging/directory/trunk/content/api/user-guide/6-ldap-data-structures.html Wed
Jul 31 09:58:28 2013
@@ -140,8 +140,8 @@
 <h1 id="6-ldap-data-structures">6 - LDAP Data Structures (...)</h1>
 <h2 id="contents">Contents</h2>
 <ul>
-<li><a href="6.1-administrative-point.html">6.1 - AdministrativePoint (...)</a></li>
-<li><a href="6.2-administrative-role.html">6.2 - AdministrativeRole (e)</a></li>
+<li><a href="6.1-administrative-point.html">6.1 - AdministrativePoint</a></li>
+<li><a href="6.2-administrative-role.html">6.2 - AdministrativeRole</a></li>
 <li><a href="6.3-attribute.html">6.3 - Attribute</a></li>
 <li><a href="6.4-attribute-type.html">6.4 - AttributeType (...)</a></li>
 <li><a href="6.5-ava.html">6.5 - Ava</a></li>

Modified: websites/staging/directory/trunk/content/api/user-guide/6.1-administrative-point.html
==============================================================================
--- websites/staging/directory/trunk/content/api/user-guide/6.1-administrative-point.html
(original)
+++ websites/staging/directory/trunk/content/api/user-guide/6.1-administrative-point.html
Wed Jul 31 09:58:28 2013
@@ -142,7 +142,7 @@
 Those classes are currently only used by the server. It will be available on the client side
later on.
 </DIV>
 
-<p>And <em>AdministrativePoint</em> is an <em>entry</em> in
the <em>DIT</em> which is associated with some <em>AdministrativeArea</em>.
In <strong>ApacheDS</strong> we support 4 different kind of roles :
+<p>An <em>AdministrativePoint</em> is an <em>entry</em> in
the <em>DIT</em> which is associated with some <em>AdministrativeArea</em>.
In <strong>ApacheDS</strong> we support 4 different kind of roles :
     * ACI
     * Collective Attributes
     * SubSchema

Added: websites/staging/directory/trunk/content/api/user-guide/6.4-attribute-type.html
==============================================================================
--- websites/staging/directory/trunk/content/api/user-guide/6.4-attribute-type.html (added)
+++ websites/staging/directory/trunk/content/api/user-guide/6.4-attribute-type.html Wed Jul
31 09:58:28 2013
@@ -0,0 +1,271 @@
+<!DOCTYPE html>
+<!--
+    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.
+-->
+<html>
+	<head>
+		<title>6.4 - AttributeType &mdash; Apache Directory</title>
+		
+	    <link href="./../../css/common.css" rel="stylesheet" type="text/css">
+	    <link href="./../../css/brown.css" rel="stylesheet" type="text/css">
+    
+        
+        <link rel="shortcut icon" href="./../../images/api-icon_16x16.png">
+    
+        <!-- Google Analytics -->
+        <script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
+        <script type="text/javascript">
+            _uacct = "UA-1358462-1";
+            urchinTracker();
+        </script>
+	</head>
+	<body>
+	    <div id="container">
+            <div id="header">
+                <div id="subProjectsNavBar">
+                    <a href="./../../">
+                        
+                        Apache Directory Project
+                        
+                    </a>
+                    &nbsp;|&nbsp;
+                    <a href="./../../apacheds">
+                        
+                        ApacheDS
+                        
+                    </a>
+                    &nbsp;|&nbsp;
+                    <a href="./../../studio">
+                        
+                        Apache Directory Studio
+                        
+                    </a>
+                    &nbsp;|&nbsp;
+                    <a href="./../../api">
+                        
+                        <STRONG>Apache LDAP API</STRONG>
+                        
+                    </a>
+                </div><!-- subProjectsNavBar -->
+            </div><!-- header -->
+            <div id="content">
+                <div id="leftColumn">
+                    
+<div id="navigation">
+    
+    <h5>Downloads</h5>
+    <ul>
+	    <li><a href="./../../api/downloads.html">Version 1.0.0-M19</a>&nbsp;&nbsp;<IMG
src="./../../images/new_badge.gif" alt="" style="margin-bottom:-3px;" border="0"></li>
+        <li><a href="./../../api/download-old-versions.html">Older versions</a></li>
+    </ul>
+    <h5>Getting Started</h5>
+    <ul>
+        <li><a href="./../../api/vision.html">Vision</a></li>
+        <li><a href="./../../api/java-api.html">Java API</a></li>
+        <li><a href="./../../api/groovy-ldap.html">Groovy API</a></li>
+    </ul>
+    <h5>Documentation</h5>
+    <ul>
+	    <li><a href="./../../api/five-minutes-tutorial.html">Five minutes tutorial</a></li>
+	    <li><a href="./../../api/user-guide.html">User Guide</a></li>
+        <li><a href="./../../api/gen-docs/latest/apidocs/">JavaDocs</a></li>
+        <!--li><a href="./../../api/gen-docs/latest/">Generated Reports</a></li-->
+        <li><a href="./../../api/developer-guide.html">Developer Guide</a></li>
+    </ul>
+    
+    
+    <h5>Support</h5>
+    <ul>
+        <li><a href="./../../mailing-lists-and-irc.html">Mailing Lists &amp;
IRC</a></li>
+        <li><a href="./../../sources.html">Sources</a></li>
+        <li><a href="./../../issue-tracking.html">Issue Tracking</a></li>
+        <li><a href="./../../commercial-support.html">Commercial Support</a></li>
+    </ul>
+    <h5>Community</h5>
+    <ul>
+        <li><a href="./../../contribute.html">How to Contribute</a></li>
+        <li><a href="./../../team.html">Team</a></li>
+        <li><a href="./../../original-project-proposal.html">Original Project
Proposal</a></li>
+        <li><a href="./../../special-thanks.html" class="external-link" rel="nofollow">Special
Thanks</a></li>
+    </ul>
+    <h5>About Apache</h5>
+    <ul>
+        <li><a href="http://www.apache.org/">Apache</a></li>
+        <li><a href="http://www.apache.org/licenses/">License</a></li>
+        <li><a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li>
+        <li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
+        <li><a href="http://www.apache.org/security/">Security</a></li>
+    </ul>
+    <a href="http://ldapcon.org" target="_blank" rel="nofollow"><img src="./../../images/banner-ldapcon-2013.png"
alt="LDAPCon 2013" width="167" height="231"></a>
+    
+</div><!-- navigation -->
+
+                </div><!-- leftColumn -->
+                <div id="rightColumn">
+
+
+    <div class="nav">
+        <div class="nav_prev">
+        
+            <a href="6.3-attribute.html">6.3 - Attribute</a>
+		
+        </div>
+        <div class="nav_up">
+        
+            <a href="6-ldap-data-structures.html">6 - LDAP data structures</a>
+		
+        </div>
+        <div class="nav_next">
+        
+            <a href="6.5-ava.html">6.5 - Ava</a>
+		
+        </div>
+        <div class="clearfix"></div>
+    </div>
+
+
+<h1 id="64-attributetype">6.4 - AttributeType</h1>
+<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>
+
+<p>The <em>AttributeType</em> is one of the most important schema element.
It describes what can be stored into an <em>Entry</em>, its syntax, and the various
rules that are to be followed when searching for an associated value.</p>
+<p><em>AttributeType</em> are immutable objects, created from the schema,
and never changed. One can add a new <em>AttributeType</em>, or delete itfrom
the schema, but once it's added to the schema, it can't be modified.</p>
+<p>Usually, we just use them. </p>
+<h2 id="description">Description</h2>
+<p>An <em>AttributeType</em> contains the following informations :</p>
+<table>
+<thead>
+<tr>
+<th>Value</th>
+<th>Description</th>
+<th>optional</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>OID</td>
+<td>An unique <em>Oid</em> for the <em>AttributeType</em></td>
+<td>no</td>
+</tr>
+<tr>
+<td>NAME</td>
+<td>some names, the fist one being considered as the <em>short name</em>.</td>
+<td>yes</td>
+</tr>
+<tr>
+<td>DESCR</td>
+<td>A textual description describing the <em>AttributeType</em> role.</td>
+<td>yes</td>
+</tr>
+<tr>
+<td>OBSOLETE</td>
+<td>A flag indicating if the <em>AttributeType</em> is deprecated</td>
+<td>yes</td>
+</tr>
+<tr>
+<td>SUP</td>
+<td>The <em>AttributeType</em> it inherit from</td>
+<td>yes (If SYNTAX is null, can't be null)</td>
+</tr>
+<tr>
+<td>EQUALITY</td>
+<td>The EQUALITY <em>MatchingRule</em></td>
+<td>yes (if null, and if SUP is not null, takes its SUP's value)</td>
+</tr>
+<tr>
+<td>ORDERING</td>
+<td>The ORDERING <em>MatchingRule</em></td>
+<td>yes (if null, and if SUP is not null, takes its SUP's value)</td>
+</tr>
+<tr>
+<td>SUBSTR</td>
+<td>The SUBSTR <em>MatchingRule</em></td>
+<td>yes (if null, and if SUP is not null, takes its SUP's value)</td>
+</tr>
+<tr>
+<td>SYNTAX</td>
+<td>The Syntax to follow</td>
+<td>yes (If SUP is null, can't be null)</td>
+</tr>
+<tr>
+<td>SINGLE-VALUE</td>
+<td>Tells that the <em>AttributeType</em> does not allow more than one
value</td>
+<td>yes</td>
+</tr>
+<tr>
+<td>COLLECTIVE</td>
+<td>Define a collective attribute. The <em>AttributeType</em> USAGE must
be <em>userApplications</em></td>
+<td>yes</td>
+</tr>
+<tr>
+<td>NO-USER-MODIFICATION</td>
+<td>Tells that the values can't be modified by the user. The <em>AttributeType</em>
USAGE must be operational</td>
+<td>yes</td>
+</tr>
+<tr>
+<td>USAGE</td>
+<td>The kind of <em>AttributeType</em> : one of {<em>userApplications</em>,
<em>directoryOperation</em>, <em>directoryOperation</em>, <em>directoryOperation</em>}</td>
+<td>yes</td>
+</tr>
+<tr>
+<td>extensions</td>
+<td>Server specific parameters</td>
+<td>yes</td>
+</tr>
+</tbody>
+</table>
+<p>An <em>AttributeType</em> 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
<em>userApplications</em> USAGE.</p>
+<p>You can check some of those elements using the following methods :</p>
+<div class="codehilite"><pre><span class="o">*</span> <span class="n">isAncestorOf</span><span
class="p">(</span> <span class="n">AttrbuteType</span> <span class="p">)</span>
<span class="p">:</span> <span class="n">tells</span> <span class="k">if</span>
<span class="n">the</span> <span class="n">current</span> <span
class="n">_AttributeType_</span> <span class="n">is</span> <span class="n">the</span>
<span class="n">ancestor</span> <span class="n">of</span> <span
class="n">another</span> <span class="n">one</span>
+<span class="o">*</span> <span class="n">isCollective</span><span
class="p">()</span> <span class="p">:</span> <span class="n">tells</span>
<span class="k">if</span> <span class="n">the</span> <span class="n">current</span>
<span class="n">_AttributeType_</span> <span class="n">is</span> <span
class="n">a</span> <span class="n">collective</span> <span class="n">attribute</span>
+<span class="o">*</span> <span class="n">isDescendantOf</span><span
class="p">(</span> <span class="n">AttributeType</span> <span class="p">)</span>
<span class="p">:</span> <span class="n">tells</span> <span class="k">if</span>
<span class="n">the</span> <span class="n">current</span> <span
class="n">_AttributeType_</span> <span class="n">inherits</span> <span
class="n">from</span> <span class="n">another</span> <span class="n">one</span>
+<span class="o">*</span> <span class="n">isOperational</span><span
class="p">()</span> <span class="p">:</span> <span class="n">tells</span>
<span class="k">if</span> <span class="n">the</span> <span class="n">current</span>
<span class="n">_AttributeType_</span> <span class="n">is</span> <span
class="n">an</span> <span class="n">Operational</span> <span class="n">Attribute</span>
+<span class="o">*</span> <span class="n">isSingleValued</span><span
class="p">()</span> <span class="p">:</span> <span class="n">tells</span>
<span class="k">if</span> <span class="n">the</span> <span class="n">current</span>
<span class="n">_AttributeType_</span> <span class="n">does</span>
<span class="n">not</span> <span class="n">allow</span> <span class="n">more</span>
<span class="n">than</span> <span class="n">one</span> <span class="n">value</span>
+<span class="o">*</span> <span class="n">isUser</span><span class="p">()</span>
<span class="p">:</span> <span class="n">tells</span> <span class="k">if</span>
<span class="n">the</span> <span class="n">current</span> <span
class="n">_AttributeType_</span> <span class="n">is</span> <span class="n">a</span>
<span class="n">User</span> <span class="n">Application</span> <span
class="n">_AttributeType_</span>
+<span class="o">*</span> <span class="n">isUserModifiable</span><span
class="p">()</span> <span class="p">:</span> <span class="n">tells</span>
<span class="k">if</span> <span class="n">the</span> <span class="n">_Attributes_</span>
<span class="n">usng</span> <span class="n">this</span> <span class="n">_AttributeType_</span>
<span class="n">can</span> <span class="n">be</span> <span class="n">modified</span>
<span class="n">on</span> <span class="n">the</span> <span class="n">server</span>
+</pre></div>
+
+
+    <div class="nav">
+        <div class="nav_prev">
+        
+            <a href="6.3-attribute.html">6.3 - Attribute</a>
+		
+        </div>
+        <div class="nav_up">
+        
+            <a href="6-ldap-data-structures.html">6 - LDAP data structures</a>
+		
+        </div>
+        <div class="nav_next">
+        
+            <a href="6.5-ava.html">6.5 - Ava</a>
+		
+        </div>
+        <div class="clearfix"></div>
+    </div>
+
+
+                </div><!-- rightColumn -->
+                <div id="endContent"></div>
+            </div><!-- content -->
+            <div id="footer">&copy; 2003-2012, <a href="http://www.apache.org">The
Apache Software Foundation</a> - <a href="./../../privacy-policy.html">Privacy
Policy</a><br />
+                Apache Directory, ApacheDS, Apache Directory Server, Apache Directory Studio,
Apache LDAP API, Apache Triplesec, Triplesec, Apache, the Apache feather logo, and the Apache
Directory project logos are trademarks of The Apache Software Foundation.
+            </div>
+        </div><!-- container -->
+    </body>
+</html>
\ No newline at end of file



Mime
View raw message