javax.resource.spi.work
Class HintsContext

java.lang.Object
  extended by javax.resource.spi.work.HintsContext
All Implemented Interfaces:
java.io.Serializable, WorkContext

public class HintsContext
extends java.lang.Object
implements 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
Version:
Java EE Connector Architecture 1.6
See Also:
WorkContextProvider, Serialized Form

Field Summary
protected  java.lang.String description
           
static java.lang.String LONGRUNNING_HINT
           
protected  java.lang.String name
           
static java.lang.String NAME_HINT
           
 
Constructor Summary
HintsContext()
           
 
Method Summary
 java.lang.String getDescription()
          Get the brief description of the role played by the WorkContext 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 the WorkContext.
 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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

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
Constructor Detail

HintsContext

public HintsContext()
Method Detail

getDescription

public java.lang.String getDescription()
Get the brief description of the role played by the WorkContext and any other related debugging information. This could be used by the WorkManager and the resource adapter for debugging purposes.

Specified by:
getDescription in interface WorkContext
Returns:
the associated description of the WorkContext

getName

public java.lang.String getName()
Get the associated name of the WorkContext. This could be used by the WorkManager and the resource adapter for debugging purposes.

Specified by:
getName in interface WorkContext
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()


Submit a bug or feature

Copyright © 2009-2011, Oracle Corporation and/or its affiliates. All Rights Reserved. Use is subject to license terms.

Generated on 10-February-2011 12:41


Spec-Zone.ru - all specs in one place



free hit counter