Management API Reference for participants

The resource that did work in a transaction.

Attributes (6)

eis-product-name - The Jakarta Connectors enterprise information system's product name.

Type	STRING
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The Jakarta Connectors enterprise information system's product name.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "configuration", "restart-required" : null, "capability-reference" : null }`

eis-product-version - The Jakarta Connectors enterprise information system's product version.

Type	STRING
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The Jakarta Connectors enterprise information system's product version.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "configuration", "restart-required" : null, "capability-reference" : null }`

jmx-name - The JMX name of this participant.

Type	STRING
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The JMX name of this participant.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "configuration", "restart-required" : null, "capability-reference" : null }`

jndi-name - JNDI name of this participant.

Type	STRING
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "JNDI name of this participant.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "configuration", "restart-required" : null, "capability-reference" : null }`

status - Reports the commitment status of this participant (can be one of Pending, Prepared, Failed, Heuristic or Readonly).

Type	STRING
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-only
Allowed Values	HEURISTIC FAILED PENDING PREPARED READONLY
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Reports the commitment status of this participant (can be one of Pending, Prepared, Failed, Heuristic or Readonly).", "expressions-allowed" : false, "required" : false, "nillable" : true, "allowed" : [ "PENDING", "PREPARED", "FAILED", "HEURISTIC", "READONLY" ], "stability" : "default", "access-type" : "read-only", "storage" : "configuration", "restart-required" : null, "capability-reference" : null }`

type - The type name under which this record is stored.

Type	STRING
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The type name under which this record is stored.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "configuration", "restart-required" : null, "capability-reference" : null }`

Operations (3)

delete - Attempt to remove this participant from its containing transaction log. If the participant is an XA resource an attempt will be made to call forget on the actual resource and if the forget call fails then the remove operation will also fail.

Raw DMR model


{
    "operation-name" : "delete",
    "description" : "Attempt to remove this participant from its containing transaction log. If the participant is an XA resource an attempt will be made to call forget on the actual resource and if the forget call fails then the remove operation will also fail.",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

recover - If this record is in a heuristic state then attempt to replay the commit phase of the 2PC transaction. It switches the 'HEURISTIC' participant status to 'PREPARED', the operation does not immediately start the recovery process but the recovery manager will consider this participant with 'PREPARED' status in the next cycle.

Raw DMR model


{
    "operation-name" : "recover",
    "description" : "If this record is in a heuristic state then attempt to replay the commit phase of the 2PC transaction. It switches the 'HEURISTIC' participant status to 'PREPARED', the operation does not immediately start the recovery process but the recovery manager will consider this participant with 'PREPARED' status in the next cycle.",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

refresh - Refresh the management view of the attributes of this participant record by querying the transaction log which will update the snapshot view loaded in the model. Note that the model contains only a snapshot view of the transactions from time the probe was executed, not the real-time data from the transaction log, hence the need for this refresh operation.

Raw DMR model


{
    "operation-name" : "refresh",
    "description" : "Refresh the management view of the attributes of this participant record by querying the transaction log which will update the snapshot view loaded in the model. Note that the model contains only a snapshot view of the transactions from time the probe was executed, not the real-time data from the transaction log, hence the need for this refresh operation.",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}