Package com.ibm.as400.access

Provides classes that represent various IBM i data and resources.

See: Description

  • Interface Summary 
    Interface Description
    ActionCompletedListener
    The ActionCompletedListener interface provides a listener interface for receiving ActionCompleted events.
    AS400CertificateListener
    The AS400CertificateListener interface provides an interface for receiving certificate events.
    AS400DataType
    Provides an interface for conversions between Java objects and byte arrays representing IBM i data types.
    AS400FileRecordDescriptionListener
    The AS400FileRecordDescriptionListener interface provides the interface that must be implemented to handle AS400FileRecordDescriptionEvent objects that are fired by the AS400FileRecordDescription class.
    AS400JDBCStatementListener
    Represents a listener that will get notified when certain events occur during the processing of an SQL statement.
    BidiStringType
    A collection of constants generally used for describing the string type of bidi (bi-directional text).
    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.
    Copyright
    The Copyright interface is used to hold the copyright string and the version information for the IBM Toolbox for Java.
    DataAreaListener
    The DataAreaListener interface provides an interface for receiving DataAreaEvents.
    DataQueueListener
    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.
    SignonHandler
    Specifies the methods required for a SignonHandler.
    SQLVariableCompressible  
    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 
    Class Description
    ActionCompletedEvent
    The ActionCompletedEvent class represents an ActionCompleted event.
    AFPResource
    The AFPResource class represents a system AFP resource.
    AFPResourceBeanInfo
    The AFPResourceBeanInfo class provides bean information for the AFPResource class.
    AFPResourceList
    The AFPResourceList class is used to build a list of IBM i AFP resource objects of type AFPResource.
    AFPResourceListBeanInfo
    BeanInfo for AFPResourceList class.
    ArrayFieldDescription
    The ArrayFieldDescription class represents the description of an array of data.
    AS400
    Represents the authentication information and a set of connections to the IBM i host servers.
    AS400AbstractTime
    An abstract base class for converters between IBM i date/time values and corresponding Java objects.
    AS400Array
    The AS400Array class provides a composite data type representing an array of AS400DataType objects.
    AS400ArrayBeanInfo
    The AS400ArrayBeanInfo class provides bean information for the AS400Array class.
    AS400BeanInfo
    The AS400BeanInfo class provides bean information for the AS400 class.
    AS400BidiTransform
    Provides layout transformations that allow the conversion of Bidi text in IBM i format (after its conversion to Unicode), to Bidi text in Java format; or vice-versa.
    AS400Bin1
    Provides a converter between a Byte object and a signed one-byte binary number.
    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 IBM i data that is not convertible.
    AS400Calendar  
    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 IBM i user profile object.
    AS400CertificateUserProfileUtilBeanInfo
    The AS400CertificateUserProfileUtilBeanInfo class provides bean information for the AS400CertificateUserProfileUtil class.
    AS400CertificateUtil
    Provides the methods common to AS400CertificateVldlUtil and AS400CertificateUserProfileUtil.
    AS400CertificateUtilBeanInfo
    The AS400CertificateUtilBeanInfo class provides bean information for the AS400CertificateUtil class.
    AS400CertificateVldlUtil
    The AS400CertificateVldlUtil class provides the implementation of the methods for accessing certificates in an IBM i validation list object.
    AS400CertificateVldlUtilBeanInfo
    The AS400CertificateVldlUtilBeanInfo class provides bean information for the AS400CertificateVldlUtil class.
    AS400ConnectionPool
    Manages a pool of AS400 objects.
    AS400ConnectionPoolBeanInfo
    The AS400ConnectionPoolBeanInfo class provides the bean information for the AS400ConnectionPool class.
    AS400Date
    Provides a converter between a java.sql.Date object and an IBM i date value such as "12/31/97".
    AS400DateTimeConverter Deprecated
    This class has been replaced by the DateTimeConverter class.
    AS400DecFloat
    The AS400DecFloat class provides a converter between a BigDecimal object and a DecimalFloat type.
    AS400File
    Represents a physical or logical file on the system.
    AS400FileBeanInfo
    The AS400FileBeanInfo class provides bean information for the AS400File class.
    AS400FileRecordDescription
    The AS400FileRecordDescription class represents the record descriptions of a physical or logical file on the system.
    AS400FileRecordDescriptionBeanInfo
    The AS400FileRecordDescriptionBeanInfo class provides bean information for the AS400FileRecordDescription class.
    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
    Represents a client for the IBM i FTP server.
    AS400FTPBeanInfo
    The AS400FTPBeanInfo class provides bean information for the FTP class.
    AS400JDBCArray
    AS400JDBCArray is an implementation of java.sql.Array and contains an array of JDBC data.
    AS400JDBCArrayResultSet
    AS400JDBCArrayResultSet is a JDBC ResultSet that contains Array data.
    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 for IBM i database.
    AS400JDBCConnectionAbortRunnable  
    AS400JDBCConnectionHandle
    The AS400JDBCConnectionHandle class represents an AS400JDBCConnection object that can be used in a AS400JDBCPooledConnection.
    AS400JDBCConnectionPool
    Represents a pool of JDBC connections that are available for use by a Java program.
    AS400JDBCConnectionPoolBeanInfo
    The AS400JDBCConnectionPoolBeanInfo class provides bean information for the AS400JDBCConnectionPool class.
    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 IBM i database connections.
    AS400JDBCDataSourceBeanInfo
    The AS400JDBCDataSourceBeanInfo class provides bean information for the AS400JDBCDataSource class.
    AS400JDBCDriver
    A JDBC 3.0/4.0/4.2 driver that accesses DB2 for IBM i databases.
    AS400JDBCFieldedTimestamp
    A internal version representing a timestamp that is used only for the implementation of batching.
    AS400JDBCManagedConnectionPoolDataSource
    This implementation of javax.sql.ConnectionPoolDataSource can be used in conjunction with AS400JDBCManagedDataSource to produce PooledConnection objects (AS400JDBCPooledConnection) that are managed by the Toolbox's built-in connection pooling manager.
    AS400JDBCManagedDataSource
    This implementation of javax.sql.DataSource can be used to produce Connection objects that will automatically participate in connection pooling, and are managed by the Toolbox's built-in connection pooling manager.
    AS400JDBCNClob
    The AS400JDBCNClob class provides access to character large objects.
    AS400JDBCNClobLocator  
    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.
    AS400JDBCRowId  
    AS400JDBCRowSet
    The AS400JDBCRowSet class represents a connected rowset that encapsulates an JDBC result set.
    AS400JDBCRowSetBeanInfo
    The AS400JDBCRowSetBeanInfo class provides bean information for the AS400JDBCRowSet class.
    AS400JDBCSavepoint
    The AS400JDBCSavepoint class is the Toolbox JDBC driver's representation of a savepoint.
    AS400JDBCSQLXML
    This class provides the object interface for using XML data through JDBC.
    AS400JDBCSQLXMLLocator
    The AS400JDBCSQLXMLLocator class provides the object interface for using XML data through JDBC.
    AS400JDBCStatement
    The AS400JDBCStatement class provides a mechanism for executing static SQL statements.
    AS400JDBCTimestamp
    A version of an java.sql.Timestamp that support picosecond precision.
    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.
    AS400JDBCXADataSourceBeanInfo
    The AS400JDBCXADataSourceBeanInfo class provides bean information for the AS400JDBCXADataSource class.
    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
    Determines if services are running on the IBM i system.
    AS400Message
    Represents a message returned from an IBM i system.
    AS400PackedDecimal
    Provides a converter between a BigDecimal object and a packed decimal format floating point number.
    AS400Structure
    Provides a composite data type representing a structure of AS400DataType objects.
    AS400StructureBeanInfo
    The AS400Structure class provides bean information for the AS400Structure class.
    AS400Text
    Provides character set conversion between Java String objects and IBM i code pages.
    AS400Time
    Provides a converter between a java.sql.Time object and an IBM i time value such as "23:59:59" or "11:59 PM".
    AS400Timestamp
    Provides a converter between a java.sql.Timestamp object and an IBM i timestamp value such as "1997-12-31-23.59.59.999999".
    AS400UnsignedBin1
    Provides a converter between a Short object and an unsigned one-byte binary number.
    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.
    AS400UnsignedBin8
    Provides a converter between a BigInteger object and an unsigned eight-byte binary number.
    AS400ZonedDecimal
    The AS400ZonedDecimal class provides a converter between a BigDecimal object and a zoned decimal format floating point number.
    BaseDataQueue
    Represents an IBM i data queue object.
    BaseDataQueueBeanInfo
    The BaseDataQueueBeanInfo class provides bean information for the BaseDataQueue class.
    BidiConversionProperties
    Provides a set of properties that can be used to control the conversion of character set data.
    BidiTransform
    The BidiTransform class defines Text Layout transformations.
    BinaryConverter
    A binary types converter between Java byte arrays and Java simple types.
    BinaryFieldDescription
    Represents the description of the data in a binary (integer) field.
    CallStackEntry
    Represents an entry in the call stack of a specific thread of a server job.
    CharacterDataArea
    The CharacterDataArea class represents a character data area on the system.
    CharacterDataAreaBeanInfo
    The CharacterDataAreaBeanInfo class provides bean information for the CharacterDataArea class.
    CharacterFieldDescription
    Represents the description of the data in a character field.
    CharConverter
    A character set converter between Java String objects and IBM i native code pages.
    ClusteredHashTable
    Provides access to an IBM i highly available Clustered Hash Table.
    ClusteredHashTableBeanInfo
    The ClusteredHashTableBeanInfo class provides bean information for the ClusteredHashTable class.
    ClusteredHashTableEntry
    The ClusteredHashTableEntry class represents an entry in an IBM i highly available Clustered Hash Table.
    ClusteredHashTableEntryBeanInfo
    The ClusteredHashTableEntryBeanInfo class provides bean information for the ClusteredHashTableEntry class.
    Command
    Represents information about a CL command (*CMD) object on the system.
    CommandBeanInfo
    The CommandBeanInfo class provides bean information for the Command class.
    CommandCall
    Represents an IBM i command object.
    CommandCallBeanInfo
    The CommandCallBeanInfo class provides bean information for the CommandCall class.
    CommandLineArguments
    A utility that parses command line arguments into options specified in the format "-optionName optionValue".
    CommandList
    The CommandList class represents a list of CL command (*CMD) objects on the system.
    CommandListBeanInfo
    The CommandListBeanInfo class provides bean information for the CommandList class.
    ConnectionEvent
    The ConnectionEvent class represents a Connection event.
    ConnectionPool
    Represents a pool of connections to the system.
    ConnectionPoolBeanInfo
    Provides bean information for the ConnectionPool class.
    ConnectionPoolEvent
    The ConnectionPoolEvent class represents a connection pool event.
    ConvTableReader
    Represents a Toolbox converter that uses stateful character conversion.
    ConvTableUnicodeBigMap  
    ConvTableWriter
    A ConvTableWriter represents a Toolbox converter that uses stateful character conversion.
    CoreMRI
    Locale-specific objects for IBM Toolbox for Java.
    DataArea
    The DataArea class is an abstract base class that represents a data area object.
    DataAreaBeanInfo
    The DataAreaBeanInfo class provides bean information for the DataArea class.
    DataAreaEvent
    The DataAreaEvent class represents a data area event.
    DataQueue
    The DataQueue class represents an IBM i sequential data queue object.
    DataQueueAttributes
    The DataQueueAttributes class represents a data queue attributes object.
    DataQueueAttributesBeanInfo
    The DataQueueAttributesBeanInfo class provides bean information for the DataQueueAttributes class.
    DataQueueBeanInfo
    The DataQueueBeanInfo class provides bean information for the DataQueue class.
    DataQueueEntry
    The DataQueueEntry class represents an entry on a data queue.
    DataQueueEvent
    The DataQueueEvent class represents a DataQueue event.
    DateFieldDescription
    Represents the description of the data in a date field.
    DateTimeConverter
    A utility for converting date/time values.
    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 system.
    DecimalDataAreaBeanInfo
    The DecimalDataAreaBeanInfo class provides bean information for the DecimalDataArea class.
    DirectoryEntry
    The DirectoryEntry class represents system distribution directory information for a particular directory entry.
    DirectoryEntryList
    Retrieves a list of system distribution directory entries.
    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
    Represents an IBM i system-level environment variable.
    EnvironmentVariableBeanInfo
    The EnvironmentVariableBeanInfo class represents the bean information for the EnvironmentVariable class.
    EnvironmentVariableList
    The EnvironmentVariableList class represents a list of IBM i system-level environment variables.
    EnvironmentVariableListBeanInfo
    The EnvironmentVariableListBeanInfo class represents the bean information for the EnvironmentVariableList class.
    ErrorCodeParameter
    Represents an IBM i "error code parameter".
    EventLog
    The EventLog class is an implementation of Log which logs exceptions and messages to the specified file or PrintStream.
    FieldDescription
    An abstract base class that allows the user to describe the data in a field with an AS400DataType object and a name.
    FileAttributes
    Represents the set of file attributes that can be retrieved and set through the Qp0lGetAttr() and Qp0lSetAttr() API's.
    FileEvent
    The FileEvent class represents a File event.
    FloatFieldDescription
    Represents the description of the data in a float field.
    FTP
    Represents a generic FTP client.
    FTPBeanInfo
    The FTPBeanInfo class provides bean information for the FTPClient class.
    FTPEvent
    The FTPEvent class represents an ftp event.
    GenerateConverterTable  
    HexFieldDescription
    The HexFieldDescription class represents the description of the data in a hexadecimal field.
    HistoryLog
    Represents a history log on the system.
    IFSExistenceOptionEditor
    The IFSExistenceOptionEditor class provides integrated file system existence editor support.
    IFSFile
    Represents an object in the IBM i integrated file system.
    IFSFileBeanInfo
    The IFSFileBeanInfo class provides BeanInfo for IFSFile.
    IFSFileDescriptor
    Represents an integrated file system file descriptor.
    IFSFileInputStream
    Represents an integrated file system input stream.
    IFSFileInputStreamBeanInfo
    The IFSFileInputStreamBeanInfo class provides bean information for the IFSFileInputStream class.
    IFSFileOutputStream
    Represents an integrated file system file output stream.
    IFSFileOutputStreamBeanInfo
    The IFSFileOutputStreamBeanInfo class provides BeanInfo for the IFSFileOutputStream class.
    IFSFileReader
    Convenience class for reading character files in the integrated file system.
    IFSFileWriter
    Convenience class for writing character files in the integrated file system.
    IFSJavaFile
    Represents an object in the IBM i integrated file system.
    IFSKey
    The IFSKey class represents an opaque handle to a byte lock on an integrated file system object.
    IFSRandomAccessFile
    Supports read and write access to integrated file system objects.
    IFSRandomAccessFileBeanInfo
    The IFSRandomAccessFileBeanInfo class provides bean information for the IFSRandonAccessFile class.
    IFSShareOptionEditor
    The IFSShareOptionEditor class provides integrated file system share option editor support.
    IFSSystemView
    Provides a gateway to the IBM i integrated file system, for use when constructing javax.swing.JFileChooser objects.
    IFSTextFileInputStream
    Represents an integrated file system input stream for character data.
    IFSTextFileInputStreamBeanInfo
    The IFSTextFileInputStreamBeanInfo class provides bean information for the IFSTextFileInputStream class.
    IFSTextFileOutputStream
    The IFSTextFileOutputStream class represents an integrated file system output stream for character data.
    IFSTextFileOutputStreamBeanInfo
    The IFSTextFileOutputStreamBeanInfo class provides bean information for the IFSTextFileOutputStream class.
    ISeriesNetServer
    Represents the NetServer service on a system.
    ISeriesNetServerConnection
    The ISeriesNetServerConnection class represents a NetServer share connection.
    ISeriesNetServerFileShare
    The ISeriesNetServerFileShare class represents a NetServer file share.
    ISeriesNetServerPrintShare
    The ISeriesNetServerPrintShare class represents a NetServer print share.
    ISeriesNetServerSession
    The ISeriesNetServerSession class represents a NetServer session.
    ISeriesNetServerShare
    The ISeriesNetServerShare class represents a NetServer share (either a file share or a print share).
    ISeriesPrinter
    Represents a printer attached to an IBM i system.
    JavaApplicationCall
    Provides an easy way to run Java applications on the IBM i system's Java Virtual Machine from a client.
    JavaApplicationCallBeanInfo
    The JavaApplicationCallBeanInfo class provides bean information for the JavaApplicationCall class.
    JavaProgram
    Represents an IBM i Java program.
    JDDataSourceURL
    A class representing a URL specifying an IBM i system data source.
    JDMRI
    Locale-specific objects for the IBM Toolbox for Java.
    JDMRI2
    Locale-specific objects for IBM Toolbox for Java.
    Job
    Represents a job on the IBM i server.
    JobBeanInfo
    The JobBeanInfo class represents the bean information for the Job class.
    JobCCSID
    The JobCCSID class represents an IBM i Job CCSID.
    JobDescription
    Represents an IBM i job description.
    JobList
    Represents a list of jobs on the system.
    JobListBeanInfo
    The JobListBeanInfo class represents the bean information for the JobList class.
    JobLog
    Represents a job log on the system.
    JobLogBeanInfo
    The JobLogBeanInfo class represents the bean information for the JobLog class.
    JVMInfo
    Provide information about the currently running JVM.
    KeyedDataQueue
    The KeyedDataQueue class represents a keyed data queue object.
    KeyedDataQueueBeanInfo
    The KeyedDataQueueBeanInfo class provides bean information for the KeyedDataQueue class.
    KeyedDataQueueEntry
    The KeyedDataQueueEntry class represents an entry on a keyed data queue.
    KeyedFile
    The KeyedFile class represents a physical or logical file on the system.
    KeyedFileBeanInfo
    The KeyedFileBeanInfo class provides BeanInfo for the KeyedFile class.
    LineDataRecordWriter
    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 system.
    LocalDataAreaBeanInfo
    The LocalDataAreaBeanInfo class provides bean information for the LocalDataArea class.
    LogicalDataArea
    The LogicalDataArea class represents a logical data area on the system.
    LogicalDataAreaBeanInfo
    The LogicalDataAreaBeanInfo class provides bean information for the LogicalDataArea class.
    MemberDescription
    Represents a database file member and its attributes.
    MemberList
    Represents a list of database file members.
    MessageFile
    Represents a message file object on the system.
    MessageFileBeanInfo
    Provides bean information for the MessageFile class.
    MessageQueue
    Represents a message queue object on the system.
    MessageQueueBeanInfo
    Provides bean information for the MessageQueue class.
    MRI
    Locale-specific objects for the IBM Toolbox for Java.
    MRI2
    Locale-specific objects for the IBM Toolbox for Java.
    NativeMethods  
    NetServer Deprecated
    This class has been replaced by ISeriesNetServer and may be removed in a future release.
    NetServerBeanInfo Deprecated
    This class may be removed in a future release.
    NetServerConnection Deprecated
    This class has been replaced by the ISeriesNetServerConnection class and may be removed in a future release.
    NetServerFileShare Deprecated
    This class has been replaced by the ISeriesNetServerFileShare class and may be removed in a future release.
    NetServerFileShareBeanInfo Deprecated
    This class may be removed in a future release.
    NetServerPrintShare Deprecated
    This class has been replaced by the ISeriesNetServerPrintShare class and may be removed in a future release.
    NetServerPrintShareBeanInfo Deprecated
    This class may be removed in a future release.
    NetServerSession Deprecated
    This class has been replaced by the ISeriesNetServerSession class and may be removed in a future release.
    NetServerShare Deprecated
    This class has been replaced by the ISeriesNetServerShare class and may be removed in a future release.
    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 a system.
    ObjectDescription
    Represents a system QSYS object and its attributes.
    ObjectEvent
    The ObjectEvent class represents an Object event.
    ObjectList
    Represents a list of system objects in a specific library, multiple libraries, or system-wide.
    ObjectLockListEntry
    Represents a single IBM i lock placed on an ObjectDescription.
    ObjectReferences
    Represents the set of information about integrated file system references on an object that can be retrieved through the QP0LROR API.
    ObjectReferences.JobUsingObjectStructure
    Contains information about the jobs that are known to be holding a reference on the object.
    ObjectReferences.SessionUsingObjectStructure
    Contains information about the sessions that are known to be holding a reference on the object.
    OutputQueue
    The OutputQueue class represents an output queue.
    OutputQueueBeanInfo
    BeanInfo for OutputQueue class.
    OutputQueueEvent
    The OutputQueueEvent class represents an OutputQueue event.
    OutputQueueList
    The OutputQueueList class is used to build a list of system objects of type OutputQueue.
    OutputQueueListBeanInfo
    BeanInfo for OutputQueueList class.
    PackedDecimalFieldDescription
    Represents the description of the data in a packed decimal field.
    PanelGroup
    Represents an IBM i panel group (*PNLGRP) object.
    PanelGroupBeanInfo
    The PanelGroupBeanInfo class provides bean information for the PanelGroup class.
    PanelGroupHelpIdentifier
    Represents information about a specific help identifier for an OS/400 panel group (*PNLGRP) object.
    PasswordDialog
    Provides a dialog for prompting end-users for a system name, a user ID, and/or a password.
    Permission
    Retrieves a user's authority to an object.
    Printer
    The Printer class represents a printer.
    PrinterBeanInfo
    BeanInfo for Printer class.
    PrinterFile
    The PrinterFile class represents a printer file.
    PrinterFileBeanInfo
    BeanInfo for PrinterFile class.
    PrinterFileList
    The PrinterFileList class is used to build a list of objects of type PrinterFile.
    PrinterFileListBeanInfo
    BeanInfo for PrinterFileList class.
    PrinterList
    The PrinterList class is used to build a list of objects of type Printer.
    PrinterListBeanInfo
    BeanInfo for PrinterList class.
    PrintObject
    The PrintObject class is an abstract base class for the various types of network print objects.
    PrintObjectBeanInfo
    Base class for the various BeanInfo classes describing print objects.
    PrintObjectInputStream
    Reads data out of a system spooled file or AFP resource such as an overlay or page segment.
    PrintObjectList
    Abstract base class for the various types of network print object lists.
    PrintObjectListBeanInfo
    BeanInfo for PrintObjectList class.
    PrintObjectListEvent
    The PrintObjectListEvent class represents a PrintObjectList event.
    PrintObjectPageInputStream
    Reads data out of a system spooled file one page at a time.
    PrintObjectTransformedInputStream
    Reads transformed data from a system spooled file.
    PrintParameterList
    The PrintParameterList class is used to group a set of attributes or parameters for use on other network print class methods.
    Product
    Represents a licensed product on the system.
    ProductDirectoryInformation
    Represents product directory information for a specific licensed product.
    ProductLicense
    Represents a license for a product on the IBM i system.
    ProductLicenseBeanInfo
    The IFSFileBeanInfo class provides BeanInfo for IFSFile.
    ProductLicenseEvent
    The ProductLiceneEvent class represents a ProductLicense event.
    ProductList
    Represents a list of licensed products.
    ProfileHandleImplNative
    The ProfileHandleImplNative class provides an implementation for behavior delegated by a ProfileHandleCredential object.
    ProfileTokenImplNative
    The ProfileTokenImplNative class provides an implementation for behavior delegated by a ProfileTokenCredential object.
    ProgramCall
    The ProgramCall class allows a user to call an IBM i system program, pass parameters to it (input and output), and access data returned in the output parameters after the program runs.
    ProgramCallBeanInfo
    The ProgramCallBeanInfo class provides bean information for the ProgramCall class.
    ProgramParameter
    Used with ProgramCall and ServiceProgramCall to pass parameter data, either to a program, from a program, or both.
    ProgramParameterBeanInfo
    The ProgramParameterBeanInfo class provides bean information for the ProgramParameter class.
    ProxyServer
    Fulfills requests from programs using the proxy jar file.
    PTF
    Represents a Program Temporary Fix (PTF) for a licensed program product.
    PTFCoverLetter
    Represents a cover letter for a Program Temporary Fix (PTF).
    PTFExitProgram
    Represents an exit program for a Program Temporary Fix (PTF).
    PTFGroup
    Lists information for a specific PTF group on a system.
    PTFGroupList
    Retrieves a list of all PTF groups that are known to a system.
    QSYSObjectPathName
    Provides an integrated file system path name that represents an object in the QSYS library file system.
    QSYSObjectPathNameBeanInfo
    The QSYSObjectPathNameBeanInfo class provides BeanInfo for QSYSObjectPathName class.
    QSYSObjectTypeTable
    Maintains a list of object types and extended attributes for objects on the system.
    QSYSPermission
    The QSYSPermission class represents the permissions for the specified user of an object in the traditional IBM i library structure stored in QSYS.LIB.
    QueuedMessage
    The QueuedMessage class represents a message on a message queue or job log.
    ReaderInputStream
    A ReaderInputStream represents a Toolbox converter that uses stateful character conversion to convert characters into bytes.
    Record
    The Record class represents the data described by a RecordFormat object.
    RecordBeanInfo
    The RecordBeanInfo class provides BeanInfo for the Record class.
    RecordDescriptionEvent
    The RecordDescriptionEvent class represents a RecordDescriptionEvent.
    RecordFormat
    The RecordFormat class represents the format of data returned from an IBM i system.
    RecordFormatBeanInfo
    The RecordFormatBeanInfo class provides BeanInfo for the RecordFormat class.
    RootPermission
    The RootPermission class represents the permissions for the specified user of an object contained in the root directory structure.
    SaveFile
    Represents a save file on a system.
    SaveFileEntry
    Represents an entry in a save file.
    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
    Represents a secure system sign-on.
    SecureAS400BeanInfo
    The SecureAS400BeanInfo class provides bean information for the SecureAS400 class.
    SequentialFile
    The SequentialFile class represents a physical or logical file on the system.
    SequentialFileBeanInfo
    The SequentialFileBeanInfo class represents bean information for the SequentialFile class.
    ServiceProgramCall
    Allows a user to call an IBM i service program.
    ServiceProgramCallBeanInfo
    The ServiceProgramCallBeanInfo class provides bean information for the ServiceProgramCall class.
    SignonEvent
    An Event object generated by an AS400 instance during an attempt to sign-on to the system.
    SignonHandlerAdapter
    An abstract adapter class for receiving Toolbox sign-on events.
    SocketProperties
    The SocketProperties class represents a set of socket options the IBM Toolbox for Java will set on its client side sockets.
    SpooledFile
    Represents a spooled file.
    SpooledFileList
    Builds a list of objects of type SpooledFile.
    SpooledFileListBeanInfo
    BeanInfo for SpooledFileList class.
    SpooledFileOutputStream
    The SpooledFileOutputStream class is used to write data into a spooled file.
    SQLDataBase
    The SQLData interface represents native SQL data.
    Subsystem
    Represents a subsystem on the system.
    SVMRI
    Locale-specific objects for IBM Toolbox for Java.
    SVMRI_en
    An empty English MRI resource bundle.
    SystemPool
    Represents a system pool.
    SystemPoolBeanInfo
    The SystemPoolBeanInfo class provides bean information for the SystemPool class.
    SystemProperties
    Contains constants representing names of all Java system properties recognized by the IBM Toolbox for Java.
    SystemStatus
    Provides access to a group of statistics that represent the current status of the system.
    SystemStatusBeanInfo
    The SystemStatusBeanInfo class provides bean information for the SystemStatus class.
    SystemValue
    The SystemValue class represents a system value or network attribute on the system.
    SystemValueBeanInfo
    The SystemValueBeanInfo class provides bean information for the SystemValue class.
    SystemValueEvent
    The SystemValueEvent class represents a system value event.
    SystemValueGroup
    The SystemValueGroup class represents a user-defined collection of system values and network attributes.
    SystemValueGroupBeanInfo
    The SystemValueGroupBeanInfo class provides bean information for the SystemValueGroup class.
    SystemValueList
    Provided methods for retrieving information about lists of System Values.
    SystemValueListBeanInfo
    The SystemValueListBeanInfo class provides bean information for the SystemValueList class.
    TimeFieldDescription
    Represents the description of the data in a time field.
    TimestampFieldDescription
    Represents the description of the data in a Timestamp field.
    Trace
    Logs trace points and diagnostic messages.
    TunnelProxyServer
    TunnelProxyServer is an HttpServlet implementation that enables proxy tunneling.
    UDFS
    Represents a user-defined file system on the IBM i system.
    User
    Represents a user profile object on the system.
    UserBeanInfo
    The UserBeanInfo class represents the bean information for the User class.
    UserGroup
    The UserGroup class represents a user profile that is a group profile.
    UserIndex
    The UserIndex class represents an IBM i user index object.
    UserList
    Represents a list of user profiles on the system.
    UserListBeanInfo
    The UserListBeanInfo class represents the bean information for the UserList class.
    UserObjectsOwnedList
    Allows you to retrieve a list of IBM i objects that a user is authorized to and/or list of IBM i objects that the user owns.
    UserObjectsOwnedListEntry
    This entry represents a single IBM i object that a user owns or is authorized to.
    UserPermission
    Represents the authority of a specific user.
    UserQueue
    The UserQueue class represents an IBM i user queue object.
    UserSpace
    Represents a user space object in the IBM i operating system.
    UserSpaceBeanInfo
    The UserSpaceBeanInfo class provides bean information for the UserSpace class.
    UserSpaceEvent
    The UserSpaceEvent class represents a user space event.
    ValidationList
    Represents a system validation list object.
    ValidationListAttribute
    Represents an attribute assigned to an entry in a validation list.
    ValidationListAttributeData
    Represents the value of a validation list attribute.
    ValidationListAttributeInfo
    Encapsulates all attribute information assigned to an entry in a validation list.
    ValidationListDataToEncrypt
    Used to specify the data to encrypt when adding or changing a validation list entry.
    ValidationListEntry
    Represents an entry in a system validation list.
    ValidationListTranslatedData
    Represents language-specific information that is assigned in a standardized format to a validation list entry.
    WriterJob
    The WriterJob class represents a writer job.
    WriterJobList
    The WriterJobList class is used to build a list of objects of type WriterJob.
    WriterJobListBeanInfo
    BeanInfo for WriterJobList class.
    ZonedDecimalFieldDescription
    Represents the description of the data in a zoned decimal field.
  • Exception Summary 
    Exception Description
    AS400Exception
    The AS400Exception class represents an exception that indicates that an error has occurred on the system.
    AS400JDBCSQLSyntaxErrorException
    The AS400JDBCSQLSyntaxErrorException class provides additional information about SQL Syntax Errors thrown by the database.
    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 connection to the system was dropped unexpectedly.
    ConnectionPoolException
    The ConnectionPoolException class represents an exception which indicates that a problem occurred with the connection pool.
    ErrnoException
    The ErrnoException class represents an exception that indicates that an errno has been returned by a system API.
    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 system.
    IllegalObjectTypeException
    The IllegalObjectTypeException class represents an exception that indicates that the IBM i system 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
    Represents an exception that indicates that an internal error has occurred.
    LicenseException
    Indicates an error condition that occured while trying to retrieve a license.
    NativeErrorCode0100Exception
    This class represents an error obtained via an format ERRC0100 errorcode from an OS/400 api.
    ObjectAlreadyExistsException
    The ObjectAlreadyExistsException class represents an exception that indicates that a system object already exists.
    ObjectDoesNotExistException
    The ObjectDoesNotExistException class represents an exception that indicates that a system object does not exist.
    PersistenceException
    Thrown when an error occurs accessing resources on the system.
    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 system is not at the correct level.
    ServerStartupException
    The ServerStartupException class represents an exception that indicates that a host server could not be started.

Package com.ibm.as400.access Description

Provides classes that represent various IBM i data and resources.

These classes work with IBM i systems to provide an internet-enabled interface to access and update data and resources on the system.

The access classes use the existing IBM i host servers as the access points to the system. Each host server runs in a separate job on the system, and sends and receives data streams on a socket connection.

Related Documentation

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