Package io.micronaut.configuration.graphql.ws

Class GraphQLWsConfiguration

java.lang.Object
io.micronaut.configuration.graphql.ws.GraphQLWsConfiguration
All Implemented Interfaces:
io.micronaut.core.util.Toggleable
@ConfigurationProperties("graphql.graphql-ws") public class GraphQLWsConfiguration extends Object implements io.micronaut.core.util.Toggleable
Configuration properties for using a web socket with GraphQL.
Since:
1.3
Author:
Gerard Klijs

  • Field Details

    • PREFIX

      public static final String PREFIX
      The prefix to use for all GraphQL websocket configuration properties.
      See Also:

    • ENABLED

      public static final String ENABLED
      The configuration name whether the GraphQL websocket is enabled.
      See Also:

    • DEFAULT_ENABLED

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

    • PATH

      public static final String PATH
      The configuration name of the GraphQL websocket path.
      See Also:

    • DEFAULT_PATH

      public static final String DEFAULT_PATH
      The default GraphQL websocket path.
      See Also:

    • KEEP_ALIVE_ENABLED

      public static final String KEEP_ALIVE_ENABLED
      The configuration name of the GraphQL keep alive enabled path..
      See Also:

    • DEFAULT_KEEP_ALIVE_ENABLED

      public static final boolean DEFAULT_KEEP_ALIVE_ENABLED
      The default keep alive enabled value.
      See Also:

    • KEEP_ALIVE_INTERVAL

      public static final String KEEP_ALIVE_INTERVAL
      The configuration name of the GraphQL keep alive interval path..
      See Also:

    • DEFAULT_KEEP_ALIVE_INTERVAL

      public static final String DEFAULT_KEEP_ALIVE_INTERVAL
      The default keep alive interval value.
      See Also:

    • enabled

      protected boolean enabled

    • path

      protected String path

    • keepAliveEnabled

      protected boolean keepAliveEnabled

    • keepAliveInterval

      protected String keepAliveInterval

  • Constructor Details

    • GraphQLWsConfiguration

      public GraphQLWsConfiguration()

  • Method Details

    • isEnabled

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

    • getPath

      public String getPath()
      Returns the GraphQL websocket path.
      Returns:
      the GraphQL websocket path

    • isKeepAliveEnabled

      public boolean isKeepAliveEnabled()
      Returns whether GraphQL websocket keep alive is enabled.
      Returns:
      whether GraphQL websocket keep alive is enabled

    • getKeepAliveInterval

      public String getKeepAliveInterval()
      Returns the GraphQL keep alive interval in seconds.
      Returns:
      the GraphQL keep alive interval in seconds