Packages

class Async3ChannelParser extends OasLikeEndpointParser

AsyncAPI 3.0 Channel parser.

In AsyncAPI 3.0 the channels object is keyed by a user-defined channel id (NOT a path/URL). The channel id becomes EndPoint.name; the address field carries the destination (mapped to EndPoint.path).

Channel-scoped fields parsed here:

  • id (YAML key) → EndPoint.name and EndPoint.path (address or key when address absent)
  • address → EndPoint.path
  • title → EndPoint.title
  • description → EndPoint.description
  • summary → EndPoint.summary
  • messages → EndPoint.messages (object-map of Message; each entry parsed via factory)
  • servers → EndPoint.servers (array of $$ref strings; resolved to real servers by ChannelServersResolutionStage)
  • parameters → EndPoint.parameters
  • bindings → EndPoint.bindings
  • tags → EndPoint.tags
  • externalDocs → EndPoint.documentation

Operations in 3.0 are top-level; a channel has NO nested operations. The factory's operationParser method must never be called for a 3.0 channel, and it throws an IllegalStateException if invoked (see Async3VersionFactory).

Note: This class must satisfy the OasLikeEndpointParser interface expected by AsyncApiDocumentParser.parseChannels. We extend OasLikeEndpointParser and override parse() entirely so that the superclass path-template logic is bypassed.

Linear Supertypes
OasLikeEndpointParser, SpecParserOps, QuickFieldParserOps, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Async3ChannelParser
  2. OasLikeEndpointParser
  3. SpecParserOps
  4. QuickFieldParserOps
  5. AnyRef
  6. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Async3ChannelParser(entry: YMapEntry, parentId: String, collector: List[EndPoint])(implicit ctx: AsyncWebApiContext)

Type Members

  1. type ConcreteContext = AsyncWebApiContext
    Definition Classes
    Async3ChannelParser → OasLikeEndpointParser
  2. implicit class FieldOps extends AnyRef
    Definition Classes
    QuickFieldParserOps
  3. class ObjectField extends (YMapEntry) ⇒ Unit
    Definition Classes
    QuickFieldParserOps
  4. trait Target extends AnyRef
    Definition Classes
    QuickFieldParserOps

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from Async3ChannelParser to any2stringadd[Async3ChannelParser] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Async3ChannelParser, B)
    Implicit
    This member is added by an implicit conversion from Async3ChannelParser to ArrowAssoc[Async3ChannelParser] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def apply(entry: YMapEntry, parentId: String, collector: List[EndPoint])(ctx: ConcreteContext): Async3ChannelParser
    Definition Classes
    Async3ChannelParser → OasLikeEndpointParser
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def checkBalancedParams(path: String, value: YNode, node: AmfObject, property: String, ctx: WebApiContext): Unit
    Attributes
    protected
    Definition Classes
    SpecParserOps
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @IntrinsicCandidate()
  10. implicit val ctx: AsyncWebApiContext
    Definition Classes
    Async3ChannelParser → OasLikeEndpointParser
  11. def ensuring(cond: (Async3ChannelParser) ⇒ Boolean, msg: ⇒ Any): Async3ChannelParser
    Implicit
    This member is added by an implicit conversion from Async3ChannelParser to Ensuring[Async3ChannelParser] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: (Async3ChannelParser) ⇒ Boolean): Async3ChannelParser
    Implicit
    This member is added by an implicit conversion from Async3ChannelParser to Ensuring[Async3ChannelParser] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean, msg: ⇒ Any): Async3ChannelParser
    Implicit
    This member is added by an implicit conversion from Async3ChannelParser to Ensuring[Async3ChannelParser] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean): Async3ChannelParser
    Implicit
    This member is added by an implicit conversion from Async3ChannelParser to Ensuring[Async3ChannelParser] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  17. def getAnnotationsFromMap(map: YMap, key: String): Annotations
    Attributes
    protected
    Definition Classes
    SpecParserOps
  18. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  24. def parse(): Option[EndPoint]

    Override parse() to implement 3.0-specific channel logic.

    Override parse() to implement 3.0-specific channel logic.

    In 3.0 the YAML key is a channel id, not a path, so we skip the TemplateUri validation that the superclass parse() applies. The id becomes both name and (initially) path; the actual address value then overrides path if present.

    Definition Classes
    Async3ChannelParser → OasLikeEndpointParser
  25. def parseEndpoint(endpoint: EndPoint): Option[EndPoint]
    Attributes
    protected
    Definition Classes
    OasLikeEndpointParser
  26. def parseEndpointMap(endpoint: EndPoint, map: YMap): EndPoint
    Attributes
    protected
    Definition Classes
    OasLikeEndpointParser
  27. def parseOperations(entries: Iterable[YMapEntry]): Seq[Operation]
    Attributes
    protected
    Definition Classes
    OasLikeEndpointParser
  28. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  29. def toString(): String
    Definition Classes
    AnyRef → Any
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. def →[B](y: B): (Async3ChannelParser, B)
    Implicit
    This member is added by an implicit conversion from Async3ChannelParser to ArrowAssoc[Async3ChannelParser] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated
  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Async3ChannelParser to StringFormat[Async3ChannelParser] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

Inherited from OasLikeEndpointParser

Inherited from SpecParserOps

Inherited from QuickFieldParserOps

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Async3ChannelParser to any2stringadd[Async3ChannelParser]

Inherited by implicit conversion StringFormat from Async3ChannelParser to StringFormat[Async3ChannelParser]

Inherited by implicit conversion Ensuring from Async3ChannelParser to Ensuring[Async3ChannelParser]

Inherited by implicit conversion ArrowAssoc from Async3ChannelParser to ArrowAssoc[Async3ChannelParser]

Ungrouped