Class GraphQLApolloWsConfiguration
java.lang.Object
io.micronaut.configuration.graphql.ws.apollo.GraphQLApolloWsConfiguration
- All Implemented Interfaces:
io.micronaut.core.util.Toggleable
@Deprecated(since="4.0")
@ConfigurationProperties("graphql.graphql-apollo-ws")
public class GraphQLApolloWsConfiguration
extends Object
implements io.micronaut.core.util.Toggleable
Deprecated.
The Apollo subscriptions-transport-ws protocol is deprecated and its usage should be replaced with the new graphql-ws implementation.
Configuration properties for using a web socket with GraphQL.
- Since:
- 1.3
- Author:
- Gerard Klijs
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final booleanDeprecated.The default enabled value.static final booleanDeprecated.The default keep alive enabled value.static final StringDeprecated.The default keep alive interval value.static final StringDeprecated.The default GraphQL websocket path.protected booleanDeprecated.static final StringDeprecated.The configuration name whether the GraphQL websocket is enabled.static final StringDeprecated.The configuration name of the GraphQL keep alive enabled path..static final StringDeprecated.The configuration name of the GraphQL keep alive interval path..protected booleanDeprecated.protected StringDeprecated.protected StringDeprecated.static final StringDeprecated.The configuration name of the GraphQL websocket path.static final StringDeprecated.The prefix to use for all GraphQL websocket configuration properties. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionDeprecated.Returns the GraphQL keep alive interval in seconds.getPath()Deprecated.Returns the GraphQL websocket path.booleanDeprecated.Returns whether GraphQL websocket is enabled.booleanDeprecated.Returns whether GraphQL websocket keep alive is enabled.voidsetEnabled(boolean enabled) Deprecated.Sets whether GraphQL websocket is enabled.voidsetKeepAliveEnabled(boolean keepAliveEnabled) Deprecated.Sets whether GraphQL websocket keep alive is enabled.voidsetKeepAliveInterval(String keepAliveInterval) Deprecated.Sets the GraphQL keep alive interval in seconds.voidDeprecated.Sets the GraphQL websocket path.
-
Field Details
-
PREFIX
Deprecated.The prefix to use for all GraphQL websocket configuration properties.- See Also:
-
ENABLED_CONFIG
Deprecated.The configuration name whether the GraphQL websocket is enabled.- See Also:
-
DEFAULT_ENABLED
public static final boolean DEFAULT_ENABLEDDeprecated.The default enabled value.- See Also:
-
PATH_CONFIG
Deprecated.The configuration name of the GraphQL websocket path.- See Also:
-
DEFAULT_PATH
Deprecated.The default GraphQL websocket path.- See Also:
-
KEEP_ALIVE_ENABLED_CONFIG
Deprecated.The configuration name of the GraphQL keep alive enabled path..- See Also:
-
DEFAULT_KEEP_ALIVE_ENABLED
public static final boolean DEFAULT_KEEP_ALIVE_ENABLEDDeprecated.The default keep alive enabled value.- See Also:
-
KEEP_ALIVE_INTERVAL_CONFIG
Deprecated.The configuration name of the GraphQL keep alive interval path..- See Also:
-
DEFAULT_KEEP_ALIVE_INTERVAL
Deprecated.The default keep alive interval value.- See Also:
-
enabled
protected boolean enabledDeprecated. -
path
Deprecated. -
keepAliveEnabled
protected boolean keepAliveEnabledDeprecated. -
keepAliveInterval
Deprecated.
-
-
Constructor Details
-
GraphQLApolloWsConfiguration
public GraphQLApolloWsConfiguration()Deprecated.
-
-
Method Details
-
isEnabled
public boolean isEnabled()Deprecated.Returns whether GraphQL websocket is enabled.- Specified by:
isEnabledin interfaceio.micronaut.core.util.Toggleable- Returns:
- whether GraphQL websocket is enabled
-
setEnabled
public void setEnabled(boolean enabled) Deprecated.Sets whether GraphQL websocket is enabled.- Parameters:
enabled- whether GraphQL websocket is enabled
-
getPath
Deprecated.Returns the GraphQL websocket path.- Returns:
- the GraphQL websocket path
-
setPath
Deprecated.Sets the GraphQL websocket path.- Parameters:
path- the GraphQL websocket path
-
isKeepAliveEnabled
public boolean isKeepAliveEnabled()Deprecated.Returns whether GraphQL websocket keep alive is enabled.- Returns:
- whether GraphQL websocket keep alive is enabled
-
setKeepAliveEnabled
public void setKeepAliveEnabled(boolean keepAliveEnabled) Deprecated.Sets whether GraphQL websocket keep alive is enabled.- Parameters:
keepAliveEnabled- whether GraphQL websocket keep alive is enabled
-
getKeepAliveInterval
Deprecated.Returns the GraphQL keep alive interval in seconds.- Returns:
- the GraphQL keep alive interval in seconds
-
setKeepAliveInterval
Deprecated.Sets the GraphQL keep alive interval in seconds.- Parameters:
keepAliveInterval- the GraphQL keep alive interval in seconds
-