@hpas Tag Reference

Define HPAS-specific deployment descriptors (hp-ejb-jar.xml) for EJB beans.

Applies to: All EJB types

@hpas Class Level Tags

@hpas.bean

@hpas.ejb-ref

@hpas.pool

@hpas Method Level Tags

@hpas Field Level Tags

@hpas Class Level Tag Usage

@hpas.bean (0..1)

Most of the class-level HPAS options are specified in parameters of this tag.

Applies to: class level of EJB

ParameterTypeApplicabilityDescriptionMandatory
read-onlyboolApplicable only to entity beans. Specifies whether the bean is marked as read only. false
passivationbool Applicable to stateful session beans and entity beans. For stateful session beans, if this parameter is used then the passivate-threshold parameter must also be present. Determines whether the container can manage the passivation behaviour of beans; indicates whether passivation is enabled for the bean. false
passivate-thresholdint Specifies the number of beans for a deployed EJB above which the container will attempt to passivate instances. Applicable to stateful session beans only, when the passivation parameter has been used. false
session-timeoutint Indicates the timeout for the session. *** Note, int used because do not know what the f**k is duration false
concurrent-message-processingboolApplicable to message driven beans only Specifies whether concurrent message processing is enabled. false
max-messagesintApplicable to message driven beans only Specifies the maximum number of messages assigned to a single session. This value is passed to the JMS server false
max-message-threadsintApplicable to message driven beans only Specifies the maximum number of separate server sessions (threads) that will be created to handle messages false
message-thread-timeoutintApplicable to message driven beans only Specifies the amount of time after which an idle server session will be available to be removed from the pool. false
connection-retryboolApplicable to message driven beans only Specifies whether an exception listener is registered for the connection. If no exception listener is established, there will be no connection failover. false
jndi-factorytextApplicable to message driven beans only Specifies the lookup string used to obtain the factory that will be used to create the connection used by the MDB. true
jndi-destinationtextApplicable to message driven beans only Specifies the lookup string for the destination topic or queue for which the bean is registered as a listener. true

@hpas.ejb-ref (0..*)

A mapping of EJB references to deployed beans. NB This is likely to be refactored in the future, to use extra parameters on the @ejb:ejb-ref and @ejb:ejb-external-ref tags instead of the @hpas.ejb-ref tag.

ParameterTypeApplicabilityDescriptionMandatory
typetext Use "co-located" for references to EJBs in the same application, and "distributed" for references to EJBs in other applications.
Valid options are:

co-located

distributed

Default value(s):

co-located
true
ref-nametext Specifies the mapping into the ejb-ref entry in the standard deployment descriptor. true
jndi-nametext Specifies the actual name under which the bean is registered in the name service. true
applicationtextOnly applies when type="distributed". Specifies the name of the application in which the EJB component is deployed. false
hosttextOnly applies when type="distributed".Specifies the host name for the name server.false
porttextOnly applies when type="distributed".Specifies the port number for the name serverfalse

@hpas.pool (0..1)

Contains the information required to setup an object pool.

Applies to: All beans

ParameterTypeApplicabilityDescriptionMandatory
initial-sizeintSpecifies the initial size of the pool.false
cache-limittext Specifies the maximum size of the pool. When the cache-limit is reached, pooled entries that are returned to the pool will be discarded; if the cache-limit is reached, new objects may still be created. NB: "integer or unlimited" is bullshit. How do I specify condition for this?

Default value(s):

unlimited
false
idle-timeoutint Specifies the idle timeout for the pool. false
use-reaperbool Specifies whether the pool should enforce the cache-limit. The reaper can be disabled to optimize pool performance. false
reap-asynchbool Specifies whether pool reaping should occur asynchronously with respect to inserting or removing objects from the pool. Setting this to true makes pool accesses faster but consumes more system resources. false

@hpas Method Level Tag Usage

@hpas Field Level Tag Usage