Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.1.2)

Part Number E27170-01

weblogic.ejbgen
Annotation Type Session


@Retention(value=CLASS)
@Target(value=java.lang.annotation.ElementType.TYPE)
public @interface Session


Required Element Summary
 String ejbName
          Names this Session bean.
 
Optional Element Summary
 Constants.Bool allowConcurrentCalls
          (True|False) Specifies whether to allow concurrent calls on that EJB.
 Constants.Bool allowRemoveDuringTransaction
          (True|False) Specifies whether remove() can be invoked during a transaction.
 String beanLoadAlgorithm
          Specifies the algorithm to be used for load-balancing among replicas of this bean.
 Session.CacheType cacheType
          (NRU|LRU) Specifies the type of the cache for this stateful Session bean.
 String callRouterClassName
          Gives class name to be used for routing home method calls.
 Constants.Bool clientsOnSameServer
          (True|False) Specifies whether the clients are colocated with the EJB on the same server.
 String createAsPrincipalName
          Names the principal to be used when ejbCreate would otherwise run with an anonymous principal.
 Constants.TransactionAttribute defaultTransaction
          (NotSupported|Supports|Required|RequiresNew|Mandatory|Never) Specifies the transaction attribute to be applied to all methods that do not have a specific transaction attribute setting.
 String dispatchPolicy
          Specifies the dispatch policy queue for this bean.
 Constants.Bool enableCallByReference
          (True|False) Specifies whether the container will call this EJB by reference.
 String homeCallRouterClassName
          Names class to be used for routing home method calls.
 Constants.Bool homeIsClusterable
          (True|False) Specifies whether this bean can be deployed from multiple servers in a cluster.
 Constants.HomeLoadAlgorithm homeLoadAlgorithm
          (RoundRobin|Random|WeightBased|RoundRobinAffinity|RandomAffinity|WeightBasedAffinity) Specifies the algorithm to use for load-balancing between replicas of this home.
 String idleTimeoutSeconds
          Specifies the maximum duration an EJB remains cached.
 String initialBeansInFreePool
          Specifies the initial number of beans in the free pool.
 Constants.Bool isClusterable
          (True|False) Sets whether this bean is clusterable.
 String maxBeansInCache
          Specifies the maximum number of beans in the cache.
 String maxBeansInFreePool
          Specifies the maximum number of beans in the free pool.
 Constants.Bool methodsAreIdempotent
          (True|False) Specifies whether the methods for this stateless session bean are idempotent or not.
 String networkAccessPoint
           
 String passivateAsPrincipalName
          Names the principal to be used when ejbPassivate would otherwise run with an anonymous principal.
 String persistentStoreDir
          Specifies the directory in which to store the passivated beans.
 String remoteClientTimeout
          remote client timeout
 String removeAsPrincipalName
          Names the principal to be used when ejbRemove would otherwise run with an anonymous principal.
 Session.ReplicationType replicationType
          (InMemory|None) Specifies how to replicate stateful session beans in a cluster.
 String runAs
          Specifies the role-name for this EJB.
 String runAsIdentityPrincipal
          Specifies the name of the principal when the role maps to several principals.
 String runAsPrincipalName
          Specifies the name of the principal when the role maps to several principals.
 String serviceEndpoint
          The fully-qualified name of the enterprise beans web service endpoint interface.
 String sessionTimeoutSeconds
          Specifies the number of seconds an EJB stays alive before being passivated.
 String timerPersistentStore
           
 Session.SessionTransactionType transactionType
          (Bean|Container) Specifies who manages the transactions for this EJB.
 String transTimeoutSeconds
          Specifies the transaction timeout (in seconds).
 Session.SessionType type
          (Stateless|Stateful) Specifies the type of the Session bean.
 Constants.Bool useCallerIdentity
          (True|False) Specifies whether this EJB uses callers identity.
 

Element Detail

ejbName

public abstract String ejbName
Names this Session bean.

isClusterable

public abstract Constants.Bool isClusterable
(True|False) Sets whether this bean is clusterable.

Default:
weblogic.ejbgen.Constants.Bool.UNSPECIFIED

replicationType

public abstract Session.ReplicationType replicationType
(InMemory|None) Specifies how to replicate stateful session beans in a cluster.

Default:
weblogic.ejbgen.Session.ReplicationType.UNSPECIFIED

clientsOnSameServer

public abstract Constants.Bool clientsOnSameServer
(True|False) Specifies whether the clients are colocated with the EJB on the same server.

Default:
weblogic.ejbgen.Constants.Bool.UNSPECIFIED

serviceEndpoint

public abstract String serviceEndpoint
The fully-qualified name of the enterprise beans web service endpoint interface.

Default:
"UNSPECIFIED"

useCallerIdentity

public abstract Constants.Bool useCallerIdentity
(True|False) Specifies whether this EJB uses callers identity.

Default:
weblogic.ejbgen.Constants.Bool.UNSPECIFIED

persistentStoreDir

public abstract String persistentStoreDir
Specifies the directory in which to store the passivated beans.

Default:
"UNSPECIFIED"

callRouterClassName

public abstract String callRouterClassName
Gives class name to be used for routing home method calls.

Default:
"UNSPECIFIED"

defaultTransaction

