net.officefloor.web.compile.CompileWebContext Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of officeweb Show documentation

OfficeFloor plug-in for Web

There is a newer version: 3.40.0

/*
 * OfficeFloor - http://www.officefloor.net
 * Copyright (C) 2005-2018 Daniel Sagenschneider
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see .
 */
package net.officefloor.web.compile;

import net.officefloor.compile.test.officefloor.CompileOfficeContext;
import net.officefloor.server.http.HttpMethod;
import net.officefloor.web.build.HttpInput;
import net.officefloor.web.build.HttpUrlContinuation;
import net.officefloor.web.build.WebArchitect;

/**
 * Context for the {@link CompileWebExtension}.
 * 
 * @author Daniel Sagenschneider
 */
public interface CompileWebContext extends CompileOfficeContext {

	/**
	 * Obtains the {@link WebArchitect}.
	 * 
	 * @return {@link WebArchitect}.
	 */
	WebArchitect getWebArchitect();

	/**
	 * Convenience method to link a URI to the service method of
	 * the {@link Class}.
	 * 
	 * @param applicationPath
	 *            Application path.
	 * @param isSecure
	 *            Indicates if secure.
	 * @param sectionClass
	 *            {@link Class} containing a service method.
	 * @return {@link HttpUrlContinuation}.
	 */
	HttpUrlContinuation link(boolean isSecure, String applicationPath, Class sectionClass);

	/**
	 * Convenience method to link a URL to the service method of
	 * the {@link Class}.
	 * 
	 * @param isSecure
	 *            Indicates if secure.
	 * @param httpMethodName
	 *            Name of the {@link HttpMethod}.
	 * @param applicationPath
	 *            Application path.
	 * @param sectionClass
	 *            {@link Class} containing a service method.
	 * @return {@link HttpInput}.
	 */
	HttpInput link(boolean isSecure, String httpMethodName, String applicationPath, Class sectionClass);

}