net.officefloor.server.http.HttpServerLocation Maven / Gradle / Ivy

Go to download
/*-
 * #%L
 * HTTP Server
 * %%
 * Copyright (C) 2005 - 2020 Daniel Sagenschneider
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */

package net.officefloor.server.http;

import net.officefloor.compile.properties.Property;
import net.officefloor.frame.api.source.SourceContext;

/**
 * 
 * Location of the HTTP server.
 * 

 * Note the {@link Property} configuration is provided here to aid identifying
 * how to configure common settings for the {@link HttpServer}. Configuration is
 * expected to follow:
 * 

 * checking the {@link SourceContext}
 * checking {@link System#getProperty(String)}
 * using defaults
 * 
 * 
 * @author Daniel Sagenschneider
 */
public interface HttpServerLocation {

	/**
	 * Name of {@link Property} for the domain.
	 */
	static final String PROPERTY_DOMAIN = "server.domain";

	/**
	 * Name of {@link Property} for the HTTP port.
	 */
	static final String PROPERTY_HTTP_PORT = "http.port";

	/**
	 * Name of {@link Property} for the HTTPS port.
	 */
	static final String PROPERTY_HTTPS_PORT = "https.port";

	/**
	 * Name of {@link Property} for the cluster host name.
	 */
	static final String PROPERTY_CLUSTER_HOST_NAME = "cluster.host";

	/**
	 * Name of {@link Property} for the cluster HTTP port.
	 */
	static final String PROPERTY_CLUSTER_HTTP_PORT = "cluster.http.port";

	/**
	 * Name of {@link Property} for the cluster HTTPS port.
	 */
	static final String PROPERTY_CLUSTER_HTTPS_PORT = "cluster.https.port";

	/**
	 * 
	 * Obtains the domain for the server.
	 * 

	 * This is as the client will see the server.
	 * 
	 * @return Domain for the server.
	 */
	String getDomain();

	/**
	 * 

	 * Obtains the HTTP port.
	 * 

	 * This is as the client will see the server.
	 * 
	 * @return HTTP port.
	 */
	int getHttpPort();

	/**
	 * 

	 * Obtains the HTTPS port.
	 * 
	 * This is as the client will see the server.
	 * 
	 * @return HTTPS port.
	 */
	int getHttpsPort();

	/**
	 * Obtains the name of the host for the server within the cluster. This name
	 * should be understood by all nodes within the cluster.
	 * 
	 * @return Name of the host within the cluster.
	 */
	String getClusterHostName();

	/**
	 * The cluster may be behind a load balancer and the server may be running
	 * on a different port than expected by the client.
	 * 
	 * @return Actual port on the cluster host the server is running on.
	 */
	int getClusterHttpPort();

	/**
	 * The cluster may be behind a load balancer and the server may be running
	 * on a different port than expected by the client.
	 * 
	 * @return Actual secure port on the cluster host the server is running on.
	 */
	int getClusterHttpsPort();

	/**
	 * Creates the client URL to call the {@link HttpServer}.
	 * 
	 * @param isSecure
	 *            If secure URL.
	 * @param path
	 *            Path including query string and fragment.
	 * @return URL for the client to call on the {@link HttpServer}.
	 */
	String createClientUrl(boolean isSecure, String path);

}