public abstract Constants.TransactionAttribute defaultTransaction
(NotSupported|Supports|Required|RequiresNew|Mandatory|Never) Specifies the transaction attribute to be applied to all methods that do not have a specific transaction attribute setting.

Default:
weblogic.ejbgen.Constants.TransactionAttribute.UNSPECIFIED

methodsAreIdempotent

public abstract Constants.Bool methodsAreIdempotent
(True|False) Specifies whether the methods for this stateless session bean are idempotent or not.

Default:
weblogic.ejbgen.Constants.Bool.UNSPECIFIED

runAsIdentityPrincipal

public abstract String runAsIdentityPrincipal
Specifies the name of the principal when the role maps to several principals.

Default:
"UNSPECIFIED"

runAsPrincipalName

public abstract String runAsPrincipalName
Specifies the name of the principal when the role maps to several principals.

Default:
"UNSPECIFIED"

enableCallByReference

public abstract Constants.Bool enableCallByReference
(True|False) Specifies whether the container will call this EJB by reference.

Default:
weblogic.ejbgen.Constants.Bool.UNSPECIFIED

dispatchPolicy

public abstract String dispatchPolicy
Specifies the dispatch policy queue for this bean.

Default:
"UNSPECIFIED"

passivateAsPrincipalName

public abstract String passivateAsPrincipalName
Names the principal to be used when ejbPassivate would otherwise run with an anonymous principal.

Default:
"UNSPECIFIED"

maxBeansInCache

public abstract String maxBeansInCache
Specifies the maximum number of beans in the cache.

Default:
"UNSPECIFIED"

initialBeansInFreePool

public abstract String initialBeansInFreePool
Specifies the initial number of beans in the free pool.

Default:
"UNSPECIFIED"

allowRemoveDuringTransaction

public abstract Constants.Bool allowRemoveDuringTransaction
(True|False) Specifies whether remove() can be invoked during a transaction.

Default:
weblogic.ejbgen.Constants.Bool.UNSPECIFIED

idleTimeoutSeconds

public abstract String idleTimeoutSeconds
Specifies the maximum duration an EJB remains cached.

Default:
"UNSPECIFIED"

type

public abstract Session.SessionType type
(Stateless|Stateful) Specifies the type of the Session bean. If this attribute is not specified, EJBGen will guess the right type by looking at the ejbCreate() methods on your class.

Default:
weblogic.ejbgen.Session.SessionType.UNSPECIFIED

removeAsPrincipalName

public abstract String removeAsPrincipalName
Names the principal to be used when ejbRemove would otherwise run with an anonymous principal.

Default:
"UNSPECIFIED"

transTimeoutSeconds

public abstract String transTimeoutSeconds
Specifies the transaction timeout (in seconds).

Default:
"UNSPECIFIED"

transactionType

public abstract Session.SessionTransactionType transactionType
(Bean|Container) Specifies who manages the transactions for this EJB.

Default:
weblogic.ejbgen.Session.SessionTransactionType.UNSPECIFIED

allowConcurrentCalls

public abstract Constants.Bool allowConcurrentCalls
(True|False) Specifies whether to allow concurrent calls on that EJB.

Default:
weblogic.ejbgen.Constants.Bool.UNSPECIFIED

maxBeansInFreePool

public abstract String maxBeansInFreePool
Specifies the maximum number of beans in the free pool.

Default:
"UNSPECIFIED"

sessionTimeoutSeconds

public abstract String sessionTimeoutSeconds
Specifies the number of seconds an EJB stays alive before being passivated.

Default:
"UNSPECIFIED"

beanLoadAlgorithm

public abstract String beanLoadAlgorithm
Specifies the algorithm to be used for load-balancing among replicas of this bean.

Default:
"UNSPECIFIED"

homeLoadAlgorithm

public abstract Constants.HomeLoadAlgorithm homeLoadAlgorithm
(RoundRobin|Random|WeightBased|RoundRobinAffinity|RandomAffinity|WeightBasedAffinity) Specifies the algorithm to use for load-balancing between replicas of this home.

Default:
weblogic.ejbgen.Constants.HomeLoadAlgorithm.UNSPECIFIED

cacheType

public abstract Session.CacheType cacheType
(NRU|LRU) Specifies the type of the cache for this stateful Session bean.

Default:
weblogic.ejbgen.Session.CacheType.UNSPECIFIED

runAs

public abstract String runAs
Specifies the role-name for this EJB.

Default:
"UNSPECIFIED"

homeIsClusterable

public abstract Constants.Bool homeIsClusterable
(True|False) Specifies whether this bean can be deployed from multiple servers in a cluster.

Default:
weblogic.ejbgen.Constants.Bool.UNSPECIFIED

homeCallRouterClassName

public abstract String homeCallRouterClassName
Names class to be used for routing home method calls.

Default:
"UNSPECIFIED"

createAsPrincipalName

public abstract String createAsPrincipalName
Names the principal to be used when ejbCreate would otherwise run with an anonymous principal.

Default:
"UNSPECIFIED"

networkAccessPoint

public abstract String networkAccessPoint
Default:
"UNSPECIFIED"

timerPersistentStore

public abstract String timerPersistentStore
Default:
"UNSPECIFIED"

remoteClientTimeout

public abstract String remoteClientTimeout
remote client timeout

Default:
"UNSPECIFIED"

Copyright 1996, 2013, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.1.2)

Part Number E27170-01