Package com.bmc.mainview.nvbapi

Provides access to MAINVIEW views over a network.

See:
          Description

Interface Summary
ConversationListener Interface for monitoring activity with the host
ViewListener The ViewListener interface is used to modify how a view is processed.
 

Class Summary
Conversation An active conversation with MVI-3.
ConversationEvent The root class for the various events presented to a ConversationListener.
ConversationRawInEvent Created when a response has been received from the host
ConversationRawOutEvent Created when characters are about to be sent to the host
ConversationStatusEvent Created when a status response is received
ConversationWriter Class responsible for recording the raw responses received from the NVBAPI and storing them as simulation properties.
ConversationXMLInEvent Created when a response has been received from the host
ConversationXMLOutEvent Created when a request is about to be sent to the host
DetailView Deprecated. It is more efficient to treat a detail view as a TabularView
Field A class holding a field definition
HostServer Defines a session with a mainframe.
Hyperlink Represents a single hyperlink from a Field
Jdk14LogWrapper An instance is created when the caller passes a JDK1.4 logger to the HostServer
LiveConv A conversation with a host server.
LiveServer Creates a session with an MVI-3 Host Server
Log4jLogWrapper  
LogWrapper Define the methods used to log events to whatever type of Logger is provided The methods are implemented by each sub-class.
LogWrapper.PrintLogger A Simple logger to write to a PrintStream such as System.out
ServicePoint A target on the mainframe.
Simulator A simulated host server.
Slf4jLogWrapper An instance is created when the caller passes an SLF4J logger to the HostServer
TabularView Modification log: JAN2011 Overrides the default refresh behaviour to ensure that the view definition is set for the conversation before the data-get is called, and that each form also refreshes immediately.
View Defines the common code for accessing MAINCVIEW views.
ViewDefinition An in-line view definition used with View and Conversation View definitions can be customized using MAINVIEW Explorer and exported as .vdf files using the "export view data" button.
XML An object containing XML stored as a DOM-like structure.
 

Exception Summary
HostErrorMessage Thrown to contain host error messages
InternalErrorException  
ViewNotFoundException Thrown when a requested view does not exist
 

Package com.bmc.mainview.nvbapi Description

Provides access to MAINVIEW views over a network. This package allows a Java program to retrieve data from any MVI-3 BMC product. The first step is to create a session by connecting to a host server running on a z/OS mainframe:

      HostServer host = new LiveServer(logger, hostName, ipAddress, port, userID, password);
      host.connect();
Then a series of conversations can be initiated to retrieve view definitions and view contents:
        ViewDefinition myView = new ViewDefinition("MYVIEW");
        myView.setProduct("MYPRODUCT");
        Conversation  conv = host.conversationFactory();
        Vector targets = host.loadTargets(conv, myProduct);
        for (int i = 0; i < targets.size(); i++) {
            ServicePoint sp = (ServicePoint) targets.elementAt(i);
            if (sp.product.equals(myProduct) && sp.status.equals("Active"))
            {
                conv.access(sp);
                TabularView view = new TabularView(myView, conv, true, null);
                Field myField = view.getField("MYFIELD");
                for (int j = 0; j < view.size(); j++) {
                   String data = view.getValue(j, myField);
                   /* Process a data item */
                }
            }
        }
        conv.close();

Lower level control

For control at a lower, more detailed level, the following methods of Conversation may also be used:

Event processing

Conversation Events

During processing the Conversation object will create a number of ConversationEvents. One or more ConversationListener may be added to react to them. Each time that a request is processed, here is the sequence of events.

  1. Build the XML object - ConversationXMLOutEvent
  2. Convert to text - ConversationRawOutEvent
  3. Send the text, receive a response - ConversationRawInEvent
  4. Parse the response - ConversationXMLInEvent
  5. Process the status information and retrieve messages - ConversationStatusEvent

View Processing Events

During the processing of a View object a series of events are created. A ViewListener object may be passed to the constructor to react to these events. Here is the sequence of event types:

  1. Set the conversation to use the view - ViewListener.VIEWSET
  2. Retrieve the view definition - ViewListener.GOTFIELDS
  3. Prepare to retrieve data from the host - ViewListener.REFRESHING

Related Documentation

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