/* * $Header: /home/wistrand/cvs/knopflerfish.org/osgi/bundles/wireadmin/src/org/osgi/service/wireadmin/WireAdminListener.java,v 1.1.1.1 2004/03/05 20:35:18 wistrand Exp $ * * Copyright (c) The Open Services Gateway Initiative (2002). * All Rights Reserved. * * Implementation of certain elements of the Open Services Gateway Initiative * (OSGI) Specification may be subject to third party intellectual property * rights, including without limitation, patent rights (such a third party may * or may not be a member of OSGi). OSGi is not responsible and shall not be * held responsible in any manner for identifying or failing to identify any or * all such third party intellectual property rights. * * This document and the information contained herein are provided on an "AS * IS" basis and OSGI DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING * BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL * NOT INFRINGE ANY RIGHTS AND ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR * FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT WILL OSGI BE LIABLE FOR ANY * LOSS OF PROFITS, LOSS OF BUSINESS, LOSS OF USE OF DATA, INTERRUPTION OF * BUSINESS, OR FOR DIRECT, INDIRECT, SPECIAL OR EXEMPLARY, INCIDENTIAL, * PUNITIVE OR CONSEQUENTIAL DAMAGES OF ANY KIND IN CONNECTION WITH THIS * DOCUMENT OR THE INFORMATION CONTAINED HEREIN, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH LOSS OR DAMAGE. * * All Company, brand and product names may be trademarks that are the sole * property of their respective owners. All rights reserved. */ package org.osgi.service.wireadmin; /** * Listener for Wire Admin Events. * *

WireAdminListener objects are registered with the Framework service registry and * are notified with a WireAdminEvent object when an event * is broadcast. *

WireAdminListener objects can inspect the received WireAdminEvent object to * determine its type, the Wire object with which it is associated, and the Wire Admin service that * broadcasts the event. * *

WireAdminListener objects must be registered with a * service property {@link WireConstants#WIREADMIN_EVENTS} * whose value is a bitwise OR of all the event types the listener * is interested in receiving. *

For example: * 

 *  Integer mask = new Integer( WIRE_TRACE
 *   | WIRE_CONNECTED
 *   | WIRE_DISCONNECTED );
 *  Hashtable ht = new Hashtable();
 *  ht.put( WIREADMIN_EVENTS, mask );
 *  context.registerService( 
 *     WireAdminListener.class.getName(), this, ht );
 *
* If a WireAdminListener object is registered without a * service property {@link WireConstants#WIREADMIN_EVENTS}, * then the WireAdminListener will receive no events. * *

Security Considerations. Bundles wishing to monitor WireAdminEvent objects * will require ServicePermission[REGISTER,WireAdminListener] to register a WireAdminListener service. * Since WireAdminEvent objects contain Wire objects, care must be taken * in assigning permission to register a WireAdminListener service. * * @see WireAdminEvent * * @version $Revision: 1.1.1.1 $ * @author Open Services Gateway Initiative */ public interface WireAdminListener { /** * Receives notification of a broadcast WireAdminEvent object. * * The event object will be of an event type specified in this * WireAdminListener service's {@link WireConstants#WIREADMIN_EVENTS} * service property. * * @param event The WireAdminEvent object. */ void wireAdminEvent(WireAdminEvent event); }