net.officefloor.web.build.HttpPathFactory Maven / Gradle / Ivy

Go to download
/*
 * 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.build;

import net.officefloor.server.http.HttpException;

/**
 * Creates the HTTP path.
 * 
 * @author Daniel Sagenschneider
 */
public interface HttpPathFactory {

	/**
	 * Obtains the expected type to retrieve values in constructing the path.
	 * 
	 * @return Expected type to retrieve values in constructing the path. May be
	 *         null if no values are required.
	 */
	Class getValuesType();

	/**
	 * 
	 * Creates the client application path.
	 * 
	 * This is the path on the server to the {@link HttpInput} (i.e. includes
	 * the context path). It, however, does not include protocol,
	 * domain and port.
	 * 
	 * @param values
	 *            Optional object to obtain values to create the path.
	 * @return Application path.
	 * @throws HttpException
	 *             If fails to create the application path.
	 */
	String createApplicationClientPath(T values) throws HttpException;

}