Integrated file system path names for server objects
Your Java™ program must use integrated file system names to refer to server objects, such as programs, libraries, commands, or spooled files. The integrated file system name is the name of a server object as it might be accessed in the library file system of the IBM® i integrated file system.
The path name may consist of the following components:
| Path name component | Description |
|---|---|
| library | The library in which the object resides. The library is a required portion of an integrated file system path name. The library name must be 10 or fewer characters and be followed by .lib. |
| object | The name of the object that the integrated file system path name represents. The object is a required portion of an integrated file system path name. The object name must be 10 or fewer characters and be followed by .type, where type is the type of the object. Types can be found by prompting for the OBJTYPE parameter on control language (CL) commands, such as the Work with Objects (WRKOBJ) command. |
| type | The type of the object. The type of the object must be specified when specifying the object. (See object above.) The type name must be 6 or fewer characters. |
| member | The name of the member that this integrated file system path name represents. The member is an optional portion of an integrated file system path name. It can be specified only when the object type is FILE. The member name must be 10 or fewer characters and followed by .mbr. |
Follow these conditions when determining and specifying the integrated file system name:
- The forward slash (/) is the path separator character.
- The root-level directory, called QSYS.LIB, contains the server library structure.
- Objects that reside in the server library QSYS have the following format:
/QSYS.LIB/object.type- Objects that reside in other libraries have the following format:
/QSYS.LIB/library.LIB/object.type- The object type extension is the server abbreviation used for that type of object.
To see a list of these types, enter a CL command that has object type as a parameter and press F4 (Prompt) for the type. For example, the Work with Objects (WRKOBJ) command has an object type parameter.
The following table is a list of some commonly used object types and the abbreviation for each type:
| Object type | Abbreviation |
|---|---|
| command | .CMD |
| data queue | .DTAQ |
| file | .FILE |
| font resource | .FNTRSC |
| form definition | .FORMDF |
| library | .LIB |
| member | .MBR |
| overlay | .OVL |
| page definition | .PAGDFN |
| page segment | .PAGSET |
| program | .PGM |
| output queue | .OUTQ |
| spooled file | .SPLF |
Use the following descriptions to help you determine how to specify integrated file system path names:
| Integrated file system name | Description |
|---|---|
| /QSYS.LIB/MY_LIB.LIB/MY_PROG.PGM | Program MY_PROG in library MY_LIB on the server |
| /QSYS.LIB/MY_LIB.LIB/MY_QUEUE.DTAQ | Data queue MY_QUEUE in library MY_LIB on the server |
| /QSYS.LIB/YEAR1998.LIB/MONTH.FILE/JULY.MBR | Member JULY in file MONTH in library YEAR1998 on the server |
Integrated file system special values
Various IBM Toolbox for Java classes recognize special values in integrated file system path names. The traditional format for these special values (as used on an IBM i command line) begins with an asterisk (*ALL). However, in a Java program that uses IBM Toolbox for Java classes, the format for these special values begins and ends with percent signs (%ALL%).
The following table shows which of these special values the IBM Toolbox for Java classes recognize for particular path name components. The table also shows how the traditional format for these special values differ from the format used in IBM Toolbox for Java classes.
| Path name component | Traditional format | IBM Toolbox for Java format |
|---|---|---|
| Library name | *ALL | %ALL% |
| *ALLUSR | %ALLUSR% | |
| *CURLIB | %CURLIB% | |
| *LIBL | %LIBL% | |
| *USRLIBL | %USRLIBL% | |
| Object name | *ALL | %ALL% |
| Member name | *ALL | %ALL% |
| *FILE | %FILE% | |
| *FIRST | %FIRST% | |
| *LAST | %LAST% |
See the QSYSObjectPathName class for information about building and parsing integrated file system names.
For more information about integrated file system concepts, see Integrated file system concepts.