001 /* AppConfigurationEntry.java
002 Copyright (C) 2004, 2006 Free Software Foundation, Inc.
003
004 This file is part of GNU Classpath.
005
006 GNU Classpath is free software; you can redistribute it and/or modify
007 it under the terms of the GNU General Public License as published by
008 the Free Software Foundation; either version 2, or (at your option)
009 any later version.
010
011 GNU Classpath is distributed in the hope that it will be useful, but
012 WITHOUT ANY WARRANTY; without even the implied warranty of
013 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014 General Public License for more details.
015
016 You should have received a copy of the GNU General Public License
017 along with GNU Classpath; see the file COPYING. If not, write to the
018 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019 02110-1301 USA.
020
021 Linking this library statically or dynamically with other modules is
022 making a combined work based on this library. Thus, the terms and
023 conditions of the GNU General Public License cover the whole
024 combination.
025
026 As a special exception, the copyright holders of this library give you
027 permission to link this library with independent modules to produce an
028 executable, regardless of the license terms of these independent
029 modules, and to copy and distribute the resulting executable under
030 terms of your choice, provided that you also meet, for each linked
031 independent module, the terms and conditions of the license of that
032 module. An independent module is a module which is not derived from
033 or based on this library. If you modify this library, you may extend
034 this exception to your version of the library, but you are not
035 obligated to do so. If you do not wish to do so, delete this
036 exception statement from your version. */
037
038
039 package javax.security.auth.login;
040
041 import java.util.Collections;
042 import java.util.HashMap;
043 import java.util.Map;
044
045 public class AppConfigurationEntry
046 {
047 // Fields.
048 // -------------------------------------------------------------------------
049
050 private final String loginModuleName;
051 private final LoginModuleControlFlag controlFlag;
052 private final Map options;
053
054 // Constructor.
055 // -------------------------------------------------------------------------
056
057 public AppConfigurationEntry (final String loginModuleName,
058 final LoginModuleControlFlag controlFlag,
059 final Map<String, ?> options)
060 {
061 if (loginModuleName == null || loginModuleName.length() == 0)
062 throw new IllegalArgumentException ("module name cannot be null nor empty");
063
064 if (LoginModuleControlFlag.OPTIONAL != controlFlag &&
065 LoginModuleControlFlag.REQUIRED != controlFlag &&
066 LoginModuleControlFlag.REQUISITE != controlFlag &&
067 LoginModuleControlFlag.SUFFICIENT != controlFlag)
068 throw new IllegalArgumentException ("invalid controlFlag");
069
070 if (options == null)
071 throw new IllegalArgumentException ("options cannot be null");
072
073 this.loginModuleName = loginModuleName;
074 this.controlFlag = controlFlag;
075 this.options = Collections.unmodifiableMap (new HashMap (options));
076 }
077
078 // Instance methods.
079 // -------------------------------------------------------------------------
080
081 public LoginModuleControlFlag getControlFlag()
082 {
083 return controlFlag;
084 }
085
086 public String getLoginModuleName()
087 {
088 return loginModuleName;
089 }
090
091 public Map<String, ?> getOptions()
092 {
093 return options;
094 }
095
096 // Object methods ----------------------------------------------------------
097
098 public String toString()
099 {
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 }