ibm-information-center/dist/eclipse/plugins/i5OS.ic.rzahy_5.4.0.1/rzahysyntax.htm

174 lines
8.0 KiB
HTML

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US" xml:lang="en-us">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="dc.language" scheme="rfc1766" content="en-us" />
<!-- All rights reserved. Licensed Materials Property of IBM -->
<!-- US Government Users Restricted Rights -->
<!-- Use, duplication or disclosure restricted by -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<meta name="dc.date" scheme="iso8601" content="2005-09-06" />
<meta name="copyright" content="(C) Copyright IBM Corporation 1998, 2006" />
<meta name="security" content="public" />
<meta name="Robots" content="index,follow"/>
<meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))' />
<title>Directory Server (LDAP) - Attribute syntax</title>
<link rel="stylesheet" type="text/css" href="ibmidwb.css" />
<link rel="stylesheet" type="text/css" href="ic.css" />
</head>
<body>
<a id="Top_Of_Page" name="Top_Of_Page"></a><!-- Java sync-link -->
<script language = "Javascript" src = "../rzahg/synch.js" type="text/javascript"></script>
<a name="rzahysyntax"></a>
<h4 id="rzahysyntax">Attribute syntax</h4>
<p>An attribute syntax defines the allowable values for an attribute. The
server uses the syntax definition for an attribute to validate data and determine
how to match values. For example, a "Boolean" attribute can only have the
values "TRUE" and "FALSE".</p>
<p>Attributes can be defined as either single-valued or multi-valued. Multi-valued
attributes are not ordered, so an application should not depend on the set
of values for a given attribute being returned in particular order. If you
need an ordered set of values, consider putting the list of values in a single
attribute value:</p>
<pre class="xmp">preferences: 1st-pref 2nd-pref 3rd-pref </pre>
<p>Or consider including order information in the value:</p>
<pre class="xmp">preferences: 2 yyy
preferences: 1 xxx
preferences: 3 zzz</pre>
<p>Multi-valued attributes are useful when an entry is known by several names.
For example, cn (common name) is multi-valued. An entry could be defined like:</p>
<pre class="xmp">dn: cn=John Smith,o=My Company,c=US
objectclass: inetorgperson
sn: Smith
cn: John Smith
cn: Jack Smith
cn: Johnny Smith</pre>
<p>This allows searches for <tt class="xph">John Smith</tt> and <tt class="xph">Jack Smith</tt> to
return the same information.</p>
<p>Binary attributes contain an arbitrary byte string, for example a JPEG
photo, and cannot be used to search for entries.</p>
<p>Boolean attributes contain the strings <tt class="xph">TRUE</tt> or <tt class="xph">FALSE</tt>.</p>
<p>DN attributes contain LDAP distinguished names. The values do not need
to be the DNs of existing entries, but they must have a valid DN syntax.</p>
<p>Directory String attributes contain a text string using UTF-8 characters.
The attribute can be case exact or case ignore with respect to values used
in search filters (based on the matching rule defined for the attribute),
though the value is always returned as originally entered.</p>
<p>Generalized Time attributes contain a string representation of a year 2000
safe date and time using GMT times with an optional GMT time zone offset.
See <a href="rzahyutctime.htm#rzahyutctime">Generalized and UTC time</a> for more details on the syntax of these values.</p>
<p>IA5 String attributes contain a text string using the IA5 character set
(7-bit US ASCII. The attribute can be case exact or case ignore with respect
to values used in search filters (based on the matching rule defined for the
attribute), though the value is always returned as originally entered. IA5
String also allows the use of a wild card character for substring searches.</p>
<p>Integer attributes contain the text string representation of the value.
For example, <tt class="xph">0</tt> or <tt class="xph">1000</tt>. Values for Integer syntax attributes
must be in the range -2147483648 to 2147483647.</p>
<p>Telephone Number attributes contain a text representation of a telephone
number. The Directory Server does not impose any particular syntax on these
values. The following are all valid values: <tt class="xph">(555)555-5555</tt>, <tt class="xph">555.555.5555</tt>, and <tt class="xph">+1 43 555 555 5555</tt>.</p>
<p>UTC Time attributes use an earlier, non-year 2000 safe, string format for
representing dates and times. See <a href="rzahyutctime.htm#rzahyutctime">Generalized and UTC time</a> for more details.</p>
<p>In the directory schema, the syntax of an attribute is specified using
Object Identifiers (OIDs) assigned to each syntax. The following table lists
the syntaxes supported by the directory server and their OIDs.</p>
<p></p>
<a name="wq28"></a>
<table id="wq28" width="100%" summary="" border="1" frame="border" rules="all" class="singleborder">
<thead valign="bottom">
<tr class="tablemainheaderbar">
<th id="wq29" width="59%" align="center" valign="top">Syntax</th>
<th id="wq30" width="40%" align="center" valign="top">OID</th>
</tr>
</thead>
<tbody valign="top">
<tr>
<td headers="wq29">Attribute Type Description syntax</td>
<td headers="wq30">1.3.6.1.4.1.1466.115.121.1.3</td>
</tr>
<tr>
<td headers="wq29">Binary - octet string</td>
<td headers="wq30">1.3.6.1.4.1.1466.115.121.1.5</td>
</tr>
<tr>
<td headers="wq29"> Boolean - TRUE/FALSE</td>
<td headers="wq30">1.3.6.1.4.1.1466.115.121.1.7</td>
</tr>
<tr>
<td headers="wq29">Directory String syntax</td>
<td headers="wq30">1.3.6.1.4.1.1466.115.121.1.15</td>
</tr>
<tr>
<td headers="wq29"> DIT Content Rule Description syntax</td>
<td headers="wq30">1.3.6.1.4.1.1466.115.121.1.16</td>
</tr>
<tr>
<td headers="wq29">DITStructure Rule Description syntax</td>
<td headers="wq30">1.3.6.1.4.1.1466.115.121.1.17</td>
</tr>
<tr>
<td headers="wq29">DN - distinguished name</td>
<td headers="wq30">1.3.6.1.4.1.1466.115.121.1.12</td>
</tr>
<tr>
<td headers="wq29">Generalized Time syntax</td>
<td headers="wq30">1.3.6.1.4.1.1466.115.121.1.24</td>
</tr>
<tr>
<td headers="wq29">IA5 String syntax</td>
<td headers="wq30">1.3.6.1.4.1.1466.115.121.1.26</td>
</tr>
<tr>
<td headers="wq29">IBM Attribute Type Description</td>
<td headers="wq30">1.3.18.0.2.8.1</td>
</tr>
<tr>
<td headers="wq29">Integer syntax - integral number</td>
<td headers="wq30">1.3.6.1.4.1.1466.115.121.1.27</td>
</tr>
<tr>
<td headers="wq29">LDAP Syntax Description syntax</td>
<td headers="wq30">1.3.6.1.4.1.1466.115.121.1.54</td>
</tr>
<tr>
<td headers="wq29">Matching Rule Description</td>
<td headers="wq30">1.3.6.1.4.1.1466.115.121.1.30</td>
</tr>
<tr>
<td headers="wq29">Matching Rule Use Description</td>
<td headers="wq30">1.3.6.1.4.1.1466.115.121.1.31</td>
</tr>
<tr>
<td headers="wq29">Name Form Description</td>
<td headers="wq30">1.3.6.1.4.1.1466.115.121.1.35</td>
</tr>
<tr>
<td headers="wq29">Object Class Description syntax</td>
<td headers="wq30">1.3.6.1.4.1.1466.115.121.1.37</td>
</tr>
<tr>
<td headers="wq29">String for containing OIDs. The OID is a string containing
digits (0-9) and decimal points (.). See <a href="rzahyoid.htm#rzahyoid">Object identifier (OID)</a>.</td>
<td headers="wq30">1.3.6.1.4.1.1466.115.121.1.38</td>
</tr>
<tr>
<td headers="wq29">Telephone Number syntax</td>
<td headers="wq30">1.3.6.1.4.1.1466.115.121.1.50</td>
</tr>
<tr>
<td headers="wq29">UTC Time syntax. UTC-Time is time string format defined
by ASN.1 standards. See ISO 8601 and X680. Use this syntax for storing time
values in UTC-Time format. See <a href="rzahyutctime.htm#rzahyutctime">Generalized and UTC time</a>.</td>
<td headers="wq30">1.3.6.1.4.1.1466.115.121.1.53</td>
</tr>
</tbody>
</table>
<a id="Bot_Of_Page" name="Bot_Of_Page"></a>
</body>
</html>