Package com.ibm.as400.access

Provides classes that represent various iSeries AS/400 data and resources.

See:
          Description

Interface Summary
ActionCompletedListener The ActionCompletedListener interface provides a listener interface for receiving ActionCompleted events.
AS400CertificateListener The AS400CertificateListener interface provides an interface for receiving AS/400 certificate events.
AS400DataType The AS400DataType interface provides an interface for conversions between Java objects and byte arrays representing AS/400 data types.
AS400FileRecordDescriptionListener The AS400FileRecordDescriptionListener interface provides the interface that must be implemented to handle AS400FileRecordDescriptionEvent objects that are fired by the AS400FileRecordDescription class.
BidiStringType The BidiStringType class is a collection of constants generally used for describing the output string type of bidi data as defined by the CDRA (Character Data Respresentation Architecture).
ConnectionListener The ConnectionListener interface provides a listener interface for receiving Connection events.
ConnectionPoolListener The ConnectionPoolListener interface provides a listener interface for receiving Connection Pool events.
DataAreaListener The DataAreaListener interface provides an interface for receiving DataAreaEvents.
DataQueueListener The DataQueueListener interface provides an interface for receiving DataQueue events.
FileListener The FileListener interface provides an interface for receiving File events.
FTPListener The FTPListener interface provides an interface for receiving FTPEvents.
IFSFileFilter The IFSFileFilter interface provides an interface for filtering files.
Log The Log interface defines a mechanism for exception and message logging in a device-independent manner.
ObjectListener The ObjectListener interface provides a listener interface for receiving Object events.
OutputQueueListener The OutputQueueListener interface provides a listener interface for receiving OutputQueue events.
PrintObjectListListener The PrintObjectListListener class provides a listener interface for receiving PrintObjectList events.
ProductLicenseListener The ProductLicenseListener interface provides an interface for receiving ProductLicense events.
RecordDescriptionListener The RecordDescriptionListener interface provides the interface that must be implemented to handle RecordDescriptionEvent objects that are fired by the record description classes, RecordFormat and Record.
ReturnCodeException The ReturnCodeException interface defines the methods required for exceptions that contain a return code.
SystemValueListener The SystemValueListener interface provides a listener interface for receiving SystemValueEvents.
UserSpaceListener The UserSpaceListener interface provides an interface for receiving UserSpaceEvents.
VariableLengthFieldDescription The VariableLengthFieldDescription interface provides an interface for FieldDescription subclasses that can contain variable-length data.
 

