All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.as400.access.LocalDataArea

java.lang.Object
   |
   +----com.ibm.as400.access.DataArea
           |
           +----com.ibm.as400.access.LocalDataArea

public class LocalDataArea
extends DataArea
implements Serializable
The LocalDataArea class represents a local data area on the AS/400.

A local data area exists as a character data area on the AS/400. It is automatically associated with a job and cannot be accessed from another job; hence, it cannot be directly created or deleted by the user.

Care must be taken when using local data areas so that the server job is not ended prematurely. When the job ends, its local data area is automatically deleted, at which point the LocalDataArea object that is referencing it will no longer be valid.

The following example demonstrates the use of LocalDataArea:

// Prepare to work with the AS/400 system named "My400".
AS400 system = new AS400("My400");
// Create a LocalDataArea object to access
// the local data area associated with this connection.
LocalDataArea dataArea = new LocalDataArea(system);
// Clear the data area
dataArea.clear();
// Write to the data area
dataArea.write("Hello world");
// Read from the data area
String data = dataArea.read();


Constructor Index

 o LocalDataArea()
Constructs a LocalDataArea object.
 o LocalDataArea(AS400)
Constructs a LocalDataArea object.

Method Index

 o clear()
Resets the data area to contain all blanks.
 o read()
Reads the data from the data area.
 o read(int, int)
Reads the data from the data area.
 o write(String)
Writes the data to the data area.
 o write(String, int)
Writes the data to the data area.

Constructors

 o LocalDataArea
 public LocalDataArea()
Constructs a LocalDataArea object. It creates a default LocalDataArea object. The system property must be set before attempting a connection.

 o LocalDataArea
 public LocalDataArea(AS400 system)
Constructs a LocalDataArea object. It creates a LocalDataArea instance that represents the local data area on system.

Parameters:
system - The AS/400 that contains the data area.

Methods

 o clear
 public void clear() throws AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, ServerStartupException, UnknownHostException
Resets the data area to contain all blanks.

Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: ServerStartupException
If the AS/400 server cannot be started.
Throws: UnknownHostException
If the AS/400 system cannot be located.
 o read
 public String read() throws AS400SecurityException, ErrorCompletingRequestException, IllegalObjectTypeException, InterruptedException, IOException, ObjectDoesNotExistException
Reads the data from the data area. It retrieves the entire contents of the data area. Note that if the data does not completely fill the data area, this method will return data containing trailing blanks up to the length of the data area.

Returns:
The data read from the data area.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: IllegalObjectTypeException
If the AS/400 object is not the required type.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
 o read
 public String read(int dataAreaOffset,
                    int dataLength) throws AS400SecurityException, ErrorCompletingRequestException, IllegalObjectTypeException, InterruptedException, IOException, ObjectDoesNotExistException
Reads the data from the data area. It retrieves dataLength characters beginning at dataAreaOffset in the data area. The first character in the data area is at offset 0.

Parameters:
dataAreaOffset - The offset in the data area at which to start reading.
dataLength - The number of characters to read. Valid values are from 1 through (data area size - dataAreaOffset).
Returns:
The data read from the data area.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: IllegalObjectTypeException
If the AS/400 object is not the required type.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
 o write
 public void write(String data) throws AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, ServerStartupException, UnknownHostException
Writes the data to the data area. It writes data to the beginning of the data area. The remaining characters in the data area are blank padded.

Parameters:
data - The data to be written.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: ServerStartupException
If the AS/400 server cannot be started.
Throws: UnknownHostException
If the AS/400 system cannot be located.
 o write
 public void write(String data,
                   int dataAreaOffset) throws AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, ServerStartupException, UnknownHostException
Writes the data to the data area. It writes data.length() characters from data to the data area beginning at dataAreaOffset. The first character in the data area is at offset 0.

Parameters:
data - The data to be written.
dataAreaOffset - The offset in the data area at which to start writing.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: ServerStartupException
If the AS/400 server cannot be started.
Throws: UnknownHostException
If the AS/400 system cannot be located.

All Packages  Class Hierarchy  This Package  Previous  Next  Index