1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156
/* * @(#)AppConfigurationEntry.java 1.36 05/11/17 * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package javax.security.auth.login; import java.util.Map; import java.util.Collections; /** * This class represents a single <code>LoginModule</code> entry * configured for the application specified in the * <code>getAppConfigurationEntry(String appName)</code> * method in the <code>Configuration</code> class. Each respective * <code>AppConfigurationEntry</code> contains a <code>LoginModule</code> name, * a control flag (specifying whether this <code>LoginModule</code> is * REQUIRED, REQUISITE, SUFFICIENT, or OPTIONAL), and LoginModule-specific * options. Please refer to the <code>Configuration</code> class for * more information on the different control flags and their semantics. * * @version 1.36, 11/17/05 * @see javax.security.auth.login.Configuration */ public class AppConfigurationEntry { private String loginModuleName; private LoginModuleControlFlag controlFlag; private Map options; /** * Default constructor for this class. * * <p> This entry represents a single <code>LoginModule</code> * entry configured for the application specified in the * <code>getAppConfigurationEntry(String appName)</code> * method from the <code>Configuration</code> class. * * @param loginModuleName String representing the class name of the * <code>LoginModule</code> configured for the * specified application. <p> * * @param controlFlag either REQUIRED, REQUISITE, SUFFICIENT, * or OPTIONAL. <p> * * @param options the options configured for this <code>LoginModule</code>. * * @exception IllegalArgumentException if <code>loginModuleName</code> * is null, if <code>LoginModuleName</code> * has a length of 0, if <code>controlFlag</code> * is not either REQUIRED, REQUISITE, SUFFICIENT * or OPTIONAL, or if <code>options</code> is null. */ public AppConfigurationEntry(String loginModuleName, LoginModuleControlFlag controlFlag, Map<String,?> options) { if (loginModuleName == null || loginModuleName.length() == 0 || (controlFlag != LoginModuleControlFlag.REQUIRED && controlFlag != LoginModuleControlFlag.REQUISITE && controlFlag != LoginModuleControlFlag.SUFFICIENT && controlFlag != LoginModuleControlFlag.OPTIONAL) || options == null) throw new IllegalArgumentException(); this.loginModuleName = loginModuleName; this.controlFlag = controlFlag; this.options = Collections.unmodifiableMap(options); } /** * Get the class name of the configured <code>LoginModule</code>. * * @return the class name of the configured <code>LoginModule</code> as * a String. */ public String getLoginModuleName() { return loginModuleName; } /** * Return the controlFlag * (either REQUIRED, REQUISITE, SUFFICIENT, or OPTIONAL) * for this <code>LoginModule</code>. * * @return the controlFlag * (either REQUIRED, REQUISITE, SUFFICIENT, or OPTIONAL) * for this <code>LoginModule</code>. */ public LoginModuleControlFlag getControlFlag() { return controlFlag; } /** * Get the options configured for this <code>LoginModule</code>. * * @return the options configured for this <code>LoginModule</code> * as an unmodifiable <code>Map</code>. */ public Map<String,?> getOptions() { return options; } /** * This class represents whether or not a <code>LoginModule</code> * is REQUIRED, REQUISITE, SUFFICIENT or OPTIONAL. */ public static class LoginModuleControlFlag { private String controlFlag; /** * Required <code>LoginModule</code>. */ public static final LoginModuleControlFlag REQUIRED = new LoginModuleControlFlag("required"); /** * Requisite <code>LoginModule</code>. */ public static final LoginModuleControlFlag REQUISITE = new LoginModuleControlFlag("requisite"); /** * Sufficient <code>LoginModule</code>. */ public static final LoginModuleControlFlag SUFFICIENT = new LoginModuleControlFlag("sufficient"); /** * Optional <code>LoginModule</code>. */ public static final LoginModuleControlFlag OPTIONAL = new LoginModuleControlFlag("optional"); private LoginModuleControlFlag(String controlFlag) { this.controlFlag = controlFlag; } /** * Return a String representation of this controlFlag. * * <p> The String has the format, "LoginModuleControlFlag: <i>flag</i>", * where <i>flag</i> is either <i>required</i>, <i>requisite</i>, * <i>sufficient</i>, or <i>optional</i>. * * @return a String representation of this controlFlag. */ public String toString() { return (sun.security.util.ResourcesMgr.getString ("LoginModuleControlFlag: ") + controlFlag); } } }