Class Summary
ActionCompletedEvent The ActionCompletedEvent class represents an ActionCompleted event.
AFPResource The AFPResource class represents an AS/400 AFP resource.
AFPResourceList The AFPResourceList class is used to build a list of AS/400 AFP resource objects of type AFPResource.
ArrayFieldDescription The ArrayFieldDescription class represents the description of an array of data.
AS400 The AS400 class represents an iSeries server sign-on.
AS400Array The AS400Array class provides a composite data type representing an array of AS400DataType objects.
AS400BidiTransform The AS400BidiTransform class provides layout transformations that allow the conversion of Bidi text in AS/400 format (after its conversion to Unicode) to Bidi text in Java format, or vice-versa.
AS400Bin2 The AS400Bin2 class provides a converter between a Short object and a signed two-byte binary number.
AS400Bin4 The AS400Bin4 class provides a converter between an Integer object and a signed four-byte binary number.
AS400Bin8 The AS400Bin8 class provides a converter between a Long object and a signed eight-byte binary number.
AS400ByteArray The AS400ByteArray class provides a converter between a byte array and fixed-length byte array representing AS/400 data that is not convertible.
AS400Certificate The AS400Certificate class represents an X.509 ASN.1 encoded certificate.
AS400CertificateAttribute The AS400CertificateAttribute class represents a certificate attribute.
AS400CertificateEvent The AS400CertificateEvent class represents an AS400Certificate event.
AS400CertificateUserProfileUtil The AS400CertificateUserProfileUtil class accesses certificates in an AS400 user profile object.
AS400CertificateUtil The AS400CertificateUtil class provides the methods common to AS400CertificateVldlUtil and AS400CertificateUserProfileUtil.
AS400CertificateVldlUtil The AS400CertificateVldlUtil class provides the implementation of the methods for accessing certificates in an AS400 validation list object.
AS400ConnectionPool The AS400ConnectionPool class manages a pool of AS400 objects.
AS400DateTimeConverter Deprecated. This class has been replaced by the DateTimeConverter class.
AS400File The AS400File class represents an AS/400 physical or logical file.
AS400FileRecordDescription The AS400FileRecordDescription class represents the record descriptions of an AS/400 physical or logical file.
AS400FileRecordDescriptionEvent The AS400FileRecordDescriptionEvent class represents a RecordDescriptionEvent.
AS400Float4 The AS400Float4 class provides a converter between a Float object and a four-byte floating point number.
AS400Float8 The AS400Float8 class provides a converter between a Double object and a eight-byte floating point number.
AS400FTP The AS400FTP class represents a client for the AS/400 FTP server.
AS400JDBCBlob The AS400JDBCBlob class provides access to binary large objects.
AS400JDBCBlobLocator The AS400JDBCBlobLocator class provides access to binary large objects.
AS400JDBCCallableStatement The AS400JDBCCallableStatement class runs a stored procedure.
AS400JDBCClob The AS400JDBCClob class provides access to character large objects.
AS400JDBCClobLocator The AS400JDBCClobLocator class provides access to character large objects.
AS400JDBCConnection The AS400JDBCConnection class provides a JDBC connection to a specific DB2 UDB for iSeries database.
AS400JDBCConnectionPool The AS400JDBCConnectionPool class represents a pool of AS/400 or iSeries JDBC connections that are available for use by a Java program.
AS400JDBCConnectionPoolDataSource The AS400JDBCConnectionPoolDataSource class represents a factory for AS400PooledConnection objects.
AS400JDBCConnectionPoolDataSourceBeanInfo The AS400JDBCConnectionPoolDataSourceBeanInfo class provides bean information for the AS400JDBCConnectionPoolDataSource class.
AS400JDBCDatabaseMetaData The AS400JDBCDatabaseMetaData class provides information about the database as a whole.
AS400JDBCDataSource The AS400JDBCDataSource class represents a factory for AS/400 or iSeries database connections.
AS400JDBCDataSourceBeanInfo The AS400JDBCDataSourceBeanInfo class provides bean information for the AS400JDBCDataSource class.
AS400JDBCDriver The AS400JDBCDriver class is a JDBC 2.0 driver that accesses DB2 UDB for iSeries databases.
AS400JDBCInputStream The AS400JDBCInputStream class provides access to binary data using an input stream.
AS400JDBCObjectFactory The AS400JDBCObjectFactory is used by a JNDI service provider to reconstruct an object when it is retrieved from JNDI.
AS400JDBCParameterMetaData The AS400JDBCParameterMetaData class can be used to retrieve information about the parameters of a PreparedStatement.
AS400JDBCPooledConnection The AS400JDBCPooledConnection class represents a connection object that provides hooks for connection pool management.
AS400JDBCPreparedStatement The AS400JDBCPreparedStatement class precompiles and stores an SQL statement.
AS400JDBCResultSet The AS400JDBCResultSet class provides access to a table of data generated by a database query.
AS400JDBCResultSetMetaData The AS400JDBCResultSetMetaData class describes the columns in a result set.
AS400JDBCRowSet The AS400JDBCRowSet class represents a connected rowset that encapsulates an JDBC result set.
AS400JDBCSavepoint The AS400JDBCSavepoint class is the Toolbox JDBC driver's representation of a savepoint.
AS400JDBCStatement The AS400JDBCStatement class provides a mechanism for executing static SQL statements.
AS400JDBCXAConnection The AS400JDBCXACConnection class represents a pooled connection object that provides hooks for connection pool management and XA resource management.
AS400JDBCXADataSource The AS400JDBCXADataSource class represents a factory for AS400JDBCXAConnection objects.
AS400JDBCXAResource The AS400JDBCXAResource class represents a resource manager for use in XA transaction management.
AS400JDBCXid The AS400JDBCXid class represents an Xid for use with an AS400JDBCXAResource.
AS400JPing The AS400JPing class is used to determine if AS/400 services are running.
AS400Message The AS400Message class represents a message returned from an AS/400.
AS400PackedDecimal The AS400PackedDecimal class provides a converter between a BigDecimal object and a packed decimal format floating point number.
AS400Structure The AS400Structure class provides a composite data type representing a structure of AS400DataType objects.
AS400Text The AS400Text class provides character set conversion between Java String objects and AS/400 native code pages.
AS400UnsignedBin2 The AS400UnsignedBin2 class provides a converter between an Integer object and an unsigned two-byte binary number.
AS400UnsignedBin4 The AS400UnsignedBin4 class provides a converter between a Long object and a unsigned four-byte binary number.
AS400ZonedDecimal The AS400ZonedDecimal class provides a converter between a BigDecimal object and a zoned decimal format floating point number.
BaseDataQueue The BaseDataQueue class represents an AS/400 data queue object.
BinaryConverter A binary types converter between Java byte arrays and Java simple types.
BinaryFieldDescription The BinaryFieldDescription class represents the description of the data in a binary (integer) field.
CharacterDataArea The CharacterDataArea class represents a character data area on the AS/400.
CharacterFieldDescription The CharacterFieldDescription class represents the description of the data in a character field.
CharConverter A character set converter between Java String objects and AS/400 native code pages.
ClusteredHashTable The ClusteredHashTable class provides access to an OS/400 highly available Clustered Hash Table.
ClusteredHashTableEntry The ClusteredHashTableEntry class represents an entry in an OS/400 highly available Clustered Hash Table.
CommandCall The CommandCall class represents an iSeries server command object.
CommandLineArguments The CommandLineArguments class will parse command line arguments into options specified in the format "-optionName optionValue".
ConnectionEvent The ConnectionEvent class represents a Connection event.
ConnectionPool The ConnectionPool class represents a pool of connections to the AS/400.
ConnectionPoolEvent The ConnectionPoolEvent class represents a connection pool event.
ConvTableReader A ConvTableReader represents a Toolbox converter that uses stateful character conversion.
ConvTableWriter A ConvTableWriter represents a Toolbox converter that uses stateful character conversion.
DataArea The DataArea class is an abstract base class that represents an AS/400 data area object.
DataAreaEvent The DataAreaEvent class represents a data area event.
DataQueue The DataQueue class represents an AS/400 data queue object.
DataQueueAttributes The DataQueueAttributes class represents an AS/400 data queue attributes object.
DataQueueEntry The DataQueueEntry class represents an entry on an AS/400 data queue.
DataQueueEvent The DataQueueEvent class represents a DataQueue event.
DateFieldDescription The DateFieldDescription class represents the description of the data in a date field.
DateTimeConverter The DateTimeConverter class represents a converted date and time.
DBCSEitherFieldDescription The DBCSEitherFieldDescription class represents the description of the data in a DBCS-either field.
DBCSGraphicFieldDescription The DBCSGraphicFieldDescription class represents the description of the data in a DBCS-graphic field.
DBCSOnlyFieldDescription The DBCSOnlyFieldDescription class represents the description of the data in a DBCS-only field.
DBCSOpenFieldDescription The DBCSOpenFieldDescription class represents the description of the data in a DBCS-open field.
DecimalDataArea The DecimalDataArea class represents a decimal data area on the AS/400.
DLOPermission The DLOPermission class represents the permission for the specfied user for document library objects (DLO) stored in QDLS.
DQAttsAuthorityEditor The DQAttsAuthorityEditor class provides the list of data queue editor authorities.
EnvironmentVariable The EnvironmentVariable class represents an AS/400 system-level environment variable.
EnvironmentVariableList The EnvironmentVariableList class represents a list of system-level AS/400 environment variables.
EventLog The EventLog class is an implementation of Log which logs exceptions and messages to the specified file or PrintStream.
FieldDescription The FieldDescription class is an abstract base class that allows the user to describe the data in a field with an AS400DataType object and a name.
FileEvent The FileEvent class represents a File event.
FloatFieldDescription The FloatFieldDescription class represents the description of the data in a float field.
FTP The FTP class represents a generic ftp client.
FTPEvent The FTPEvent class represents an ftp event.
HexFieldDescription The HexFieldDescription class represents the description of the data in a hexadecimal field.
IFSExistenceOptionEditor The IFSExistenceOptionEditor class provides integrated file system existence editor support.
IFSFile The IFSFile class represents an object in the integrated file system on the server.
IFSFileDescriptor The IFSFileDescriptor class represents an integrated file system file descriptor.
IFSFileInputStream The IFSFileInputStream class represents an integrated file system input stream.
IFSFileOutputStream The IFSFileOutputStream class represents an integrated file system file output stream.
IFSJavaFile The IFSJavaFile class represents a file in the integrated file system of the iSeries server.
IFSKey The IFSKey class represents an opaque handle to a byte lock on an integrated file system object.
IFSRandomAccessFile The IFSRandomAccessFile class supports read and write access to integrated file system objects.
IFSShareOptionEditor The IFSShareOptionEditor class provides integrated file system share option editor support.
IFSTextFileInputStream The IFSTextFileInputStream class represents an integrated file system input stream for character data.
IFSTextFileOutputStream The IFSTextFileOutputStream class represents an integrated file system output stream for character data.
JavaApplicationCall The JavaApplicationCall class provides an easy way to run Java applications on the AS/400's Java Virtual Machine from a client.
Job The Job class represents an OS/400 job.
JobList The JobList class represents a list of OS/400 jobs.
JobLog The JobLog class represents an AS/400 job log.
KeyedDataQueue The KeyedDataQueue class represents an AS/400 keyed data queue object.
KeyedDataQueueEntry The KeyedDataQueueEntry class represents an entry on an AS/400 keyed data queue.
KeyedFile The KeyedFile class represents an AS/400 physical or logical file.
LineDataRecordWriter The LineDataRecordWriter class writes a record in line data format (with the name of the record format inserted into positions 1-10 of the line data), translating characters into bytes of the specified CCSID.
LocalDataArea The LocalDataArea class represents a local data area on the AS/400.
LogicalDataArea The LogicalDataArea class represents a logical data area on the AS/400.
MessageFile The MessageFile class allows a user to get a message from an AS/400 message file.
MessageQueue The MessageQueue class represents an AS/400 message queue.
NetServer The NetServer class represents the NetServer service on a server.
NetServerConnection The NetServerConnection class represents a NetServer share connection.
NetServerFileShare The NetServerFileShare class represents a NetServer file server share.
NetServerPrintShare The NetServerPrintShare class represents a NetServer print server share.
NetServerSession The NetServerSession class represents a NetServer session.
NetServerShare The NetServerShare class represents a NetServer share.
NLS The NLS class contains a set of static methods that can be used to access various pieces of National Language Support information (such as language and country descriptions) on an OS/400 server.
ObjectEvent The ObjectEvent class represents an Object event.
OutputQueue The OutputQueue class represents an AS/400 output queue.
OutputQueueEvent The OutputQueueEvent class represents an OutputQueue event.
OutputQueueList The OutputQueueList class is used to build a list of AS/400 output queue objects of type OutputQueue.
PackedDecimalFieldDescription The PackedDecimalFieldDescription class represents the description of the data in a packed decimal field.
PasswordDialog The PasswordDialog class is a dialog for prompting end-users for a system name, a user ID, and/or a password.
Permission The Permission class is provided to retrieve user's authority to an object.
To improve performance, the Permission object caches authority changes until the commit() method is called.
Printer The Printer class represents an AS/400 printer.
PrinterFile The PrinterFile class represents an AS/400 printer file.
PrinterFileList The PrinterFileList class is used to build a list of AS/400 printer file objects of type PrinterFile.
PrinterList The PrinterList class is used to build a list of AS/400 printer objects of type Printer.
PrintObject The PrintObject class is an abstract base class for the various types of network print objects.
PrintObjectInputStream The PrintObjectInputStream class is used to read data out of an AS/400 spooled file or AFP resource such as an overlay or page segment.
PrintObjectList The PrintObjectList class is an abstract base class for the various types of network print object lists.
PrintObjectListEvent The PrintObjectListEvent class represents a PrintObjectList event.
PrintObjectPageInputStream The PrintObjectPageInputStream class is used to read data out of an AS/400 spooled file one page at a time.
PrintObjectTransformedInputStream The PrintObjectTransformedInputStream class is used to read transformed data from an AS/400 spooled file.
PrintParameterList The PrintParameterList class is used to group a set of attributes or parameters for use on other network print class methods.
ProductLicense A ProductLicense object represents a license for an AS/400 product.
ProductLicenseEvent The ProductLiceneEvent class represents a ProductLicense event.
ProgramCall The ProgramCall class allows a user to call an iSeries server program, pass parameters to it (input and output), and access data returned in the output parameters after the program runs.
ProgramParameter The ProgramParameter class is used with ProgramCall and ServiceProgramCall to pass parameter data to a program, from a program, or both.
ProxyServer The ProxyServer class is used to fulfill requests from programs using the proxy jar file.
QSYSObjectPathName The QSYSObjectPathName class provides an integrated file system path name that represents an object in the QSYS library file system.
QSYSObjectTypeTable The QSYSObjectTypeTable class maintains a list of object types and extended attributes for AS/400 objects.
QSYSPermission The QSYSPermission class represents the permissions for the specified user of an object in the traditional iSeries library structure stored in QSYS.LIB.
QueuedMessage The QueuedMessage class represents a message on an AS/400 message queue or job log.
Record The Record class represents the data described by a RecordFormat object.
RecordDescriptionEvent The RecordDescriptionEvent class represents a RecordDescriptionEvent.
RecordFormat The RecordFormat class represents the format of data returned from an AS/400 system.
RootPermission The RootPermission class represents the permissions for the specified user of an object contained in the root directory structure.
SCS3812Writer The SCS3812Writer class writes an SCS 3812 data stream to an output stream, translating characters into bytes of the specified CCSID.
SCS5219Writer The SCS5219Writer class writes an SCS 5219 data stream to an output stream, translating characters into bytes of the specified CCSID.
SCS5224Writer The SCS5224Writer class writes an SCS 5224 data stream to an output stream, translating characters into bytes of the specified CCSID.
SCS5256Writer The SCS5256Writer class writes an SCS 5256 data stream to an output stream, translating characters into bytes of the specified CCSID.
SCS5553Writer The SCS5553Writer class writes an SCS 5553 data stream to an output stream, translating characters into bytes of the specified CCSID.
SecureAS400 The SecureAS400 class represents a secure iSeries server sign-on.
SequentialFile The SequentialFile class represents an AS/400 physical or logical file.
ServiceProgramCall The ServiceProgramCall class allows a user to call a service program, passing data via input parameters, then accessing data returned via output parameters.
SpooledFile The SpooledFile class represents an AS/400 spooled file.
SpooledFileList The SpooledFileList class is used to build a list of AS/400 spooled file objects of type SpooledFile.
SpooledFileOutputStream The SpooledFileOutputStream class is used to write data into an AS/400 spooled file.
SystemPool The SystemPool class represents a system pool on an AS/400.
SystemStatus The SystemStatus class represents the system status on the AS/400.
SystemValue The SystemValue class represents a system value or network attribute on the AS/400.
SystemValueEvent The SystemValueEvent class represents a system value event.
SystemValueGroup The SystemValueGroup class represents a user-defined collection of system values and network attributes.
SystemValueList  
TimeFieldDescription The TimeFieldDescription class represents the description of the data in a time field.
TimestampFieldDescription The TimestampFieldDescription class represents the description of the data in a Timestamp field.
Trace The Trace class logs trace points and diagnostic messages.
User The User class represents an AS/400 user profile and directory entry.
UserGroup The UserGroup class represents a user profile that is a group profile.
UserList The UserList class represents a list of AS/400 users.
UserPermission The UserPermission class represents the authority of a specific user.
UserSpace The UserSpace class represents a user space on the AS/400.
UserSpaceEvent The UserSpaceEvent class represents a user space event.
WriterJob The WriterJob class represents an AS/400 writer job.
WriterJobList The WriterJobList class is used to build a list of AS/400 writer job objects of type WriterJob.
ZonedDecimalFieldDescription The ZonedDecimalFieldDescription class represents the description of the data in a zoned decimal field.
 

