javax.security.auth.login

Class AppConfigurationEntry

Contents

  • public class AppConfigurationEntry
extends Object
    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

    • Constructor Detail

      • AppConfigurationEntry

        public AppConfigurationEntry(String loginModuleName,
                     AppConfigurationEntry.LoginModuleControlFlag controlFlag,
                     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.

        Parameters:
        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.

    • Method Detail

      • getLoginModuleName

        public String getLoginModuleName()
        Get the class name of the configured LoginModule.
        Returns:
        the class name of the configured LoginModule as a String.

      • getControlFlag

        public AppConfigurationEntry.LoginModuleControlFlag getControlFlag()
        Return the controlFlag (either REQUIRED, REQUISITE, SUFFICIENT, or OPTIONAL) for this LoginModule.
        Returns:
        the controlFlag (either REQUIRED, REQUISITE, SUFFICIENT, or OPTIONAL) for this LoginModule.

      • getOptions

        public Map<String,?> getOptions()
        Get the options configured for this LoginModule.
        Returns:
        the options configured for this LoginModule as an unmodifiable Map.

Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-javax/security/auth/login/AppConfigurationEntry.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

  1. View the html document Language of the document:fr Manuel PHP : https://docs.oracle.com/en/java/, Class AppConfigurationEntry

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.