Class IniRealm

java.lang.Object
org.apache.shiro.realm.CachingRealm
org.apache.shiro.realm.AuthenticatingRealm
org.apache.shiro.realm.AuthorizingRealm
org.apache.shiro.realm.SimpleAccountRealm
org.apache.shiro.realm.text.TextConfigurationRealm
org.apache.shiro.realm.text.IniRealm
All Implemented Interfaces:
LogoutAware, Authorizer, PermissionResolverAware, RolePermissionResolverAware, org.apache.shiro.cache.CacheManagerAware, org.apache.shiro.lang.util.Initializable, org.apache.shiro.lang.util.Nameable, Realm
public class IniRealm extends TextConfigurationRealm
A Realm implementation that creates SimpleAccount instances based on Ini configuration.

This implementation looks for two sections in the Ini configuration: 

 [users]
 # One or more user definitions
 ...
 [roles]
 # One or more role definitions

This class also supports setting the resourcePath property to create account data from an .ini resource. This will only be used if there isn't already account data in the Realm.

Since:
1.0

  • Field Details

  • Constructor Details

    • IniRealm

      public IniRealm()

    • IniRealm

      public IniRealm(org.apache.shiro.config.Ini ini)
      This constructor will immediately process the definitions in the Ini argument. If you need to perform additional configuration before processing (e.g. setting a permissionResolver, etc.), do not call this constructor. Instead, do the following:
      1. Call the default no-arg constructor
      2. Set the Ini instance you wish to use via #setIni
      3. Set any other configuration properties
      4. Call AuthenticatingRealm.init()
      Parameters:
      ini - the Ini instance which will be inspected to create accounts, groups and permissions for this realm.

    • IniRealm

      public IniRealm(String resourcePath)
      This constructor will immediately process the definitions in the Ini resolved from the specified resourcePath. If you need to perform additional configuration before processing (e.g. setting a permissionResolver, etc.), do not call this constructor. Instead, do the following:
      1. Call the default no-arg constructor
      2. Set the Ini instance you wish to use via #setIni
      3. Set any other configuration properties
      4. Call AuthenticatingRealm.init()
      Parameters:
      resourcePath - the resource path of the Ini config which will be inspected to create accounts, groups and permissions for this realm.

  • Method Details

    • getResourcePath

      public String getResourcePath()

    • setResourcePath

      public void setResourcePath(String resourcePath)

    • getIni

      public org.apache.shiro.config.Ini getIni()
      Returns the Ini instance used to configure this realm. Provided for JavaBeans-style configuration of this realm, particularly useful in Dependency Injection environments.
      Returns:
      the Ini instance which will be inspected to create accounts, groups and permissions for this realm.

    • setIni

      public void setIni(org.apache.shiro.config.Ini ini)
      Sets the Ini instance used to configure this realm. Provided for JavaBeans-style configuration of this realm, particularly useful in Dependency Injection environments.
      Parameters:
      ini - the Ini instance which will be inspected to create accounts, groups and permissions for this realm.

    • onInit

      protected void onInit()
      Description copied from class: TextConfigurationRealm
      Will call 'processDefinitions' on startup.
      Overrides:
      onInit in class TextConfigurationRealm
      See Also: