com.autonomy.aci.client.services.AciService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aci-api Show documentation
Java client for communicating with IDOL ACI servers.
The newest version!
/*
 * 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.services;

import com.autonomy.aci.client.transport.AciServerDetails;
import com.autonomy.aci.client.transport.ActionParameter;

import java.util.Set;

/**
 * Defines methods for executing ACI actions on any ACI server and processing of the resulting response.
 */
public interface AciService {

    /**
     * Executes an ACI action and processes the response with the supplied Processor.
     * @param  Return type.
     * @param parameters The parameters to use with the ACI command. This should include an {@code
     *                   Action=} parameter
     * @param processor  The Processor to use for converting the response stream into an object
     * @return The ACI response encoded as an object of type T
     * @throws AciServiceException If an error occurred during the communication with the ACI Server, processing the
     *                             response or if the response contained an error
     */
     T executeAction(Set> parameters, Processor processor);

    /**
     * Executes an ACI action and processes the response with the supplied Processor.
     * @param  Return type.
     * @param serverDetails The connection details of the ACI Server to execute the action on
     * @param parameters    The parameters to use with the ACI command. This should include an {@code
     *                      Action=} parameter
     * @param processor     The Processor to use for converting the response stream into an object
     * @return The ACI response encoded as an object of type T
     * @throws AciServiceException If an error occurred during the communication with
     *                             the ACI Server, processing the response or if the response contained an error
     */
     T executeAction(AciServerDetails serverDetails, Set> parameters, Processor processor);

}