All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.autonomy.aci.client.transport.AciHttpClient Maven / Gradle / Ivy

/*
 * Copyright 2006-2018 Open Text.
 *
 * Licensed under the MIT License (the "License"); you may not use this file
 * except in compliance with the License.
 *
 * The only warranties for products and services of Open Text and its affiliates
 * and licensors ("Open Text") are as may be set forth in the express warranty
 * statements accompanying such products and services. Nothing herein should be
 * construed as constituting an additional warranty. Open Text shall not be
 * liable for technical or editorial errors or omissions contained herein. The
 * information contained herein is subject to change without notice.
 */

package com.autonomy.aci.client.transport;

import java.io.IOException;
import java.util.Set;

/**
 * This interface defines the methods which should be implemented by any class that does the actual communication with
 * an ACI Server.
 */
public interface AciHttpClient {

    /**
     * Execute an ACI action on the ACI Server whose connection details are supplied.
     * @param serverDetails Details of the ACI Server to send the action to
     * @param parameters    The parameters to send with the ACI action
     * @return A {@code com.autonomy.aci.client.transport.AciResponseInputStream} containing the ACI response
     * @throws IOException      If an I/O (transport) error occurs. Some transport exceptions can be recovered from.
     * @throws AciHttpException If a protocol exception occurs. Usually protocol exceptions cannot be recovered from.
     */
    AciResponseInputStream executeAction(AciServerDetails serverDetails, Set> parameters) throws IOException, AciHttpException;

}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy