1 /*

     2  * Copyright 2007-2008 Sun Microsystems, Inc.  All Rights Reserved.

     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

     4  *

     5  * This code is free software; you can redistribute it and/or modify it

     6  * under the terms of the GNU General Public License version 2 only, as

     7  * published by the Free Software Foundation.  Sun designates this

     8  * particular file as subject to the "Classpath" exception as provided

     9  * by Sun in the LICENSE file that accompanied this code.

    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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,

    22  * CA 95054 USA or visit www.sun.com if you need additional information or

    23  * have any questions.

    24  */

    25 

    26 package javax.management.event;

    27 

    28 import java.io.IOException;

    29 import javax.management.Notification;

    30 

    31 /**

    32  * This interface can be used to specify a custom forwarding mechanism for

    33  * {@code EventClientDelegateMBean} to forward events to the client.

    34  *

    35  * @see <a href="package-summary.html#transports">Custom notification

    36  * transports</a>

    37  */

    38 public interface EventForwarder {

    39     /**

    40      * Forwards a notification.

    41      * @param n The notification to be forwarded to a remote listener.

    42      * @param listenerId The identifier of the listener to receive the notification.

    43      * @throws IOException If it is closed or an I/O error occurs.

    44      */

    45     public void forward(Notification n, Integer listenerId)

    46         throws IOException;

    47 

    48     /**

    49      * Informs the {@code EventForwarder} to shut down.

    50      * <p> After this method is called, any call to the method

    51      * {@link #forward forward(Notification, Integer)} may get an {@code IOException}.

    52      * @throws IOException If an I/O error occurs.

    53      */

    54     public void close() throws IOException;

    55 

    56     /**

    57      * Sets an event client identifier created by {@link EventClientDelegateMBean}.

    58      * <P> This method will be called just after this {@code EventForwarder}

    59      * is constructed and before calling the {@code forward} method to forward any

    60      * notifications.

    61      */

    62     public void setClientId(String clientId) throws IOException;

    63 }