dev.galasa.zosmf.IZosmfRestApiProcessor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dev.galasa.zosmf.manager Show documentation

A Galasa project

The newest version!

/*
 * Copyright contributors to the Galasa project
 *
 * SPDX-License-Identifier: EPL-2.0
 */
package dev.galasa.zosmf;

import java.util.List;
import java.util.Map;

import javax.validation.constraints.NotNull;

import dev.galasa.zosbatch.ZosBatchException;
import dev.galasa.zosmf.IZosmf.ZosmfCustomHeaders;
import dev.galasa.zosmf.IZosmf.ZosmfRequestType;

public interface IZosmfRestApiProcessor {    
    
    /**
     * Send zOSMF request
     * @param requestType as defined by {@link ZosmfRequestType}
     * @param path the zOSMF API path
     * @param headers the required HTTP headers (e.g. See {@link ZosmfCustomHeaders} or null
     * @param body the request body or null
     * @param validStatusCodes list HTTP status codes expected from this request. default of HTTP 200 when null 
     * @param convert is a data conversion required. If true, data will be converted between EBCDIC to ISO8859-1. If false, no data conversion will take place.
     * @return the response {@link IZosmfResponse}
     * @throws ZosBatchException
     */
    public @NotNull IZosmfResponse sendRequest(ZosmfRequestType requestType, String path, Map headers, Object body, List validStatusCodes, boolean convert) throws ZosmfException;
}