Moving to root below branch label

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@2005 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261

source/java/org/alfresco/filesys/smb/server/ProtocolHandler.java

@@ -0,0 +1,198 @@
+/*
+ * Copyright (C) 2005 Alfresco, Inc.
+ *
+ * Licensed under the Mozilla Public License version 1.1 
+ * with a permitted attribution clause. You may obtain a
+ * copy of the License at
+ *
+ *   http://www.alfresco.org/legal/license.txt
+ *
+ * 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.alfresco.filesys.smb.server;
+
+import java.io.IOException;
+
+import org.alfresco.filesys.server.filesys.DiskDeviceContext;
+import org.alfresco.filesys.server.filesys.DiskInterface;
+import org.alfresco.filesys.server.filesys.DiskSizeInterface;
+import org.alfresco.filesys.server.filesys.DiskVolumeInterface;
+import org.alfresco.filesys.server.filesys.SrvDiskInfo;
+import org.alfresco.filesys.server.filesys.TooManyConnectionsException;
+import org.alfresco.filesys.server.filesys.VolumeInfo;
+import org.alfresco.filesys.smb.PacketType;
+
+/**
+ * Protocol handler abstract base class.
+ * <p>
+ * The protocol handler class is the base of all SMB protocol/dialect handler classes.
+ */
+abstract class ProtocolHandler
+{
+
+    // Server session that this protocol handler is associated with.
+
+    protected SMBSrvSession m_sess;
+
+    /**
+     * Create a protocol handler for the specified session.
+     */
+    protected ProtocolHandler()
+    {
+    }
+
+    /**
+     * Create a protocol handler for the specified session.
+     * 
+     * @param sess SMBSrvSession
+     */
+    protected ProtocolHandler(SMBSrvSession sess)
+    {
+        m_sess = sess;
+    }
+
+    /**
+     * Return the protocol handler name.
+     * 
+     * @return java.lang.String
+     */
+    public abstract String getName();
+
+    /**
+     * Run the SMB protocol handler for this server session.
+     * 
+     * @exception java.io.IOException
+     * @exception SMBSrvException
+     */
+    public abstract boolean runProtocol() throws IOException, SMBSrvException, TooManyConnectionsException;
+
+    /**
+     * Get the server session that this protocol handler is associated with.
+     * 
+     * @param sess SMBSrvSession
+     */
+    protected final SMBSrvSession getSession()
+    {
+        return m_sess;
+    }
+
+    /**
+     * Set the server session that this protocol handler is associated with.
+     * 
+     * @param sess SMBSrvSession
+     */
+    protected final void setSession(SMBSrvSession sess)
+    {
+        m_sess = sess;
+    }
+
+    /**
+     * Determine if the request is a chained (AndX) type command and there is a chained command in
+     * this request.
+     * 
+     * @param pkt SMBSrvPacket
+     * @return true if there is a chained request to be handled, else false.
+     */
+    protected final boolean hasChainedCommand(SMBSrvPacket pkt)
+    {
+
+        // Determine if the command code is an AndX command
+
+        int cmd = pkt.getCommand();
+
+        if (cmd == PacketType.SessionSetupAndX || cmd == PacketType.TreeConnectAndX || cmd == PacketType.OpenAndX
+                || cmd == PacketType.WriteAndX || cmd == PacketType.ReadAndX || cmd == PacketType.LogoffAndX
+                || cmd == PacketType.LockingAndX || cmd == PacketType.NTCreateAndX)
+        {
+
+            // Check if there is a chained command
+
+            return pkt.hasAndXCommand();
+        }
+
+        // Not a chained type command
+
+        return false;
+    }
+
+    /**
+     * Get disk sizing information from the specified driver and context.
+     * 
+     * @param disk DiskInterface
+     * @param ctx DiskDeviceContext
+     * @return SrvDiskInfo
+     * @exception IOException
+     */
+    protected final SrvDiskInfo getDiskInformation(DiskInterface disk, DiskDeviceContext ctx) throws IOException
+    {
+
+        // Get the static disk information from the context, if available
+
+        SrvDiskInfo diskInfo = ctx.getDiskInformation();
+
+        // If we did not get valid disk information from the device context check if the driver
+        // implements the
+        // disk sizing interface
+
+        if (diskInfo == null)
+            diskInfo = new SrvDiskInfo();
+
+        // Check if the driver implements the dynamic sizing interface to get realtime disk size
+        // information
+
+        if (disk instanceof DiskSizeInterface)
+        {
+
+            // Get the dynamic disk sizing information
+
+            DiskSizeInterface sizeInterface = (DiskSizeInterface) disk;
+            sizeInterface.getDiskInformation(ctx, diskInfo);
+        }
+
+        // Return the disk information
+
+        return diskInfo;
+    }
+
+    /**
+     * Get disk volume information from the specified driver and context
+     * 
+     * @param disk DiskInterface
+     * @param ctx DiskDeviceContext
+     * @return VolumeInfo
+     */
+    protected final VolumeInfo getVolumeInformation(DiskInterface disk, DiskDeviceContext ctx)
+    {
+
+        // Get the static volume information from the context, if available
+
+        VolumeInfo volInfo = ctx.getVolumeInformation();
+
+        // If we did not get valid volume information from the device context check if the driver
+        // implements the
+        // disk volume interface
+
+        if (disk instanceof DiskVolumeInterface)
+        {
+
+            // Get the dynamic disk volume information
+
+            DiskVolumeInterface volInterface = (DiskVolumeInterface) disk;
+            volInfo = volInterface.getVolumeInformation(ctx);
+        }
+
+        // If we still have not got valid volume information then create empty volume information
+
+        if (volInfo == null)
+            volInfo = new VolumeInfo("");
+
+        // Return the volume information
+
+        return volInfo;
+    }
+}