com.exactpro.sf.scriptrunner.IConnectionManager Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sailfish-core Show documentation
'Exactpro Sailfish Core'
There is a newer version: 3.4.260
/******************************************************************************
 * Copyright 2009-2018 Exactpro (Exactpro Systems Limited)
 *
 * 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.exactpro.sf.scriptrunner;

import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.Future;

import org.jetbrains.annotations.NotNull;

import com.exactpro.sf.center.IDisposable;
import com.exactpro.sf.common.services.ServiceName;
import com.exactpro.sf.services.IService;
import com.exactpro.sf.services.IServiceSettings;
import com.exactpro.sf.services.ServiceDescription;

public interface IConnectionManager extends IDisposable
{
    /**
     * Adds default service. Default service is a service which will be added to all existing and newly created environments.
     * Already existing services on environments will not be replaced.
     * @param serviceDescription description of a service to add (environment will be ignored)
     * @param exceptionListener exception listener
     * @return
     */
    void addDefaultService(ServiceDescription serviceDescription, IServiceNotifyListener exceptionListener);

    /**
     * Removes default service. Services already added to environments will not be removed
     * @param serviceName name of a service to remove (without environment)
     * @param exceptionListener exception listener
     * @return
     */
    void removeDefaultService(String serviceName, IServiceNotifyListener exceptionListener);

    Future addService(ServiceDescription serviceDescription, IServiceNotifyListener exceptionListener);

	Future initService(ServiceName serviceName, IServiceNotifyListener exceptionListener);

	Future startService(ServiceName serviceName, IServiceNotifyListener exceptionListener);

	Future disposeService(ServiceName serviceName, IServiceNotifyListener exceptionListener);

	Future removeService(ServiceName serviceName, IServiceNotifyListener exceptionListener);

    Future removeServices(Collection serviceName, IServiceNotifyListener notifyListener);

    Future updateService(ServiceDescription serviceDescription, IServiceNotifyListener exceptionListener);

	Future copyService(ServiceName from, ServiceName to, IServiceNotifyListener notifyListener);

    Future removeEnvironment(String envName, IServiceNotifyListener notifyListener);

    Future addEnvironment(String envName, IServiceNotifyListener notifyListener);

    Future renameEnvironment(String oldEnvName, String newEnvName, IServiceNotifyListener notifyListener);

    List getEnvironmentList();

    /**
     * Lock services which are used in a script.
     * If another script will lock one of the locked services it will wait
     * until service release in setServiceNotUsed method.
     * @param names collection of services to be locked
     * @throws InterruptedException
     */
    void setServiceUsed(String[] name) throws InterruptedException;

    /**
     * Release specified services.
     * @param names collection of services to be released
     */
    void setServiceNotUsed(String[] name);

    /**
     * Tries to acquire a lock for a service.
     * Throws exception if it fails to do so in specified time or if the service doesn't exist.
     * @param name service name
     * @param timeout time to wait for the lock in milliseconds
     * @throws InterruptedException
     */
    void tryLockService(@NotNull ServiceName name, long timeout) throws InterruptedException;

    /**
     * Unlocks a service.
     * Throws exception if the service wasn't locked by a current thread or if it doesn't exist.
     * @param name service name
     */
    void unlockService(@NotNull ServiceName name);

    Set getUsedServices();

     Service getService(ServiceName serviceName);

    ServiceName[] getServiceNames();

    IService[] getStartedServices();

    ServiceDescription[] getServicesDescriptions();

    ServiceDescription getServiceDescription(ServiceName serviceName);

	IServiceSettings getServiceSettings(ServiceName serviceName);

	void cleanup(List services);

	void subscribeForEvents(IEnvironmentListener listener);

	void unSubscribeForEvents(IEnvironmentListener listener);

	List getEnvironmentListeners();

    Map getVariableSet(String name);

    void putVariableSet(String name, Map variableSet);

    void removeVariableSet(String name);

    boolean isVariableSetExists(String name);

    Set getVariableSets();

    void setEnvironmentVariableSet(String environmentName, String variableSetName);

    String getEnvironmentVariableSet(String environmentName);
}