com.tcdng.unify.web.ui.widget.ResponseWriterPool Maven / Gradle / Ivy

/*
 * Copyright 2018-2023 The Code Department.
 * 
 * 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 com.tcdng.unify.web.ui.widget;

import com.tcdng.unify.core.UnifyComponent;
import com.tcdng.unify.core.UnifyException;
import com.tcdng.unify.web.ClientRequest;

/**
 * Represents a pool of response writers that facilitates writer reuse.
 * 
 * @author The Code Department
 * @since 1.0
 */
public interface ResponseWriterPool extends UnifyComponent {

    /**
     * Returns a response writer from pool based on current session context.
     * 
     * @param clientRequest the client request object.
     * @throws UnifyException
     *             if get operation times out.
     */
    ResponseWriter getResponseWriter(ClientRequest clientRequest) throws UnifyException;

    /**
     * Restores response writer to this pool.
     * 
     * @param writer
     * @return a true value if writer belongs to this pool and was successfully
     *         restored.
     * @throws UnifyException
     *             if an error occurs.
     */
    boolean restore(ResponseWriter writer) throws UnifyException;
}