Source for javax.security.auth.login.AppConfigurationEntry

   1: /* AppConfigurationEntry.java
   2:    Copyright (C) 2004, 2006 Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: 
  39: package javax.security.auth.login;
  40: 
  41: import java.util.Collections;
  42: import java.util.HashMap;
  43: import java.util.Map;
  44: 
  45: public class AppConfigurationEntry
  46: {
  47:   // Fields.
  48:   // -------------------------------------------------------------------------
  49: 
  50:   private final String loginModuleName;
  51:   private final LoginModuleControlFlag controlFlag;
  52:   private final Map options;
  53: 
  54:   // Constructor.
  55:   // -------------------------------------------------------------------------
  56: 
  57:   public AppConfigurationEntry (final String loginModuleName,
  58:                                 final LoginModuleControlFlag controlFlag,
  59:                                 final Map<String, ?> options)
  60:   {
  61:     if (loginModuleName == null || loginModuleName.length() == 0)
  62:       throw new IllegalArgumentException ("module name cannot be null nor empty");
  63: 
  64:     if (LoginModuleControlFlag.OPTIONAL != controlFlag &&
  65:         LoginModuleControlFlag.REQUIRED != controlFlag &&
  66:         LoginModuleControlFlag.REQUISITE != controlFlag &&
  67:         LoginModuleControlFlag.SUFFICIENT != controlFlag)
  68:       throw new IllegalArgumentException ("invalid controlFlag");
  69: 
  70:     if (options == null)
  71:       throw new IllegalArgumentException ("options cannot be null");
  72: 
  73:     this.loginModuleName = loginModuleName;
  74:     this.controlFlag = controlFlag;
  75:     this.options = Collections.unmodifiableMap (new HashMap (options));
  76:   }
  77: 
  78:   // Instance methods.
  79:   // -------------------------------------------------------------------------
  80: 
  81:   public LoginModuleControlFlag getControlFlag()
  82:   {
  83:     return controlFlag;
  84:   }
  85: 
  86:   public String getLoginModuleName()
  87:   {
  88:     return loginModuleName;
  89:   }
  90: 
  91:   public Map<String, ?> getOptions()
  92:   {
  93:     return options;
  94:   }
  95: 
  96:   // Object methods ----------------------------------------------------------
  97: 
  98:   public String toString()
  99:   {
 100:     
 101:     return loginModuleName + "\t"
 102:         + String.valueOf(controlFlag) + "\t"
 103:         + String.valueOf(options);
 104:   }
 105: 
 106:   // Inner class.
 107:   // -------------------------------------------------------------------------
 108: 
 109:   public static class LoginModuleControlFlag
 110:   {
 111: 
 112:     // Constants.
 113:     // -----------------------------------------------------------------------
 114: 
 115:     public static final LoginModuleControlFlag OPTIONAL = new LoginModuleControlFlag();
 116:     public static final LoginModuleControlFlag REQUIRED = new LoginModuleControlFlag();
 117:     public static final LoginModuleControlFlag REQUISITE = new LoginModuleControlFlag();
 118:     public static final LoginModuleControlFlag SUFFICIENT = new LoginModuleControlFlag();
 119: 
 120:     // Constructor.
 121:     // -----------------------------------------------------------------------
 122: 
 123:     private LoginModuleControlFlag()
 124:     {
 125:     }
 126: 
 127:     // Instance methods.
 128:     // -----------------------------------------------------------------------
 129: 
 130:     public String toString()
 131:     {
 132:       if (this == LoginModuleControlFlag.REQUIRED)
 133:         return "REQUIRED";
 134:       if (this == LoginModuleControlFlag.REQUISITE)
 135:         return "REQUISITE";
 136:       if (this == LoginModuleControlFlag.SUFFICIENT)
 137:         return "SUFFICIENT";
 138:       if (this == LoginModuleControlFlag.OPTIONAL)
 139:         return "OPTIONAL";
 140:       return "???";
 141:     }
 142:   }
 143: }