src/java.naming/share/classes/javax/naming/event/NamespaceChangeListener.java
author lancea
Thu, 14 Mar 2019 10:50:35 -0400
changeset 54126 478f1483c511
parent 47216 71c04702a3d5
permissions -rw-r--r--
8220252: Fix Headings in java.naming Reviewed-by: dfuchs
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     2
 * Copyright (c) 1999, Oracle and/or its affiliates. All rights reserved.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
 * 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
     7
 * published by the Free Software Foundation.  Oracle designates this
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
 *
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    23
 * questions.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
package javax.naming.event;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
/**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
  * Specifies the methods that a listener interested in namespace changes
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
  * must implement.
32029
a5538163e144 8132877: docs: replace <tt> tags (obsolete in html5) for javax.naming
avstepan
parents: 25859
diff changeset
    31
  * Specifically, the listener is interested in {@code NamingEvent}s
a5538163e144 8132877: docs: replace <tt> tags (obsolete in html5) for javax.naming
avstepan
parents: 25859
diff changeset
    32
  * with event types of {@code OBJECT_ADDED, OBJECT_RENAMED}, or
a5538163e144 8132877: docs: replace <tt> tags (obsolete in html5) for javax.naming
avstepan
parents: 25859
diff changeset
    33
  * {@code OBJECT_REMOVED}.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
  *<p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
  * Such a listener must:
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
  *<ol>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
  *<li>Implement this interface and its methods.
32029
a5538163e144 8132877: docs: replace <tt> tags (obsolete in html5) for javax.naming
avstepan
parents: 25859
diff changeset
    38
  *<li>Implement {@code NamingListener.namingExceptionThrown()} so that
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
  * it will be notified of exceptions thrown while attempting to
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
  * collect information about the events.
32029
a5538163e144 8132877: docs: replace <tt> tags (obsolete in html5) for javax.naming
avstepan
parents: 25859
diff changeset
    41
  *<li>Register with the source using the source's {@code addNamingListener()}
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
  *    method.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
  *</ol>
32029
a5538163e144 8132877: docs: replace <tt> tags (obsolete in html5) for javax.naming
avstepan
parents: 25859
diff changeset
    44
  * A listener that wants to be notified of {@code OBJECT_CHANGED} event types
a5538163e144 8132877: docs: replace <tt> tags (obsolete in html5) for javax.naming
avstepan
parents: 25859
diff changeset
    45
  * should also implement the {@code ObjectChangeListener}
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
  * interface.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
  *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
  * @author Rosanna Lee
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
  * @author Scott Seligman
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
  *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
  * @see NamingEvent
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
  * @see ObjectChangeListener
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
  * @see EventContext
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
  * @see EventDirContext
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
  * @since 1.3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
  */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
public interface NamespaceChangeListener extends NamingListener {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
     * Called when an object has been added.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
     *<p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
     * The binding of the newly added object can be obtained using
32029
a5538163e144 8132877: docs: replace <tt> tags (obsolete in html5) for javax.naming
avstepan
parents: 25859
diff changeset
    63
     * {@code evt.getNewBinding()}.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
     * @param evt The nonnull event.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
     * @see NamingEvent#OBJECT_ADDED
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
    void objectAdded(NamingEvent evt);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
     * Called when an object has been removed.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
     *<p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
     * The binding of the newly removed object can be obtained using
32029
a5538163e144 8132877: docs: replace <tt> tags (obsolete in html5) for javax.naming
avstepan
parents: 25859
diff changeset
    73
     * {@code evt.getOldBinding()}.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
     * @param evt The nonnull event.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    75
     * @see NamingEvent#OBJECT_REMOVED
90ce3da70b43 Initial load
duke
parents:
diff changeset
    76
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    77
    void objectRemoved(NamingEvent evt);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    78
90ce3da70b43 Initial load
duke
parents:
diff changeset
    79
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    80
     * Called when an object has been renamed.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    81
     *<p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    82
     * The binding of the renamed object can be obtained using
32029
a5538163e144 8132877: docs: replace <tt> tags (obsolete in html5) for javax.naming
avstepan
parents: 25859
diff changeset
    83
     * {@code evt.getNewBinding()}. Its old binding (before the rename)
a5538163e144 8132877: docs: replace <tt> tags (obsolete in html5) for javax.naming
avstepan
parents: 25859
diff changeset
    84
     * can be obtained using {@code evt.getOldBinding()}.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    85
     * One of these may be null if the old/new binding was outside the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    86
     * scope in which the listener has registered interest.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    87
     * @param evt The nonnull event.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    88
     * @see NamingEvent#OBJECT_RENAMED
90ce3da70b43 Initial load
duke
parents:
diff changeset
    89
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    90
    void objectRenamed(NamingEvent evt);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    91
}