Package javax.resource.spi.work
Class HintsContext
java.lang.Object
javax.resource.spi.work.HintsContext
- All Implemented Interfaces:
Serializable
,WorkContext
A standard
WorkContext
that allows a Work
instance to propagate quality-of-service (QoS) hints about the Work
to the WorkManager
.- Since:
- 1.6
- See Also:
-
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGet the brief description of the role played by theWorkContext
and any other related debugging information.getHints()
getName()
Get the associated name of theWorkContext
.void
setDescription
(String description) Set a brief description of the role played by the instance of HintsContext and any other related debugging information.void
setHint
(String hintName, Serializable value) Set a Hint and a related value.void
Set the associated name of the HintsContext.
-
Field Details
-
NAME_HINT
- See Also:
-
LONGRUNNING_HINT
- See Also:
-
description
-
name
-
-
Constructor Details
-
HintsContext
public HintsContext()
-
-
Method Details
-
getDescription
Get the brief description of the role played by theWorkContext
and any other related debugging information. This could be used by the WorkManager and the resource adapter for debugging purposes.- Specified by:
getDescription
in interfaceWorkContext
- Returns:
- the associated description of the
WorkContext
-
getName
Get the associated name of theWorkContext
. This could be used by the WorkManager and the resource adapter for debugging purposes.- Specified by:
getName
in interfaceWorkContext
- Returns:
- the associated name of the
WorkContext
-
setDescription
Set a brief description of the role played by the instance of HintsContext and any other related debugging information. This could be used by the resource adapter and the WorkManager for logging and debugging purposes. -
setName
Set the associated name of the HintsContext. This could be used by the resource adapter and the WorkManager for logging and debugging purposes. -
setHint
Set a Hint and a related value. The hintName must be non-Null. Standard HintNames are defined in the Connector specification. Use of "javax.resource." prefixed hintNames are reserved for use by the Connector specification. -
getHints
-