1 files changed, 235 insertions, 0 deletions
diff --git a/qpid/java/broker/src/main/java/org/apache/qpid/server/protocol/AMQProtocolSession.java b/qpid/java/broker/src/main/java/org/apache/qpid/server/protocol/AMQProtocolSession.java
new file mode 100644
index 0000000000..c64ed4ad5a
--- /dev/null
+++ b/qpid/java/broker/src/main/java/org/apache/qpid/server/protocol/AMQProtocolSession.java
@@ -0,0 +1,235 @@
+/*
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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.apache.qpid.server.protocol;
+
+import javax.security.sasl.SaslServer;
+
+import org.apache.qpid.AMQException;
+import org.apache.qpid.common.ClientProperties;
+import org.apache.qpid.framing.*;
+import org.apache.qpid.AMQConnectionException;
+import org.apache.qpid.protocol.AMQVersionAwareProtocolSession;
+import org.apache.qpid.server.AMQChannel;
+import org.apache.qpid.server.security.PrincipalHolder;
+import org.apache.qpid.server.logging.LogActor;
+import org.apache.qpid.server.output.ProtocolOutputConverter;
+import org.apache.qpid.server.virtualhost.VirtualHost;
+
+import java.security.Principal;
+import java.util.List;
+
+
+public interface AMQProtocolSession extends AMQVersionAwareProtocolSession, PrincipalHolder, AMQConnectionModel
+{
+    long getSessionID();
+
+    LogActor getLogActor();
+
+    void setMaxFrameSize(long frameMax);
+
+    long getMaxFrameSize();
+
+    boolean isClosing();
+
+    public static final class ProtocolSessionIdentifier
+    {
+        private final Object _sessionIdentifier;
+        private final Object _sessionInstance;
+
+        ProtocolSessionIdentifier(AMQProtocolSession session)
+        {
+            _sessionIdentifier = session.getClientIdentifier();
+            _sessionInstance = session.getClientProperties() == null ? null : session.getClientProperties().getObject(ClientProperties.instance.toAMQShortString());
+        }
+
+        public Object getSessionIdentifier()
+        {
+            return _sessionIdentifier;
+        }
+
+        public Object getSessionInstance()
+        {
+            return _sessionInstance;
+        }
+    }
+
+    public static interface Task
+    {
+        public void doTask(AMQProtocolSession session) throws AMQException;
+    }
+
+    /**
+     * Called when a protocol data block is received
+     *
+     * @param message the data block that has been received
+     *
+     * @throws Exception if processing the datablock fails
+     */
+    void dataBlockReceived(AMQDataBlock message) throws Exception;
+
+    /**
+     * Get the context key associated with this session. Context key is described in the AMQ protocol specification (RFC
+     * 6).
+     *
+     * @return the context key
+     */
+    AMQShortString getContextKey();
+
+    /**
+     * Set the context key associated with this session. Context key is described in the AMQ protocol specification (RFC
+     * 6).
+     *
+     * @param contextKey the context key
+     */
+    void setContextKey(AMQShortString contextKey);
+
+    /**
+     * Get the channel for this session associated with the specified id. A channel id is unique per connection (i.e.
+     * per session).
+     *
+     * @param channelId the channel id which must be valid
+     *
+     * @return null if no channel exists, the channel otherwise
+     */
+    AMQChannel getChannel(int channelId);
+
+    /**
+     * Associate a channel with this session.
+     *
+     * @param channel the channel to associate with this session. It is an error to associate the same channel with more
+     *                than one session but this is not validated.
+     */
+    void addChannel(AMQChannel channel) throws AMQException;
+
+    /**
+     * Close a specific channel. This will remove any resources used by the channel, including: <ul><li>any queue
+     * subscriptions (this may in turn remove queues if they are auto delete</li> </ul>
+     *
+     * @param channelId id of the channel to close
+     *
+     * @throws org.apache.qpid.AMQException if an error occurs closing the channel
+     * @throws IllegalArgumentException     if the channel id is not valid
+     */
+    void closeChannel(int channelId) throws AMQException;
+
+    /**
+     * Markes the specific channel as closed. This will release the lock for that channel id so a new channel can be
+     * created on that id.
+     *
+     * @param channelId id of the channel to close
+     */
+    void closeChannelOk(int channelId);
+
+    /**
+     * Check to see if this chanel is closing
+     *
+     * @param channelId id to check
+     * @return boolean with state of channel awaiting closure
+     */
+    boolean channelAwaitingClosure(int channelId);
+
+    /**
+     * Remove a channel from the session but do not close it.
+     *
+     * @param channelId
+     */
+    void removeChannel(int channelId);
+
+    /**
+     * Initialise heartbeats on the session.
+     *
+     * @param delay delay in seconds (not ms)
+     */
+    void initHeartbeats(int delay);
+
+    /** This must be called when the session is _closed in order to free up any resources managed by the session. */
+    void closeSession() throws AMQException;
+
+    /** This must be called to close the session in order to free up any resources managed by the session. */
+    void closeConnection(int channelId, AMQConnectionException e, boolean closeProtocolSession) throws AMQException;
+
+
+    /** @return a key that uniquely identifies this session */
+    Object getKey();
+
+    /**
+     * Get the fully qualified domain name of the local address to which this session is bound. Since some servers may
+     * be bound to multiple addresses this could vary depending on the acceptor this session was created from.
+     *
+     * @return a String FQDN
+     */
+    String getLocalFQDN();
+
+    /** @return the sasl server that can perform authentication for this session. */
+    SaslServer getSaslServer();
+
+    /**
+     * Set the sasl server that is to perform authentication for this session.
+     *
+     * @param saslServer
+     */
+    void setSaslServer(SaslServer saslServer);
+
+
+    FieldTable getClientProperties();
+
+    void setClientProperties(FieldTable clientProperties);
+
+    Object getClientIdentifier();
+
+    VirtualHost getVirtualHost();
+
+    void setVirtualHost(VirtualHost virtualHost) throws AMQException;
+
+    void addSessionCloseTask(Task task);
+
+    void removeSessionCloseTask(Task task);
+
+    public ProtocolOutputConverter getProtocolOutputConverter();
+
+    void setAuthorizedID(Principal authorizedID);
+
+    public java.net.SocketAddress getRemoteAddress();
+
+    public MethodRegistry getMethodRegistry();
+
+    public MethodDispatcher getMethodDispatcher();
+
+    public ProtocolSessionIdentifier getSessionIdentifier();
+
+    String getClientVersion();
+
+    long getLastIoTime();
+
+    long getWrittenBytes();
+
+    Long getMaximumNumberOfChannels();
+
+    void setMaximumNumberOfChannels(Long value);
+
+    void commitTransactions(AMQChannel channel) throws AMQException;
+
+    void rollbackTransactions(AMQChannel channel) throws AMQException;
+
+    List<AMQChannel> getChannels();
+
+    void mgmtCloseChannel(int channelId);
+}