org.glassfish.jersey.servlet.spi.AsyncContextDelegate Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2012 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* http://glassfish.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package org.glassfish.jersey.servlet.spi;
import java.util.concurrent.TimeUnit;
import org.glassfish.jersey.server.spi.ContainerResponseWriter;
/**
* Utilized by the Servlet container response writer to deal with the container async features.
* Individual instances are created by {@link AsyncContextDelegateProvider}.
*
* @see AsyncContextDelegateProvider
*
* @author Jakub Podlesak (jakub.podlesak at oracle.com)
*/
public interface AsyncContextDelegate {
/**
* Invoked by the superior {@link ContainerResponseWriter} responsible
* for writing the response when processing is to be suspended.
* An implementation can throw an {@link UnsupportedOperationException} if suspend is not supported (the default behavior).
*
* @param writer response writer.
* @param timeOut time-out value.
* @param timeUnit time-out time unit.
* @param timeoutHandler response writer time-out handler.
* @throws IllegalStateException
*
* @see ContainerResponseWriter#suspend(long, java.util.concurrent.TimeUnit, org.glassfish.jersey.server.spi.ContainerResponseWriter.TimeoutHandler)
*/
public void suspend(final ContainerResponseWriter writer, final long timeOut, final TimeUnit timeUnit, final ContainerResponseWriter.TimeoutHandler timeoutHandler) throws IllegalStateException;
/**
* Invoked by the superior {@link ContainerResponseWriter} responsible
* for writing the response when new timeout values are to be set.
* An implementation can throw an {@link UnsupportedOperationException} if suspend is not supported (the default behavior).
*
* @param timeOut new time-out value.
* @param timeUnit new time-out time unit.
* @throws IllegalStateException
*
* @see ContainerResponseWriter#setSuspendTimeout(long, java.util.concurrent.TimeUnit)
*/
public void setSuspendTimeout(final long timeOut, final TimeUnit timeUnit) throws IllegalStateException;
/**
* Invoked upon a response writing completion when the response write is either committed or canceled.
*/
public void complete();
}