org.yelong.support.servlet.mvc.Controller Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of yelong-support Show documentation

对各种开源框架的包装、支持、拓展。这里也包含的yelong-core与orm框架的整合。默认对所有依赖为 scope 为 provided 。您需要针对自己的需要进行再次依赖

There is a newer version: 2.2.0

/**
 * 
 */
package org.yelong.support.servlet.mvc;

import java.io.File;
import java.io.IOException;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.yelong.core.annotation.Nullable;

/**
 * @author PengFei
 */
public interface Controller {

	/**
	 * @return HttpServletRequest
	 */
	HttpServletRequest getRequest();

	/**
	 * @return HttpServletResponse
	 */
	HttpServletResponse getResponse();

	/**
	 * 响应一个文本
	 * 
	 * @param text 内容
	 */
	void responseText(String text) throws IOException;

	/**
	 * 响应一个文件
	 * 
	 * @param file 文件
	 */
	void responseFile(File file) throws IOException;

	/**
	 * 响应一个文件并指定文件的名称
	 * 
	 * @param file     文件
	 * @param filename 响应的文件名称。默认为 {@link File#getName()}
	 * @throws IOException
	 */
	void responseFile(File file, @Nullable String filename) throws IOException;

	/**
	 * 响应文件
	 * 
	 * @param fileByteArray 文件流
	 * @param fileName      文件名称
	 * @throws IOException
	 */
	void responseFile(String fileName, byte[] fileBytsArray) throws IOException;

	/**
	 * 设置响应内容
	 * 
	 * @param content 内容字节数组
	 */
	void responseContent(byte[] content) throws IOException;

}