- java.lang.Object
-
- jakarta.resource.spi.work.HintsContext
-
- All Implemented Interfaces:
WorkContext
,Serializable
public class HintsContext extends Object implements WorkContext
A standardWorkContext
that allows aWork
instance to propagate quality-of-service (QoS) hints about theWork
to theWorkManager
.- Since:
- 1.6
- See Also:
WorkContextProvider
, Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected String
description
static String
LONGRUNNING_HINT
protected String
name
static String
NAME_HINT
-
Constructor Summary
Constructors Constructor Description HintsContext()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getDescription()
Get the brief description of the role played by theWorkContext
and any other related debugging information.Map<String,Serializable>
getHints()
Get all hintsString
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
setName(String name)
Set the associated name of the HintsContext.
-
-
-
Field Detail
-
NAME_HINT
public static final String NAME_HINT
- See Also:
- Constant Field Values
-
LONGRUNNING_HINT
public static final String LONGRUNNING_HINT
- See Also:
- Constant Field Values
-
description
protected String description
-
name
protected String name
-
-
Method Detail
-
getDescription
public String 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
public String 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
public void setDescription(String description)
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.- Parameters:
description
- The description
-
setName
public void setName(String name)
Set the associated name of the HintsContext. This could be used by the resource adapter and the WorkManager for logging and debugging purposes.- Parameters:
name
- The name
-
setHint
public void setHint(String hintName, Serializable value)
Set a Hint and a related value. The hintName must be non-Null. Standard HintNames are defined in the Jakarta Connectors specification. Use of "jakarta.resource." prefixed hintNames are reserved for use by the Jakarta Connectors specification.- Parameters:
hintName
- name of the hint to setvalue
- value to set
-
getHints
public Map<String,Serializable> getHints()
Get all hints- Returns:
- Map keyed on hint name
-
-