dev.galasa.zosmf.Zosmf Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dev.galasa.zosmf.manager Show documentation

A Galasa project

The newest version!

/*
 * Copyright contributors to the Galasa project
 *
 * SPDX-License-Identifier: EPL-2.0
 */
package dev.galasa.zosmf;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import dev.galasa.framework.spi.ValidAnnotatedFields;
import dev.galasa.zosmf.internal.ZosmfManagerField;

/**
 * z/OS MF 
 * 
 * @galasa.annotation
 * 
 * @galasa.description The {@literal @}Zosmf annotation requests the z/OSMF Manager to provide a
 * z/OSMF instance associated with a z/OS image. 
 * The test can request multiple z/OSMF instances, with the default being associated with the primary zOS image.
 * 
 * @galasa.examples 
 * 
 * {@literal @}ZosImage(imageTag="A")

 * public IZosImage zosImageA;

 * {@literal @}Zosmf(imageTag="A")

 * public IZosmf zosmfA;

 * 
 * 
 * @galasa.extra
 * The IZosmf interface has a number of methods to issue requests to the zOSMF REST API.
 * 
 * @see Zosmf
 * @see IZosmf
 * 
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.FIELD })
@ZosmfManagerField
@ValidAnnotatedFields({ IZosmf.class })
public @interface Zosmf {
    
    /**
     * @return The tag of the zOS Image with which this variable will to be populated
     */
    String imageTag() default "PRIMARY";

}