antfarm/lib/environment/server.d.ts

File automation framework for ants.

/// <reference types="express" />
import { Environment } from "./environment";
import { WebhookNest } from "../nest/webhookNest";
import { WebhookJob } from "../job/webhookJob";
import * as express from "express";
import { InterfaceManager } from "../ui/interfaceManager";
import { Logger } from "./logger";
/**
 * Webhook and logging server.
 */
export declare class Server {
    protected server: express.Application;
    protected e: Environment;
    protected hookRoutes: any[];
    protected hookInterfaceRoutes: any[];
    protected upload: any;
    protected config: {
        hooks_prefix: string;
        hooks_ui_prefix: string;
        log_prefix: string;
    };
    constructor(e: Environment);
    /**
     * Creates the server.
     */
    protected createServer(): void;
    createLogServer(logger: Logger): void;
    /**
     * Log _name
     * @returns {string}
     */
    toString(): string;
    /**
     * Adds a webhook to the server.
     * @param nest {WebhookNest}
     */
    addWebhook(nest: WebhookNest): void;
    /**
     * Handles request and response of the web hook, creates a new job, as well as calling the nest's arrive.
     * @param nest {WebhookNest}
     * @param req {express.Request}
     * @param res {express.Response}
     * @param customHandler     Custom request handler.
     */
    protected handleHookRequest(nest: WebhookNest, req: any, res: any, customHandler?: any): void;
    /**
     * Sends the actual hook response.
     * @param holdResponse      Flag to bypass sending now for held responses.
     * @param job               Webhook job
     * @param nest              Webhook nest
     * @param req
     * @param res
     * @param customHandler
     * @param message
     */
    sendHookResponse(holdResponse: boolean, job: WebhookJob, nest: WebhookNest, req: any, res: any, customHandler?: any, message?: string): void;
    /**
     * Adds a webhook interface to the webhook server.
     * @param im {InterfaceManager}
     */
    addWebhookInterface(im: InterfaceManager): void;
    /**
     * Handles request and response of the web hook interface.
     * @param im {InterfaceManager}
     * @param req {express.Request}
     * @param res {express.Response}
     * @param customHandler             Custom request handler.
     */
    protected handleHookInterfaceRequest: (im: InterfaceManager, req: any, res: any, customHandler?: any) => void;
}