com.ibm.cics.server.invocation

Annotation Type CICSProgram



  • @Documented
     @Retention(value=SOURCE)
     @Target(value=METHOD)
    public @interface CICSProgram

    Indicates that methods can be called by CICS Transaction Server.

    This type should be used on methods to make them program resources in CICS Transaction Server, enabling them to be called using the EXEC CICS LINK API from native languages such as COBOL and PL/I or using the com.ibm.cics.server.Program.link() method in JCICS.

    When an application that has been annotated with this type is installed into a Liberty JVM server in CICS Transaction Server, each annotated method will result in a new program resource being created, unless a program resource with the same name already exists.

    Similarly, when the application is uninstalled, any program resources that were created due to this annotation will be deleted.

    Indicate the name of the program resource using the value attribute.

    • Field Summary

      Fields 
      Modifier and Type Fields and Description
      static java.lang.String COPYRIGHT
      Copyright statement
    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element and Description
      java.lang.String value
      The name of the CICS program resource that will be created in CICS Transaction Server.
    • Field Detail

      • COPYRIGHT

        public static final java.lang.String COPYRIGHT
        Copyright statement
    • Element Detail

      • value

        public abstract java.lang.String value

        The name of the CICS program resource that will be created in CICS Transaction Server.

        The name can be up to eight characters in length. Acceptable characters are: A-Z 0-9 $ @ #. It is preferable not to use names that start with DFH because these characters are reserved for use by CICS.

        Returns:
        the name of the CICS program.
      • targetType

        public abstract CICSProgram.TargetType targetType
        Returns:
        The type of class that will invoked by CICS
        Default:
        com.ibm.cics.server.invocation.CICSProgram.TargetType.UNSPECIFIED