io.vertx.up.uca.rs.hunt.adaptor.Wings Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of vertx-up Show documentation

There is a newer version: 0.9.0

package io.vertx.up.uca.rs.hunt.adaptor;

import io.vertx.core.http.HttpServerResponse;
import io.vertx.up.commune.Envelop;

/**
 * 「Co」Zero Framework
 *
 * Here I added new configuration `freedom` to zero framework as critical data specification here for
 * old system integration here. This configuration is new released after `0.5.3`
 *
 * ```yaml
 * // 
 * zero:
 *   freedom: true
 * // 
 * ```
 *
 * * The default value of `freedom` is false, it means that you must be under zero data specification.
 * * You Also can use your own setting to set `freedom` to true, it means original raw data.
 *
 * Here are two features
 *
 * 1. Build response by `Accept` and `Content-Type`, set the media type
 * 2. Convert media type to actual response data.
 *
 * @author Lang
 */
public interface Wings {
    /**
     * Pre-Condition
     * 1) Response is not ended
     * 2) The request method is not HEAD
     *
     * @param response ServerResponse reference
     * @param envelop  The response uniform model
     */
    void output(HttpServerResponse response, Envelop envelop);
}