Package com.ibm.cics.server.invocation

Annotation Interface CICSProgram

@Documented @Retention(SOURCE) @Target(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 Program.link() method in JCICS.

When an application that has been annotated with this type is installed into an OSGi or 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.

The following criteria must be met for the annotation to be valid:

The annotation
  • Must be on a method
  • Must have a value attribute of a PROGRAM name.
The method
  • Must be concrete (not abstact)
  • Must be public
  • Must have no arguments
The class
  • Must be top level
  • Must not have more than one method that is annotated with the same PROGRAM name.
Since CICS TS version:
5.3

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    CICSProgram.TargetType
    Defines the supported types of classes which can be targeted by the CICSProgram annotation.

  • Required Element Summary

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

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    CICSProgram.TargetType
    targetType
     

  • Element Details

    • value

      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

      CICSProgram.TargetType targetType
      Returns:
      the type of class that will invoked by CICS
      Since CICS TS version:
      5.5
      Default:
      UNSPECIFIED