org.testifyproject.ClientProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of api Show documentation

A module that provides Testify's annotations

There is a newer version: 1.0.6

/*
 * Copyright 2016-2017 Testify Project.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.testifyproject;

import java.net.URI;

/**
 * A contract that defines methods for configuring, initializing and destroying
 * a client used to communicate with the server.
 *
 * @author saden
 * @param  the client configuration type
 * @param  the client instance type
 */
public interface ClientProvider {

    /**
     * Configure the client using the given server instance.
     *
     * @param testContext the test context
     * @param baseURI the base server URI
     * @return client configuration object
     */
    T configure(TestContext testContext, URI baseURI);

    /**
     * Create and initialize the client instance using the given base URI and
     * configuration object.
     *
     * @param testContext the test context
     * @param baseURI the base server URI
     * @param configuration client configuration object
     * @return a client instance.
     */
    ClientInstance create(TestContext testContext, URI baseURI, T configuration);

    /**
     * Destroy the client.
     */
    void destroy();

}