Exception Summary
AS400Exception The AS400Exception class represents an exception that indicates that an error has occurred on the AS/400 system.
AS400SecurityException The AS400SecurityException class represents an exception that indicates that a security or authority error has occurred.
ConnectionDroppedException The ConnectionDroppedException class represents an exception that indicates that the AS/400 connection was dropped unexpectedly.
ConnectionPoolException The ConnectionPoolException class represents an exception which indicates that a problem occurred with the connection pool.
ErrorCompletingRequestException The ErrorCompletingRequestException class represents an exception that indicates an error occurred that prevented the request from completing.
ExtendedIllegalArgumentException The ExtendedIllegalArgumentException class represents an exception that indicates that an argument is not valid.
ExtendedIllegalStateException The ExtendedIllegalStateException class represents an exception that indicates that an object is not in the proper state to perform the requested operation.
ExtendedIOException The ExtendedIOException class represents an exception that indicates that an error has occurred while communicating with the AS/400.
IllegalObjectTypeException The IllegalObjectTypeException class represents an exception that indicates that the AS/400 object is not the required type.
IllegalPathNameException The IllegalPathNameException class represents an exception that indicates that the integrated file system path name is not valid.
InternalErrorException The InternalErrorException class represents an exception that indicates that an internal error has occurred.
LicenseException The LicenseException class is used to indicate an error condition that occured while trying to retrieve a license.
ObjectAlreadyExistsException The ObjectAlreadyExistsException class represents an exception that indicates that an AS/400 object already exists.
ObjectDoesNotExistException The ObjectDoesNotExistException class represents an exception that indicates that an AS/400 object does not exists.
ProxyException The ProxyException class represents an exception that indicates an error occurred while communicating with the proxy server.
RequestNotSupportedException The RequestNotSupportedException class represents an exception that indicates that the requested function is not supported because the AS/400 system is not at the correct level.
ServerStartupException The ServerStartupException class represents an exception that indicates that a server could not be started.
 

Package com.ibm.as400.access Description

Provides classes that represent various iSeries AS/400 data and resources.

These classes work with iSeries or AS/400 servers to provide an internet-enabled interface to access and update data and resources on the server. The functionality provided is similar to using Client Access APIs; however, Client Access is not a requirement for using the classes.

The access classes use the existing host servers as the access points to the iSeries or AS/400 system. Each server runs in a separate job on the server and sends and receives data streams on a socket connection.

Related Documentation

For overviews, tutorials, examples, guides, and tool documentation, please see: