Package io.micronaut.configuration.graphql

Class GraphQLConfiguration

java.lang.Object

io.micronaut.configuration.graphql.GraphQLConfiguration

All Implemented Interfaces:

io.micronaut.core.util.Toggleable

@ConfigurationProperties("graphql")
public class GraphQLConfiguration
extends Object
implements io.micronaut.core.util.Toggleable

Configuration properties for GraphQL.

Since:

1.0

Author:

Marcel Overdijk, James Kleeh

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GraphQLConfiguration.GraphiQLConfiguration	Configuration properties for GraphiQL.

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	DEFAULT_ENABLED	The default enabled value.
static final String	DEFAULT_PATH	The default GraphQL path.
protected boolean	enabled
static final String	ENABLED_CONFIG	The configuration name whether GraphQL is enabled.
protected GraphQLConfiguration.GraphiQLConfiguration	graphiql
protected String	path
static final String	PATH_CONFIG	The configuration name of the GraphQL path.
static final String	PREFIX	The prefix to use for all GraphQL configuration properties.

Constructor Summary

Constructors

Constructor	Description
GraphQLConfiguration()

Method Summary

Modifier and Type	Method	Description
GraphQLConfiguration.GraphiQLConfiguration	getGraphiql()	Returns the GraphiQL configuration.
String	getPath()	Returns the GraphQL path.
boolean	isEnabled()	Returns whether GraphQL is enabled.

Methods inherited from class java.lang.Object

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

Field Details

PREFIX

public static final String PREFIX

The prefix to use for all GraphQL configuration properties.

See Also:

• Constant Field Values

ENABLED_CONFIG

public static final String ENABLED_CONFIG

The configuration name whether GraphQL 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_CONFIG

public static final String PATH_CONFIG

The configuration name of the GraphQL path.

See Also:

• Constant Field Values

DEFAULT_PATH

public static final String DEFAULT_PATH

The default GraphQL path.

See Also:

• Constant Field Values

enabled

protected boolean enabled

path

protected String path

graphiql

protected GraphQLConfiguration.GraphiQLConfiguration graphiql

Constructor Details

GraphQLConfiguration

public GraphQLConfiguration()

Method Details

isEnabled

public boolean isEnabled()

Returns whether GraphQL is enabled.

Specified by:

isEnabled in interface io.micronaut.core.util.Toggleable

Returns:

whether GraphQL is enabled

getPath

public String getPath()

Returns the GraphQL path.

Returns:

the GraphQL path

getGraphiql

public GraphQLConfiguration.GraphiQLConfiguration getGraphiql()

Returns the GraphiQL configuration.

Returns:

the GraphiQL configuration