Package io.micronaut.configuration.graphql

Class GraphQLConfiguration.GraphiQLConfiguration

  • All Implemented Interfaces:
    io.micronaut.core.util.Toggleable
    Enclosing class:
    GraphQLConfiguration
    @ConfigurationProperties("graphiql")
public static class GraphQLConfiguration.GraphiQLConfiguration
extends java.lang.Object
implements io.micronaut.core.util.Toggleable
    Configuration properties for GraphiQL.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static boolean DEFAULT_ENABLED
      The default enabled value.
      static java.lang.String DEFAULT_PAGE_TITLE
      The default GraphiQL page title.
      static java.lang.String DEFAULT_PATH
      The default GraphiQL path.
      static java.util.Map<java.lang.String,​java.lang.String> DEFAULT_TEMPLATE_PARAMETERS
      The default GraphiQL template parameters.
      static java.lang.String DEFAULT_TEMPLATE_PATH
      The default GraphiQL template path.
      static java.lang.String DEFAULT_VERSION
      The default GraphiQL version.
      protected boolean enabled  
      static java.lang.String ENABLED
      The configuration name whether GraphiQL is enabled.
      static java.lang.String PAGE_TITLE
      The configuration name of the GraphiQL page title.
      protected java.lang.String pageTitle  
      protected java.lang.String path  
      static java.lang.String PATH
      The configuration name of the GraphiQL path.
      static java.lang.String PREFIX
      The prefix to use for all GraphiQL configuration properties.
      static java.lang.String TEMPLATE_PARAMETERS
      The configuration name of the GraphiQL template parameters.
      static java.lang.String TEMPLATE_PATH
      The configuration name of the GraphiQL template path.
      protected java.util.Map<java.lang.String,​java.lang.String> templateParameters  
      protected java.lang.String templatePath  
      protected java.lang.String version  
      static java.lang.String VERSION
      The configuration name of the GraphiQL version.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getPageTitle()
      Returns the GraphiQL page title.
      java.lang.String getPath()
      Returns the GraphiQL path.
      java.util.Map<java.lang.String,​java.lang.String> getTemplateParameters()
      Returns the GraphiQL template parameters to be substituted in the template.
      java.lang.String getTemplatePath()
      Returns the GraphiQL template path.
      java.lang.String getVersion()
      Returns the GraphiQL version.
      boolean isEnabled()
      Returns whether GraphiQL is enabled.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • PREFIX

        public static final java.lang.String PREFIX
        The prefix to use for all GraphiQL configuration properties.
        See Also:
        Constant Field Values

      • ENABLED

        public static final java.lang.String ENABLED
        The configuration name whether GraphiQL is enabled.
        See Also:
        Constant Field Values

      • DEFAULT_ENABLED

        public static final boolean DEFAULT_ENABLED
        The default enabled value.
        See Also:
        Constant Field Values

      • VERSION

        public static final java.lang.String VERSION
        The configuration name of the GraphiQL version.
        See Also:
        Constant Field Values

      • DEFAULT_VERSION

        public static final java.lang.String DEFAULT_VERSION
        The default GraphiQL version.
        See Also:
        Constant Field Values

      • PATH

        public static final java.lang.String PATH
        The configuration name of the GraphiQL path.
        See Also:
        Constant Field Values

      • DEFAULT_PATH

        public static final java.lang.String DEFAULT_PATH
        The default GraphiQL path.
        See Also:
        Constant Field Values

      • TEMPLATE_PATH

        public static final java.lang.String TEMPLATE_PATH
        The configuration name of the GraphiQL template path.
        See Also:
        Constant Field Values

      • DEFAULT_TEMPLATE_PATH

        public static final java.lang.String DEFAULT_TEMPLATE_PATH
        The default GraphiQL template path.
        See Also:
        Constant Field Values

      • TEMPLATE_PARAMETERS

        public static final java.lang.String TEMPLATE_PARAMETERS
        The configuration name of the GraphiQL template parameters.
        See Also:
        Constant Field Values

      • DEFAULT_TEMPLATE_PARAMETERS

        public static final java.util.Map<java.lang.String,​java.lang.String> DEFAULT_TEMPLATE_PARAMETERS
        The default GraphiQL template parameters.

      • PAGE_TITLE

        public static final java.lang.String PAGE_TITLE
        The configuration name of the GraphiQL page title.
        See Also:
        Constant Field Values

      • DEFAULT_PAGE_TITLE

        public static final java.lang.String DEFAULT_PAGE_TITLE
        The default GraphiQL page title.
        See Also:
        Constant Field Values

      • enabled

        protected boolean enabled

      • version

        protected java.lang.String version

      • path

        protected java.lang.String path

      • templatePath

        protected java.lang.String templatePath

      • templateParameters

        protected java.util.Map<java.lang.String,​java.lang.String> templateParameters

      • pageTitle

        protected java.lang.String pageTitle

    • Constructor Detail

      • GraphiQLConfiguration

        public GraphiQLConfiguration()

    • Method Detail

      • isEnabled

        public boolean isEnabled()
        Returns whether GraphiQL is enabled.
        Specified by:
        isEnabled in interface io.micronaut.core.util.Toggleable
        Returns:
        whether GraphiQL is enabled

      • getVersion

        public java.lang.String getVersion()
        Returns the GraphiQL version.
        Returns:
        the GraphiQL version

      • getPath

        public java.lang.String getPath()
        Returns the GraphiQL path.
        Returns:
        the GraphiQL path

      • getTemplatePath

        public java.lang.String getTemplatePath()
        Returns the GraphiQL template path.
        Returns:
        the GraphiQL template path

      • getTemplateParameters

        public java.util.Map<java.lang.String,​java.lang.String> getTemplateParameters()
        Returns the GraphiQL template parameters to be substituted in the template.
        Returns:
        the GraphiQL template parameters

      • getPageTitle

        public java.lang.String getPageTitle()
        Returns the GraphiQL page title.
        Returns:
        the GraphiQL page title