PUProtocolRequest.java

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2007-2010 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
 * https://glassfish.dev.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 com.sun.grizzly.portunif;

import java.nio.ByteBuffer;
import java.nio.channels.SelectableChannel;
import java.nio.channels.SelectionKey;
import java.util.Collection;
import javax.net.ssl.SSLEngine;

/**
 *
 * @author Alexey Stashok
 */
public interface PUProtocolRequest {
    public SelectionKey getSelectionKey();
    
    public SelectableChannel getChannel();
    
    public ByteBuffer getByteBuffer();
    
    public void setByteBuffer(ByteBuffer byteBuffer);
    
    public SSLEngine getSSLEngine();
    
    public void setSSLEngine(SSLEngine sslEngine);
    
    public ByteBuffer getSecuredInputByteBuffer();
    
    public void setSecuredInputByteBuffer(ByteBuffer securedInputByteBuffer);
    
    public ByteBuffer getSecuredOutputByteBuffer();

    public void setSecuredOutputByteBuffer(ByteBuffer securedOutputByteBuffer);
    
    public Collection<String> getPassedPreProcessors();
    
    public boolean isPreProcessorPassed(String id);
    
    public void addPassedPreProcessor(String preProcessor);
    
    public String getProtocolName();
    
    public void setProtocolName(String protocolName);
    
    public void setExecuteFilterChain(boolean isExecuteFilterChain);
    
    public boolean isExecuteFilterChain();
    
    /**
     * Returns whether we need to map SelectionKey to the specific ProtocolHandler permanently.
     * So all next requests will directly go to the specific ProtocolHandler, without
     * ProtocolFinder to be called. If Protocol
     * 
     * @return true - SelectionKey should be permanently associated with ProtocolHandler,
     * false - otherwise.
     */
    public boolean isMapSelectionKey();
    
    /**
     * Sets whether we need to map SelectionKey to the specific ProtocolHandler permanently.
     * So all next requests will directly go to the specific ProtocolHandler, without
     * ProtocolFinder to be called. If Protocol
     * 
     * @param mapSelectionKey  True if SelectionKey should be permanently 
     * associated with ProtocolHandler, false - otherwise.
     */
    public void setMapSelectionKey(boolean mapSelectionKey);
}