RestConfig

Configuration for REST handler

This can also be loaded from an externalized AKKA configuration file. For example:

rest-config {
# The version of your API. Required.
api-version="1.0"

# Root path to your API with the scheme, domain and port. Required.
# This is the path as seen by the end user and not from on the local server.
root-api-url=http://yourdomain.com/api

# Swagger definition version. Defaults to `1.1` if setting is omitted.
swagger-version="1.1"

# Path segments to group your APIs into Swagger resources. For exmaple, `/pet` is one resource
# while `/user` is another. Default is `1` which refers to the first relative path segment.
swagger-api-grouping-path-segment=1

# Number of seconds before a request is timed out.
# Defaults to `60` seconds if setting is omitted.
request-timeout-seconds=60

# Number of seconds before a SockoEvent is removed from the cache and cannot be accessed by
# your actor. Defaults to `5` if setting is omitted.
socko-event-cache-timeout-seconds=5

# Maximum number of workers per RestHandler
# Defaults to 100 if setting is omitted.
max-worker-count=100

# Reschedule a message for processing again using this delay when max worker count has been reached.
# Defaults to 500 if setting is omitted
max-worker-reschedule-milliseconds=500

# Determines if the message from runtime exceptions caught during handing of a REST request is returned
# to the caller in addition to the HTTP status code. Values are: `Never`, `BadRequestsOnly`,
# `InternalServerErrorOnly or `All`.
# Defaults to `Never` if setting is omitted
report-runtime-exception=Never

# Swagger details overriding the details loaded via reflection
overrides {
  classes = [{
    name = TestOverrideClass
    description = Test Override Description
    properties = [{
      name = Property1
      type = Int
      description = Description of Property 1
      required = true
    }]
  }]
}

}

can be loaded as follows:

object MyRestHandlerConfig extends ExtensionId[RestConfig] with ExtensionIdProvider {
  override def lookup = MyRestHandlerConfig
  override def createExtension(system: ExtendedActorSystem) =
    new RestConfig(system.settings.config, "rest-config")
}

val myRestConfig = MyRestHandlerConfig(actorSystem)

apiVersion

the version of your API

rootApiUrl

Root path to your API with the scheme, domain and port. For example, http://yourdomain.com/api. This is the path as seen by the end user and not from on the local server.

swaggerVersion

Swagger definition version

swaggerApiGroupingPathSegment

Path segments to group APIs by. Default is 1 which refers to the first relative path segment.

For example, the following will be grouped under the /pets because the the share pets in the 1st path segment.

/pets
/pets/{petId}
/pets/findById

requestTimeoutSeconds

Number of seconds before a request is timed out. Make sure that your processor actor responds within this number of seconds or throws an exception. Defaults to 60 seconds.

sockoEventCacheTimeoutSeconds

Number of seconds before a org.mashupbots.socko.events.SockoEvent is removed from the cache and cannot be accessed by the REST processor. Once the REST processor has access to the org.mashupbots.socko.events.SockoEvent, its expiry from the cache does not affect usability. The cache is just used as a means to pass the event. Defaults to 5 seconds.

maxWorkerCount

Maximum number of workers per org.mashupbots.socko.rest.RestHandler.

maxWorkerRescheduleMilliSeconds

Reschedule a message for processing again using this delay when max worker count has been reached.

reportRuntimeException

Determines if the message from runtime exceptions caught during handing of a REST request is returned to the caller in addition to the HTTP status code.

Two types of exceptions are raised: 400 Bad Requests and 500 Internal Server Error. If turned on, the message will be return in the response and the content type set to text/plain; charset=UTF-8.

overrides

Used to override the documentation associated with one or more classes, which will otherwise be created via reflection. The format of the override within application.conf is as follows:

overrides {
classes = [{
  name = <class name>
  description = <description>
  properties = [{
    name = <property name>
    type = <property type>
    description = <property description>
    required = <true or false>
    range {min=<min>, max=<max>} or list = [<value1>, <value2>, ... <valueN>] (optional)
  }]
}]
}

where class name = name of class without package (e.g. String instead of java.lang.String) description = brief text description of class property name = name of property within class property type = type of property (int, String, CustomClassName, etc) property description = brief text description of property required = true if property is required, else false if it is optional range or list = allowed values, or disregard if no allowable values are to be documented

Linear Supertypes

Serializable, Serializable, Product, Equals, Extension, AnyRef, Any

Instance Constructors

new RestConfig(config: Config, prefix: String)

