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 of the graphql-ws protocol support.
Since:
4.0
Author:
Jeremy Grelle

  • Field Details

    • PREFIX

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

    • ENABLED_CONFIG

      public static final String ENABLED_CONFIG
      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_CONFIG

      public static final String PATH_CONFIG
      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:

    • DEFAULT_CONNECTION_TIMEOUT

      public static final Duration DEFAULT_CONNECTION_TIMEOUT
      The default connection initialisation wait timeout.

    • enabled

      protected boolean enabled

    • path

      protected String path

    • connectionInitWaitTimeout

      protected Duration connectionInitWaitTimeout

  • 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

    • setEnabled

      public void setEnabled(boolean enabled)
      Sets whether GraphQL websocket is enabled.
      Parameters:
      enabled - whether GraphQL websocket is enabled

    • getPath

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

    • setPath

      public void setPath(String path)
      Sets the GraphQL websocket path.
      Parameters:
      path - the GraphQL websocket path

    • getConnectionInitWaitTimeout

      public Duration getConnectionInitWaitTimeout()
      Returns the connection intialisation wait timeout.
      Returns:
      the connection intialisation wait timeout

    • setConnectionInitWaitTimeout

      public void setConnectionInitWaitTimeout(Duration connectionInitWaitTimeout)
      Sets the connection intialisation wait timeout.
      Parameters:
      connectionInitWaitTimeout - the connection intialisation wait timeout