- java.lang.Object
-
- javax.resource.spi.work.HintsContext
-
- All Implemented Interfaces:
- Serializable, WorkContext
public class HintsContext extends Object implements WorkContext
A standardWorkContextthat allows aWorkinstance to propagate quality-of-service (QoS) hints about theWorkto theWorkManager.- Since:
- 1.6
- Version:
- Java EE Connector Architecture 1.6
- See Also:
WorkContextProvider, Serialized Form
-
-
Field Summary
Fields Modifier and Type Field and Description protected Stringdescriptionstatic StringLONGRUNNING_HINTprotected Stringnamestatic StringNAME_HINT
-
Constructor Summary
Constructors Constructor and Description HintsContext()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description StringgetDescription()Get the brief description of the role played by theWorkContextand any other related debugging information.Map<String,Serializable>getHints()StringgetName()Get the associated name of theWorkContext.voidsetDescription(String description)Set a brief description of the role played by the instance of HintsContext and any other related debugging information.voidsetHint(String hintName, Serializable value)Set a Hint and a related value.voidsetName(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 theWorkContextand any other related debugging information. This could be used by the WorkManager and the resource adapter for debugging purposes.- Specified by:
getDescriptionin 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:
getNamein 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.
-
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.
-
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 Connector specification. Use of "javax.resource." prefixed hintNames are reserved for use by the Connector specification.
-
getHints
public Map<String,Serializable> getHints()
-
-
Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/resource/spi/work/hintscontext.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.