| author | egahlin |
| Fri, 27 Sep 2019 13:20:04 +0200 | |
| branch | JEP-349-branch |
| changeset 58373 | 849a45ac808a |
| parent 55131 | 9889f5e3ba00 |
| permissions | -rw-r--r-- |
| 2 | 1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> |
2 |
<html> |
|
3 |
<head> |
|
4 |
<!-- |
|
| 55131 | 5 |
Copyright (c) 1999, 2019, Oracle and/or its affiliates. All rights reserved. |
| 2 | 6 |
DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
7 |
||
8 |
This code is free software; you can redistribute it and/or modify it |
|
9 |
under the terms of the GNU General Public License version 2 only, as |
|
| 5506 | 10 |
published by the Free Software Foundation. Oracle designates this |
| 2 | 11 |
particular file as subject to the "Classpath" exception as provided |
| 5506 | 12 |
by Oracle in the LICENSE file that accompanied this code. |
| 2 | 13 |
|
14 |
This code is distributed in the hope that it will be useful, but WITHOUT |
|
15 |
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
16 |
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
17 |
version 2 for more details (a copy is included in the LICENSE file that |
|
18 |
accompanied this code). |
|
19 |
||
20 |
You should have received a copy of the GNU General Public License version |
|
21 |
2 along with this work; if not, write to the Free Software Foundation, |
|
22 |
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
|
23 |
||
|
5551
327690766109
6956202: Fix a few missed rebranding issues, please contact lines etc.
ohair
parents:
5506
diff
changeset
|
24 |
Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
|
327690766109
6956202: Fix a few missed rebranding issues, please contact lines etc.
ohair
parents:
5506
diff
changeset
|
25 |
or visit www.oracle.com if you need additional information or have any |
|
327690766109
6956202: Fix a few missed rebranding issues, please contact lines etc.
ohair
parents:
5506
diff
changeset
|
26 |
questions. |
| 2 | 27 |
--> |
28 |
</head> |
|
29 |
<body bgcolor="white"> |
|
30 |
||
|
32029
a5538163e144
8132877: docs: replace <tt> tags (obsolete in html5) for javax.naming
avstepan
parents:
30678
diff
changeset
|
31 |
Extends the <code>javax.naming</code> package to provide functionality |
| 2 | 32 |
for accessing directory services. |
33 |
||
34 |
<p> |
|
35 |
This package defines the directory operations of the Java Naming and |
|
| 30678 | 36 |
Directory Interface™ (JNDI). |
| 2 | 37 |
JNDI provides naming and directory functionality to applications |
38 |
written in the Java programming language. It is designed to be |
|
39 |
independent of any specific naming or directory service |
|
40 |
implementation. Thus a variety of services--new, emerging, and |
|
41 |
already deployed ones--can be accessed in a common way. |
|
42 |
||
43 |
<p> |
|
44 |
This package allows applications to retrieve and update attributes |
|
45 |
associated with objects stored in a directory, and to search for |
|
46 |
objects using specified attributes. |
|
47 |
||
| 55131 | 48 |
<h2>The Directory Context</h2> |
| 2 | 49 |
|
|
32029
a5538163e144
8132877: docs: replace <tt> tags (obsolete in html5) for javax.naming
avstepan
parents:
30678
diff
changeset
|
50 |
The <code>DirContext</code> |
| 2 | 51 |
interface represents a <em>directory context</em>. |
52 |
It defines methods for examining and updating attributes associated with a |
|
53 |
<em>directory object</em>, or <em>directory entry</em> as it is sometimes |
|
54 |
called. |
|
55 |
<p> |
|
|
32029
a5538163e144
8132877: docs: replace <tt> tags (obsolete in html5) for javax.naming
avstepan
parents:
30678
diff
changeset
|
56 |
You use <code>getAttributes()</code> to retrieve the attributes |
| 2 | 57 |
associated with a directory object (for which you supply the name). |
|
32029
a5538163e144
8132877: docs: replace <tt> tags (obsolete in html5) for javax.naming
avstepan
parents:
30678
diff
changeset
|
58 |
Attributes are modified using <code>modifyAttributes()</code>. |
| 2 | 59 |
You can add, replace, or remove attributes and/or attribute values |
60 |
using this operation. |
|
61 |
<p> |
|
|
32029
a5538163e144
8132877: docs: replace <tt> tags (obsolete in html5) for javax.naming
avstepan
parents:
30678
diff
changeset
|
62 |
<code>DirContext</code> also behaves as a naming context |
|
a5538163e144
8132877: docs: replace <tt> tags (obsolete in html5) for javax.naming
avstepan
parents:
30678
diff
changeset
|
63 |
by extending the <code>Context</code> interface in the <code>javax.naming</code> package. |
| 2 | 64 |
This means that any directory object can also provide |
65 |
a naming context. |
|
66 |
For example, the directory object for a person might contain |
|
67 |
the attributes of that person, and at the same time provide |
|
68 |
a context for naming objects relative to that person |
|
69 |
such as his printers and home directory. |
|
70 |
||
| 55131 | 71 |
<h3>Searches</h3> |
|
32029
a5538163e144
8132877: docs: replace <tt> tags (obsolete in html5) for javax.naming
avstepan
parents:
30678
diff
changeset
|
72 |
<code>DirContext</code> contains methods for |
| 2 | 73 |
performing content-based searching of the directory. |
74 |
In the simplest and most common form of usage, the application |
|
|
32029
a5538163e144
8132877: docs: replace <tt> tags (obsolete in html5) for javax.naming
avstepan
parents:
30678
diff
changeset
|
75 |
specifies a set of attributes--possibly with specific |
|
a5538163e144
8132877: docs: replace <tt> tags (obsolete in html5) for javax.naming
avstepan
parents:
30678
diff
changeset
|
76 |
values--to match, and submits this attribute set, to the |
|
a5538163e144
8132877: docs: replace <tt> tags (obsolete in html5) for javax.naming
avstepan
parents:
30678
diff
changeset
|
77 |
<code>search()</code> method. |
|
a5538163e144
8132877: docs: replace <tt> tags (obsolete in html5) for javax.naming
avstepan
parents:
30678
diff
changeset
|
78 |
There are other overloaded forms of <code>search()</code> |
| 2 | 79 |
that support more sophisticated <em>search filters</em>. |
80 |
||
81 |
||
82 |
<h2>Package Specification</h2> |
|
83 |
||
84 |
The JNDI API Specification and related documents can be found in the |
|
|
45136
bd5c526bc443
8180176: Broken javadoc links in java.logging and java.naming
dfuchs
parents:
45132
diff
changeset
|
85 |
{@extLink jndi_overview JNDI documentation}.
|
| 2 | 86 |
|
87 |
@since 1.3 |
|
88 |
||
89 |
</body> |
|
90 |
</html> |