Package io.gravitee.gateway.reactive.api.connector.entrypoint

Interface BaseEntrypointConnector<C extends BaseExecutionContext>

All Superinterfaces:
Connector, io.gravitee.common.component.LifecycleComponent<Connector>
All Known Subinterfaces:
EntrypointConnector, HttpEntrypointConnector, TcpEntrypointConnector
All Known Implementing Classes:
EntrypointAsyncConnector, EntrypointSyncConnector, HttpEntrypointAsyncConnector, HttpEntrypointSyncConnector
public interface BaseEntrypointConnector<C extends BaseExecutionContext> extends Connector
Interface describing Entrypoint Connector which could be implemented to deal with new protocol specification
Author:
GraviteeSource Team

  • Method Summary

    Modifier and Type
    Method
    Description
    io.reactivex.rxjava3.core.Completable
    handleRequest(C ctx)
    Handle incoming request by doing or adding anything to the context anything required by the entrypoint.
    io.reactivex.rxjava3.core.Completable
    handleResponse(C ctx)
    Handle outgoing response by doing or adding anything to the context anything required by the entrypoint.
    int
    matchCriteriaCount()
    Returns the number of criteria used in {matches(C).
    boolean
    matches(C ctx)
    Check if incoming request matches entrypoint criteria.
    ListenerType
    supportedListenerType()
    Returns the ListenerType supported by this entrypoint.

    Methods inherited from interface io.gravitee.gateway.reactive.api.connector.Connector

    id, supportedApi, supportedModes

    Methods inherited from interface io.gravitee.common.component.LifecycleComponent

    lifecycleState, postStart, postStop, preStart, preStop, start, stop

  • Method Details

    • supportedListenerType

      ListenerType supportedListenerType()
      Returns the ListenerType supported by this entrypoint. It will be used to filter available entrypoint when creating a new API
      Returns:
      ListenerType supported by this entrypoint.

    • matchCriteriaCount

      int matchCriteriaCount()
      Returns the number of criteria used in {matches(C). This number is used to sort compatible entrypoint from a request in the descending order.
      Returns:
      Number of criteria used in {matches(C)

    • matches

      boolean matches(C ctx)
      Check if incoming request matches entrypoint criteria.
      Returns:
      true if the incoming request matches all criteria, false otherwise

    • handleRequest

      io.reactivex.rxjava3.core.Completable handleRequest(C ctx)
      Handle incoming request by doing or adding anything to the context anything required by the entrypoint.
      Returns:
      Completable

    • handleResponse

      io.reactivex.rxjava3.core.Completable handleResponse(C ctx)
      Handle outgoing response by doing or adding anything to the context anything required by the entrypoint.
      Returns:
      Completable