com.legstar.host.invoke.HostInvoker Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of legstar-invoker Show documentation

Provide remote procedure call to mainframe programs.

There is a newer version: 1.5.3

/*******************************************************************************
 * Copyright (c) 2010 LegSem.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the GNU Lesser Public License v2.1
 * which accompanies this distribution, and is available at
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * 
 * Contributors:
 *     LegSem - initial API and implementation
 ******************************************************************************/
package com.legstar.host.invoke;

import java.util.Map;

import com.legstar.host.access.HostAccessStrategy;
import com.legstar.host.invoke.model.HostProgram;
import com.legstar.messaging.LegStarAddress;

/**
 * Abstract class to invoke host functions.
 */
public interface HostInvoker {

    /**
     * Invoke a host function using one input and one output raw mainframe
     * data buffers.
     * 
     * Caller is in charge of transforming mainframe data to whatever format
     * he needs.
     * @param requestID an identifier for this request (used for tracing)
     * @param requestBytes the request mainframe data byte array
     * @return the reply mainframe data bytes
     * @throws HostInvokerException if invoke fails
     */
    byte[] invoke(
            String requestID,
            byte[] requestBytes) throws HostInvokerException;

    /**
     * Invoke a host function with multiple input and multiple parts.
     * 

     * Parts are named and associated with a raw mainframe data buffer.
     * 
     * Caller is in charge of transforming mainframe data to whatever format
     * he needs.
     * @param requestID an identifier for this request (used for tracing)
     * @param requestParts a map of mainframe data byte arrays
     * @return a map of mainframe data byte arrays
     * @throws HostInvokerException if invoke fails
     */
    Map < String, byte[] > invoke(
            String requestID,
            Map < String, byte[] > requestParts)
    throws HostInvokerException;

    /**
     * @return the host address this invoker is targeting
     */
    LegStarAddress getAddress();

    /**
     * @return the host access strategy this invoker is using
     */
    HostAccessStrategy getHostAccessStrategy();

    /**
     * @deprecated
     * @return the attributes of the target host program
     */
    
    HostProgramProperties getProgramAttr();

    /**
     * @return the attributes of the target host program
     */
    HostProgram getHostProgram();
}