/*
 * Copyright (c) 1998, 2010, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package javax.security.auth.login;

import java.util.Map;
import java.util.Collections;

This class represents a single LoginModule entry configured for the application specified in the getAppConfigurationEntry(String appName) method in the Configuration class. Each respective AppConfigurationEntry contains a LoginModule name, a control flag (specifying whether this LoginModule is REQUIRED, REQUISITE, SUFFICIENT, or OPTIONAL), and LoginModule-specific options. Please refer to the Configuration class for more information on the different control flags and their semantics.
See Also:
  • Configuration
/** * 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. * * @see javax.security.auth.login.Configuration */
public class AppConfigurationEntry { private String loginModuleName; private LoginModuleControlFlag controlFlag; private Map<String,?> options;
Default constructor for this class.

This entry represents a single LoginModule entry configured for the application specified in the getAppConfigurationEntry(String appName) method from the Configuration class.

Params:
  • loginModuleName – String representing the class name of the LoginModule configured for the specified application.

  • controlFlag – either REQUIRED, REQUISITE, SUFFICIENT, or OPTIONAL.

  • options – the options configured for this LoginModule.
Throws:
  • IllegalArgumentException – if loginModuleName is null, if LoginModuleName has a length of 0, if controlFlag is not either REQUIRED, REQUISITE, SUFFICIENT or OPTIONAL, or if options is null.
/** * 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 LoginModule.
Returns:the class name of the configured LoginModule as a String.
/** * 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 LoginModule.
Returns:the controlFlag (either REQUIRED, REQUISITE, SUFFICIENT, or OPTIONAL) for this LoginModule.
/** * 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 LoginModule.
Returns:the options configured for this LoginModule as an unmodifiable Map.
/** * 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 LoginModule is REQUIRED, REQUISITE, SUFFICIENT or OPTIONAL.
/** * This class represents whether or not a <code>LoginModule</code> * is REQUIRED, REQUISITE, SUFFICIENT or OPTIONAL. */
public static class LoginModuleControlFlag { private String controlFlag;
Required LoginModule.
/** * Required <code>LoginModule</code>. */
public static final LoginModuleControlFlag REQUIRED = new LoginModuleControlFlag("required");
Requisite LoginModule.
/** * Requisite <code>LoginModule</code>. */
public static final LoginModuleControlFlag REQUISITE = new LoginModuleControlFlag("requisite");
Sufficient LoginModule.
/** * Sufficient <code>LoginModule</code>. */
public static final LoginModuleControlFlag SUFFICIENT = new LoginModuleControlFlag("sufficient");
Optional LoginModule.
/** * 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.

The String has the format, "LoginModuleControlFlag: flag", where flag is either required, requisite, sufficient, or optional.

Returns:a String representation of this 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); } } }