src/java.naming/share/classes/javax/naming/directory/package.html
author darcy
Mon, 06 Aug 2018 14:29:22 -0700
changeset 51317 e122220d7d7e
parent 47216 71c04702a3d5
child 55131 9889f5e3ba00
permissions -rw-r--r--
8209024: Use SuppressWarnings on serialVersionUID fields in interfaces Reviewed-by: bpb, rriggs, mullan
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
90ce3da70b43 Initial load
duke
parents:
diff changeset
     2
<html>
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
<head>
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
<!--
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     5
Copyright (c) 1999, 2006, Oracle and/or its affiliates. All rights reserved.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     7
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     9
under the terms of the GNU General Public License version 2 only, as
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    10
published by the Free Software Foundation.  Oracle designates this
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
particular file as subject to the "Classpath" exception as provided
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    12
by Oracle in the LICENSE file that accompanied this code.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    21
2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    22
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    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
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
-->
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
</head>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
<body bgcolor="white">
90ce3da70b43 Initial load
duke
parents:
diff changeset
    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
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
for accessing directory services.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
<p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
This package defines the directory operations of the Java Naming and
30678
a8b7fd8ede97 8075284: fix up miscellaneous TM constructions
darcy
parents: 25859
diff changeset
    36
Directory Interface&trade; (JNDI). &nbsp;
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
JNDI provides naming and directory functionality to applications
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
written in the Java programming language.  It is designed to be
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
independent of any specific naming or directory service
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
implementation.  Thus a variety of services--new, emerging, and
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
already deployed ones--can be accessed in a common way.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
<p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
This package allows applications to retrieve and update attributes
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
associated with objects stored in a directory, and to search for
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
objects using specified attributes.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
45132
db2f2d72cd4f 8179697: Fix Html5 errors in java.naming, java.logging, jdk.httpserver, jdk.net, jdk.sctp
ksrini
parents: 32029
diff changeset
    48
<h3>The Directory Context</h3>
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    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
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
interface represents a <em>directory context</em>.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
It defines methods for examining and updating attributes associated with a
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
<em>directory object</em>, or <em>directory entry</em> as it is sometimes
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
called.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    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
90ce3da70b43 Initial load
duke
parents:
diff changeset
    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
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
You can add, replace, or remove attributes and/or attribute values
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
using this operation.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    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
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
This means that any directory object can also provide
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
a naming context. 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
For example, the directory object for a person might contain
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
the attributes of that person, and at the same time provide
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
a context for naming objects relative to that person
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
such as his printers and home directory.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
<h4>Searches</h4>
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
90ce3da70b43 Initial load
duke
parents:
diff changeset
    73
performing content-based searching of the directory.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    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
90ce3da70b43 Initial load
duke
parents:
diff changeset
    79
that support more sophisticated <em>search filters</em>.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    80
90ce3da70b43 Initial load
duke
parents:
diff changeset
    81
90ce3da70b43 Initial load
duke
parents:
diff changeset
    82
<h2>Package Specification</h2>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    83
90ce3da70b43 Initial load
duke
parents:
diff changeset
    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
90ce3da70b43 Initial load
duke
parents:
diff changeset
    86
90ce3da70b43 Initial load
duke
parents:
diff changeset
    87
@since 1.3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    88
90ce3da70b43 Initial load
duke
parents:
diff changeset
    89
</body>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    90
</html>