1   /*
    2     * JBoss, Home of Professional Open Source
    3     * Copyright 2005, 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   import javax.security.auth.message.AuthException;
   25   import javax.security.auth.message.MessageInfo;
   26   
   27   //$Id: AuthConfig.java 64016 2007-07-12 21:12:52Z anil.saldhana@jboss.com $
   28   
   29   /**
   30    *  <p>This interface defines the common functionality implemented by 
   31    *  Authentication context configuration objects.</p>
   32    *  
   33    *  @author <a href="mailto:Anil.Saldhana@jboss.org">Anil Saldhana</a>
   34    *  @author Charlie Lai, Ron Monzillo (Javadoc for JSR-196)</a> 
   35    *  @since  May 12, 2006 
   36    *  @version $Revision: 64016 $
   37    */
   38   public interface AuthConfig
   39   {
   40      /**
   41       * Get the application context identifier of this authentication context 
   42       * configuration object.
   43       * @return the String identifying the application context of this configuration 
   44       *         object or null if the configuration object pertains to an unspecified 
   45       *         application context.
   46       */
   47      String getAppContext();
   48      
   49      String getAuthContextID(MessageInfo messageInfo);
   50      
   51      /**
   52       * Get the message layer name of this authentication context configuration object.
   53       * @return the message layer name of this configuration object, or null if the 
   54       *         configuration object pertains to an unspecified message layer.
   55       */
   56      String getMessageLayer();
   57      
   58      boolean isProtected();
   59      
   60      /**
   61       * Causes a dynamic anthentication context configuration object to update its internal 
   62       * state and such that any change to its state is recognized by any authentication 
   63       * context objects that were previously obtained from the config object.
   64       * @throws AuthException if an error occured during the update.
   65       * @throws SecurityException if the caller does not have permission to refresh 
   66       *                           the configuration object.
   67       */
   68      void refresh() throws AuthException, SecurityException;
   69   }