dev.galasa.cicsts.spi.ICicstsManagerSpi Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dev.galasa.cicsts.manager Show documentation
A Galasa project
There is a newer version: 0.38.0
Show newest version
/*
 * Copyright contributors to the Galasa project
 */
package dev.galasa.cicsts.spi;

import java.util.List;
import java.util.Map;

import javax.validation.constraints.NotNull;

import dev.galasa.ProductVersion;
import dev.galasa.cicsts.CicstsManagerException;
import dev.galasa.cicsts.ICicsRegion;
import dev.galasa.cicsts.ICicsTerminal;
import dev.galasa.zosbatch.IZosBatch;
import dev.galasa.zosfile.IZosFileHandler;

public interface ICicstsManagerSpi {

    void registerProvisioner(ICicsRegionProvisioner provisioner);

    @NotNull
    List getLogonProviders();

    @NotNull
    String getProvisionType();

    @NotNull
    ProductVersion getDefaultVersion();
    
    
    /**
     * Register the a ICeci instance provider with the CICS TS Manager
     * 
     * @param ceciProvider - the new provider
     */
    void registerCeciProvider(@NotNull ICeciProvider ceciProvider);
    
    /**
     * Register the a ICeda instance provider with the CICS TS Manager
     * 
     * @param cedaProvider - the new provider
     */
    void registerCedaProvider(@NotNull ICedaProvider cedaProvider);
    
    /**
     * Register the a ICicsResource instance provider with the CICS TS Manager
     * 
     * @param cicsResourceProvider - the new provider
     */
    void registerCicsResourceProvider(@NotNull ICicsResourceProvider cicsResourceProvider);
    
    /**
     * Register the a ICemt instance provider with the CICS TS Manager
     * 
     * @param cemtProvider - the new provider
     */
    void registerCemtProvider(@NotNull ICemtProvider cemtProvider);
    
    /**
     * @return The registered CECI provider
     * @throws CicstsManagerException
     */
    @NotNull
    public ICeciProvider getCeciProvider() throws CicstsManagerException;

    /**
     * @return The registered CEDA provider
     * @throws CicstsManagerException
     */
    @NotNull
    public ICedaProvider getCedaProvider() throws CicstsManagerException;

    /**
     * @return The registered CICS Resource provider
     * @throws CicstsManagerException
     */
    @NotNull
    public ICicsResourceProvider getCicsResourceProvider() throws CicstsManagerException;

    /**
     * @return The registered CEMT provider
     * @throws CicstsManagerException
     */
    @NotNull
    public ICemtProvider getCemtProvider() throws CicstsManagerException;

    
    public void cicstsRegionStarted(ICicsRegion region) throws CicstsManagerException;

	public IZosBatch getZosBatch(ICicsRegion region) throws CicstsManagerException;

	public IZosFileHandler getZosFileHandler() throws CicstsManagerException;
	
	public ICicsTerminal generateCicsTerminal(String tag) throws CicstsManagerException;
	
	public Map getTaggedCicsRegions();

	public ICicsRegion locateCicsRegion(String tag) throws CicstsManagerException;
}