< prev index next >

src/java.naming/share/classes/javax/naming/event/NamingListener.java

Print this page




  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package javax.naming.event;
  27 
  28 /**
  29   * This interface is the root of listener interfaces that
  30   * handle <tt>NamingEvent</tt>s.
  31   * It does not make sense for a listener to implement just this interface.
  32   * A listener typically implements a subinterface of <tt>NamingListener</tt>,
  33   * such as <tt>ObjectChangeListener</tt> or <tt>NamespaceChangeListener</tt>.
  34   *<p>
  35   * This interface contains a single method, <tt>namingExceptionThrown()</tt>,
  36   * that must be implemented so that the listener can be notified of
  37   * exceptions that are thrown (by the service provider) while gathering
  38   * information about the events that they're interested in.
  39   * When this method is invoked, the listener has been automatically deregistered
  40   * from the <tt>EventContext</tt> with which it has registered.
  41   *<p>
  42   * For example, suppose a listener implements <tt>ObjectChangeListener</tt> and
  43   * registers with a <tt>EventContext</tt>.
  44   * Then, if the connection to the server is subsequently broken,
  45   * the listener will receive a <tt>NamingExceptionEvent</tt> and may
  46   * take some corrective action, such as notifying the user of the application.
  47   *
  48   * @author Rosanna Lee
  49   * @author Scott Seligman
  50   *
  51   * @see NamingEvent
  52   * @see NamingExceptionEvent
  53   * @see EventContext
  54   * @see EventDirContext
  55   * @since 1.3
  56   */
  57 public interface NamingListener extends java.util.EventListener {
  58     /**
  59      * Called when a naming exception is thrown while attempting
  60      * to fire a <tt>NamingEvent</tt>.
  61      *
  62      * @param evt The nonnull event.
  63      */
  64     void namingExceptionThrown(NamingExceptionEvent evt);
  65 }


  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package javax.naming.event;
  27 
  28 /**
  29   * This interface is the root of listener interfaces that
  30   * handle {@code NamingEvent}s.
  31   * It does not make sense for a listener to implement just this interface.
  32   * A listener typically implements a subinterface of {@code NamingListener},
  33   * such as {@code ObjectChangeListener} or {@code NamespaceChangeListener}.
  34   *<p>
  35   * This interface contains a single method, {@code namingExceptionThrown()},
  36   * that must be implemented so that the listener can be notified of
  37   * exceptions that are thrown (by the service provider) while gathering
  38   * information about the events that they're interested in.
  39   * When this method is invoked, the listener has been automatically deregistered
  40   * from the {@code EventContext} with which it has registered.
  41   *<p>
  42   * For example, suppose a listener implements {@code ObjectChangeListener} and
  43   * registers with a {@code EventContext}.
  44   * Then, if the connection to the server is subsequently broken,
  45   * the listener will receive a {@code NamingExceptionEvent} and may
  46   * take some corrective action, such as notifying the user of the application.
  47   *
  48   * @author Rosanna Lee
  49   * @author Scott Seligman
  50   *
  51   * @see NamingEvent
  52   * @see NamingExceptionEvent
  53   * @see EventContext
  54   * @see EventDirContext
  55   * @since 1.3
  56   */
  57 public interface NamingListener extends java.util.EventListener {
  58     /**
  59      * Called when a naming exception is thrown while attempting
  60      * to fire a {@code NamingEvent}.
  61      *
  62      * @param evt The nonnull event.
  63      */
  64     void namingExceptionThrown(NamingExceptionEvent evt);
  65 }
< prev index next >