dev.galasa.cicsts.internal.properties.DseUssHome 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

/*
 * Licensed Materials - Property of IBM
 * 
 * (c) Copyright IBM Corp. 2021.
 */
package dev.galasa.cicsts.internal.properties;

import dev.galasa.cicsts.CicstsManagerException;
import dev.galasa.framework.spi.ConfigurationPropertyStoreException;
import dev.galasa.framework.spi.cps.CpsProperties;

/**
 * Developer Supplied Environment - CICS TS Region - USSHOME
 * 
 * @galasa.cps.property
 * 
 * @galasa.name cicsts.dse.tag.[TAG].usshome
 * 
 * @galasa.description Provides the USSHOME value of the CICS TS region.
 * 
 * @galasa.required Yes if you want to use a Manager that requires the value, e.g. for JVMSERVER, otherwise not required
 * 
 * @galasa.default None
 * 
 * @galasa.valid_values A value for USSHOME that matches the value supplied to the DSE CICS region.
 * 
 * @galasa.examples 
 * cicsts.dse.tag.PRIMARY.usshome=/cics/cics730

 *
 */
public class DseUssHome extends CpsProperties {

    public static String get(String tag) throws CicstsManagerException {
        try {
        	return getStringNulled(CicstsPropertiesSingleton.cps(), "dse.tag." + tag, "usshome");
        } catch (ConfigurationPropertyStoreException e) {
            throw new CicstsManagerException("Problem asking CPS for the DSE USSHOME for tag " + tag, e); 
        }
    }
}