Class

agora.rest

ServerConfig

Related Doc: package rest

Permalink

class ServerConfig extends RichConfigOps

A parsed configuration for our agora app

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ServerConfig
  2. RichConfigOps
  3. LowPriorityImplicits
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ServerConfig(config: Config)

    Permalink

Type Members

  1. implicit class RichArgs extends AnyRef

    Permalink
    Definition Classes
    LowPriorityImplicits
  2. implicit class RichMap extends AnyRef

    Permalink
    Definition Classes
    LowPriorityImplicits
  3. implicit class RichString extends AnyRef

    Permalink
    Definition Classes
    LowPriorityImplicits

Value Members

  1. final def !=(arg0: Any): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. def actorSystemName: String

    Permalink
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def asList(path: String, separator: Option[String] = Option(",")): List[String]

    Permalink

    produces a scala list, either from a StringList or a comma-separated string value

    produces a scala list, either from a StringList or a comma-separated string value

    path

    the config path

    separator

    if specified, the value at the given path will be parsed if it is a string and not a stringlist

    Definition Classes
    RichConfigOps
  7. implicit def asRichConfig(c: Config): RichConfig

    Permalink
    Definition Classes
    LowPriorityImplicits
  8. def chunkSize: Int

    Permalink
  9. lazy val clientConfig: ClientConfig

    Permalink

    We have server settings like this:

    We have server settings like this:

    host : abc
    port : 123
    
    client : {
      host : abc
      port : 123
    }

    To allow the user to override run-time client and server settings in light of the two-step typesafe config resolution, we allow the client to take on 'default' host and port values (empty string and 0, respectively) so that we can fall-back to (resolved) server host/port values.

  10. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. def collectAsMap: Map[String, String]

    Permalink
    Definition Classes
    RichConfigOps
  12. def collectAsStrings: List[(String, String)]

    Permalink
    Definition Classes
    RichConfigOps
  13. val config: Config

    Permalink
    Definition Classes
    ServerConfigRichConfigOps
  14. def describe(implicit opts: ConfigRenderOptions = concise().setFormatted(true)): String

    Permalink
    Definition Classes
    RichConfigOps
  15. def enableSupportRoutes: Boolean

    Permalink
  16. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  18. def filterNot(path: (String) ⇒ Boolean): Config

    Permalink
    Definition Classes
    RichConfigOps
  19. def finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  21. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  22. def host: String

    Permalink
  23. def hostLocationForConfig(c: Config): HostLocation

    Permalink
  24. def includeSwaggerRoutes: Boolean

    Permalink
  25. def includeUIRoutes: Boolean

    Permalink
  26. def intersect(other: Config): Config

    Permalink
    Definition Classes
    RichConfigOps
  27. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  28. def json: String

    Permalink
    Definition Classes
    RichConfigOps
  29. def launchBrowser: Boolean

    Permalink
  30. def location: HostLocation

    Permalink
  31. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  32. def newConfig(overrides: Map[String, String]): Config

    Permalink
    Attributes
    protected
  33. def newSystem(name: String = nextActorSystemName): AkkaImplicits

    Permalink
  34. def nextActorSystemName(): String

    Permalink
  35. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  36. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  37. def or(other: Config): Config

    Permalink
    Definition Classes
    RichConfigOps
  38. def pathRoots: List[String]

    Permalink
    Definition Classes
    RichConfigOps
  39. def paths: List[String]

    Permalink
    Definition Classes
    RichConfigOps
  40. def port: Int

    Permalink
  41. def runWithRoutes[T](routes: Route, svc: T): Future[RunningService[ServerConfig, T]]

    Permalink
  42. lazy val serverImplicits: AkkaImplicits

    Permalink
  43. def show(options: ConfigRenderOptions = ...): Option[String]

    Permalink

    If 'show' specified, either by just 'show' on its own or 'show=path.to.config.or.value', then this will return the configuration at that path

    If 'show' specified, either by just 'show' on its own or 'show=path.to.config.or.value', then this will return the configuration at that path

    returns

    the optional value of what's pointed to if 'show=<path>' is specified

    Definition Classes
    RichConfigOps
  44. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  45. def toString(): String

    Permalink
    Definition Classes
    ServerConfig → AnyRef → Any
  46. def unique: Config

    Permalink
    Definition Classes
    RichConfigOps
  47. def uniquePaths: List[String]

    Permalink

    And example which uses most of the below stuff to showcase what this is for Note : writing a 'diff' using this would be pretty straight forward

    And example which uses most of the below stuff to showcase what this is for Note : writing a 'diff' using this would be pretty straight forward

    Definition Classes
    RichConfigOps
  48. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  51. def waitOnUserInput: Boolean

    Permalink
  52. def withFallback(fallback: Config): ServerConfig

    Permalink
  53. def withOverrides(overrides: Config): ServerConfig

    Permalink
  54. def withPaths(paths: List[String]): Config

    Permalink
    Definition Classes
    RichConfigOps
  55. def withPaths(first: String, theRest: String*): Config

    Permalink
    Definition Classes
    RichConfigOps
  56. def withUserArgs(args: Array[String], unrecognizedArg: (String) ⇒ Config = ParseArg.Throw): Config

    Permalink

    args

    the user arguments in the form <key>=<value>, <filePath> or <fileOnTheClasspath>

    unrecognizedArg

    what to do with malformed user input

    returns

    a configuration with the given user-argument overrides applied over top

    Definition Classes
    RichConfigOps
  57. def without(paths: TraversableOnce[String]): Config

    Permalink
    Definition Classes
    RichConfigOps
  58. def without(firstPath: String, theRest: String*): Config

    Permalink
    Definition Classes
    RichConfigOps
  59. def without(other: Config): Config

    Permalink
    Definition Classes
    RichConfigOps
  60. def withoutSystem: Config

    Permalink

    this config w/o the system props and stuff

    this config w/o the system props and stuff

    Definition Classes
    RichConfigOps

Inherited from RichConfigOps

Inherited from LowPriorityImplicits

Inherited from AnyRef

Inherited from Any

Ungrouped