Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: 894dc21ccbea2a0d67f3b70d84b174cd13f485cc (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
    <title>Target Communication Framework Services - File System</title>
</head>

<body lang='EN-US'>

<h1>Target Communication Framework Services - File System</h1>

<ul>
    <li><a href='#VersionHistory'>Version History</a>
    <li><a href='#Overview'>Overview</a>
    <li><a href='#ReqSync'>Request Synchronization and Reordering</a>
    <li><a href='#FileNames'>File Names</a>
    <li><a href='#FileModes'>File Open Modes</a>
    <li><a href='#FileAttributes'>File Attributes</a>
    <li><a href='#ErrorCodes'>Error Codes</a>
    <li><a href='#Cmds'>Commands</a>
    <ul>
        <li><a href='#CmdOpen'>open</a>
        <li><a href='#CmdClose'>close</a>
        <li><a href='#CmdRead'>read</a>
        <li><a href='#CmdWrite'>write</a>
        <li><a href='#CmdStat'>stat</a>
        <li><a href='#CmdLStat'>lstat</a>
        <li><a href='#CmdFStat'>fstat</a>
        <li><a href='#CmdSetStat'>setstat</a>
        <li><a href='#CmdFSetStat'>fsetstat</a>
        <li><a href='#CmdOpenDir'>opendir</a>
        <li><a href='#CmdReadDir'>readdir</a>
        <li><a href='#CmdMkDir'>mkdir</a>
        <li><a href='#CmdRmDir'>rmdir</a>
        <li><a href='#CmdRoots'>roots</a>
        <li><a href='#CmdRemove'>remove</a>
        <li><a href='#CmdRealPath'>realpath</a>
        <li><a href='#CmdRename'>rename</a>
        <li><a href='#CmdReadLink'>readlink</a>
        <li><a href='#CmdSymLink'>symlink</a>
        <li><a href='#CmdSymLink'>copy</a>
        <li><a href='#CmdSymLink'>user</a>
    </ul>
    <li><a href='#API'>API</a>
</ul>

<h1>File System Service</h1>

<h2><a name='VersionHistory'>Version History</a></h2>

<table border=1 cellpadding=8>
    <tr>
        <th>Version
        <th>Date
        <th>Change
    <tr>
        <td>0.1
        <td>2008-01-10
        <td>Initial contribution
</table>

<h2><a name='Overview'>Overview</a></h2>

<p>File System service provides file transfer (and more generally file
system access) functionality in TCF. The service design is
derived from SSH File Transfer Protocol specifications.</p>

<h2><a name='ReqSync'>Request Synchronization and Reordering</a></h2>

<p>The protocol and implementations MUST process requests relating to
the same file in the order in which they are received.  In other
words, if an application submits multiple requests to the server, the
results in the responses will be the same as if it had sent the
requests one at a time and waited for the response in each case.  For
example, the server may process non-overlapping read/write requests
to the same file in parallel, but overlapping reads and writes cannot
be reordered or parallelized.  However, there are no ordering
restrictions on the server for processing requests from two different
file transfer connections.  The server may interleave and parallelize
them at will.</p>

<p>There are no restrictions on the order in which responses to
outstanding requests are delivered to the client, except that the
server must ensure fairness in the sense that processing of no
request will be indefinitely delayed even if the client is sending
other requests so that there are multiple outstanding requests all
the time.</p>

<p>There is no limit on the number of outstanding (non-acknowledged)
requests that the client may send to the server.  In practice this is
limited by the buffering available on the data stream and the queuing
performed by the server.  If the server's queues are full, it should
not read any more data from the stream, and flow control will prevent
the client from sending more requests.</p>

<h2><a name='FileNames'>File Names</a></h2>

<p>This protocol represents file names as strings.  File names are
assumed to use the slash ('/') character as a directory separator.</p>

<p>File names starting with a slash are "absolute", and are relative to
the root of the file system.  Names starting with any other character
are relative to the user's default directory (home directory). Client
can use 'user()' command to retrieve current user home directory.</p>

<p>Servers SHOULD interpret a path name component ".." as referring to
the parent directory, and "." as referring to the current directory.
If the server implementation limits access to certain parts of the
file system, it must be extra careful in parsing file names when
enforcing such restrictions.  There have been numerous reported
security bugs where a ".." in a path name has allowed access outside
the intended area.</p>

<p>An empty path name is valid, and it refers to the user's default
directory (usually the user's home directory).</p>

<p>Otherwise, no syntax is defined for file names by this specification.
Clients should not make any other assumptions; however, they can
splice path name components returned by readdir() together
using a slash ('/') as the separator, and that will work as expected.</p>

<h2><a name='FileModes'>File Open Modes</a></h2>

<p>File open mode is bitwise OR of mode flags:</p>

<dl>
    <dt><code>TCF_O_READ = 0x00000001</code>
    <dd>Open the file for reading.

    <dt><code>TCF_O_WRITE = 0x00000002</code>
    <dd>Open the file for writing. If both this and TCF_O_READ are
    specified, the file is opened for both reading and writing.

    <dt><code>TCF_O_APPEND = 0x00000004</code>
    <dd>Force all writes to append data at the end of the file.

    <dt><code>TCF_O_CREAT = 0x00000008</code>
    <dd>If this flag is specified, then a new file will be created if one
    does not already exist (if TCF_O_TRUNC is specified, the new file will
    be truncated to zero length if it previously exists).

    <dt><code>TCF_O_TRUNC = 0x00000010</code>
    <dd>Forces an existing file with the same name to be truncated to zero
    length when creating a file by specifying TCF_O_CREAT.
    TCF_O_CREAT MUST also be specified if this flag is used.

    <dt><code>TCF_O_EXCL = 0x00000020</code>
    <dd>Causes the request to fail if the named file already exists.
    TCF_O_CREAT MUST also be specified if this flag is used.
</dl>

<h2><a name='FileAttributes'>File Attributes</a></h2>

<pre><b><font face="Courier New" size=2 color=#333399>
<i>&lt;file attributes&gt;</i>
    &rArr; <i>&lt;object&gt;</i>
</font></b></pre>

<p>All attributes are optional.
Tools and targets can define additional attributes. Predefined attributes are:</p>
<ul>
    <li><code><b><font face="Courier New" size=2 color=#333399>"Size" : <i>&lt;int&gt;</i></font></b></code>
    - file size in bytes
    <li><code><b><font face="Courier New" size=2 color=#333399>"UID" : <i>&lt;int&gt;</i></font></b></code>
    - file owner user ID
    <li><code><b><font face="Courier New" size=2 color=#333399>"GID" : <i>&lt;int&gt;</i></font></b></code>
    - file owner group ID
    <li><code><b><font face="Courier New" size=2 color=#333399>"Permissions" : <i>&lt;int&gt;</i></font></b></code>
    - file access permissions
    <li><code><b><font face="Courier New" size=2 color=#333399>"ATime" : <i>&lt;int&gt;</i></font></b></code>
    - file last access time
    <li><code><b><font face="Courier New" size=2 color=#333399>"MTime" : <i>&lt;int&gt;</i></font></b></code>
    - file last modification time
</ul>

<h2><a name='ErrorCodes'>Error codes</a></h2>

<p>The service uses standard format for error reports,
see <a href='TCF Error Report Format.html'>Error Report Format</a>.</p>

<p>Currently, the following values are defined for service specific error codes (other values may be
defined by future versions of this protocol):</p>

<dl>
    <dt><code>STATUS_EOF = 0x10001</code>
    <dd>Indicates end-of-file condition; for 'read' it means that no
    more data is available in the file, and for 'readdir' it
    indicates that no more files are contained in the directory.

    <dt><code>STATUS_NO_SUCH_FILE = 0x10002</code>
    <dd>This code is returned when a reference is made to a file which
    should exist but doesn't.

    <dt><code>STATUS_PERMISSION_DENIED = 0x10003</code>
    <dd>is returned when the authenticated user does not have sufficient
    permissions to perform the operation.
</dl>

<h2><a name='Cmds'>Commands</a></h2>

<h3><a name='CmdOpen'>open</a></h3>

<pre><b><font face="Courier New" size=2 color=#333399>
C &bull; <i>&lt;token&gt;</i> &bull; FileSystem &bull; open &bull; <i>&lt;string: file name&gt;</i> &bull; <i>&lt;int: mode&gt;</i> &bull; <i>&lt;file attributes&gt;</i> &bull;
</font></b></pre>

<p>The command opens or creates a file on a remote system. If mode contains TCF_O_CREAT then new file is created, otherwise exsting
file is opened. If the file is created, file attributes is looked up for UID, GID and permissions. If no attribute value is found in
the command parameters, a default value is used.</p>

<p>Reply:</p>

<pre><b><font face="Courier New" size=2 color=#333399>
R &bull; <i>&lt;token&gt;</i> &bull; <i>&lt;error report&gt;</i> &bull; <i>&lt;file handle&gt;</i> &bull;

<i>&lt;file handle&gt;</i>
    &rArr; null
    &rArr; <i>&lt;string&gt;</i>
</font></b></pre>

<p>On success, the replay contains open file handle. The handle is encoded as a string of characters. Client should never try
to decode the string, but should use it as is to issue further file access commands. Client should close the file when it is
not needed any more. Server should close all files that were left open after client connection was closed ot terminated.</p>

<h3><a name='CmdClose'>close</a></h3>

<pre><b><font face="Courier New" size=2 color=#333399>
C &bull; <i>&lt;token&gt;</i> &bull; FileSystem &bull; close &bull; <i>&lt;string: file handle&gt;</i> &bull;
</font></b></pre>

<p>The command closes a handle, which was open by 'open' or 'opendir' commands.</p>

<p>Reply:</p>

<pre><b><font face="Courier New" size=2 color=#333399>
R &bull; <i>&lt;token&gt;</i> &bull; <i>&lt;error report&gt;</i> &bull;
</font></b></pre>

<h3><a name='CmdRead'>read</a></h3>

<pre><b><font face="Courier New" size=2 color=#333399>
C &bull; <i>&lt;token&gt;</i> &bull; FileSystem &bull; read &bull; <i>&lt;string: file handle&gt;</i> &bull; <i>&lt;int: offset&gt;</i> &bull; <i>&lt;int: size&gt;</i> &bull;
</font></b></pre>

<p>The command reads bytes from an open file.
In response to this request, the server will read as many bytes as it
can from the file (up to `size'), and return them in a byte array.
If an error occurs or EOF is encountered, the server may return
fewer bytes then requested. Replay argument 'error report'
will be not null in case of error, and argument 'eof' will be
true in case of EOF. For normal disk files, it is guaranteed
that this will read the specified number of bytes, or up to end of file
or error. For e.g. device files this may return fewer bytes than requested.</p>

<p>If 'offset' < 0 then reading will start from current position in the file.</p>

<p>Reply:</p>

<pre><b><font face="Courier New" size=2 color=#333399>
R &bull; <i>&lt;token&gt;</i> &bull; <i>&lt;string: data&gt;</i> &bull; <i>&lt;error report&gt;</i> &bull; <i>&lt;boolean: eof&gt;</i> &bull;
</font></b></pre>

<p><i>&lt;string: data&gt;</i> is Base64 encoded byte array of file data. Number of bytes is determined by the string length.
'eof' is true when 'data' contains all available bytes up to the end of the file.</p>

<h3><a name='CmdWrite'>write</a></h3>

<pre><b><font face="Courier New" size=2 color=#333399>
C &bull; <i>&lt;token&gt;</i> &bull; FileSystem &bull; write &bull; <i>&lt;string: file handle&gt;</i> &bull; <i>&lt;int: offset&gt;</i> &bull; <i>&lt;string: data&gt;</i> &bull;
</font></b></pre>

<p>The command writes bytes into an open file.
The write will extend the file if writing beyond the end of the file.
It is legal to write way beyond the end of the file; the semantics
are to write zeroes from the end of the file to the specified offset
and then the data. <i>&lt;string: data&gt;</i> is Base64 encoded array of data bytes.</p>

<p>If 'offset' < 0 then writing will start from current position in the file.</p>

<p>Reply:</p>

<pre><b><font face="Courier New" size=2 color=#333399>
R &bull; <i>&lt;token&gt;</i> &bull; <i>&lt;error report&gt;</i> &bull;
</font></b></pre>

<h3><a name='CmdStat'>stat</a></h3>

<pre><b><font face="Courier New" size=2 color=#333399>
C &bull; <i>&lt;token&gt;</i> &bull; FileSystem &bull; stat &bull; <i>&lt;string: file name&gt;</i> &bull;
</font></b></pre>

<p>The command retrieves file attributes.</p>

<p>Reply:</p>

<pre><b><font face="Courier New" size=2 color=#333399>
R &bull; <i>&lt;token&gt;</i> &bull; <i>&lt;error report&gt;</i> &bull; <i>&lt;file attributes&gt;</i> &bull;
</font></b></pre>

<h3><a name='CmdLStat'>lstat</a></h3>

<pre><b><font face="Courier New" size=2 color=#333399>
C &bull; <i>&lt;token&gt;</i> &bull; FileSystem &bull; lstat &bull; <i>&lt;string: file name&gt;</i> &bull;
</font></b></pre>

<p>The command retrieves file attributes.
Unlike 'stat', 'lstat' does not follow symbolic links.</p>

<p>Reply:</p>

<pre><b><font face="Courier New" size=2 color=#333399>
R &bull; <i>&lt;token&gt;</i> &bull; <i>&lt;error report&gt;</i> &bull; <i>&lt;file attributes&gt;</i> &bull;
</font></b></pre>

<h3><a name='CmdFStat'>fstat</a></h3>

<pre><b><font face="Courier New" size=2 color=#333399>
C &bull; <i>&lt;token&gt;</i> &bull; FileSystem &bull; fstat &bull; <i>&lt;string: file handle&gt;</i> &bull;
</font></b></pre>

<p>The command retrieves file attributes for an open file (identified by the file handle).</p>

<p>Reply:</p>

<pre><b><font face="Courier New" size=2 color=#333399>
R &bull; <i>&lt;token&gt;</i> &bull; <i>&lt;error report&gt;</i> &bull; <i>&lt;file attributes&gt;</i> &bull;
</font></b></pre>

<h3><a name='CmdSetStat'>setstat</a></h3>

<pre><b><font face="Courier New" size=2 color=#333399>
C &bull; <i>&lt;token&gt;</i> &bull; FileSystem &bull; setstat &bull; <i>&lt;string: file name&gt;</i> &bull; <i>&lt;file attributes&gt;</i> &bull;
</font></b></pre>

<p>The command sets file attributes.
This request is used for operations such as changing the ownership,
permissions or access times, as well as for truncating a file.
An error will be returned if the specified file system object does
not exist or the user does not have sufficient rights to modify the
specified attributes.</p>

<p>Reply:</p>

<pre><b><font face="Courier New" size=2 color=#333399>
R &bull; <i>&lt;token&gt;</i> &bull; <i>&lt;error report&gt;</i> &bull;
</font></b></pre>

<h3><a name='CmdFSetStat'>fsetstat</a></h3>

<pre><b><font face="Courier New" size=2 color=#333399>
C &bull; <i>&lt;token&gt;</i> &bull; FileSystem &bull; fsetstat &bull; <i>&lt;string: file handle&gt;</i> &bull; <i>&lt;file attributes&gt;</i> &bull;
</font></b></pre>

<p>The command sets file attributes for an open file (identified by the file handle).
This request is used for operations such as changing the ownership,
permissions or access times, as well as for truncating a file.</p>

<p>Reply:</p>

<pre><b><font face="Courier New" size=2 color=#333399>
R &bull; <i>&lt;token&gt;</i> &bull; <i>&lt;error report&gt;</i> &bull;
</font></b></pre>

<h3><a name='CmdOpenDir'>opendir</a></h3>

<pre><b><font face="Courier New" size=2 color=#333399>
C &bull; <i>&lt;token&gt;</i> &bull; FileSystem &bull; opendir &bull; <i>&lt;string: path&gt;</i> &bull;
</font></b></pre>

<p>The command opens a directory for reading.
Once the directory has been successfully opened, files (and
directories) contained in it can be listed using 'readdir' requests.
When the client no longer wishes to read more names from the
directory, it SHOULD call 'close' for the handle.  The handle
should be closed regardless of whether a read errors have occurred or not.</p>

<p>Reply:</p>

<pre><b><font face="Courier New" size=2 color=#333399>
R &bull; <i>&lt;token&gt;</i> &bull; <i>&lt;error report&gt;</i> &bull; <i>&lt;file handle&gt;</i> &bull;
</font></b></pre>

<h3><a name='CmdReadDir'>readdir</a></h3>

<pre><b><font face="Courier New" size=2 color=#333399>
C &bull; <i>&lt;token&gt;</i> &bull; FileSystem &bull; readdir &bull; <i>&lt;string: file handle&gt;</i> &bull;
</font></b></pre>

<p>The command returns one
or more file names with full file attributes for each file.  The
client should call 'readdir' repeatedly until it has found the
file it is looking for or until the server responds with a
message indicating an error or end of file. The client should then
close the handle using the 'close' request.
Note: directory entries "." and ".." are NOT included into readdir()
response.</p>

<p>Reply:</p>

<pre><b><font face="Courier New" size=2 color=#333399>
R &bull; <i>&lt;token&gt;</i> &bull; <i>&lt;array of directory entries&gt;</i> &bull; <i>&lt;error report&gt;</i> &bull; <i>&lt;boolean: eof&gt;</i> &bull;

<i>&lt;array of directory entries&gt;</i>
    &rArr; null
    &rArr; [ ]
    &rArr; [ <i>&lt;directory entry list&gt;</i> ]

<i>&lt;directory entry list&gt;</i>
    &rArr; <i>&lt;directory entry&gt;</i>
    &rArr; <i>&ltdirectory entry list&gt;</i> , <i>&lt;directory entry&gt;</i>

<i>&lt;directory entry&gt;</i>
    &rArr; <i>&lt;object&gt;</i>
</font></b></pre>

<p>Directory entry attributes are:</p>
<ul>
    <li><code><b><font face="Courier New" size=2 color=#333399>"FileName" : <i>&lt;string&gt;</i></font></b></code>
    - a file name being returned, it will be a relative name within the directory,
    without any path components.
    <li><code><b><font face="Courier New" size=2 color=#333399>"LongName" : <i>&lt;string&gt;</i></font></b></code>
    - a human readable, expanded format for the file name, similar to what
    is returned by "ls -l" on Unix systems
    <li><code><b><font face="Courier New" size=2 color=#333399>"Attrs" : <i>&lt;file attributes&gt;</i></font></b></code>
    - the attributes of the file as described in Section <a href='#FileAttributes'>File Attributes</a>.
</ul>

<h3><a name='CmdMkDir'>mkdir</a></h3>

<pre><b><font face="Courier New" size=2 color=#333399>
C &bull; <i>&lt;token&gt;</i> &bull; FileSystem &bull; mkdir &bull; <i>&lt;string: directory path&gt;</i> &bull; <i>&lt;file attributes&gt;</i> &bull;
</font></b></pre>

<p>The command creates a directory on the server.
<i>&lt;string: directory path&gt;</i> specifies the directory to be created.
<i>&lt;file attributes&gt;</i> specifies new directory attributes.</p>

<p>Reply:</p>

<pre><b><font face="Courier New" size=2 color=#333399>
R &bull; <i>&lt;token&gt;</i> &bull; <i>&lt;error report&gt;</i> &bull;
</font></b></pre>

<h3><a name='CmdRmDir'>rmdir</a></h3>

<pre><b><font face="Courier New" size=2 color=#333399>
C &bull; <i>&lt;token&gt;</i> &bull; FileSystem &bull; rmdir &bull; <i>&lt;string: directory path&gt;</i> &bull;
</font></b></pre>

<p>The command removes a directory.
An error will be returned if no directory
with the specified path exists, or if the specified directory is not
empty, or if the path specified a file system object other than a
directory. <i>&lt;string: directory path&gt;</i> - specifies the directory to be removed.</p>

<p>Reply:</p>

<pre><b><font face="Courier New" size=2 color=#333399>
R &bull; <i>&lt;token&gt;</i> &bull; <i>&lt;error report&gt;</i> &bull;
</font></b></pre>

<h3><a name='CmdRoots'>roots</a></h3>

<pre><b><font face="Courier New" size=2 color=#333399>
C &bull; <i>&lt;token&gt;</i> &bull; FileSystem &bull; roots &bull;
</font></b></pre>

<p>The command retrieves file system roots - top level file system objects.
UNIX file system can report just one root with path "/". Other types of systems
can have more the one root. For example, Windows server can return multiple roots:
one per disc (e.g. "/C:/", "/D:/", etc.). Note: even Windows implementation of
the service must use forward slash as directory separator, and must start
absolute path with "/". Server should implement proper translation of
protocol file names to OS native names and back.</p>

<p>Reply:</p>

<pre><b><font face="Courier New" size=2 color=#333399>
R &bull; <i>&lt;token&gt;</i> &bull; <i>&lt;array of directory entries&gt;</i> &bull; <i>&lt;error report&gt;</i> &bull;
</font></b></pre>

<h3><a name='CmdRemove'>remove</a></h3>

<pre><b><font face="Courier New" size=2 color=#333399>
C &bull; <i>&lt;token&gt;</i> &bull; FileSystem &bull; remove &bull; <i>&lt;string: path&gt;</i> &bull;
</font></b></pre>

<p>The command removes a file or symbolic link.
This request cannot be used to remove directories.</p>

<p>Reply:</p>

<pre><b><font face="Courier New" size=2 color=#333399>
R &bull; <i>&lt;token&gt;</i> &bull; <i>&lt;error report&gt;</i> &bull;
</font></b></pre>

<h3><a name='CmdRealPath'>realpath</a></h3>

<pre><b><font face="Courier New" size=2 color=#333399>
C &bull; <i>&lt;token&gt;</i> &bull; FileSystem &bull; realpath &bull; <i>&lt;string: path&gt;</i> &bull;
</font></b></pre>

<p>The command canonicalizes any given path name to an absolute path.
This is useful for converting path names containing ".." components or
relative pathnames without a leading slash into absolute paths.</p>

<p>Reply:</p>

<pre><b><font face="Courier New" size=2 color=#333399>
R &bull; <i>&lt;token&gt;</i> &bull; <i>&lt;error report&gt;</i> &bull; <i>&lt;string: path&gt;</i> &bull;
</font></b></pre>

<h3><a name='CmdRename'>rename</a></h3>

<pre><b><font face="Courier New" size=2 color=#333399>
C &bull; <i>&lt;token&gt;</i> &bull; FileSystem &bull; rename &bull; <i>&lt;string: old path&gt;</i> &bull; <i>&lt;string: new path&gt;</i> &bull;
</font></b></pre>

<p>The command renames a file.
It is an error if there already exists a file
with the name specified by <i>&lt;string: new path&gt;</i>.  The server may also fail rename
requests in other situations, for example if <i>&lt;string: old path&gt;</i> and <i>&lt;string: new path&gt;</i>
point to different file systems on the server.</p>

<p>Reply:</p>

<pre><b><font face="Courier New" size=2 color=#333399>
R &bull; <i>&lt;token&gt;</i> &bull; <i>&lt;error report&gt;</i> &bull;
</font></b></pre>

<h3><a name='CmdReadLink'>readlink</a></h3>

<pre><b><font face="Courier New" size=2 color=#333399>
C &bull; <i>&lt;token&gt;</i> &bull; FileSystem &bull; readlink &bull; <i>&lt;string: link path&gt;</i> &bull;
</font></b></pre>

<p>The command reads the target of a symbolic link.
<i>&lt;string: link path&gt;</i> specifies the path name of the symbolic link to be read.</p>

<p>Reply:</p>

<pre><b><font face="Courier New" size=2 color=#333399>
R &bull; <i>&lt;token&gt;</i> &bull; <i>&lt;error report&gt;</i> &bull; <i>&lt;string: path&gt;</i> &bull;
</font></b></pre>

<h3><a name='CmdSymLink'>symlink</a></h3>

<pre><b><font face="Courier New" size=2 color=#333399>
C &bull; <i>&lt;token&gt;</i> &bull; FileSystem &bull; symlink &bull; <i>&lt;string: link path&gt;</i> &bull; <i>&lt;string: target path&gt;</i> &bull;
</font></b></pre>

<p>The command creates a symbolic link on the server.
<i>&lt;string: link path&gt;</i> specifies the path name of the symbolic link to be created.
<i>&lt;string: target path&gt;</i> specifies the target of the symbolic link.</p>

<p>Reply:</p>

<pre><b><font face="Courier New" size=2 color=#333399>
R &bull; <i>&lt;token&gt;</i> &bull; <i>&lt;error report&gt;</i> &bull;
</font></b></pre>

<h3><a name='CmdCopy'>copy</a></h3>

<pre><b><font face="Courier New" size=2 color=#333399>
C &bull; <i>&lt;token&gt;</i> &bull; FileSystem &bull; copy &bull; <i>&lt;string: source path&gt;</i> &bull; <i>&lt;string: destination path&gt;</i> &bull;
    <i>&lt;boolean: copy permissions&gt;</i> &bull; <i>&lt;boolean: copy ownership&gt;</i> &bull;
</font></b></pre>

<p>The command copies a file on remote system.
<i>&lt;string: source path&gt;</i> specifies the path name of the file to be copied.
<i>&lt;string: destination path&gt;</i> specifies destination file name.
If <i>&lt;boolean: copy permissions&gt;</i> is true then copy source file permissions.
If <i>&lt;boolean: copy ownership&gt;</i> is true then copy source file UID and GID.</p>

<p>Reply:</p>

<pre><b><font face="Courier New" size=2 color=#333399>
R &bull; <i>&lt;token&gt;</i> &bull; <i>&lt;error report&gt;</i> &bull;
</font></b></pre>

<h3><a name='CmdUser'>user</a></h3>

<pre><b><font face="Courier New" size=2 color=#333399>
C &bull; <i>&lt;token&gt;</i> &bull; FileSystem &bull; user &bull;
</font></b></pre>

<p>The command retrieves information about user account, which is used by server
to access file system on behalf of the client.</p>

<p>Reply:</p>

<pre><b><font face="Courier New" size=2 color=#333399>
R &bull; <i>&lt;token&gt;</i> &bull; <i>&lt;int: real UID&gt;</i> &bull; <i>&lt;int: effective UID&gt;</i> &bull;
    <i>&lt;int: real GID&gt;</i> &bull; <i>&lt;int: effective GID&gt;</i> &bull; <i>&lt;string: home directory&gt;</i> &bull;
</font></b></pre>

<h2><a name='API'>API</a></h2>

<pre>
<font color=#3F5FBF>/**
 * File System service provides file transfer (and more generally file
 * system access) functionality in TCF. The service design is
 * derived from SSH File Transfer Protocol specifications.
 *
 *      Request Synchronization and Reordering
 *
 * The protocol and implementations MUST process requests relating to
 * the same file in the order in which they are received.  In other
 * words, if an application submits multiple requests to the server, the
 * results in the responses will be the same as if it had sent the
 * requests one at a time and waited for the response in each case.  For
 * example, the server may process non-overlapping read/write requests
 * to the same file in parallel, but overlapping reads and writes cannot
 * be reordered or parallelized.  However, there are no ordering
 * restrictions on the server for processing requests from two different
 * file transfer connections.  The server may interleave and parallelize
 * them at will.
 *
 * There are no restrictions on the order in which responses to
 * outstanding requests are delivered to the client, except that the
 * server must ensure fairness in the sense that processing of no
 * request will be indefinitely delayed even if the client is sending
 * other requests so that there are multiple outstanding requests all
 * the time.
 *
 * There is no limit on the number of outstanding (non-acknowledged)
 * requests that the client may send to the server.  In practice this is
 * limited by the buffering available on the data stream and the queuing
 * performed by the server.  If the server's queues are full, it should
 * not read any more data from the stream, and flow control will prevent
 * the client from sending more requests.
 *
 *      File Names
 *
 * This protocol represents file names as strings.  File names are
 * assumed to use the slash ('/') character as a directory separator.
 *
 * File names starting with a slash are "absolute", and are relative to
 * the root of the file system.  Names starting with any other character
 * are relative to the user's default directory (home directory). Client
 * can use 'user()' command to retrieve current user home directory.
 *
 * Servers SHOULD interpret a path name component ".." as referring to
 * the parent directory, and "." as referring to the current directory.
 * If the server implementation limits access to certain parts of the
 * file system, it must be extra careful in parsing file names when
 * enforcing such restrictions.  There have been numerous reported
 * security bugs where a ".." in a path name has allowed access outside
 * the intended area.
 *
 * An empty path name is valid, and it refers to the user's default
 * directory (usually the user's home directory).
 *
 * Otherwise, no syntax is defined for file names by this specification.
 * Clients should not make any other assumptions; however, they can
 * splice path name components returned by readdir() together
 * using a slash ('/') as the separator, and that will work as expected.
 *
 * <font color=#7F9FBF>@noimplement</font> This interface is not intended to be implemented by clients.
 */</font>
<font color=#7F0055>public interface</font> IFileSystem <font color=#7F0055>extends</font> IService {

    <font color=#3F5FBF>/**
     * This service name, as it appears on the wire - a TCF name of the service.
     */</font>
    <font color=#7F0055>static final</font> String NAME = "FileSystem";

    <font color=#3F5FBF>/**
     * Flags to be used with open() method.
     */</font>
    <font color=#7F0055>static final int</font>

        <font color=#3F5FBF>/**
         * Open the file for reading.
         */</font>
        TCF_O_READ              = 0x00000001,

        <font color=#3F5FBF>/**
         * Open the file for writing. If both this and TCF_O_READ are
         * specified, the file is opened for both reading and writing.
         */</font>
        TCF_O_WRITE             = 0x00000002,

        <font color=#3F5FBF>/**
         * Force all writes to append data at the end of the file.
         */</font>
        TCF_O_APPEND            = 0x00000004,

        <font color=#3F5FBF>/**
         * If this flag is specified, then a new file will be created if one
         * does not already exist (if TCF_O_TRUNC is specified, the new file will
         * be truncated to zero length if it previously exists).
         */</font>
        TCF_O_CREAT             = 0x00000008,

        <font color=#3F5FBF>/**
         * Forces an existing file with the same name to be truncated to zero
         * length when creating a file by specifying TCF_O_CREAT.
         * TCF_O_CREAT MUST also be specified if this flag is used.
         */</font>
        TCF_O_TRUNC             = 0x00000010,

        <font color=#3F5FBF>/**
         * Causes the request to fail if the named file already exists.
         * TCF_O_CREAT MUST also be specified if this flag is used.
         */</font>
        TCF_O_EXCL              = 0x00000020;

    <font color=#3F5FBF>/**
     * Flags to be used together with FileAttrs.
     * The flags specify which of the fields are present.  Those fields
     * for which the corresponding flag is not set are not present (not
     * included in the message).
     */</font>
    <font color=#7F0055>static final int</font>
        ATTR_SIZE               = 0x00000001,
        ATTR_UIDGID             = 0x00000002,
        ATTR_PERMISSIONS        = 0x00000004,
        ATTR_ACMODTIME          = 0x00000008;

    <font color=#3F5FBF>/**
     * FileAttrs is used both when returning file attributes from
     * the server and when sending file attributes to the server.  When
     * sending it to the server, the flags field specifies which attributes
     * are included, and the server will use default values for the
     * remaining attributes (or will not modify the values of remaining
     * attributes).  When receiving attributes from the server, the flags
     * specify which attributes are included in the returned data.  The
     * server normally returns all attributes it knows about.
     */</font>
    <font color=#7F0055>final static class</font> FileAttrs {

        <font color=#3F5FBF>/**
         * The `flags' specify which of the fields are present.
         */</font>
        <font color=#7F0055>public final int</font> flags;

        <font color=#3F5FBF>/**
         * The `size' field specifies the size of the file in bytes.
         */</font>
        <font color=#7F0055>public final long</font> size;

        <font color=#3F5FBF>/**
         * The `uid' and `gid' fields contain numeric Unix-like user and group
         * identifiers, respectively.
         */</font>
        <font color=#7F0055>public final int</font> uid;
        <font color=#7F0055>public final int</font> gid;

        <font color=#3F5FBF>/**
         * The `permissions' field contains a bit mask of file permissions as
         * defined by posix [1].
         */</font>
        <font color=#7F0055>public final int</font> permissions;

        <font color=#3F5FBF>/**
         * The `atime' and `mtime' contain the access and modification times of
         * the files, respectively. They are represented as milliseconds from
         * midnight Jan 1, 1970 in UTC.
         */</font>
        <font color=#7F0055>public final long</font> atime;
        <font color=#7F0055>public final long</font> mtime;

        <font color=#3F5FBF>/**
         * Additional (non-standard) attributes.
         */</font>
        <font color=#7F0055>public final</font> Map&lt;String,Object&gt; attributes;

        <font color=#7F0055>public</font> FileAttrs(<font color=#7F0055>int</font> flags, <font color=#7F0055>long</font> size, <font color=#7F0055>int</font> uid, <font color=#7F0055>int</font> gid,
                <font color=#7F0055>int</font> permissions, <font color=#7F0055>long</font> atime, <font color=#7F0055>long</font> mtime, Map&lt;String,Object&gt; attributes) {
            <font color=#7F0055>this</font>.flags = flags;
            <font color=#7F0055>this</font>.size = size;
            <font color=#7F0055>this</font>.uid = uid;
            <font color=#7F0055>this</font>.gid = gid;
            <font color=#7F0055>this</font>.permissions = permissions;
            <font color=#7F0055>this</font>.atime = atime;
            <font color=#7F0055>this</font>.mtime = mtime;
            <font color=#7F0055>this</font>.attributes = attributes;
        }

        <font color=#3F5FBF>/**
         * Determines if the file system object is a file on the remote file system.
         *
         * <font color=#7F9FBF>@return</font> true if and only if the object on the remote system can be considered to have "contents" that
         * have the potential to be read and written as a byte stream.
         */</font>
        <font color=#7F0055>public</font> <font color=#7F0055>boolean</font> isFile() {
            if ((flags & ATTR_PERMISSIONS) == 0) return false;
            return (permissions & S_IFMT) == S_IFREG;
        }

        <font color=#3F5FBF>/**
         * Determines if the file system object is a directory on the remote file system.
         *
         * <font color=#7F9FBF>@return</font> true if and only if the object on the remote system is a directory.
         * That is, it contains entries that can be interpreted as other files.
         */</font>
        <font color=#7F0055>public</font> <font color=#7F0055>boolean</font> isDirectory() {
            if ((flags & ATTR_PERMISSIONS) == 0) return false;
            return (permissions & S_IFMT) == S_IFDIR;
        }
    }

    <font color=#3F5FBF>/**
     * The following flags are defined for the 'permissions' field:
     */</font>
    <font color=#7F0055>static final int</font>
        S_IFMT     = 0170000,   // bitmask for the file type bitfields
        S_IFSOCK   = 0140000,   // socket
        S_IFLNK    = 0120000,   // symbolic link
        S_IFREG    = 0100000,   // regular file
        S_IFBLK    = 0060000,   // block device
        S_IFDIR    = 0040000,   // directory
        S_IFCHR    = 0020000,   // character device
        S_IFIFO    = 0010000,   // fifo
        S_ISUID    = 0004000,   // set UID bit
        S_ISGID    = 0002000,   // set GID bit (see below)
        S_ISVTX    = 0001000,   // sticky bit (see below)
        S_IRWXU    = 00700,     // mask for file owner permissions
        S_IRUSR    = 00400,     // owner has read permission
        S_IWUSR    = 00200,     // owner has write permission
        S_IXUSR    = 00100,     // owner has execute permission
        S_IRWXG    = 00070,     // mask for group permissions
        S_IRGRP    = 00040,     // group has read permission
        S_IWGRP    = 00020,     // group has write permission
        S_IXGRP    = 00010,     // group has execute permission
        S_IRWXO    = 00007,     // mask for permissions for others (not in group)
        S_IROTH    = 00004,     // others have read permission
        S_IWOTH    = 00002,     // others have write permission
        S_IXOTH    = 00001;     // others have execute permission

    <font color=#7F0055>final static class</font> DirEntry {
        <font color=#3F5FBF>/**
         * `filename' is a file name being returned. It is a relative name within
         * the directory, without any path components;
         */</font>
        <font color=#7F0055>public final</font> String filename;

        <font color=#3F5FBF>/**
         * `longname' is an expanded format for the file name, similar to what
         * is returned by "ls -l" on Unix systems.
         * The format of the `longname' field is unspecified by this protocol.
         * It MUST be suitable for use in the output of a directory listing
         * command (in fact, the recommended operation for a directory listing
         * command is to simply display this data).  However, clients SHOULD NOT
         * attempt to parse the longname field for file attributes; they SHOULD
         * use the attrs field instead.
         */</font>
        <font color=#7F0055>public final</font> String longname;

        <font color=#3F5FBF>/**
         * `attrs' is the attributes of the file.
         */</font>
        <font color=#7F0055>public final</font> FileAttrs attrs;

        <font color=#7F0055>public</font> DirEntry(String filename, String longname, FileAttrs attrs) {
            <font color=#7F0055>this</font>.filename = filename;
            <font color=#7F0055>this</font>.longname = longname;
            <font color=#7F0055>this</font>.attrs = attrs;
        }
    }

    <font color=#3F5FBF>/**
     * Opaque representation of open file handle.
     * Note: open file handle can be used only with service instance that
     * created the handle.
     */</font>
    <font color=#7F0055>interface</font> IFileHandle {
        IFileSystem getService();
    }

    <font color=#3F5FBF>/**
     * Service specific error codes.
     */</font>
    <font color=#7F0055>static final int</font>

        <font color=#3F5FBF>/**
         * Indicates end-of-file condition; for read() it means that no
         * more data is available in the file, and for readdir() it
         * indicates that no more files are contained in the directory.
         */</font>
        STATUS_EOF = 0x10001,

        <font color=#3F5FBF>/**
         * This code is returned when a reference is made to a file which
         * should exist but doesn't.
         */</font>
        STATUS_NO_SUCH_FILE = 0x10002,

        <font color=#3F5FBF>/**
         * is returned when the authenticated user does not have sufficient
         * permissions to perform the operation.
         */</font>
        STATUS_PERMISSION_DENIED = 0x10003;

    <font color=#3F5FBF>/**
     * The class to represent File System error reports.
     */</font>
    @SuppressWarnings("serial")
    <font color=#7F0055>abstract static class</font> FileSystemException <font color=#7F0055>extends</font> IOException {

        <font color=#7F0055>protected</font> FileSystemException(String message) {
            super(message);
        }

        <font color=#7F0055>protected</font> FileSystemException(Exception x) {
            super(x.getMessage());
            initCause(x);
        }

        <font color=#3F5FBF>/**
         * Get error code. The code can be standard TCF error code or
         * one of service specific codes, see STATUS_*.
         * <font color=#7F9FBF>@return</font> error code.
         */</font>
        <font color=#7F0055>public abstract int</font> getStatus();
    }

    <font color=#3F5FBF>/**
     * Open or create a file on a remote system.
     *
     * <font color=#7F9FBF>@param</font> file_name specifies the file name.  See 'File Names' for more information.
     * <font color=#7F9FBF>@param</font> flags is a bit mask of TCF_O_* flags.
     * <font color=#7F9FBF>@param</font> attrs specifies the initial attributes for the file.
     *  Default values will be used for those attributes that are not specified.
     * <font color=#7F9FBF>@param</font> done is call back object.
     * <font color=#7F9FBF>@return</font> pending command handle.
     */</font>
    IToken open(String file_name, <font color=#7F0055>int</font> flags, FileAttrs attrs, DoneOpen done);

    <font color=#7F0055>interface</font> DoneOpen {
        <font color=#7F0055>void</font> doneOpen(IToken token, FileSystemException error, IFileHandle handle);
    }

    <font color=#3F5FBF>/**
     * Close a file on a remote system.
     *
     * <font color=#7F9FBF>@param</font> handle is a handle previously returned in the response to
     * open() or opendir().
     * <font color=#7F9FBF>@param</font> done is call back object.
     * <font color=#7F9FBF>@return</font> pending command handle.
     */</font>
    IToken close(IFileHandle handle, DoneClose done);

    <font color=#7F0055>interface</font> DoneClose {
        <font color=#7F0055>void</font> doneClose(IToken token, FileSystemException error);
    }

    <font color=#3F5FBF>/**
     * Read bytes from an open file.
     * In response to this request, the server will read as many bytes as it
     * can from the file (up to `len'), and return them in a byte array.
     * If an error occurs or EOF is encountered, the server may return
     * fewer bytes then requested. Call back method doneRead() argument 'error'
     * will be not null in case of error, and argument 'eof' will be
     * true in case of EOF. For normal disk files, it is guaranteed
     * that this will read the specified number of bytes, or up to end of file
     * or error. For e.g. device files this may return fewer bytes than requested.
     *
     * <font color=#7F9FBF>@param</font> handle is an open file handle returned by open().
     * <font color=#7F9FBF>@param</font> offset is the offset (in bytes) relative
     * to the beginning of the file from where to start reading.
     * If offset &lt; 0 then reading starts from current position in the file.
     * <font color=#7F9FBF>@param</font> len is the maximum number of bytes to read.
     * <font color=#7F9FBF>@param</font> done is call back object.
     * <font color=#7F9FBF>@return</font> pending command handle.
     */</font>
    IToken read(IFileHandle handle, <font color=#7F0055>long</font> offset, <font color=#7F0055>int</font> len, DoneRead done);

    <font color=#7F0055>interface</font> DoneRead {
        <font color=#7F0055>void</font> doneRead(IToken token, FileSystemException error, <font color=#7F0055>byte</font>[] data, <font color=#7F0055>boolean</font> eof);
    }

    <font color=#3F5FBF>/**
     * Write bytes into an open file.
     * The write will extend the file if writing beyond the end of the file.
     * It is legal to write way beyond the end of the file; the semantics
     * are to write zeroes from the end of the file to the specified offset
     * and then the data.
     *
     * <font color=#7F9FBF>@param</font> handle is an open file handle returned by open().
     * <font color=#7F9FBF>@param</font> offset is the offset (in bytes) relative
     * to the beginning of the file from where to start writing.
     * If offset &lt; 0 then writing starts from current position in the file.
     * <font color=#7F9FBF>@param</font> data is byte array that contains data for writing.
     * <font color=#7F9FBF>@param</font> data_pos if offset in 'data' of first byte to write.
     * <font color=#7F9FBF>@param</font> data_size is the number of bytes to write.
     * <font color=#7F9FBF>@param</font> done is call back object.
     * <font color=#7F9FBF>@return</font> pending command handle.
     */</font>
    IToken write(IFileHandle handle, <font color=#7F0055>long</font> offset,
            <font color=#7F0055>byte</font>[] data, <font color=#7F0055>int</font> data_pos, <font color=#7F0055>int</font> data_size, DoneWrite done);

    <font color=#7F0055>interface</font> DoneWrite {
        <font color=#7F0055>void</font> doneWrite(IToken token, FileSystemException error);
    }

    <font color=#3F5FBF>/**
     * Retrieve file attributes.
     *
     * <font color=#7F9FBF>@param</font> path - specifies the file system object for which
     * status is to be returned.
     * <font color=#7F9FBF>@param</font> done is call back object.
     * <font color=#7F9FBF>@return</font> pending command handle.
     */</font>
    IToken stat(String path, DoneStat done);

    <font color=#3F5FBF>/**
     * Retrieve file attributes.
     * Unlike 'stat()', 'lstat()' does not follow symbolic links.
     *
     * <font color=#7F9FBF>@param</font> path - specifies the file system object for which
     * status is to be returned.
     * <font color=#7F9FBF>@param</font> done is call back object.
     * <font color=#7F9FBF>@return</font> pending command handle.
     */</font>
    IToken lstat(String path, DoneStat done);

    <font color=#3F5FBF>/**
     * Retrieve file attributes for an open file (identified by the file handle).
     *
     * <font color=#7F9FBF>@param</font> handle is a file handle returned by 'open()'.
     * <font color=#7F9FBF>@param</font> done is call back object.
     * <font color=#7F9FBF>@return</font> pending command handle.
     */</font>
    IToken fstat(IFileHandle handle, DoneStat done);

    <font color=#7F0055>interface</font> DoneStat {
        <font color=#7F0055>void</font> doneStat(IToken token, FileSystemException error, FileAttrs attrs);
    }

    <font color=#3F5FBF>/**
     * Set file attributes.
     * This request is used for operations such as changing the ownership,
     * permissions or access times, as well as for truncating a file.
     * An error will be returned if the specified file system object does
     * not exist or the user does not have sufficient rights to modify the
     * specified attributes.
     *
     * <font color=#7F9FBF>@param</font> path specifies the file system object (e.g. file or directory)
     * whose attributes are to be modified.
     * <font color=#7F9FBF>@param</font> attrs specifies the modifications to be made to file attributes.
     * <font color=#7F9FBF>@param</font> done is call back object.
     * <font color=#7F9FBF>@return</font> pending command handle.
     */</font>
    IToken setstat(String path, FileAttrs attrs, DoneSetStat done);

    <font color=#3F5FBF>/**
     * Set file attributes for an open file (identified by the file handle).
     * This request is used for operations such as changing the ownership,
     * permissions or access times, as well as for truncating a file.
     *
     * <font color=#7F9FBF>@param</font> handle is a file handle returned by 'open()'.
     * <font color=#7F9FBF>@param</font> attrs specifies the modifications to be made to file attributes.
     * <font color=#7F9FBF>@param</font> done is call back object.
     * <font color=#7F9FBF>@return</font> pending command handle.
     */</font>
    IToken fsetstat(IFileHandle handle, FileAttrs attrs, DoneSetStat done);

    <font color=#7F0055>interface</font> DoneSetStat {
        <font color=#7F0055>void</font> doneSetStat(IToken token, FileSystemException error);
    }

    <font color=#3F5FBF>/**
     * The opendir() command opens a directory for reading.
     * Once the directory has been successfully opened, files (and
     * directories) contained in it can be listed using readdir() requests.
     * When the client no longer wishes to read more names from the
     * directory, it SHOULD call close() for the handle.  The handle
     * should be closed regardless of whether an error has occurred or not.

     * <font color=#7F9FBF>@param</font> path - name of the directory to be listed (without any trailing slash).
     * <font color=#7F9FBF>@param</font> done - result call back object.
     * <font color=#7F9FBF>@return</font> pending command handle.
     */</font>
    IToken opendir(String path, DoneOpen done);

    <font color=#3F5FBF>/**
     * The files in a directory can be listed using the opendir() and
     * readdir() requests.  Each readdir() request returns one
     * or more file names with full file attributes for each file.  The
     * client should call readdir() repeatedly until it has found the
     * file it is looking for or until the server responds with a
     * message indicating an error or end of file. The client should then
     * close the handle using the close() request.
     * Note: directory entries "." and ".." are NOT included into readdir()
     * response.
     * <font color=#7F9FBF>@param</font> handle - file handle created by opendir()
     * <font color=#7F9FBF>@param</font> done - result call back object.
     * <font color=#7F9FBF>@return</font> pending command handle.
     */</font>
    IToken readdir(IFileHandle handle, DoneReadDir done);

    <font color=#7F0055>interface</font> DoneReadDir {
        <font color=#7F0055>void</font> doneReadDir(IToken token, FileSystemException error, DirEntry[] entries, <font color=#7F0055>boolean</font> eof);
    }

    <font color=#3F5FBF>/**
     * Create a directory on the server.
     *
     * <font color=#7F9FBF>@param</font> path - specifies the directory to be created.
     * <font color=#7F9FBF>@param</font> attrs - new directory attributes.
     * <font color=#7F9FBF>@param</font> done - result call back object.
     * <font color=#7F9FBF>@return</font> pending command handle.
     */</font>
    IToken mkdir(String path, FileAttrs attrs, DoneMkDir done);

    <font color=#7F0055>interface</font> DoneMkDir {
        <font color=#7F0055>void</font> doneMkDir(IToken token, FileSystemException error);
    }

    <font color=#3F5FBF>/**
     * Remove a directory.
     * An error will be returned if no directory
     * with the specified path exists, or if the specified directory is not
     * empty, or if the path specified a file system object other than a
     * directory.
     *
     * <font color=#7F9FBF>@param</font> path - specifies the directory to be removed.
     * <font color=#7F9FBF>@param</font> done - result call back object.
     * <font color=#7F9FBF>@return</font> pending command handle.
     */</font>
    IToken rmdir(String path, DoneRemove done);

    <font color=#7F0055>interface</font> DoneRemove {
        <font color=#7F0055>void</font> doneRemove(IToken token, FileSystemException error);
    }

    <font color=#3F5FBF>/**
     * Retrieve file system roots - top level file system objects.
     * UNIX file system can report just one root with path "/". Other types of systems
     * can have more the one root. For example, Windows server can return multiple roots:
     * one per disc (e.g. "/C:/", "/D:/", etc.). Note: even Windows implementation of
     * the service must use forward slash as directory separator, and must start
     * absolute path with "/". Server should implement proper translation of
     * protocol file names to OS native names and back.
     *
     * <font color=#7F9FBF>@param</font> done - result call back object.
     * <font color=#7F9FBF>@return</font> pending command handle.
     */</font>
    IToken roots(DoneRoots done);

    <font color=#7F0055>interface</font> DoneRoots {
        <font color=#7F0055>void</font> doneRoots(IToken token, FileSystemException error, DirEntry[] entries);
    }

    <font color=#3F5FBF>/**
     * Remove a file or symbolic link.
     * This request cannot be used to remove directories.
     *
     * <font color=#7F9FBF>@param</font> file_name is the name of the file to be removed.
     * <font color=#7F9FBF>@param</font> done - result call back object.
     * <font color=#7F9FBF>@return</font> pending command handle.
     */</font>
    IToken remove(String file_name, DoneRemove done);

    <font color=#3F5FBF>/**
     * Canonicalize any given path name to an absolute path.
     * This is useful for converting path names containing ".." components or
     * relative pathnames without a leading slash into absolute paths.
     *
     * <font color=#7F9FBF>@param</font> path specifies the path name to be canonicalized.
     * <font color=#7F9FBF>@param</font> done - result call back object.
     * <font color=#7F9FBF>@return</font> pending command handle.
     */</font>
    IToken realpath(String path, DoneRealPath done);

    <font color=#7F0055>interface</font> DoneRealPath {
        <font color=#7F0055>void</font> doneRealPath(IToken token, FileSystemException error, String path);
    }

    <font color=#3F5FBF>/**
     * Rename a file.
     * It is an error if there already exists a file
     * with the name specified by 'new_path'.  The server may also fail rename
     * requests in other situations, for example if `old_path' and `new_path'
     * point to different file systems on the server.
     *
     * <font color=#7F9FBF>@param</font> old_path is the name of an existing file or directory.
     * <font color=#7F9FBF>@param</font> new_path is the new name for the file or directory.
     * <font color=#7F9FBF>@param</font> done - result call back object.
     * <font color=#7F9FBF>@return</font> pending command handle.
     */</font>
    IToken rename(String old_path, String new_path, DoneRename done);

    <font color=#7F0055>interface</font> DoneRename {
        <font color=#7F0055>void</font> doneRename(IToken token, FileSystemException error);
    }

    <font color=#3F5FBF>/**
     * Read the target of a symbolic link.
     *
     * <font color=#7F9FBF>@param</font> path specifies the path name of the symbolic link to be read.
     * <font color=#7F9FBF>@param</font> done - result call back object.
     * <font color=#7F9FBF>@return</font> pending command handle.
     */</font>
    IToken readlink(String path, DoneReadLink done);

    <font color=#7F0055>interface</font> DoneReadLink {
        <font color=#7F0055>void</font> doneReadLink(IToken token, FileSystemException error, String path);
    }

    <font color=#3F5FBF>/**
     * Create a symbolic link on the server.
     *
     * <font color=#7F9FBF>@param</font> link_path specifies the path name of the symbolic link to be created.
     * <font color=#7F9FBF>@param</font> target_path specifies the target of the symbolic link.
     * <font color=#7F9FBF>@param</font> done - result call back object.
     * <font color=#7F9FBF>@return</font> pending command handle.
     */</font>
    IToken symlink(String link_path, String target_path, DoneSymLink done);

    <font color=#7F0055>interface</font> DoneSymLink {
        <font color=#7F0055>void</font> doneSymLink(IToken token, FileSystemException error);
    }

    <font color=#3F5FBF>/**
     * Copy a file on remote system.
     *
     * <font color=#7F9FBF>@param</font> src_path specifies the path name of the file to be copied.
     * <font color=#7F9FBF>@param</font> dst_path specifies destination file name.
     * <font color=#7F9FBF>@param</font> copy_permissions - if true then copy source file permissions.
     * <font color=#7F9FBF>@param</font> copy_ownership - if true then copy source file UID and GID.
     * <font color=#7F9FBF>@param</font> done - result call back object.
     * <font color=#7F9FBF>@return</font> pending command handle.
     */</font>
    IToken copy(String src_path, String dst_path,
            <font color=#7F0055>boolean</font> copy_permissions, <font color=#7F0055>boolean</font> copy_ownership, DoneCopy done);

    <font color=#7F0055>interface</font> DoneCopy {
        <font color=#7F0055>void</font> doneCopy(IToken token, FileSystemException error);
    }

    <font color=#3F5FBF>/**
     * Retrieve information about user account, which is used by server
     * to access file system on behalf of the client.
     *
     * <font color=#7F9FBF>@param</font> done - result call back object.
     * <font color=#7F9FBF>@return</font> pending command handle.
     */</font>
    IToken user(DoneUser done);

    <font color=#7F0055>interface</font> DoneUser {
        <font color=#7F0055>void</font> doneUser(IToken token, FileSystemException error,
                <font color=#7F0055>int</font> real_uid, <font color=#7F0055>int</font> effective_uid, <font color=#7F0055>int</font> real_gid, <font color=#7F0055>int</font> effective_gid,
                String home);
    }
}
</pre>

</body>
</html>

Back to the top