Package org.hippoecm.hst.core.request

Interface ComponentConfiguration

All Superinterfaces:
ParameterConfiguration
public interface ComponentConfiguration extends ParameterConfiguration
A ComponentConfiguration provides some configuration information to a component.
Version:
$Id$

  • Method Details

    • getLocalParameter

      String getLocalParameter(String name, ResolvedSiteMapItem hstResolvedSiteMapItem)
      Returns the property without inheritance and if an expression exists it is resolved with the help of the ResolvedSiteMapItem

    • getLocalParameters

      Map<String,String> getLocalParameters(ResolvedSiteMapItem hstResolvedSiteMapItem)
      Returns all resolved parameters without inheritance into a map
      Parameters:
      hstResolvedSiteMapItem -

    • getDynamicComponentParameters

      List<DynamicParameter> getDynamicComponentParameters()

    • getDynamicComponentParameter

      Optional<DynamicParameter> getDynamicComponentParameter(String name)

    • getRawParameters

      Map<String,String> getRawParameters()
      Also see ParameterConfiguration.getParameters(ResolvedSiteMapItem). Normally, you use ParameterConfiguration.getParameters(ResolvedSiteMapItem), unless you want to access parameter values without having their property placeholders (like ${1}) substituded by the current request context. In other words, the parameter values exactly the way they are in the HstComponentConfiguration
      Returns:
      An unmodifiableMap of all parameters the way they are configured in the hst component configuration without having any property placeholder filled in by the current context

    • getRawLocalParameters

      Map<String,String> getRawLocalParameters()
      Also see getLocalParameters(ResolvedSiteMapItem). Normally, you use getLocalParameters(ResolvedSiteMapItem), unless you want to access parameter values without having their property placeholders (like ${1}) substituded by the current request context. In other words, the parameter values exactly the way they are in the HstComponentConfiguration. Note that this method does not return inherited parameters, but only its local (directly) configured ones
      Returns:
      An unmodifiableMap of all parameters the way they are configured in the hst component configuration without having any property placeholder filled in by the current context and without parameter inheritance

    • getRenderPath

      String getRenderPath()
      Returns:
      the location of the view renderer

    • getServeResourcePath

      String getServeResourcePath()
      Returns:
      return the servletpath of the servlet that must serve the resources for this HstComponent

    • getCanonicalPath

      String getCanonicalPath()
      Returns the canonical path of the backing stored configuration location. Note that multiple (many) ComponentConfiguration's can share the same canonical path: When a component is added by a reference, this method will return the same canonical path as the direct (not referenced) component.
      Returns:
      the canonical path of the backing stored configuration location.

    • getCanonicalIdentifier

      String getCanonicalIdentifier()
      Returns the identifier of the backing stored component configuration. Note that multiple ComponentConfiguration's can share the same canonical identifier due to inheritance. Also, multiple subsites can share the same backing configuration, and thus share the same canonical identifiers
      Returns:
      the identifier of the backing stored component configuration

    • getXType

      String getXType()
      Returns:
      the xtype of this ComponentConfiguration and null if the component does not have one

    • getCType

      String getCType()
      Returns:
      the ctype of this ComponentConfiguration and null if the component does not have one

    • getComponentType

      HstComponentConfiguration.Type getComponentType()
      Returns:
      the HstComponentConfiguration.Type of this ComponentConfiguration

    • getParametersInfoClassName

      String getParametersInfoClassName()
      Returns:
      if configured, the fully-qualified class name of the interface representing ParametersInfo for a component, and otherwise null.