1   /*
    2     * JBoss, Home of Professional Open Source
    3     * Copyright 2007, JBoss Inc., and individual contributors as indicated
    4     * by the @authors tag. See the copyright.txt in the distribution for a
    5     * full listing of individual contributors.
    6     *
    7     * This is free software; you can redistribute it and/or modify it
    8     * under the terms of the GNU Lesser General Public License as
    9     * published by the Free Software Foundation; either version 2.1 of
   10     * the License, or (at your option) any later version.
   11     *
   12     * This software is distributed in the hope that it will be useful,
   13     * but WITHOUT ANY WARRANTY; without even the implied warranty of
   14     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
   15     * Lesser General Public License for more details.
   16     *
   17     * You should have received a copy of the GNU Lesser General Public
   18     * License along with this software; if not, write to the Free
   19     * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
   20     * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
   21     */
   22   package javax.security.auth.message.config;
   23    
   24   /**
   25    * <p>A Listener that may associated with a provider registration by a user 
   26    * of the registration. The Listener will be notified if the corresponding 
   27    * provider is unregistered or replaced.</p>
   28    *  @author Anil.Saldhana@redhat.com
   29    *  @since  Jul 10, 2007 
   30    *  @version $Revision$    
   31    */
   32   public interface RegistrationListener
   33   {
   34      /**
   35       * Notify the listener that a registration with which it was associated, was 
   36       * replaced or unregistered. When a RegistrationListener is associated with a 
   37       * provider registration within the factory, the factory must call its notify 
   38       * method when the corresponding registration is unregistered or replaced.
   39       * 
   40       * @param layer a String identifying the message layer(s) corresponding to 
   41       *              registration for which the listerner is being notified.
   42       * @param appContext a String value identifying the application context(s) 
   43       *              corresponding to registration for which the listerner is being 
   44       *              notified. The factory detaches the listener from the 
   45       *              corresponding registration once the listener has been notified 
   46       *              for the registration. The detachListerner method must be called 
   47       *              to detach listeners that are no longer in use.
   48       */
   49      public void notify( String layer, String appContext); 
   50   }