Package javax.resource.spi.work
Class HintsContext
- java.lang.Object
-
- javax.resource.spi.work.HintsContext
-
- All Implemented Interfaces:
java.io.Serializable
,WorkContext
public class HintsContext extends java.lang.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 java.lang.String
description
static java.lang.String
LONGRUNNING_HINT
protected java.lang.String
name
static java.lang.String
NAME_HINT
-
Constructor Summary
Constructors Constructor Description HintsContext()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getDescription()
Get the brief description of the role played by theWorkContext
and any other related debugging information.java.util.Map<java.lang.String,java.io.Serializable>
getHints()
java.lang.String
getName()
Get the associated name of theWorkContext
.void
setDescription(java.lang.String description)
Set a brief description of the role played by the instance of HintsContext and any other related debugging information.void
setHint(java.lang.String hintName, java.io.Serializable value)
Set a Hint and a related value.void
setName(java.lang.String name)
Set the associated name of the HintsContext.
-
-
-
Field Detail
-
NAME_HINT
public static final java.lang.String NAME_HINT
- See Also:
- Constant Field Values
-
LONGRUNNING_HINT
public static final java.lang.String LONGRUNNING_HINT
- See Also:
- Constant Field Values
-
description
protected java.lang.String description
-
name
protected java.lang.String name
-
-
Method Detail
-
getDescription
public java.lang.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 java.lang.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(java.lang.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(java.lang.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(java.lang.String hintName, java.io.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 java.util.Map<java.lang.String,java.io.Serializable> getHints()
-
-