Refactoring of the pseudo file/desktop action code to allow use by AVM and repo filesystem drivers.

Added virtualization view to the AVM filesystem driver that shows all stores and versions using a single
shared filesystem.


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/BRANCHES/WCM-DEV2/root@4443 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261

source/java/org/alfresco/filesys/alfresco/DesktopParams.java

@@ -0,0 +1,180 @@
+/*
+ * Copyright (C) 2005-2006 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.alfresco;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.alfresco.filesys.server.SrvSession;
+import org.alfresco.filesys.server.auth.ClientInfo;
+import org.alfresco.filesys.server.filesys.NetworkFile;
+import org.alfresco.service.cmr.repository.NodeRef;
+
+/**
+ * Desktop Parameters Class
+ * 
+ * <p>Contains the parameters for a desktop action request from the client side application.
+ * 
+ * @author gkspencer
+ */
+public class DesktopParams {
+
+	// File server session
+	
+	private SrvSession m_session;
+	
+	// Folder node that the actions are working in
+	
+	private NodeRef m_folderNode;
+	
+	// Network file for the folder node
+	
+	private NetworkFile m_folderFile;
+	
+	// List of file/folder/node targets for the action
+	
+	private List<DesktopTarget> m_targets;
+	
+	/**
+	 * Default constructor
+	 */
+	public DesktopParams()
+	{
+	}
+	
+	/**
+	 * Class constructor
+	 * 
+	 * @param sess SrvSession
+	 * @param folderNode NodeRef
+	 * @param folderFile NetworkFile
+	 */
+	public DesktopParams(SrvSession sess, NodeRef folderNode, NetworkFile folderFile)
+	{
+		m_session    = sess;
+		m_folderNode = folderNode;
+		m_folderFile = folderFile;
+	}
+	
+	/**
+	 * Return the count of target nodes for the action
+	 * 
+	 * @return int
+	 */
+	public final int numberOfTargetNodes()
+	{
+		return m_targets != null ? m_targets.size() : 0;
+	}
+
+	/**
+	 * Return the file server session
+	 * 
+	 * @return SrvSession
+	 */
+	public final SrvSession getSession()
+	{
+		return m_session;
+	}
+
+	/**
+	 * Return the authentication ticket for the user/session
+	 * 
+	 * @return String
+	 */
+	public final String getTicket()
+	{
+		ClientInfo cInfo = m_session.getClientInformation();
+		if ( cInfo != null)
+			return cInfo.getAuthenticationTicket();
+		return null;
+	}
+	
+	/**
+	 * Return the working directory node
+	 * 
+	 *  @return NodeRef
+	 */
+	public final NodeRef getFolderNode()
+	{
+		return m_folderNode;
+	}
+
+	/**
+	 * Return the folder network file
+	 * 
+	 * @return NetworkFile
+	 */
+	public final NetworkFile getFolder()
+	{
+		return m_folderFile;
+	}
+	
+	/**
+	 * Set the folder network file
+	 * 
+	 * @param netFile NetworkFile
+	 */
+	public final void setFolder(NetworkFile netFile)
+	{
+		m_folderFile = netFile;
+	}
+	
+	/**
+	 * Return the required target
+	 * 
+	 * @param idx int
+	 * @return DesktopTarget
+	 */
+	public final DesktopTarget getTarget(int idx)
+	{
+		DesktopTarget deskTarget = null;
+		
+		if ( m_targets != null && idx >= 0 && idx < m_targets.size())
+			deskTarget = m_targets.get(idx);
+		
+		return deskTarget;
+	}
+	
+	/**
+	 * Add a target node for the action
+	 * 
+	 * @param target DesktopTarget
+	 */
+	public final void addTarget(DesktopTarget target)
+	{
+		if ( m_targets == null)
+			m_targets = new ArrayList<DesktopTarget>();
+		m_targets.add(target);
+	}
+	
+	/**
+	 * Return the desktop parameters as a string
+	 * 
+	 * @return String
+	 */
+	public String toString()
+	{
+		StringBuilder str = new StringBuilder();
+		
+		str.append("[");
+		str.append("Targets=");
+		str.append(numberOfTargetNodes());
+		str.append("]");
+		
+		return str.toString();
+	}
+}