Interface IEPAdapter

    • Method Detail

      • getName

        java.lang.String getName()
        Getter for field NAME

        Name

        Specifies the name of this event processing adapter. The name can be up to 32 characters in length.

        Specified by:
        getName in interface ICICSObject
      • getEnablestatus

        IEPAdapter.EnablestatusValue getEnablestatus()
        Getter for field ENABLESTATUS

        Enabled status

        Indicates whether the event processong adapter is enabled or not. Values are:

        DISABLED
        The event binding is not enabled.
        ENABLED
        The event binding is enabled.
      • getAdaptertype

        IEPAdapter.AdaptertypeValue getAdaptertype()
        Getter for field ADAPTERTYPE

        Adapter type

        Indicates the type of the EPADAPTER. Values are:

        CUSTOM
        A user-written event processing adapter that emits events in any format that you require to any destination.
        HTTP
        The IBM supplied HTTP event processing adapter that emits events to an HTTP server for consumption by products such as IBM Operational Decision Manager and IBM Business Monitor.
        TDQUEUE
        The IBM supplied TDQ event processing adapter that emits events to a named CICS TD queue.
        TRANSTART
        The IBM supplied Transaction Start event processing adapter that emits events to a named CICS transaction.
        TSQUEUE
        The IBM supplied TSQ event processing adapter that emits events to a named CICS TS queue.
        IBM MQ
        The IBM supplied IBM MQ event processing adapter that emits events to an IBM MQ Queue for consumption by products such as IBM Operational Decision Manager and IBM Business Monitor.
      • getAuthority

        IEPAdapter.AuthorityValue getAuthority()
        Getter for field AUTHORITY

        Authority

        Indicates the Authority of the event processing adapter. Values are:

        CONTEXT
        The event processing adapter runs using the user ID of the task that caused the event to be captured. This is always the case when EMITMODE is SYNCHRONOUS or when 'Use Context User ID' is specified for the event processing adapter.
        REGION
        The event processing adapter runs using the CICS region user ID.
        USERID
        The event processing adapter is attached using the identifier specified in the event processing adapter 'User ID' and returned in the AUTHUSERID attribute.
        DEFAULT
        The EP adapter runs using the CICS default user ID.
      • getChangeAgent

        IEPAdapter.ChangeAgentValue getChangeAgent()
        Getter for field CHANGEAGENT

        Last modification agent

        The change agent identifier that made the last modification.

        • CSDAPI - The resource was last changed by a CEDA transaction, by the programmable interface to DFHEDAP or by an EXEC CICS CSD command.
        • CSDBATCH - The resource was last changed by a DFHCSDUP job.
        • DREPAPI - The resource was last changed by a CICSPlex SM BAS API command.
        • DREPBATCH - The resource was last changed by a CICSPlex SM utility.
        • CREATESPI - The resource was installed by an EXEC CICS CREATE command.
        • NOTAPPLIC - This field is not applicable for this resource.
        • OVERRIDE - Resource was last changed by resource overrides.
      • getChangeAgentRelease

        java.lang.String getChangeAgentRelease()
        Getter for field CHANGEAGREL

        Last modification agent release

        The CICS release level of the agent that made the last modification to the resource definition.

      • getChangeUserID

        java.lang.String getChangeUserID()
        Getter for field CHANGEUSRID

        Last modification user ID

        The user ID that made the last modification to the resource definition.

      • getDefineSource

        java.lang.String getDefineSource()
        Getter for field DEFINESOURCE

        Source of the resource definition

        The source of the definition, depending on which agent made the last change.

      • getInstallAgent

        IEPAdapter.InstallAgentValue getInstallAgent()
        Getter for field INSTALLAGENT

        Installation agent

        The install agent identifier that made the installation.

        • BUNDLE - The resource was installed by a bundle deployment.
      • getInstallUserID

        java.lang.String getInstallUserID()
        Getter for field INSTALLUSRID

        Installation user ID

        The user ID that installed the resource definition.

      • getDefineTime

        java.util.Date getDefineTime()
        Getter for field DEFINETIME

        Creation time

        The local date and time when the resource definition record was created on DFHCSD or EYUDREP.

      • getChangeTime

        java.util.Date getChangeTime()
        Getter for field CHANGETIME

        Last modification time

        The local date and time when the definition was last changed.

      • getInstallTime

        java.util.Date getInstallTime()
        Getter for field INSTALLTIME

        Installation time

        The local date and time when the definition was installed.

      • getAuthuserid

        java.lang.String getAuthuserid()
        Getter for field AUTHUSERID

        Authority user ID

        The 8-character user identifier to be used to start the event processing adapter transaction. This attribute is only set if AUTHORITY is USERID.

      • getConfigdata1

        java.lang.String getConfigdata1()
        Getter for field CONFIGDATA1

        Event processing adapter configuration data

        A 64-character data area containing the primary configuration data item for the event processing adapter. If the primary configuration data item is less than 64 bytes, the field is padded with blanks. The data item returned is dependent upon ADAPTERTYPE, as follows:

        CUSTOM
        The first 64 bytes of custom event processing adapter configuration data.
        HTTP
        The 8-character name of the URIMAP definition to be used by an HTTP event processing adapter to locate the HTTP server.
        TDQ
        The 4-character name of the transient data queue for the event emitted by a TDQ event processing adapter.
        TRANSTART
        The 4-character name of the event consumer transaction that is started by a Transaction Start event processing adapter.
        TSQ
        The 16-character name of the temporary storage queue for the event emitted by a TSQ event processing adapter.
        IBM MQ
        The 48-character name of the IBM MQ queue for event messages emitted by this IBM MQ event processing adapter. This data is in the code page defined by the LOCALCCSID system initialization parameter.
      • getDataformat

        IEPAdapter.DataformatValue getDataformat()
        Getter for field DATAFORMAT

        Event format

        The format of events emitted by this event processing adapter. Values are:

        USER
        The format is user-defined.
        CBER
        Common Base Event REST format for the IBM Business Monitor REST HTTP server.
        CBE
        Common Base Event format for consumption by products such as IBM Business Monitor.
        CCE
        CICS Container Event format.
        CFE
        CICS Flattened Event format.
        DSIE
        Decision Server Insights Event format.
        WBE
        WebSphere Business Events XML format.
      • getEmitmode

        IEPAdapter.EmitmodeValue getEmitmode()
        Getter for field EMITMODE

        Emission mode

        The event emission mode of this event processing adapter. Values are:

        ASYNCHRONOUS
        Event emission is asynchronous of the capturing transaction. The unit of work for the capturing transaction might complete successfully even when the event is not emitted.
        SYNCHRONOUS
        Event emission is synchronous with the capturing transaction. The unit of work for the capturing transaction does not complete successfully when the event is not emitted.
      • getInvoketype

        IEPAdapter.InvoketypeValue getInvoketype()
        Getter for field INVOKETYPE

        Invoke type

        Indicates how the event processing adapter is invoked. Values are:

        ATTACH
        The event processing adapter is attached as a separate task.
        LINK
        The event processing adapter program is linked to.
      • getPriority

        IEPAdapter.PriorityValue getPriority()
        Getter for field PRIORITY

        Priority

        Indicates the dispatching priority of event emission for this event processing adapter. This attribute is ignored when EMITMODE is SYNCHRONOUS. Values are:

        HIGH
        Events emitted for this event processing adapter are high priority.
        NORMAL
        Events emitted for this event processing adapter are normal priority.
      • getProgram

        java.lang.String getProgram()
        Getter for field PROGRAM

        Program

        The 8-character name of the event processing adapter program. If the ADAPTERTYPE is CUSTOM, this attribute is only applicable if INVOKETYPE is LINK.

      • getTransaction

        java.lang.String getTransaction()
        Getter for field TRANSACTION

        Transaction

        The 4-character name of the transaction definition that is used if the event processing adapter transaction is attached. The TRANSACTION attributes is only applicable if INVOKETYPE is ATTACH.

      • getTransmode

        IEPAdapter.TransmodeValue getTransmode()
        Getter for field TRANSMODE

        Transactionality

        Indicates the event transactionality attribute of this event processing adapter. Values are:

        NONTRANS
        Events are not transactional. Events can be emitted regardless of whether the unit of work for the capturing transaction completes successfully.
        TRANS
        Events are transactional. Events can be emitted only when the unit of work for the capturing transaction completes successfully.
      • getBundle

        java.lang.String getBundle()
        Getter for field BUNDLE

        Bundle name

        Name of the bundle from which the event processing adapter is installed.

      • getPutevents

        java.lang.Long getPutevents()
        Getter for field PUTEVENTS

        Number of events emitted

        The number of events that have been emitted by this event processing Adapter.