KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > alfresco > filesys > server > filesys > IOCtlInterface


1 /*
2  * Copyright (C) 2005 Alfresco, Inc.
3  *
4  * Licensed under the Mozilla Public License version 1.1
5  * with a permitted attribution clause. You may obtain a
6  * copy of the License at
7  *
8  * http://www.alfresco.org/legal/license.txt
9  *
10  * Unless required by applicable law or agreed to in writing,
11  * software distributed under the License is distributed on an
12  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
13  * either express or implied. See the License for the specific
14  * language governing permissions and limitations under the
15  * License.
16  */

17
18 package org.alfresco.filesys.server.filesys;
19
20 import org.alfresco.filesys.server.SrvSession;
21 import org.alfresco.filesys.smb.SMBException;
22 import org.alfresco.filesys.util.DataBuffer;
23
24 /**
25  * IO Control Interface
26  *
27  * <p>Optional interface that a DiskInterface driver can implement to enable NT I/O control function
28  * processing.
29  *
30  * @author gkspencer
31  */

32 public interface IOCtlInterface
33 {
34     /**
35      * Process a filesystem I/O control request
36      *
37      * @param sess Server session
38      * @param tree Tree connection.
39      * @param ctrlCode I/O control code
40      * @param fid File id
41      * @param dataBuf I/O control specific input data
42      * @param isFSCtrl true if this is a filesystem control, or false for a device control
43      * @param filter if bit0 is set indicates that the control applies to the share root handle
44      * @return DataBuffer
45      * @exception IOControlNotImplementedException
46      * @exception SMBException
47      */

48     public DataBuffer processIOControl(SrvSession sess, TreeConnection tree, int ctrlCode, int fid, DataBuffer dataBuf,
49             boolean isFSCtrl, int filter) throws IOControlNotImplementedException, SMBException;
50 }
51
Popular Tags