org.testifyproject.RemoteResourceInstance 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 org.testifyproject.annotation.RemoteResource;
import org.testifyproject.trait.PropertiesReader;

/**
 * A contract that defines methods to get information about a remote resource instance. A remote
 * instance consists of a client that can be used to communicate with the remote resource and
 * properties associated with the remote resource instance.
 *
 * @author saden
 * @param  the underlying remote resource type
 */
public interface RemoteResourceInstance extends PropertiesReader {

    /**
     * Get a unique fully qualified name associated with the remote resource.
     *
     * @return the remote resource's fully qualified name
     */
    String getFqn();

    /**
     * Get the remote resource annotation associated with the remote resource instance.
     *
     * @return the remote resource annotation
     */
    RemoteResource getRemoteResource();

    /**
     * Get the resource instance associated with the remote resource.
     *
     * @return a remote resource instance
     */
    Instance getResource();

}