src.com.ibm.as400.access.PrintObjectImplRemote Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jt400 Show documentation
Show all versions of jt400 Show documentation
The Open Source version of the IBM Toolbox for Java
///////////////////////////////////////////////////////////////////////////////
//
// JTOpen (IBM Toolbox for Java - OSS version)
//
// Filename: PrintObjectImplRemote.java
//
// The source code contained herein is licensed under the IBM Public License
// Version 1.0, which has been approved by the Open Source Initiative.
// Copyright (C) 1997-2000 International Business Machines Corporation and
// others. All rights reserved.
//
///////////////////////////////////////////////////////////////////////////////
package com.ibm.as400.access;
import java.io.IOException;
import java.io.UnsupportedEncodingException;
/**
* The PrintObjectImplRemote class implements the public methods defined in
* PrintObjectImpl. It also provides for the complete implementation of the
* PrintObject class, an abstract base class for the various types of
* network print objects.
**/
abstract class PrintObjectImplRemote
implements PrintObjectImpl
{
private static final String copyright = "Copyright (C) 1997-2000 International Business Machines Corporation and others.";
NPCPAttribute attrs;
private AS400ImplRemote system_;
private NPCPID cpID_;
private int objectType_;
/**
* Check to see if the system has been set...
**/
void checkRunTimeState()
{
if( getSystem() == null )
{
Trace.log(Trace.ERROR, "Parameter 'system' has not been set.");
throw new ExtendedIllegalStateException(
"system", ExtendedIllegalStateException.PROPERTY_NOT_SET);
}
}
abstract NPCPAttributeIDList getAttrIDsToRetrieve();
abstract NPCPAttributeIDList getAttrIDsToRetrieve(int AttrID);
/**
* Gets the print object attributes.
* This method is required so changes in the public class
* are propagated to this remote implementation of the class.
*
* @return NPCPAttribute
**/
public NPCPAttribute getAttrValue()
{
return attrs;
}
// This method is available for use by other classes within the package.
final NPCPID getIDCodePoint()
{
return cpID_;
}
/**
* Returns an attribute of the object that is a Integer type attribute.
*
* @param attributeID Identifies which attribute to retrieve.
* See the following links for the attribute IDs that are valid for each
* particular subclass.
* - AFP Resource Attributes
*
- Output Queue Attributes
*
- Printer Attributes
*
- Printer File Attributes
*
- Spooled File Attributes
*
- Writer Job Attributes
*
*
* @return The value of the attribute.
*
* @exception AS400Exception If the server returns an error message.
* @exception AS400SecurityException If a security or authority error occurs.
* @exception ErrorCompletingRequestException If an error occurs before the request is completed.
* @exception IOException If an error occurs while communicating with the server.
* @exception InterruptedException If this thread is interrupted.
* @exception RequestNotSupportedException If the requested function is not supported because the
* server operating system is not at the correct level.
**/
public Integer getIntegerAttribute(int attributeID)
throws AS400Exception,
AS400SecurityException,
ErrorCompletingRequestException,
IOException,
InterruptedException,
RequestNotSupportedException
{
Integer aValue = null;
if (attrs != null)
{
aValue = attrs.getIntValue(attributeID);
}
if (aValue == null)
{
aValue = getIDCodePoint().getIntValue(attributeID);
if (aValue == null)
{
NPCPAttributeIDList attrIDsToRetreive = getAttrIDsToRetrieve();
if (attrIDsToRetreive.containsID(attributeID))
{
updateAttrs(attrIDsToRetreive);
if (attrs != null)
{
aValue = attrs.getIntValue(attributeID);
}
}
else
{
Trace.log(Trace.ERROR, "PrintObjectImplRemote.java - Attribute " + attributeID + " requested but not valid at this time.");
throw new ExtendedIllegalArgumentException(PrintObject.getAttributeName(attributeID), ExtendedIllegalArgumentException.PARAMETER_VALUE_NOT_VALID);
}
}
}
// if we haven't gotten a value and haven't already generated an exception it must mean that the server
// doesn't support the requested value
if (aValue == null)
{
NPSystem npSystem = NPSystem.getSystem(getSystem());
NPConversation conversation = npSystem.getConversation();
String curLevel = conversation.getAttribute(PrintObject.ATTR_NPSLEVEL);
npSystem.returnConversation(conversation);
throw new RequestNotSupportedException(curLevel,
RequestNotSupportedException.SYSTEM_LEVEL_NOT_CORRECT);
}
return aValue;
}
/**
* Returns an attribute of the object that is a Integer type attribute.
*
* @param attributeID Identifies which attribute to retrieve.
* See the following links for the attribute IDs that are valid for each
* particular subclass.
* - AFP Resource Attributes
*
- Output Queue Attributes
*
- Printer Attributes
*
- Printer File Attributes
*
- Spooled File Attributes
*
- Writer Job Attributes
*
*
* @return The value of the attribute.
*
* @exception AS400Exception If the server returns an error message.
* @exception AS400SecurityException If a security or authority error occurs.
* @exception ErrorCompletingRequestException If an error occurs before the request is completed.
* @exception IOException If an error occurs while communicating with the server.
* @exception InterruptedException If this thread is interrupted.
* @exception RequestNotSupportedException If the requested function is not supported because the
* server operating system is not at the correct level.
**/
public Integer getSingleIntegerAttribute(int attributeID)
throws AS400Exception,
AS400SecurityException,
ErrorCompletingRequestException,
IOException,
InterruptedException,
RequestNotSupportedException
{
Integer aValue = null;
if (attrs != null)
{
aValue = attrs.getIntValue(attributeID);
}
if (aValue == null)
{
aValue = getIDCodePoint().getIntValue(attributeID);
if (aValue == null)
{
NPCPAttributeIDList attrIDsToRetreive = getAttrIDsToRetrieve(attributeID);
if (attrIDsToRetreive.containsID(attributeID))
{
updateAttrs(attrIDsToRetreive);
if (attrs != null)
{
aValue = attrs.getIntValue(attributeID);
}
}
else
{
Trace.log(Trace.ERROR, "PrintObjectImplRemote.java - Attribute " + attributeID + " requested but not valid at this time.");
throw new ExtendedIllegalArgumentException(PrintObject.getAttributeName(attributeID), ExtendedIllegalArgumentException.PARAMETER_VALUE_NOT_VALID);
}
}
}
// if we haven't gotten a value and haven't already generated an exception it must mean that the server
// doesn't support the requested value
if (aValue == null)
{
NPSystem npSystem = NPSystem.getSystem(getSystem());
NPConversation conversation = npSystem.getConversation();
String curLevel = conversation.getAttribute(PrintObject.ATTR_NPSLEVEL);
npSystem.returnConversation(conversation);
throw new RequestNotSupportedException(curLevel,
RequestNotSupportedException.SYSTEM_LEVEL_NOT_CORRECT);
}
return aValue;
}
/**
* Returns an attribute of the object that is a Float type attribute.
*
* @param attributeID Identifies which attribute to retrieve.
* See the following links for the attribute IDs that are valid for each
* particular subclass.
* - AFP Resource Attributes
*
- Output Queue Attributes
*
- Printer Attributes
*
- Printer File Attributes
*
- Spooled File Attributes
*
- Writer Job Attributes
*
*
* @return The value of the attribute.
* @exception AS400Exception If the server returns an error message.
* @exception AS400SecurityException If a security or authority error occurs.
* @exception ErrorCompletingRequestException If an error occurs before the request is completed.
* @exception IOException If an error occurs while communicating with the server.
* @exception InterruptedException If this thread is interrupted.
* @exception RequestNotSupportedException If the requested function is not supported because the
* server operating system is not at the correct level.
**/
public Float getSingleFloatAttribute(int attributeID)
throws AS400Exception,
AS400SecurityException,
ErrorCompletingRequestException,
IOException,
InterruptedException,
RequestNotSupportedException
{
Float aValue = null;
if (attrs != null)
{
aValue = attrs.getFloatValue(attributeID);
}
if (aValue == null)
{
aValue = getIDCodePoint().getFloatValue(attributeID);
if (aValue == null)
{
NPCPAttributeIDList attrIDsToRetreive = getAttrIDsToRetrieve(attributeID);
if (attrIDsToRetreive.containsID(attributeID))
{
updateAttrs(attrIDsToRetreive);
if (attrs != null)
{
aValue = attrs.getFloatValue(attributeID);
}
}
else
{
Trace.log(Trace.ERROR, "PrintObjectImplRemote.java - Attribute " + attributeID + " requested but not valid at this time.");
throw new ExtendedIllegalArgumentException(PrintObject.getAttributeName(attributeID), ExtendedIllegalArgumentException.PARAMETER_VALUE_NOT_VALID);
}
}
}
// if we haven't gotten a value and haven't already generated an exception it must mean that the server
// doesn't support the requested value
if (aValue == null)
{
NPSystem npSystem = NPSystem.getSystem(getSystem());
NPConversation conversation = npSystem.getConversation();
String curLevel = conversation.getAttribute(PrintObject.ATTR_NPSLEVEL);
npSystem.returnConversation(conversation);
throw new RequestNotSupportedException(curLevel,
RequestNotSupportedException.SYSTEM_LEVEL_NOT_CORRECT);
}
return aValue;
}
/**
* Returns an attribute of the object that is a String type attribute.
*
* @param attributeID Identifies which attribute to retrieve.
* See the following links for the attribute IDs that are valid for each
* particular subclass.
* - AFP Resource Attributes
*
- Output Queue Attributes
*
- Printer Attributes
*
- Printer File Attributes
*
- Spooled File Attributes
*
- Writer Job Attributes
*
*
* @return The value of the attribute.
*
* @exception AS400Exception If the server returns an error message.
* @exception AS400SecurityException If a security or authority error occurs.
* @exception ErrorCompletingRequestException If an error occurs before the request is completed.
* @exception IOException If an error occurs while communicating with the server.
* @exception InterruptedException If this thread is interrupted.
* @exception RequestNotSupportedException If the requested function is not supported because the
* server operating system is not at the correct level.
**/
public String getSingleStringAttribute(int attributeID)
throws AS400Exception,
AS400SecurityException,
ErrorCompletingRequestException,
IOException,
InterruptedException,
RequestNotSupportedException
{
String str = null;
if (attrs != null)
{
str = attrs.getStringValue(attributeID);
}
if (str == null)
{
str = getIDCodePoint().getStringValue(attributeID);
if (str == null)
{
NPCPAttributeIDList attrIDsToRetreive = getAttrIDsToRetrieve(attributeID);
if (attrIDsToRetreive.containsID(attributeID))
{
updateAttrs(attrIDsToRetreive);
if (attrs != null) {
str = attrs.getStringValue(attributeID);
}
}
else
{
Trace.log(Trace.ERROR, "PrintObjectImplRemote.java - Attribute " + attributeID + " requested but not valid at this time.");
throw new ExtendedIllegalArgumentException(PrintObject.getAttributeName(attributeID), ExtendedIllegalArgumentException.PARAMETER_VALUE_NOT_VALID);
}
}
}
// if we haven't gotten a value and haven't already generated an exception it must mean that the server
// doesn't support the requested value
if (str == null)
{
NPSystem npSystem = NPSystem.getSystem(getSystem());
NPConversation conversation = npSystem.getConversation();
String curLevel = conversation.getAttribute(PrintObject.ATTR_NPSLEVEL);
npSystem.returnConversation(conversation);
throw new RequestNotSupportedException(curLevel,
RequestNotSupportedException.SYSTEM_LEVEL_NOT_CORRECT);
}
return str;
}
/**
* Returns an attribute of the object that is a Float type attribute.
*
* @param attributeID Identifies which attribute to retrieve.
* See the following links for the attribute IDs that are valid for each
* particular subclass.
*
* @return The value of the attribute.
* @exception AS400Exception If the server returns an error message.
* @exception AS400SecurityException If a security or authority error occurs.
* @exception ErrorCompletingRequestException If an error occurs before the request is completed.
* @exception IOException If an error occurs while communicating with the server.
* @exception InterruptedException If this thread is interrupted.
* @exception RequestNotSupportedException If the requested function is not supported because the
* server operating system is not at the correct level.
**/
public Float getFloatAttribute(int attributeID)
throws AS400Exception,
AS400SecurityException,
ErrorCompletingRequestException,
IOException,
InterruptedException,
RequestNotSupportedException
{
Float aValue = null;
if (attrs != null)
{
aValue = attrs.getFloatValue(attributeID);
}
if (aValue == null)
{
aValue = getIDCodePoint().getFloatValue(attributeID);
if (aValue == null)
{
NPCPAttributeIDList attrIDsToRetreive = getAttrIDsToRetrieve();
if (attrIDsToRetreive.containsID(attributeID))
{
updateAttrs(attrIDsToRetreive);
if (attrs != null)
{
aValue = attrs.getFloatValue(attributeID);
}
}
else
{
Trace.log(Trace.ERROR, "PrintObjectImplRemote.java - Attribute " + attributeID + " requested but not valid at this time.");
throw new ExtendedIllegalArgumentException(PrintObject.getAttributeName(attributeID), ExtendedIllegalArgumentException.PARAMETER_VALUE_NOT_VALID);
}
}
}
// if we haven't gotten a value and haven't already generated an exception it must mean that the server
// doesn't support the requested value
if (aValue == null)
{
NPSystem npSystem = NPSystem.getSystem(getSystem());
NPConversation conversation = npSystem.getConversation();
String curLevel = conversation.getAttribute(PrintObject.ATTR_NPSLEVEL);
npSystem.returnConversation(conversation);
throw new RequestNotSupportedException(curLevel,
RequestNotSupportedException.SYSTEM_LEVEL_NOT_CORRECT);
}
return aValue;
}
/**
* Returns an attribute of the object that is a String type attribute.
*
* @param attributeID Identifies which attribute to retrieve.
* See the following links for the attribute IDs that are valid for each
* particular subclass.
*
* @return The value of the attribute.
*
* @exception AS400Exception If the server returns an error message.
* @exception AS400SecurityException If a security or authority error occurs.
* @exception ErrorCompletingRequestException If an error occurs before the request is completed.
* @exception IOException If an error occurs while communicating with the server.
* @exception InterruptedException If this thread is interrupted.
* @exception RequestNotSupportedException If the requested function is not supported because the
* server operating system is not at the correct level.
**/
public String getStringAttribute(int attributeID)
throws AS400Exception,
AS400SecurityException,
ErrorCompletingRequestException,
IOException,
InterruptedException,
RequestNotSupportedException
{
String str = null;
if (attrs != null)
{
str = attrs.getStringValue(attributeID);
}
if (str == null)
{
str = getIDCodePoint().getStringValue(attributeID);
if (str == null)
{
NPCPAttributeIDList attrIDsToRetreive = getAttrIDsToRetrieve();
if (attrIDsToRetreive.containsID(attributeID))
{
updateAttrs(attrIDsToRetreive);
if (attrs != null)
{
str = attrs.getStringValue(attributeID);
}
}
else
{
Trace.log(Trace.ERROR, "PrintObjectImplRemote.java - Attribute " + attributeID + " requested but not valid at this time.");
throw new ExtendedIllegalArgumentException(PrintObject.getAttributeName(attributeID), ExtendedIllegalArgumentException.PARAMETER_VALUE_NOT_VALID);
}
}
}
// if we haven't gotten a value and haven't already generated an exception it must mean that the server
// doesn't support the requested value
if (str == null)
{
NPSystem npSystem = NPSystem.getSystem(getSystem());
NPConversation conversation = npSystem.getConversation();
String curLevel = conversation.getAttribute(PrintObject.ATTR_NPSLEVEL);
npSystem.returnConversation(conversation);
throw new RequestNotSupportedException(curLevel,
RequestNotSupportedException.SYSTEM_LEVEL_NOT_CORRECT);
}
return str;
}
/**
* Returns the system on which this object exists.
* @return The server on which this object exists.
**/
final public AS400ImplRemote getSystem()
{
return system_;
}
// This method is available for use by other classes within the package.
final void setIDCodePoint(NPCPID cpID)
{
cpID_ = cpID;
}
/**
* Sets the print object attributes.
* This method is required so changes in the public class
* are propogated to this remote implementation of the class.
*
* @param idCodePoint The ID code point
* @param cpAttrs The code point attributes
* @param type The type.
**/
public void setPrintObjectAttrs(NPCPID idCodePoint,
NPCPAttribute cpAttrs,
int type)
{
cpID_ = idCodePoint;
attrs = cpAttrs;
objectType_ = type;
try {
cpID_.setConverter(ConverterImplRemote.getConverter(system_.getCcsid(), system_));
if (attrs != null)
attrs.setConverter(ConverterImplRemote.getConverter(system_.getCcsid(), system_));
}
catch(UnsupportedEncodingException e) {
if (Trace.isTraceErrorOn())
Trace.log(Trace.ERROR, "Error initializing converter for print object", e);
}
}
/**
* Sets the system on which this object exists. This
* method is primarily provided for visual application builders
* that support JavaBeans. Application programmers should
* specify the system in the constructor for the
* specific print object.
*
* @param system The system on which this object exists.
**/
final public void setSystem(AS400Impl system)
{
system_ = (AS400ImplRemote) system;
attrs = null;
}
/**
* Updates the attributes of this object by going to the server and
* retrieving the latest attributes for the object.
*
* @exception AS400Exception If the server returns an error message.
* @exception AS400SecurityException If a security or authority error occurs.
* @exception ErrorCompletingRequestException If an error occurs before the request is completed.
* @exception IOException If an error occurs while communicating with the server.
* @exception InterruptedException If this thread is interrupted.
* @exception RequestNotSupportedException If the requested function is not supported because the
* server operating system is not at the correct level.
**/
public void update()
throws AS400Exception,
AS400SecurityException,
ErrorCompletingRequestException,
IOException,
InterruptedException,
RequestNotSupportedException
{
updateAttrs(getAttrIDsToRetrieve());
}
/**
* Go to the server and get the lastest attributes for this object
**/
void updateAttrs(NPCPAttributeIDList attrIDs)
throws AS400Exception,
AS400SecurityException,
ErrorCompletingRequestException,
IOException,
InterruptedException,
RequestNotSupportedException
{
checkRunTimeState();
NPDataStream req = new NPDataStream(objectType_);
NPDataStream reply = new NPDataStream(objectType_);
NPCPAttribute cpAttrs = new NPCPAttribute();
req.setAction(NPDataStream.RETRIEVE_ATTRIBUTES);
req.addCodePoint(getIDCodePoint());
req.addCodePoint(attrIDs);
reply.addCodePoint(cpAttrs);
NPSystem npSystem = NPSystem.getSystem(getSystem());
if (npSystem != null) {
int rc = npSystem.makeRequest(req, reply);
if (rc == 0) {
if (attrs != null) {
attrs.addUpdateAttributes(cpAttrs);
}
else {
attrs = cpAttrs;
}
}
else {
NPConversation conversation = npSystem.getConversation();
String curLevel = conversation.getAttribute(PrintObject.ATTR_NPSLEVEL);
npSystem.returnConversation(conversation);
switch(rc) {
// we get back RET_INV_REQ_ACT on pre-V3R7 systems if we try
// to open an AFP resource. The server must be at V3R7 with PTFs
// to work with AFP resources so throw a requestNotSupportedException
// here.
case NPDataStream.RET_INV_REQ_ACT:
throw new RequestNotSupportedException(curLevel,
RequestNotSupportedException.SYSTEM_LEVEL_NOT_CORRECT);
// any other error is either an unexpected error or an error
// completing request
default:
break;
}
} // end else
}
}
}