com.fitbur.testify.client.ClientInstance Maven / Gradle / Ivy

Go to download

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

The newest version!

/*
 * Copyright 2015 Sharmarke Aden.
 *
 * 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 com.fitbur.testify.client;

import java.net.URI;

/**
 * A contract that defines methods for getting information a client.
 *
 * @author saden
 * @param  the client type
 */
public interface ClientInstance {

    /**
     * The base server URI used by the client.
     *
     * @return the base URI.
     */
    URI getURI();

    /**
     * Get a configured client instance.
     * 
     * Note that the instance returned could be the same as the instance
     * returned by {@link #getClient()}
     * 
     *
     * @return a configured client instance
     */
    T getTarget();

    /**
     * Get the underlying client instance.
     *
     * @param  the underlying client
     * @return a client instance
     */
     S getClient();

    /**
     * Close the client instance.
     */
    void close();

}