com.linecorp.armeria.server.ServiceConfig

public final class ServiceConfig
extends Object

An HttpService configuration.

See Also:: ServerConfig.serviceConfigs(), VirtualHost.serviceConfigs()

Method Summary

Modifier and Type	Method	Description
`AccessLogWriter`	`accessLogWriter()`	Returns the access log writer.
`String`	`defaultLogName()`	Returns the default value of the `RequestOnlyLog.name()` property which is used when no name was set via `RequestLogBuilder.name(String, String)`.
`String`	`defaultServiceName()`	Returns the default value of the `RequestOnlyLog.serviceName()` property which is used when no service name was set via `RequestLogBuilder.name(String, String)`.
`long`	`maxRequestLength()`	Returns the maximum allowed length of the content decoded at the session layer.
`long`	`requestTimeoutMillis()`	Returns the timeout of a request.
`Route`	`route()`	Returns the `Route` of the `service()`.
`Server`	`server()`	Returns the `Server` the `service()` belongs to.
`HttpService`	`service()`	Returns the `HttpService`.
`boolean`	`shutdownAccessLogWriterOnStop()`	Tells whether the `AccessLogWriter` is shut down when the `Server` stops.
`String`	`toString()`
`Set<TransientServiceOption>`	`transientServiceOptions()`	Returns the `Set` of `TransientServiceOption`s that are enabled for the `service()`.
`boolean`	`verboseResponses()`	Returns whether the verbose response mode is enabled.
`VirtualHost`	`virtualHost()`	Returns the `VirtualHost` the `service()` belongs to.

Methods inherited from class java.lang.Object

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

Method Details
- virtualHost
  
  public VirtualHost virtualHost()
  
  Returns the VirtualHost the service() belongs to.
- server
  
  public Server server()
  
  Returns the Server the service() belongs to.
- route
  
  public Route route()
  
  Returns the Route of the service().
- service
  
  public HttpService service()
  
  Returns the HttpService.
- defaultServiceName
  
  @Nullable public String defaultServiceName()
  Returns the default value of the RequestOnlyLog.serviceName() property which is used when no service name was set via RequestLogBuilder.name(String, String). If null, one of the following values will be used instead:
  
  gRPC - a service name (e.g, com.foo.GrpcService)
  
  Thrift - a service type (e.g, com.foo.ThriftService$AsyncIface or com.foo.ThriftService$Iface)
  
  HttpService and annotated service - an innermost class name
- defaultLogName
  
  @Nullable public String defaultLogName()
  Returns the default value of the RequestOnlyLog.name() property which is used when no name was set via RequestLogBuilder.name(String, String). If null, one of the following values will be used instead:
  
  gRPC - A capitalized method name defined in io.grpc.MethodDescriptor (e.g, GetItems)
  
  Thrift and annotated service - a method name (e.g, getItems)
  
  HttpService - an HTTP method name
- requestTimeoutMillis
  
  public long requestTimeoutMillis()
  
  Returns the timeout of a request.
  
  See Also:
  
  VirtualHost.requestTimeoutMillis()
- maxRequestLength
  
  public long maxRequestLength()
  
  Returns the maximum allowed length of the content decoded at the session layer. e.g. the content length of an HTTP request.
  
  See Also:
  
  VirtualHost.maxRequestLength()
- verboseResponses
  
  public boolean verboseResponses()
  
  Returns whether the verbose response mode is enabled. When enabled, the service response will contain the exception type and its full stack trace, which may be useful for debugging while potentially insecure. When disabled, the service response will not expose such server-side details to the client.
  
  See Also:
  
  VirtualHost.verboseResponses()
- accessLogWriter
  
  public AccessLogWriter accessLogWriter()
  
  Returns the access log writer.
  
  See Also:
  
  VirtualHost.accessLogWriter()
- shutdownAccessLogWriterOnStop
  
  public boolean shutdownAccessLogWriterOnStop()
  
  Tells whether the AccessLogWriter is shut down when the Server stops.
  
  See Also:
  
  VirtualHost.shutdownAccessLogWriterOnStop()
- transientServiceOptions
  
  public Set<TransientServiceOption> transientServiceOptions()
  
  Returns the Set of TransientServiceOptions that are enabled for the service(). This method always returns TransientServiceOption.allOf() for a non-TransientService because only a TransientService can opt in and out using TransientServiceBuilder.transientServiceOptions(TransientServiceOption...).
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Object

Class ServiceConfig

Method Summary

Methods inherited from class java.lang.Object

Method Details