com.ibm.etools.iseries.comm
Class README

java.lang.Object
  com.ibm.etools.iseries.comm.README

public class README
extends Object

This package is designed to be standalone and not dependent on anything in the IDE or the systems packages. The idea is that this package constitutes the new AS/400 communication layer, leveraging only the AS/400 system APIs and commands executed via the AS/400 Toolbox for Java, which is the one single dependency of this package. By keeping this as a completely standalone package we enable: - the ability to write batch testcases to drive and test it non-interactively. - the ability for IBM and non-IBM programmers to use it for both tools and deployed applications - the flexibility for us to deploy this layer in the IDE either on a local Windows/Linux machine or on the AS/400 itself, sending the results back to the IDE via XML and HTTP (for example). To enable this requires a heavy use of interfaces for the objects returned by the host APIs. Anyone using this package then has the option of implementing their own objects tightly coupled to their needs, as long as those objects implement the required interfaces. It also means that our code which needs to instantiate returned objects need a way for the callers to tell us how to instantiate their potentially unique objects ... so for this all our interface families require an accompanying factory interface which prescribes a method that when called will return an instantiation of an object implementing the appropriate interface. Another consideration for maximum re-use is how to enable callers to tell us how much information to return. Each AS/400 system API can potentially return a huge amount of detail, which would be a performance and memory waste if not needed. So we generally define three levels of returned-information (brief, basic and exhaustive). Each level is represented by a different interface in an interface family. We examine which interface is implemented by the object returned by the factory method in order to establish how much information to return to the caller. The factory method is coded to return the brief interface, but since the basic and exhaustive interfaces extend the brief interface, you are free to return an object that implements any of these 3 interfaces. Each prescribes increasing numbers of getters/setters for returned data. All interfaces and default class implementers of these interfaces are in the comm.interfaces package.

Field Summary

static String

Copyright

Constructor Summary

README()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

Copyright

public static final String Copyright

See Also:

Constant Field Values

Constructor Detail

README

public README()