|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.as400.access.UserSpace
The UserSpace class represents a user space object in the server operating system. By default, when running on a system other than the server that contains the user space, the UserSpace class will make use of two separate host servers. The file server will be used for read() and write() requests and the remote command server will be used for the other requests. This behavior can be changed with the setMustUseProgramCall() method. Although it is not recommended, applications using the QTEMP library might wish to set the mustUseProgramCall property to true.
Field Summary | |
---|---|
static String |
DOMAIN_DEFAULT
Constant representing the default domain for the user space. |
static String |
DOMAIN_SYSTEM
Constant indicating the domain for the user space is *SYSTEM. |
static String |
DOMAIN_USER
Constant indicating the domain for the user space is *USER. |
static int |
FORCE_ASYNCHRONOUS
Force to auxiliary storage option that allows changes to be forced asynchronously. |
static int |
FORCE_NONE
Force to auxiliary storage option that does not allow changes to be forced. |
static int |
FORCE_SYNCHRONOUS
Force to auxiliary storage option that allows changes to be forced synchronously. |
Constructor Summary | |
---|---|
UserSpace()
Constructs a UserSpace object. |
|
UserSpace(AS400 system,
String path)
Constructs a UserSpace object. |
Method Summary | |
---|---|
void |
addPropertyChangeListener(PropertyChangeListener listener)
Adds a listener to be notified when the value of any bound property is changed. |
void |
addUserSpaceListener(UserSpaceListener listener)
Adds a listener to be notified when a UserSpaceEvent is fired. |
void |
addVetoableChangeListener(VetoableChangeListener listener)
Adds a listener to be notified when the value of any constrained property is changed. |
void |
close()
Closes the user space and releases any system resources associated with the stream. |
void |
create(int length,
boolean replace,
String extendedAttribute,
byte initialValue,
String textDescription,
String authority)
Creates the user space. |
void |
create(String domain,
int length,
boolean replace,
String extendedAttribute,
byte initialValue,
String textDescription,
String authority)
Creates the user space. |
void |
delete()
Deletes the user space. |
boolean |
exists()
Determines if the user space exists. |
byte |
getInitialValue()
Returns the initial value used for filling in the user space during creation and extension. |
int |
getLength()
Returns the size (in bytes) of the user space. |
String |
getName()
Returns the user space name. |
String |
getPath()
Returns the integrated file system path name of the object represented by the user space. |
AS400 |
getSystem()
Returns the system object for this user space. |
boolean |
isAutoExtendible()
Indicates if the user space is auto extendible. |
boolean |
isMustUseProgramCall()
Indicates if Toolbox ProgramCall class will be used internally to perform user space read and write requests. |
int |
read(byte[] dataBuffer,
int userSpaceOffset)
Reads up to dataBuffer.length bytes from the user space beginning at userSpaceOffset into dataBuffer. |
int |
read(byte[] dataBuffer,
int userSpaceOffset,
int dataOffset,
int length)
Reads up to length bytes from the user space beginning at userSpaceOffset into dataBuffer beginning at dataOffset. |
String |
read(int userSpaceOffset,
int length)
Returns a string from the user space beginning at userSpaceOffset. |
void |
removePropertyChangeListener(PropertyChangeListener listener)
Removes this listener from being notified when a bound property changes. |
void |
removeUserSpaceListener(UserSpaceListener listener)
Removes a listener from the UserSpace listeners list. |
void |
removeVetoableChangeListener(VetoableChangeListener listener)
Removes this listener from being notified when a constrained property changes. |
void |
setAutoExtendible(boolean autoExtendibility)
Sets the auto extend attribute if possible. |
void |
setInitialValue(byte initialValue)
Sets the initial value to be used during user space creation or extension. |
void |
setLength(int length)
Sets the size (in bytes) of the user space. |
void |
setMustUseProgramCall(boolean useProgramCall)
Sets the method used to carry out user space read and write operations. |
void |
setPath(String path)
Sets the path for the user space. |
void |
setSystem(AS400 system)
Sets the system object for the user space. |
void |
write(byte[] dataBuffer,
int userSpaceOffset)
Writes up to dataBuffer.length bytes from dataBuffer into the user space beginning at userSpaceOffset. |
void |
write(byte[] dataBuffer,
int userSpaceOffset,
int dataOffset,
int length)
Writes up to length bytes from dataBuffer beginning at dataOffset into the user space beginning at userSpaceOffset. |
void |
write(byte[] dataBuffer,
int userSpaceOffset,
int dataOffset,
int length,
int forceAuxiliary)
Writes up to length bytes from dataBuffer beginning at dataOffset into the user space beginning at userSpaceOffset. |
void |
write(String data,
int userSpaceOffset)
Writes a string into the user space beginning at userSpaceOffset. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final int FORCE_ASYNCHRONOUS
public static final int FORCE_NONE
public static final int FORCE_SYNCHRONOUS
public static final String DOMAIN_DEFAULT
public static final String DOMAIN_USER
public static final String DOMAIN_SYSTEM
Constructor Detail |
public UserSpace()
public UserSpace(AS400 system, String path)
system
- The server that contains the user space.path
- The fully qualified integrated file system path name to the user space.Method Detail |
public void addPropertyChangeListener(PropertyChangeListener listener)
listener
- The listener object.public void addUserSpaceListener(UserSpaceListener listener)
listener
- The listener object.public void addVetoableChangeListener(VetoableChangeListener listener)
listener
- The listener object.public void close() throws IOException
IOException
public void create(int length, boolean replace, String extendedAttribute, byte initialValue, String textDescription, String authority) throws AS400SecurityException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException
length
- The initial size (in bytes) of the user space. Valid values are 1 through 16,776,704. User spaces with lengths of 16,773,120 or less will be created with optimum space alignment. These user spaces can not be resized to greater than 16,773,120 bytes. For performance, lengths of 16,773,120 or less are recommended.replace
- The value indicating if an existing user space is to be replaced.extendedAttribute
- The user-defined extended attribute of the user space. This string must be 10 characters or less.initialValue
- The value used in creation and extension.textDescription
- The text describing the user space. This string must be 50 characters or less.authority
- The public authority for the user space. This string must be 10 characters or less. Valid values are:
AS400SecurityException
- If a security or authority error occurs.
ErrorCompletingRequestException
- If an error occurs before the request is completed.
InterruptedException
- If this thread is interrupted.
IOException
- If an error occurs while communicating with the server.
ObjectDoesNotExistException
- If the object does not exist on the server.public void create(String domain, int length, boolean replace, String extendedAttribute, byte initialValue, String textDescription, String authority) throws AS400SecurityException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException
domain
- The domain into which the user space is created. Valid value are:
length
- The initial size (in bytes) of the user space. Valid values are 1 through 16,776,704. User spaces with lengths of 16,773,120 or less will be created with optimum space alignment. These user spaces can not be resized to greater than 16,773,120 bytes. For performance, lengths of 16,773,120 or less are recommended.replace
- The value indicating if an existing user space is to be replaced.extendedAttribute
- The user-defined extended attribute of the user space. This string must be 10 characters or less.initialValue
- The value used in creation and extension.textDescription
- The text describing the user space. This string must be 50 characters or less.authority
- The public authority for the user space. This string must be 10 characters or less. Valid values are:
AS400SecurityException
- If a security or authority error occurs.
ErrorCompletingRequestException
- If an error occurs before the request is completed.
InterruptedException
- If this thread is interrupted.
IOException
- If an error occurs while communicating with the server.
ObjectDoesNotExistException
- If the object does not exist on the server.public void delete() throws AS400SecurityException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException
AS400SecurityException
- If a security or authority error occurs.
ErrorCompletingRequestException
- If an error occurs before the request is completed.
InterruptedException
- If this thread is interrupted.
IOException
- If an error occurs while communicating with the server.
ObjectDoesNotExistException
- If the object does not exist on the server.public boolean exists() throws AS400SecurityException, ErrorCompletingRequestException, InterruptedException, IOException
AS400SecurityException
- If a security or authority error occurs.
ErrorCompletingRequestException
- If an error occurs before the request is completed.
InterruptedException
- If this thread is interrupted.
IOException
- If an error occurs while communicating with the server.public byte getInitialValue() throws AS400SecurityException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException
AS400SecurityException
- If a security or authority error occurs.
ErrorCompletingRequestException
- If an error occurs before the request is completed.
InterruptedException
- If this thread is interrupted.
IOException
- If an error occurs while communicating with the server.
ObjectDoesNotExistException
- If the object does not exist on the server.public int getLength() throws AS400SecurityException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException
AS400SecurityException
- If a security or authority error occurs.
ErrorCompletingRequestException
- If an error occurs before the request is completed.
InterruptedException
- If this thread is interrupted.
IOException
- If an error occurs while communicating with the server.
ObjectDoesNotExistException
- If the object does not exist on the server.public String getName()
public String getPath()
public AS400 getSystem()
public boolean isAutoExtendible() throws AS400SecurityException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException
AS400SecurityException
- If a security or authority error occurs.
ErrorCompletingRequestException
- If an error occurs before the request is completed.
InterruptedException
- If this thread is interrupted.
IOException
- If an error occurs while communicating with the server.
ObjectDoesNotExistException
- If the object does not exist on the server.public boolean isMustUseProgramCall()
public int read(byte[] dataBuffer, int userSpaceOffset) throws AS400SecurityException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException
dataBuffer
- The buffer to fill with data. Buffer.length() bytes will be read from the user space.userSpaceOffset
- The offset in the user space from which to start reading.
AS400SecurityException
- If a security or authority error occurs.
ErrorCompletingRequestException
- If an error occurs before the request is completed.
InterruptedException
- If this thread is interrupted.
IOException
- If an error occurs while communicating with the server.
ObjectDoesNotExistException
- If the object does not exist on the server.public int read(byte[] dataBuffer, int userSpaceOffset, int dataOffset, int length) throws AS400SecurityException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException
dataBuffer
- The buffer to fill with data.userSpaceOffset
- The offset in the user space from which to start reading.dataOffset
- The starting offset in the data buffer for the results of the read.length
- The number of bytes to read.
AS400SecurityException
- If a security or authority error occurs.
ErrorCompletingRequestException
- If an error occurs before the request is completed.
InterruptedException
- If this thread is interrupted.
IOException
- If an error occurs while communicating with the server.
ObjectDoesNotExistException
- If the object does not exist on the server.public String read(int userSpaceOffset, int length) throws AS400SecurityException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException
userSpaceOffset
- The offset in the user space from which to start reading.length
- The number of bytes to read.
AS400SecurityException
- If a security or authority error occurs.
ErrorCompletingRequestException
- If an error occurs before the request is completed.
InterruptedException
- If this thread is interrupted.
IOException
- If an error occurs while communicating with the server.
ObjectDoesNotExistException
- If the object does not exist on the server.public void removePropertyChangeListener(PropertyChangeListener listener)
listener
- The listener object.public void removeUserSpaceListener(UserSpaceListener listener)
listener
- The listener object.public void removeVetoableChangeListener(VetoableChangeListener listener)
listener
- The listener object.public void setAutoExtendible(boolean autoExtendibility) throws AS400SecurityException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException
autoExtendibility
- The attribute for user space auto extendibility.
AS400SecurityException
- If a security or authority error occurs.
ErrorCompletingRequestException
- If an error occurs before the request is completed.
InterruptedException
- If this thread is interrupted.
IOException
- If an error occurs while communicating with the server.
ObjectDoesNotExistException
- If the object does not exist on the server.public void setInitialValue(byte initialValue) throws AS400SecurityException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException
initialValue
- The new initial value used during future extensions. For best performance, set to zero.
AS400SecurityException
- If a security or authority error occurs.
ErrorCompletingRequestException
- If an error occurs before the request is completed.
InterruptedException
- If this thread is interrupted.
IOException
- If an error occurs while communicating with the server.
ObjectDoesNotExistException
- If the object does not exist on the server.public void setLength(int length) throws AS400SecurityException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException
length
- The new size (in bytes) of the user space. Valid values are 1 through 16,776,704. User spaces with lengths of 16,773,120 or less, created with optimum space alignment, can not be resized to greater than 16,773,120 bytes. For performance, lengths of 16,773,120 or less are recommended.
AS400SecurityException
- If a security or authority error occurs.
ErrorCompletingRequestException
- If an error occurs before the request is completed.
InterruptedException
- If this thread is interrupted.
IOException
- If an error occurs while communicating with the server.
ObjectDoesNotExistException
- If the object does not exist on the server.public void setMustUseProgramCall(boolean useProgramCall)
useProgramCall
- Internally use ProgramCall to carry out read and write requests.public void setPath(String path) throws PropertyVetoException
path
- The fully qualified integrated file system path name to the user space.
PropertyVetoException
- If the change is vetoed.public void setSystem(AS400 system) throws PropertyVetoException
system
- The server that contains the user space.
PropertyVetoException
- If the change is vetoed.public void write(byte[] dataBuffer, int userSpaceOffset) throws AS400SecurityException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException
dataBuffer
- The data buffer to be written to the user space.userSpaceOffset
- The position in the user space to start writing.
AS400SecurityException
- If a security or authority error occurs.
ErrorCompletingRequestException
- If an error occurs before the request is completed.
InterruptedException
- If this thread is interrupted.
IOException
- If an error occurs while communicating with the server.
ObjectDoesNotExistException
- If the object does not exist on the server.public void write(byte[] dataBuffer, int userSpaceOffset, int dataOffset, int length) throws AS400SecurityException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException
dataBuffer
- The data buffer to be written to the user space.userSpaceOffset
- The position in the user space to start writing.dataOffset
- The position in the write data buffer from which to start copying.length
- The length (in bytes) of data to be written.
AS400SecurityException
- If a security or authority error occurs.
ErrorCompletingRequestException
- If an error occurs before the request is completed.
InterruptedException
- If this thread is interrupted.
IOException
- If an error occurs while communicating with the server.
ObjectDoesNotExistException
- If the object does not exist on the server.public void write(byte[] dataBuffer, int userSpaceOffset, int dataOffset, int length, int forceAuxiliary) throws AS400SecurityException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException
dataBuffer
- The data buffer to be written to the user space.userSpaceOffset
- The position in the user space to start writing.dataOffset
- The position in the write data buffer from which to start copying.length
- The length (in bytes) of data to be written.forceAuxiliary
- The method of forcing changes made to the user space to auxiliary storage. Valid values are:
AS400SecurityException
- If a security or authority error occurs.
ErrorCompletingRequestException
- If an error occurs before the request is completed.
InterruptedException
- If this thread is interrupted.
IOException
- If an error occurs while communicating with the server.
ObjectDoesNotExistException
- If the object does not exist on the server.public void write(String data, int userSpaceOffset) throws AS400SecurityException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException
data
- The data buffer to be written to the user space.userSpaceOffset
- The position in the user space to start writing.
AS400SecurityException
- If a security or authority error occurs.
ErrorCompletingRequestException
- If an error occurs before the request is completed.
InterruptedException
- If this thread is interrupted.
IOException
- If an error occurs while communicating with the server.
ObjectDoesNotExistException
- If the object does not exist on the server.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |