org.wildfly.security.http.HttpServerResponse Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wildfly-client-all

This artifact provides a single jar that contains all classes required to use remote EJB and JMS, including all dependencies. It is intended for use by those not using maven, maven users should just import the EJB and JMS BOM's instead (shaded JAR's cause lots of problems with maven, as it is very easy to inadvertently end up with different versions on classes on the class path).

There is a newer version: 34.0.0.Final

Show newest version

/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2015 Red Hat, Inc., and individual contributors
 * as indicated by the @author tags.
 *
 * 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.
 */
package org.wildfly.security.http;

import java.io.OutputStream;

/**
 * Server side representation of a HTTP response.
 *
 * @author Darran Lofthouse
 */
public interface HttpServerResponse {

    /**
     * Add the specified header and value to the end of the current response headers,
     *
     * @param headerName the name of the header.
     * @param headerValue the value of the header.
     */
    void addResponseHeader(final String headerName, final String headerValue);

    /**
     * Set the desired status code for the current request.
     *
     * Note: If multiple mechanisms call this method then a resolution process will begin to decide which one to use.
     *
     * @param statusCode the response code.
     */
    void setStatusCode(final int statusCode);

    /**
     * Sets a response cookie
     *
     * @param cookie the cookie
     */
    void setResponseCookie(final HttpServerCookie cookie);

    /**
     * Returns the output stream.
     *
     * @return the output stream or {@code null} if not supported.
     */
    OutputStream getOutputStream();

    /**
     * Forward the current request to a different path.
     *
     * @return {@code true} if forwarding was supported and successful, {@code false} otherwise.
     */
     boolean forward(String path);

}