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

Go to download

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

Provides HTTP Server

The newest version!

/*-
 * #%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.frame.api.escalate.Escalation;

/**
 * Context for the {@link HttpEscalationHandler}.
 * 
 * @author Daniel Sagenschneider
 */
public interface HttpEscalationContext {

	/**
	 * Obtains the {@link Escalation}.
	 * 
	 * @return {@link Escalation}.
	 */
	Throwable getEscalation();

	/**
	 * Indicates whether the stack trace should be included.
	 * 
	 * @return true to include the stack trace.
	 */
	boolean isIncludeStacktrace();

	/**
	 * Obtains the {@link ServerHttpConnection} to write the {@link Escalation}.
	 * 
	 * @return {@link ServerHttpConnection}.
	 */
	ServerHttpConnection getServerHttpConnection();

}