jdk/src/java.naming/share/classes/javax/naming/spi/package.html
author chegar
Sun, 17 Aug 2014 15:54:13 +0100
changeset 25859 3317bb8137f4
parent 5551 jdk/src/share/classes/javax/naming/spi/package.html@327690766109
child 30678 a8b7fd8ede97
permissions -rw-r--r--
8054834: Modular Source Code Reviewed-by: alanb, chegar, ihse, mduigou Contributed-by: alan.bateman@oracle.com, alex.buckley@oracle.com, chris.hegarty@oracle.com, erik.joelsson@oracle.com, jonathan.gibbons@oracle.com, karen.kinnear@oracle.com, magnus.ihse.bursie@oracle.com, mandy.chung@oracle.com, mark.reinhold@oracle.com, paul.sandoz@oracle.com
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
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
Provides the means for dynamically plugging in support for accessing
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
naming and directory services through the <tt>javax.naming</tt> 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
and related packages.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
<p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
This package defines the service provider interface (SPI) of the Java Naming
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
and Directory Interface<font size=-2><sup>TM</sup></font> (JNDI). &nbsp;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
JNDI provides naming and directory functionality to applications
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
written in the Java programming language.  It is designed to be
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
independent of any specific naming or directory service
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
implementation.  Thus a variety of services--new, emerging, and
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
already deployed ones--can be accessed in a common way.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
<p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
The JNDI SPI provides the means for creating JNDI service providers,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
through which JNDI applications access different naming and
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
directory services.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
<h4>Plug-in Architecture</h4>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
The service provider package allows different implementations to be plugged in
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
dynamically.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
These different implementations include those for the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
<em>initial context</em>,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
and implementations for contexts that can be reached 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
from the initial context.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
<h4>Java Object Support</h4>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
The service provider package provides support 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
for implementors of the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
<tt>javax.naming.Context.lookup()</tt> 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
method and related methods to return Java objects that are natural
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
and intuitive for the Java programmer.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
For example, when looking up a printer name from the directory,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
it is natural for you to expect to get
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
back a printer object on which to operate.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
<h4>Multiple Naming Systems (Federation)</h4>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
90ce3da70b43 Initial load
duke
parents:
diff changeset
    73
JNDI operations allow applications to supply names that span multiple
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
naming systems.  So in the process of completing
90ce3da70b43 Initial load
duke
parents:
diff changeset
    75
an operation, one service provider might need to interact
90ce3da70b43 Initial load
duke
parents:
diff changeset
    76
with another service provider, for example, to pass on
90ce3da70b43 Initial load
duke
parents:
diff changeset
    77
the operation to be continued in the next naming system.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    78
The service provider package provides support for
90ce3da70b43 Initial load
duke
parents:
diff changeset
    79
different providers to cooperate to complete JNDI operations.
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 SPI Specification and related documents can be found in the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    85
<a href="../../../../technotes/guides/jndi/index.html">JNDI documentation</a>.
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>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    91
<body>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    92
</body>