Class HttpServiceSparqlEndpoint

constructor

• new HttpServiceSparqlEndpoint(
      args: IHttpServiceSparqlEndpointArgs,
  ): HttpServiceSparqlEndpoint

• Parameters

  • args: IHttpServiceSparqlEndpointArgs

  Returns HttpServiceSparqlEndpoint

Readonlycontext

ReadonlycontextOverride

Readonlyengine

ReadonlyfreshWorkerPerQuery

lastQueryId

Readonlyport

Readonlytimeout

Readonlyworkers

Static ReadonlyMIME_JSON

Static ReadonlyMIME_PLAIN

handleRequest

• handleRequest(
      engine: QueryEngineBase<
          IQueryContextCommon,
          QueryStringContext,
          QueryAlgebraContext,
      >,
      variants: { quality: number; type: string }[],
      stdout: Writable,
      stderr: Writable,
      request: IncomingMessage,
      response: ServerResponse<IncomingMessage>,
  ): Promise<void>

• Handles an HTTP request.

  Parameters

  • engine: QueryEngineBase<IQueryContextCommon, QueryStringContext, QueryAlgebraContext>

    A SPARQL engine.
  • variants: { quality: number; type: string }[]

    Allowed variants.
  • stdout: Writable

    Output stream.
  • stderr: Writable

    Error output stream.
  • request: IncomingMessage

    Request object.
  • response: ServerResponse<IncomingMessage>

    Response object.

  Returns Promise<void>

parseBody

• parseBody(request: IncomingMessage): Promise<IQueryBody>

• Parses the body of a SPARQL POST request

  Parameters

  • request: IncomingMessage

    Request object.

  Returns Promise<IQueryBody>

  A promise resolving to a query body object.

run

• run(stdout: Writable, stderr: Writable): Promise<void>

• Start the HTTP service.

  Parameters

  • stdout: Writable

    The output stream to log to.
  • stderr: Writable

    The error stream to log errors to.

  Returns Promise<void>

runMaster

• runMaster(stdout: Writable, stderr: Writable): Promise<void>

• Start the HTTP service as master.

  Parameters

  • stdout: Writable

    The output stream to log to.
  • stderr: Writable

    The error stream to log errors to.

  Returns Promise<void>

runWorker

• runWorker(stdout: Writable, stderr: Writable): Promise<void>

• Start the HTTP service as worker.

  Parameters

  • stdout: Writable

    The output stream to log to.
  • stderr: Writable

    The error stream to log errors to.

  Returns Promise<void>

stopResponse

• stopResponse(
      response: ServerResponse<IncomingMessage>,
      queryId: number,
      stderr: Writable,
      eventEmitter?: EventEmitter<DefaultEventMap>,
  ): void

• Stop after timeout or if the connection is terminated

  Parameters

  • response: ServerResponse<IncomingMessage>

    Response object.
  • queryId: number

    The unique query id.
  • stderr: Writable

    Error stream to write to.
  • OptionaleventEmitter: EventEmitter<DefaultEventMap>

    Query result stream.

  Returns void

writeQueryResult

• writeQueryResult(
      engine: QueryEngineBase<
          IQueryContextCommon,
          QueryStringContext,
          QueryAlgebraContext,
      >,
      stdout: Writable,
      stderr: Writable,
      request: IncomingMessage,
      response: ServerResponse<IncomingMessage>,
      queryBody: undefined | IQueryBody,
      mediaType: string,
      headOnly: boolean,
      readOnly: boolean,
      queryId: number,
  ): Promise<void>

• Writes the result of the given SPARQL query.

  Parameters

  • engine: QueryEngineBase<IQueryContextCommon, QueryStringContext, QueryAlgebraContext>

    A SPARQL engine.
  • stdout: Writable

    Output stream.
  • stderr: Writable

    Error output stream.
  • request: IncomingMessage

    Request object.
  • response: ServerResponse<IncomingMessage>

    Response object.
  • queryBody: undefined | IQueryBody

    The query body.
  • mediaType: string

    The requested response media type.
  • headOnly: boolean

    If only the header should be written.
  • readOnly: boolean

    If only data can be read, but not updated. (i.e., if we're in a GET request)
  • queryId: number

    The unique id of this query.

  Returns Promise<void>

writeServiceDescription

• writeServiceDescription(
      engine: QueryEngineBase<
          IQueryContextCommon,
          QueryStringContext,
          QueryAlgebraContext,
      >,
      stdout: Writable,
      stderr: Writable,
      request: IncomingMessage,
      response: ServerResponse<IncomingMessage>,
      mediaType: string,
      headOnly: boolean,
  ): Promise<void>

• Parameters

  • engine: QueryEngineBase<IQueryContextCommon, QueryStringContext, QueryAlgebraContext>
  • stdout: Writable
  • stderr: Writable
  • request: IncomingMessage
  • response: ServerResponse<IncomingMessage>
  • mediaType: string
  • headOnly: boolean

  Returns Promise<void>

StaticgenerateConstructorArguments

• generateConstructorArguments(
      argv: string[],
      moduleRootPath: string,
      env: ProcessEnv,
      defaultConfigPath: string,
      stderr: Writable,
      exit: (code: number) => void,
      cliArgsHandlers: ICliArgsHandler[],
  ): Promise<IHttpServiceSparqlEndpointArgs>

• Takes parsed commandline arguments and turns them into an object used in the HttpServiceSparqlEndpoint constructor

  Parameters

  • argv: string[]

    The commandline arguments that the script was called with
  • moduleRootPath: string

    The path to the invoking module.
  • env: ProcessEnv

    The process env to get constants from.
  • defaultConfigPath: string

    The path to get the config from if none is defined in the environment.
  • stderr: Writable

    The error stream.
  • exit: (code: number) => void

    An exit process callback.
  • cliArgsHandlers: ICliArgsHandler[]

    Enables manipulation of the CLI arguments and their processing.

  Returns Promise<IHttpServiceSparqlEndpointArgs>

StaticrunArgsInProcess

• runArgsInProcess(
      argv: string[],
      stdout: Writable,
      stderr: Writable,
      moduleRootPath: string,
      env: ProcessEnv,
      defaultConfigPath: string,
      exit: (code: number) => void,
      cliArgsHandlers?: ICliArgsHandler[],
  ): Promise<void>

• Starts the server

  Parameters

  • argv: string[]

    The commandline arguments that the script was called with
  • stdout: Writable

    The output stream to log to.
  • stderr: Writable

    The error stream to log errors to.
  • moduleRootPath: string

    The path to the invoking module.
  • env: ProcessEnv

    The process env to get constants from.
  • defaultConfigPath: string

    The path to get the config from if none is defined in the environment.
  • exit: (code: number) => void

    The callback to invoke to stop the script.
  • cliArgsHandlers: ICliArgsHandler[] = []

    Enables manipulation of the CLI arguments and their processing.

  Returns Promise<void>

  A promise that resolves when the server has been started.