GrpcSessionConfigurationBean (Coherence Spring Docs 3.1.0 API)

java.lang.Object
- com.oracle.coherence.spring.configuration.session.AbstractSessionConfigurationBean
- - com.oracle.coherence.spring.configuration.session.GrpcSessionConfigurationBean

All Implemented Interfaces:

SessionConfigurationProvider
```
public class GrpcSessionConfigurationBean
extends AbstractSessionConfigurationBean
```
A GrpcSessionConfiguration bean that will be created for each named session in the application configuration properties.
This configuration bean specifically produces GrpcSessionConfiguration beans only if the configuration has a channelName property. The channelName refers to the name of a Channel bean.
Sessions are configured with the coherence.session prefix, for example coherence.session.foo configures a session named foo.
The session name default is a special case that configures the default session named Coherence.DEFAULT_NAME.

Since:

3.0

Author:

Gunnar Hillert

See Also:

GrpcSessionConfiguration

Field Summary
- Fields inherited from class com.oracle.coherence.spring.configuration.session.AbstractSessionConfigurationBean
  DEFAULT_SESSION_NAME

Constructor Summary

Constructors
Constructor	Description
`GrpcSessionConfigurationBean()`
`GrpcSessionConfigurationBean(String name, ConfigurableApplicationContext ctx)`	Create a named `GrpcSessionConfigurationBean`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Optional<com.tangosol.net.SessionConfiguration>`	`getConfiguration()`	Returns the optional `SessionConfiguration` that is provider provides.
`void`	`setChannelName(String channelName)`	Set the name of the gRPC `Channel` bean.
`void`	`setSerializer(String serializer)`	Set the name of the `Serializer`.
`void`	`setTracing(boolean enabled)`	Set whether distributed tracing should be enabled.

Methods inherited from class com.oracle.coherence.spring.configuration.session.AbstractSessionConfigurationBean
getName, getPriority, getScopeName, getType, setName, setPriority, setScopeName, setType

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GrpcSessionConfigurationBean
```
public GrpcSessionConfigurationBean(String name,
                                    ConfigurableApplicationContext ctx)
```
    Create a named GrpcSessionConfigurationBean.
    
    Parameters:
    
    name - the name for the session
    
    ctx - the Spring application context
  - GrpcSessionConfigurationBean
```
public GrpcSessionConfigurationBean()
```
- Method Detail
  - getConfiguration
```
public Optional<com.tangosol.net.SessionConfiguration> getConfiguration()
```
    Description copied from interface: SessionConfigurationProvider
    
    Returns the optional SessionConfiguration that is provider provides.
    
    Returns:
    
    the optional SessionConfiguration that is provider provides or an empty Optional if this provider cannot provide a configuration
  - setChannelName
```
public void setChannelName(String channelName)
```
    Set the name of the gRPC Channel bean.
    
    Parameters:
    
    channelName - the name of the gRPC Channel bean
  - setSerializer
```
public void setSerializer(String serializer)
```
    Set the name of the Serializer.
    
    Parameters:
    
    serializer - the name of the Serializer
  - setTracing
```
public void setTracing(boolean enabled)
```
    Set whether distributed tracing should be enabled.
    
    Parameters:
    
    enabled - true to enable distributed tracing