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(value="graphql.graphql-ws")
public class GraphQLWsConfiguration
extends java.lang.Object
implements io.micronaut.core.util.Toggleable

Configuration properties for using a web socket with GraphQL.

Since:

1.3

Author:

Gerard Klijs

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_ENABLED The default enabled value.
static boolean	DEFAULT_KEEP_ALIVE_ENABLED The default keep alive enabled value.
static java.lang.String	DEFAULT_KEEP_ALIVE_INTERVAL The default keep alive interval value.
static java.lang.String	DEFAULT_PATH The default GraphQL websocket path.
protected boolean	enabled
static java.lang.String	ENABLED The configuration name whether the GraphQL websocket is enabled.
static java.lang.String	KEEP_ALIVE_ENABLED The configuration name of the GraphQL keep alive enabled path..
static java.lang.String	KEEP_ALIVE_INTERVAL The configuration name of the GraphQL keep alive interval path..
protected boolean	keepAliveEnabled
protected java.lang.String	keepAliveInterval
protected java.lang.String	path
static java.lang.String	PATH The configuration name of the GraphQL websocket path.
static java.lang.String	PREFIX The prefix to use for all GraphQL websocket configuration properties.

Constructor Summary

Constructors

Constructor and Description
GraphQLWsConfiguration()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getKeepAliveInterval() Returns the GraphQL keep alive interval in seconds.
java.lang.String	getPath() Returns the GraphQL websocket path.
boolean	isEnabled() Returns whether GraphQL websocket is enabled.
boolean	isKeepAliveEnabled() Returns whether GraphQL websocket keep alive 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 GraphQL websocket configuration properties.

See Also:

Constant Field Values

ENABLED

public static final java.lang.String ENABLED

The configuration name whether the GraphQL websocket is enabled.

See Also:

Constant Field Values

DEFAULT_ENABLED

public static final boolean DEFAULT_ENABLED

The default enabled value.

See Also:

Constant Field Values

PATH

public static final java.lang.String PATH

The configuration name of the GraphQL websocket path.

See Also:

Constant Field Values

DEFAULT_PATH

public static final java.lang.String DEFAULT_PATH

The default GraphQL websocket path.

See Also:

Constant Field Values

KEEP_ALIVE_ENABLED

public static final java.lang.String KEEP_ALIVE_ENABLED

The configuration name of the GraphQL keep alive enabled path..

See Also:

Constant Field Values

DEFAULT_KEEP_ALIVE_ENABLED

public static final boolean DEFAULT_KEEP_ALIVE_ENABLED

The default keep alive enabled value.

See Also:

Constant Field Values

KEEP_ALIVE_INTERVAL

public static final java.lang.String KEEP_ALIVE_INTERVAL

The configuration name of the GraphQL keep alive interval path..

See Also:

Constant Field Values

DEFAULT_KEEP_ALIVE_INTERVAL

public static final java.lang.String DEFAULT_KEEP_ALIVE_INTERVAL

The default keep alive interval value.

See Also:

Constant Field Values

enabled

protected boolean enabled

path

protected java.lang.String path

keepAliveEnabled

protected boolean keepAliveEnabled

keepAliveInterval

protected java.lang.String keepAliveInterval

Constructor Detail

GraphQLWsConfiguration

public GraphQLWsConfiguration()

Method Detail

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 java.lang.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 java.lang.String getKeepAliveInterval()

Returns the GraphQL keep alive interval in seconds.

Returns:

the GraphQL keep alive interval in seconds