Package org.springframework.extensions.webscripts

Class ConfigModel

  • Direct Known Subclasses:
    ScriptConfigModel, TemplateConfigModel
    public abstract class ConfigModel
extends java.lang.Object
    Abstract base class used for objects that represent configuration as a root object in a script or template model.
    Author:
    gavinc

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      class  ConfigModel.ScopedConfigMap
      Map to allow access to scoped config in a unified way for scripts and templates.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected org.springframework.extensions.config.ConfigService configService  
      protected java.util.Map<java.lang.String,​org.springframework.extensions.config.ConfigElement> globalConfig  
      protected java.lang.String scriptConfig  

    • Constructor Summary

      Constructors 
      Constructor Description
      ConfigModel​(org.springframework.extensions.config.ConfigService configService, java.lang.String scriptConfig)  

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Map<java.lang.String,​org.springframework.extensions.config.ConfigElement> getGlobal()
      Retrieves the global configuration as a Map.
      java.util.Map<java.lang.String,​org.springframework.extensions.config.ConfigElement> getScoped()
      Retrieves scoped configuration as a Map.
      abstract java.lang.Object getScript()
      Retrieves the script configuration.
      It's up to the subclass what is returned to represent script config.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • configService

        protected org.springframework.extensions.config.ConfigService configService

      • globalConfig

        protected java.util.Map<java.lang.String,​org.springframework.extensions.config.ConfigElement> globalConfig

      • scriptConfig

        protected java.lang.String scriptConfig

    • Constructor Detail

      • ConfigModel

        public ConfigModel​(org.springframework.extensions.config.ConfigService configService,
                   java.lang.String scriptConfig)

    • Method Detail

      • getGlobal

        public java.util.Map<java.lang.String,​org.springframework.extensions.config.ConfigElement> getGlobal()
        Retrieves the global configuration as a Map.
        Returns:
        Map of the global config

      • getScoped

        public java.util.Map<java.lang.String,​org.springframework.extensions.config.ConfigElement> getScoped()
        Retrieves scoped configuration as a Map.
        Returns:
        Map of the scoped config

      • getScript

        public abstract java.lang.Object getScript()
        Retrieves the script configuration.
        It's up to the subclass what is returned to represent script config.
        Returns:
        script configuration