Read configuration from AKKA's application.conf
new RestConfig(apiVersion: String, rootApiUrl: String, swaggerVersion: String = "1.1", swaggerApiGroupingPathSegment: Int = 1, requestTimeoutSeconds: Int = 60, sockoEventCacheTimeoutSeconds: Int = 5, maxWorkerCount: Int = 100, maxWorkerRescheduleMilliSeconds: Int = 500, reportRuntimeException: ReportRuntimeException.Value = ReportRuntimeException.Never, overrides: Map[String, SwaggerModel] = Map.empty)
apiVersion
the version of your API
rootApiUrl
Root path to your API with the scheme, domain and port. For example, http://yourdomain.com/api. This is the path as seen by the end user and not from on the local server.
swaggerVersion
Swagger definition version
swaggerApiGroupingPathSegment
Path segments to group APIs by. Default is 1 which refers to the first relative path segment.
For example, the following will be grouped under the /pets because the the share pets in the 1st path segment.
```
/pets
/pets/{petId}
/pets/findById
```
requestTimeoutSeconds
Number of seconds before a request is timed out. Make sure that your processor actor responds within this number of seconds or throws an exception. Defaults to 60 seconds.
sockoEventCacheTimeoutSeconds
Number of seconds before a org.mashupbots.socko.events.SockoEvent is removed from the cache and cannot be accessed by the REST processor. Once the REST processor has access to the org.mashupbots.socko.events.SockoEvent, its expiry from the cache does not affect usability. The cache is just used as a means to pass the event. Defaults to 5 seconds.
maxWorkerCount
Maximum number of workers per org.mashupbots.socko.rest.RestHandler.
maxWorkerRescheduleMilliSeconds
Reschedule a message for processing again using this delay when max worker count has been reached.
reportRuntimeException
Determines if the message from runtime exceptions caught during handing of a REST request is returned to the caller in addition to the HTTP status code.
Two types of exceptions are raised: 400 Bad Requests and 500 Internal Server Error. If turned on, the message will be return in the response and the content type set to text/plain; charset=UTF-8.
overrides
Used to override the documentation associated with one or more classes, which will otherwise be created via reflection. The format of the override within application.conf is as follows:
```
overrides {
classes = [{
  name = <class name>
  description = <description>
  properties = [{
    name = <property name>
    type = <property type>
    description = <property description>
    required = <true or false>
    range {min=<min>, max=<max>} or list = [<value1>, <value2>, ... <valueN>] (optional)
  }]
}]
}
```
where class name = name of class without package (e.g. String instead of java.lang.String) description = brief text description of class property name = name of property within class property type = type of property (int, String, CustomClassName, etc) property description = brief text description of property required = true if property is required, else false if it is optional range or list = allowed values, or disregard if no allowable values are to be documented

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val apiVersion: String

the version of your API
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val maxWorkerCount: Int

Maximum number of workers per org.mashupbots.socko.rest.RestHandler.
val maxWorkerRescheduleMilliSeconds: Int

Reschedule a message for processing again using this delay when max worker count has been reached.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val overrides: Map[String, SwaggerModel]

Used to override the documentation associated with one or more classes, which will otherwise be created via reflection.
Used to override the documentation associated with one or more classes, which will otherwise be created via reflection. The format of the override within application.conf is as follows:
```
overrides {
classes = [{
  name = <class name>
  description = <description>
  properties = [{
    name = <property name>
    type = <property type>
    description = <property description>
    required = <true or false>
    range {min=<min>, max=<max>} or list = [<value1>, <value2>, ... <valueN>] (optional)
  }]
}]
}
```
where class name = name of class without package (e.g. String instead of java.lang.String) description = brief text description of class property name = name of property within class property type = type of property (int, String, CustomClassName, etc) property description = brief text description of property required = true if property is required, else false if it is optional range or list = allowed values, or disregard if no allowable values are to be documented
val reportOn400BadRequests: Boolean
val reportOn500InternalServerError: Boolean
val reportRuntimeException: ReportRuntimeException.Value

Determines if the message from runtime exceptions caught during handing of a REST request is returned to the caller in addition to the HTTP status code.
Determines if the message from runtime exceptions caught during handing of a REST request is returned to the caller in addition to the HTTP status code.
Two types of exceptions are raised: 400 Bad Requests and 500 Internal Server Error. If turned on, the message will be return in the response and the content type set to text/plain; charset=UTF-8.
val requestTimeoutSeconds: Int

Number of seconds before a request is timed out.
Number of seconds before a request is timed out. Make sure that your processor actor responds within this number of seconds or throws an exception. Defaults to 60 seconds.
val rootApiURI: URI
val rootApiUrl: String

Root path to your API with the scheme, domain and port.
Root path to your API with the scheme, domain and port. For example, http://yourdomain.com/api. This is the path as seen by the end user and not from on the local server.
val rootPath: String
val schemeDomainPort: String
val sockoEventCacheTimeoutMilliSeconds: Int
val sockoEventCacheTimeoutSeconds: Int

Number of seconds before a org.mashupbots.socko.events.SockoEvent is removed from the cache and cannot be accessed by the REST processor.
Number of seconds before a org.mashupbots.socko.events.SockoEvent is removed from the cache and cannot be accessed by the REST processor. Once the REST processor has access to the org.mashupbots.socko.events.SockoEvent, its expiry from the cache does not affect usability. The cache is just used as a means to pass the event. Defaults to 5 seconds.
val swaggerApiGroupingPathSegment: Int

Path segments to group APIs by.
Path segments to group APIs by. Default is 1 which refers to the first relative path segment.
For example, the following will be grouped under the /pets because the the share pets in the 1st path segment.
```
/pets
/pets/{petId}
/pets/findById
```
val swaggerVersion: String

Swagger definition version
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Instance Constructors

new RestConfig(config: Config, prefix: String)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val apiVersion: String

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

val maxWorkerCount: Int

val maxWorkerRescheduleMilliSeconds: Int

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val overrides: Map[String, SwaggerModel]

val reportOn400BadRequests: Boolean

val reportOn500InternalServerError: Boolean

val reportRuntimeException: ReportRuntimeException.Value

val requestTimeoutSeconds: Int

val rootApiURI: URI

val rootApiUrl: String

val rootPath: String

val schemeDomainPort: String

val sockoEventCacheTimeoutMilliSeconds: Int

val sockoEventCacheTimeoutSeconds: Int

val swaggerApiGroupingPathSegment: Int

val swaggerVersion: String

final def synchronized[T0](arg0: ⇒ T0): T0

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Extension

Inherited from AnyRef

Inherited from Any

Ungrouped