org.filesys.server.filesys.TreeConnection Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jfileserver Show documentation
Show all versions of jfileserver Show documentation
Java file server with SMB, FTP/FTPS and NFS support, virtual filesystems, database filesystems
/*
* Copyright (C) 2006-2010 Alfresco Software Limited.
* Copyright (C) 2018 GK Spencer
*
* This file is part of Alfresco
*
* Alfresco is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Alfresco is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Alfresco. If not, see fileIter = m_files.iterateFileHandles();
while (fileIter.hasNext()) {
// Get the current file id handle
Integer fileHandle = fileIter.next();
// Get the current open file
NetworkFile openFile = m_files.findFile( fileHandle);
if ( openFile != null) {
// Close the file
try {
// Access the disk interface and close the file
DiskInterface disk = (DiskInterface) m_shareDev.getInterface();
openFile.setForce(true);
disk.closeFile(sess, this, openFile);
openFile.setClosed(true);
}
catch (Exception ex) {
}
}
}
// Remove all the open files
m_files.removeAllFiles();
}
// Decrement the active connection count for the shared device
m_shareDev.decrementConnectionCount();
}
/**
* Return the specified network file.
*
* @param fid int
* @return NetworkFile
*/
public synchronized NetworkFile findFile(int fid) {
return m_files.findFile( fid);
}
/**
* Determine if the shared device has an associated context
*
* @return boolean
*/
public final boolean hasContext() {
if (m_shareDev != null)
return m_shareDev.getContext() != null ? true : false;
return false;
}
/**
* Return the interface specific context object.
*
* @return Device interface context object.
*/
public final DeviceContext getContext() {
if (m_shareDev == null)
return null;
return m_shareDev.getContext();
}
/**
* Return the share access permissions that the user has been granted.
*
* @return ShareStatus
*/
public final ISMBAuthenticator.ShareStatus getPermission() {
return m_permission;
}
/**
* Deterimine if the access permission for the shared device allows read access
*
* @return boolean
*/
public final boolean hasReadAccess() {
if (m_permission == ISMBAuthenticator.ShareStatus.READ_ONLY ||
m_permission == ISMBAuthenticator.ShareStatus.WRITEABLE)
return true;
return false;
}
/**
* Determine if the access permission for the shared device allows write access
*
* @return boolean
*/
public final boolean hasWriteAccess() {
if (m_permission == ISMBAuthenticator.ShareStatus.WRITEABLE)
return true;
return false;
}
/**
* Return the shared device that this tree connection is using.
*
* @return SharedDevice
*/
public final SharedDevice getSharedDevice() {
return m_shareDev;
}
/**
* Return the shared device interface
*
* @return DeviceInterface
*/
public final DeviceInterface getInterface() {
if (m_shareDev == null)
return null;
try {
return m_shareDev.getInterface();
}
catch (InvalidDeviceInterfaceException ex) {
}
return null;
}
/**
* Return the count of open files on this tree connection.
*
* @return int
*/
public synchronized int openFileCount() {
return m_files.openFileCount();
}
/**
* Iterate the open file handles
*
* @return Iterator<Integer>
*/
public final Iterator iterateOpenFileHandles() {
return m_files.iterateFileHandles();
}
/**
* Remove all files from the tree connection.
*/
public synchronized final void removeAllFiles() {
m_files.removeAllFiles();
}
/**
* Remove a network file from the list of open files for this connection.
*
* @param fid int
* @param sess SrvSession
*/
public synchronized void removeFile(int fid, SrvSession sess) {
// Remove the file
NetworkFile netFile = m_files.removeFile( fid, sess);
if ( netFile != null) {
// Inform listeners of the file closure
NetworkFileServer fileSrv = (NetworkFileServer) sess.getServer();
if (fileSrv != null)
fileSrv.fireCloseFileEvent(sess, netFile);
}
}
/**
* Set the access permission for this share that the user has been granted.
*
* @param perm ShareStatus
*/
public final void setPermission(ISMBAuthenticator.ShareStatus perm) {
m_permission = perm;
}
/**
* Set the access permission for this share by mapping from an ACL permission
*
* @param aclPerm int
*/
public final void setPermission(int aclPerm) {
switch ( aclPerm) {
case AccessControl.NoAccess:
m_permission = ISMBAuthenticator.ShareStatus.NO_ACCESS;
break;
case AccessControl.ReadOnly:
m_permission = ISMBAuthenticator.ShareStatus.READ_ONLY;
break;
case AccessControl.ReadWrite:
m_permission = ISMBAuthenticator.ShareStatus.WRITEABLE;
break;
}
}
/**
* Return the tree connection as a string.
*
* @return String
*/
public String toString() {
StringBuffer str = new StringBuffer();
str.append("[");
str.append(m_shareDev.toString());
str.append(", id=");
str.append(getId());
str.append(", fileCnt=");
str.append(openFileCount());
str.append(", perm=");
str.append(m_permission.name());
str.append("]");
return str.toString();
}
/**
* Dump the open file list
*
* @param sess SMBSrvSession
*/
public final void dumpOpenFiles(SMBSrvSession sess) {
// Dump the open file list
sess.debugPrintln("Dump open files:");
Iterator iterHandles = iterateOpenFileHandles();
while ( iterHandles.hasNext()) {
// Get the next file handle
Integer handle = iterHandles.next();
NetworkFile netFile = findFile( handle);
if ( netFile != null)
sess.debugPrintln(" " + handle + ": " + netFile);
}
}
}