Component property
names begin with com.sybase.jaguar.component.
In EAServer Manager, configure component properties in the Component Properties
dialog box.
Specifies whether client proxies can transparently fail over to a different server.
Allowable values are true and false.
In EAServer Manager, set this property using the “Automatic failover” check box on the Transactions tab.
Chapter 7, “Load Balancing, Failover, and Component Availability”
Obsolete.
Not applicable.
While required to support automatic failover in some earlier EAServer versions, this property is no longer used.
com.sybase.jaguar.component.auto.failover
Specifies the name with which the component is bound to the name service. If not specified, the default is package/component where package is the EAServer package name, and component is the component name.
name
Where name is the name service path, relative to the server or cluster’s initial naming context.
In EAServer Manager, you can set this property in the Component Properties dialog as follows:
For EJB components, enter the value in the bean Home Name field on the General tab.
For components of other types, use the Advanced tab.
com.sybase.jaguar.server.CosNaming.initialcontext, com.sybase.jaguar.cluster.initialcontext
Specifies whether instances are bound to client’s object reference.
true or false.
The default is false.
This property cannot be enabled unless the component is stateful and thread-safe.
In EAServer Manager, set this property using the Bind Object check box on the Instances tab in the Component Properties dialog box.
com.sybase.jaguar.component.thread.safe, com.sybase.jaguar.component.stateless, com.sybase.jaguar.component.tx_vote
Specifies whether instances are bound to the thread that created them.
true or false.
The default is false.
Set this property to true if your component uses thread-local storage. This property must be enabled for ActiveX components.
In EAServer Manager, set this property using the Bind Thread check box on the Instances tab in the Component Properties dialog box.
Specifies how the custom class loader (version 2) resolves version conflicts when you specify the same class at multiple levels in the class loader hierarchy.
Same as com.sybase.jaguar.application.classloaderpolicy.
com.sybase.jaguar.server.jvm.classloader, com.sybase.jaguar.application.classloaderpolicy, com.sybase.jaguar.package.classloaderpolicy, com.sybase.jaguar.webapplication.classloaderpolicy
Chapter 30, “Configuring Custom Java Class Lists,” in the EAServer Programmer’s Guide.
Specifies the effective transaction isolation level for EJB CMP entity beans.
See “Configuring CMP isolation level” in the EAServer Performance and Tuning Guide.
com.sybase.jaguar.server.cmp_iso_level
For EJB 2.0 entity beans that use CMP (automatic persistence), specifies the CMP model version.
Allowable values are:
Value |
To indicate |
|---|---|
1.1 (the default) |
CMP according to the EJB 1.1 specification. |
2.0 |
CMP according to the EJB 2.0 specification. |
If no value is specified, the default is 1.1.
For PowerBuilder, C, or C++ components, specifies the coded character set name used to encode character and string parameter data.
codeset
Where codeset is the coded character set name. The default is the package character set specified by com.sybase.jaguar.package.code.set. For the list of the supported values, list the subdirectories of the charsets directory. Each subdirectory matches the name of a supported character set.
In EAServer Manager, set this property using the Code set field on the General tab in the Component Properties dialog box.
com.sybase.jaguar.package.code.set
Specifies the progid that the component uses in the COM Automation Server Registry.
progid
Where progid is the COM progid.
In EAServer Manager, set this property using the Prog ID field on the General tab in the Component Properties dialog box.
Specifies the name of the component’s context IDL interface: for example, CtsComponents::ObjectContext.
context
Where context is the name of the context IDL interface.
The context interface must match the context interface used in the component’s control interface. For example, if the control interface is CtsComponents::ObjectControl, specify CtsComponents::ObjectContext.
In EAServer Manager, set this property using the Advanced tab in the Component Properties dialog box.
com.sybase.jaguar.component.control
Specifies the name of the component’s control IDL interface, for example CtsComponents::ObjectControl.
control
Where control is the name of the control IDL interface.
The control interface defines methods called by EAServer in response to changes in the instance life cycle. The choices are summarized in this table:
Control interface |
Description |
|---|---|
JaguarEJB::EntityBean |
For EJB entity beans. |
JaguarEJB::StatefulSessionBean |
For EJB stateful session beans. |
JaguarEJB::StatelessSessionBean |
For EJB stateless session beans. |
JaguarEJB::ServerBean |
The EAServer 1.1 Java component life cycle model. The default for Java/CORBA components that do not have persistent state (that is, when the Persistence field is None). |
CtsComponents::ObjectControl |
A CORBA life cycle model based on the EJB entity bean model. The default for Java/CORBA and C++/CORBA components with persistent state (that is, when the Persistence field is Component Managed). |
JaguarCOM::ObjectControl |
For ActiveX components. |
These interfaces are documented in the generated IDL documentation, which is available in HTML format in the html/ir subdirectory of your EAServer installation. If you use a control interface other than JaguarEJB::ServerBean, EAServer generates the control interface methods in the implementation template when you generate a C++ or Java skeleton.
In EAServer Manager, set this property using the Advanced tab in the Component Properties dialog box. For EJB components, the control interface is set correctly when you specify the component type property in EAServer Manager, and should not be changed.
com.sybase.jaguar.component.context, com.sybase.jaguar.component.pooling, com.sybase.jaguar.component.stateless, com.sybase.jaguar.component.tx_vote
For a C++ component, specifies the implementation class name.
class
Where class is the name of the implementation class.
In EAServer Manager, set this property in the C++ Class field on the General tab in the Component Properties dialog box.
com.sybase.jaguar.component.cpp.library
For C and C++ components, specifies whether the server should copy the component library before running it.
true or false.
The default is false.
Set this property to true to allow updates to the implementation on operating systems that do not allow overwriting a DLL or shared library while the library is in use.
In EAServer Manager, set this property using the Advanced tab in the Component Properties dialog box.
com.sybase.jaguar.component.refresh
For a C++ component, specifies whether to catch exceptions.
true or false.
The default is true, which
specifies that exceptions are caught in the server.
When debugging an executing component, set this property to false to allow exceptions to reach your debugger. You must set this property to true to debug an executing C++ component in Microsoft Visual C++. Other C++ debuggers may require the same setting as well.
In a production server, set the property to true so exceptions thrown by component code do not terminate the server process.
In EAServer Manager, set this property using the Advanced tab in the Component Properties dialog box.
For C and C++ components, specifies the name of the DLL or shared library that contains the implementation class.
library
Where library is the library name, minus
platform extensions such as .dll for Windows
or .so for Solaris. You can append ${JAGUAR_PLATFORM} to
the name. ${JAGUAR_PLATFORM} indicates
that this part of the name should be replaced with the EAServer
platform identifier (specified by the JAGUAR_PLATFORM variable
set in the generated makefile). This substitution allows you to
deploy libraries for multiple platforms to support multiplatform clusters.
The library must be located in the EAServer cpplib directory to support component refresh.
In EAServer Manager, set this property in the DLL Name field on the General tab in the Component Properties dialog box.
com.sybase.jaguar.component.cpp.class
For C++ components, specifies the name of an external process to run the component. If the property is not set, the component executes within the EAServer process.
executable
Where executable is the name of the executable file, minus platform extensions (such as .exe for Windows). The executable must be located in the EAServer cpplib subdirectory.
In EAServer Manager, set this property in the C++ Executable field on the General tab in the Component Properties dialog box.
For a C component, specifies whether the implementation has a create routine.
true or false.
The default is false.
The Jaguar server calls create when creating a new instance of the component. The signature for create is:
CS_RETCODE CS_PUBLIC create()
create must return CS_SUCCEED.
In EAServer Manager, set this property using the Advanced tab in the Component Properties dialog box.
com.sybase.jaguar.component.cs.destroy
For a C component, specifies whether the implementation has a destroy routine.
true or false.
The default is false.
The Jaguar server calls destroy when destroying an instance of the component. The signature for destroy is:
CS_RETCODE CS_PUBLIC destroy()
destroy must return CS_SUCCEED.
In EAServer Manager, set this property using the Advanced tab in the Component Properties dialog box.
com.sybase.jaguar.component.cs.create
For an EJB CMP entity bean, or components of other types that use automatic persistence, specifies the database sequence name, if required by the database.
The syntax used depends on the database you are using. See “Enabling automatic key generation” in Chapter 27, “Creating Entity Components,” in the EAServer Programmer’s Guide.
Specifies whether the server logs trace information for instance life cycle events such as creation, destruction, pooling, and so forth.
true or false.
The default is false.
In EAServer Manager, set this property using the Advanced tab in the Component Properties dialog box.
com.sybase.jaguar.component.cpp.debug, com.sybase.jaguar.component.pb.debug, com.sybase.jaguar.component.trace
In an EJB CMP entity bean that uses a Sybase CMP wrapper driver, specifies which SQL commands may be deferred to the end of the transaction.
Specify “none” or a comma-separated list
of these commands: insert, delete, update.
When using a Sybase CMP wrapper JDBC driver, the default is insert,delete,update to
specify that insert, delete, and update commands are all deferred
to the end of the transaction. When not using a Sybase CMP wrapper
driver, the default is “none”.
If inserts are deferred, create methods do not throw DuplicateKeyException. Instead
the insert fails when the transaction is committed. This behavior
is allowed by the EJB 2.0 specification, but may be incompatible
with applications coded for EJB 1.1. To use the EJB 1.1 behavior,
remove insert from the list
of deferrable commands.
“Using CMP JDBC wrapper drivers” in the EAServer Performance and Tuning Guide.
Overrides the com.sybase.jaguar.server.destroyPooledInstancesOnShutdown server property.
If the server property com.sybase.jaguar.server.destroyPooledInstancesOnShutdown is true,
you can set this component property to false to
disable destruction of pooled instances of this component. The component
property is ignored if the server property is not set to true.
com.sybase.jaguar.component.destroyPooledInstancesOnShutdownTimeout, com.sybase.jaguar.server.destroyPooledInstancesOnShutdown
How long to wait for each instance destruction method to return when destroying pooled instances during server shutdown.
The time to wait, in seconds. If no value is specified, the default is the value of the server property com.sybase.jaguar.server.destroyPooledInstancesOnShutdownTimeout.
com.sybase.jaguar.component.destroyPooledInstancesOnShutdown, com.sybase.jaguar.server.destroyPooledInstancesOnShutdown, com.sybase.jaguar.server.destroyPooledInstancesOnShutdownTimeout
For EJB CMP entity beans that use instance and query caching with database change notification enabled, this property enables automatic creation of database triggers to notify the EAServer cache manager when the table data changes.
true or false.
The default is false.
In EAServer Manager, set this property using the Create Database Triggers check box on the Persistence/General tab in the Component Properties dialog box.
Chapter 27, “Creating Entity Components,” in the EAServer Programmer’s Guide.
Specifies the class name for a custom DOM XML parser factory class.
The class name. Either the class name, or, if the class is in a JAR file, the JAR file name, must be listed in the com.sybase.jaguar.component.java.classes property, and the file must be placed in either the EAServer java/classes or java/lib directory.
com.sybase.jaguar.application.SAXfactory, com.sybase.jaguar.application.XSLTfactory
For EJB components, specifies the home interface class name. Derived from com.sybase.jaguar.component.home.
class
Where class is the Java class name, for example, com.sybase.jaguar.sample.GlossaryHome.
This property is read-only. It is automatically set when you specify the component’s IDL home interface with the com.sybase.jaguar.component.home property.
In EAServer Manager, view this property in the Home Interface field on the General tab in the Component Properties window.
com.sybase.jaguar.component.home, com.sybase.jaguar.component.ejb.remote
For an EJB entity bean component, specifies the class name for the primary key type. Derived from com.sybase.jaguar.component.key.
class
Where class is the Java class name; for example, com.sybase.jaguar.sample.GlossaryKey or java.lang.String.
This property is read-only. It is automatically set when you specify the component’s IDL primary key type with the com.sybase.jaguar.component.key property.
In EAServer Manager, view this property in the Primary Key field on the General tab in the Component Properties window.
com.sybase.jaguar.component.key
For EJB 2.0 components, specifies the Java local interface name.
class
Where class is the Java class name; for example, com.sybase.jaguar.sample.LocalGlossary.
This property is read-only. It is automatically set when you specify the component’s IDL remote interface with the com.sybase.jaguar.component.local property.
In EAServer Manager, view this property in the Local Interface field on the General tab in the Component Properties window.
com.sybase.jaguar.component.local, com.sybase.jaguar.component.ejb.local.home, com.sybase.jaguar.component.ejb.remote
For EJB 2.0 components, specifies the Java local home interface name.
class
Where class is the Java class name, for example com.sybase.jaguar.sample.LocalGlossaryHome.
This property is read-only. It is automatically set when you specify the component’s IDL local home interface with the com.sybase.jaguar.component.local.home property.
In EAServer Manager, view this property in the Local Home Interface field on the General tab in the Component Properties window.
com.sybase.jaguar.component.local, com.sybase.jaguar.component.ejb.home
Specifies the remote interface class name for an EJB component. Derived from com.sybase.jaguar.component.remote.
class
Where class is the Java class name; for example com.sybase.jaguar.sample.Glossary.
This property is read-only. It is automatically set when you specify the component’s IDL remote interface with the com.sybase.jaguar.component.remote property.
In EAServer Manager, view this property in the Remote Interface field on the General tab in the Component Properties window.
com.sybase.jaguar.component.remote, com.sybase.jaguar.component.ejb.home
For EJB components, specifies a list of EJB local references that define aliased JNDI names for local components invoked by this component.
ejb-ref1, ejb-ref2, ...
Where ejb-ref1, ejb-ref2, and so forth follow the syntax of EJB local reference properties.
Use this property if aliased beans are invoked using local interfaces. If you are using remote interfaces, use the com.sybase.jaguar.component.ejb-ref property.
EJB local reference properties, com.sybase.jaguar.component.ejb-ref
For EBJ components, specifies a list of EJB references that define aliased JNDI names for components invoked by this component.
ejb-ref1, ejb-ref2, ...
Where ejb-ref1, ejb-ref2, and so forth follow the syntax of EJB reference properties.
Use this property if aliased beans are invoked using remote interfaces. If you are using local interfaces, use the com.sybase.jaguar.component.ejb-local-ref property.
For EJB components (EJB version 1.1 or later), specifies environment properties.
In EAServer Manager, configure environment properties on the Environment tab in the Component Properties dialog box.
EJB 1.0 components do not use this property. Any property whose name does not begin with com.sybase.jaguar.component is considered an environment property for an EJB 1.0 component.
For components that run in an external server, specifies how long to wait for a response from the external server before returning an error to the client.
The timeout in seconds. If not set, the default is the value of the server property com.sybase.jaguar.server.external.serverstart.timeout for the server where the component is installed. A value of 0 specifies infinity.
com.sybase.jaguar.component.external.servername, com.sybase.jaguar.server.external.request.timeout
For stateless components, specifies the server name for external component execution.
The server name. The external server must run on the same machine as the server to which your application’s clients connect.
If not set, the component executes in the same process as the server in which it is installed. This property is ignored if the component is not stateless (com.sybase.jaguar.component.stateless is false).
Running a component externally protects the server process from application problems such as memory leaks or segmentation violations. Stateless components of any type can run externally, with full access to server-side features such as cached connections. When you mark a component to run externally, EAServer runs it in a separate server process. You can identify which external server runs the component, and assign groups of related components to run in the same external server. EAServer starts the external server when required, and restarts the server if it stops responding.
com.sybase.jaguar.component.external.request.timeout, com.sybase.jaguar.component.external.serverstart.timeout, com.sybase.jaguar.component.stateless
If the component is configured to run in an external server, specifies how long to wait for a response from the external server before returning an error to the client.
The timeout in seconds. If not set, the default is the value of the server property com.sybase.jaguar.server.external.serverstart.timeout for the server where the component is installed. A value of 0 specifies infinity.
com.sybase.jaguar.component.external.servername, com.sybase.jaguar.server.external.serverstart.timeout
Specifies additional files that are included when the component is archived with the package export feature or replicated with the synchronize feature.
Same as for com.sybase.jaguar.applicationclient.files
The com.sybase.jaguar.component.files property specifies a list of files to be included when the component is exported into a package archive file or replicated to another server with the synchronize feature. By default, the following files are included when you export packages or synchronize between servers:
The IDL files that define interfaces and types used by the component.
For C or C++ components, the DLL or shared library that is specified on the General tab of the Component Properties window. If your component requires additional DLLs or shared libraries, you must specify them in the list.
For Java components the implementation class and any classes listed in the property com.sybase.jaguar.component.java.classes, plus stub classes listed in the com.sybase.jaguar.component.files.corbastubs, and com.sybase.jaguar.component.files.ejbstubs properties.
For PowerBuilder components, the libraries starting with $ (dollar sign) that are referenced by the property com.sybase.jaguar.component.pb.librarylist.
In EAServer Manager, set this property using the Additional Files tab in the Component Properties dialog box.
Java and C++ stubs are not included
by default in the component’s file set. These can be regenerated
on the target server after synchronization or installing the archive.
If you do not want to regenerate, add the stub files to the value
of the com.sybase.jaguar.component.files property.
com.sybase.jaguar.component.java.classes, com.sybase.jaguar.component.files.corbastubs, com.sybase.jaguar.component.files.ejbstubs, com.sybase.jaguar.component.pb.librarylist, com.sybase.jaguar.package.files
Specifies the files that implement the component’s Java/CORBA stubs.
Set when Java/CORBA stubs are generated. Do not modify.
com.sybase.jaguar.component.files, com.sybase.jaguar.component.files.ejbstubs, com.sybase.jaguar.package.files.corbastubs
Specifies the files that implement the component’s EJB stubs.
Set when EJB stubs are generated. Do not modify.
com.sybase.jaguar.component.files, com.sybase.jaguar.component.files.corbastubs, com.sybase.jaguar.package.files.ejbstubs
For an EJB CMP entity bean, or other types of components that use automatic persistence, specifies whether the key values the mapped database table are automatically generated.
true or false.
The default is false.
“Enabling automatic key generation” in Chapter 27, “Creating Entity Components,” in the EAServer Programmer’s Guide.
Specifies the component’s home IDL interface. EJB components must have a home interface, and other component types must have one to support access from EJB clients.
home
Where home is the IDL interface name. For example, examples::QueryHome. For an EJB component, the default is:
package::componentHome
Where package is the EAServer package name, and component is the EAServer package name. If the component does not have remote interfaces, set the property to an empty string or remove the setting.
For other component types, there is no default.
EJB components must have a home interface or a local home interface (specified by com.sybase.jaguar.component.local.home). A component of any type must have a home interface to be invoked from EJB clients or EJB components.
If an EJB component has only local interfaces, that is, no home and remote interface, when you deploy the EJB, EAServer sets the com.sybase.jaguar.component.remote property to match the local IDL interface (com.sybase.jaguar.component.local) and sets the com.sybase.jaguar.component.home property to match the local home IDL interface (com.sybase.jaguar.component.local.home).
In EAServer Manager, set this property using the File menu for the component’s Interfaces folder.
com.sybase.jaguar.component.remote, com.sybase.jaguar.component.ejb.home, com.sybase.jaguar.component.local, com.sybase.jaguar.component.local.home
Specifies repository IDs for the component’s home IDL interface. Derived from com.sybase.jaguar.component.home.
A comma-separated list of repository IDs.
This property is read-only. It is set automatically when you set the com.sybase.jaguar.component.home property. In EAServer Manager, view the property using the Advanced tab in the Component Properties dialog box.
com.sybase.jaguar.component.home
Specifies whether to use the connection user name or SSL certificate for role-based authorization.
Allowable values are:
Value |
To indicate |
|---|---|
jaguar |
Authorize based on the EAServer connection user name |
ssl |
Authorize based on the SSL certificate digital ID |
In EAServer Manager, set this property on the Advanced tab in the Component Properties dialog box.
Specifies repository IDs for the component’s IDL interfaces. Derived from com.sybase.jaguar.component.interfaces.
A comma-separated list of repository identifiers.
This property is read-only. It is set automatically when you set the com.sybase.jaguar.component.interfaces property. In EAServer Manager, view the property using the Advanced tab in the Component Properties dialog box.
com.sybase.jaguar.component.interfaces
Constrains the component to run in the specified instance pool.
The name of the instance pool. Table B-7 describes the default used when this property is not set.
Specifies the IDL interfaces that the component supports for client use.
A comma-separated list of IDL interface names. For example:
MyModule::iFace1,MyModule::iFace2
The default is:
package::component
Where package is the package name, and component is the component name.
In EAServer Manager, the component’s interfaces can be modified using the Interfaces folder displayed beneath the component icon. See Chapter 5, “Defining Component Interfaces,” in the EAServer Programmer’s Guide for more information.
com.sybase.jaguar.component.remote
For EJB 1.0 components, specifies the isolation level for transactions begun by the component’s methods.
Table B-1 lists allowable values. You can specify the isolation level for individual methods by setting the method property com.sybase.jaguar.method.iso_level.
Value |
Transaction isolation level |
|---|---|
(the default) |
If set at the component level, use the database or JDBC driver default setting. If set at the method level, use the component level setting. |
|
Read uncommitted. |
|
Read committed. |
|
Repeatable read. |
|
Serializable. |
In EAServer Manager, you can set this property using the Transaction Isolation Level field on the Transactions tab in the Component Properties dialog box.
com.sybase.jaguar.component.tx_type, com.sybase.jaguar.method.iso_level
For Java components (CORBA and EJB), specifies the name of the Java implementation class.
The Java class name. For example, com.sybase.jaguar.sample.GlossaryImpl. There is no default.
In EAServer Manager, set this property in the Java Class field on the General tab in the Component Properties dialog box.
com.sybase.jaguar.component.java.classes
For Java components (CORBA and EJB), specifies additional classes to be loaded by the component class loader.
Same as for com.sybase.jaguar.application.java.classes.
See “Custom class lists for Java and EJB components” in Chapter 30, “Configuring Custom Java Class Lists,” in the EAServer Programmer’s Guide.
In EAServer Manager, set this property using the Java Classes tab in the Component Properties dialog box.
com.sybase.jaguar.component.java.class, com.sybase.jaguar.component.refresh, com.sybase.jaguar.application.java.classes, com.sybase.jaguar.package.java.classes, com.sybase.jaguar.server.java.classes
For an entity component, specifies the IDL datatype for the primary key.
The value can be one of the following:
An IDL structure The structure should reflect the primary key for the database relation that the entity bean represents. In other words, add a field for each column in the primary key. Define the structure to match the intended Java package and class name. For example, if the Java class is to be foo.bar.PK1, define a new structure PK1 in module foo::bar. See Chapter 5, “Defining Component Interfaces,” in the EAServer Programmer’s Guide for more information.
The name of a serializable Java class Enter the name of a serializable Java class; for example, foo.bar.MyPK.
The IDL string type Use string if the key relation has only a string column. In Java, the mapped primary key is java.lang.String.
The default is an IDL structure named:
module::remoteKey
Where module is the module that contains the remote interface, and remote is the unscoped IDL name of the remote interface. For example, samples::MyBeanKey. If the structure does not exist, EAServer creates a structure with this name containing a single long field named value.
Interoperability and key types
Use an IDL structure or string if other
types of clients besides Java will use the bean.
In EAServer Manager, set this property in the Primary Key field on the Persistence tab in the Component Properties dialog box.
com.sybase.jaguar.component.ejb.key, com.sybase.jaguar.component.list
Specifies the type code string for the primary key IDL type. Derived from com.sybase.jaguar.component.key.
The type code string.
This property is read-only. It is set automatically when you set the com.sybase.jaguar.component.key property. In EAServer Manager, view the value on the Advanced tab in the Component Properties dialog box.
com.sybase.jaguar.component.key
For entity components, specifies the name of an IDL type definition (typedef) for a sequence of the component’s primary key datatype. This type is used when generating the skeleton and implementation classes for the component.
The name of an IDL typedef that specifies a sequence of primary key type. The default is an IDL typedef:
module::remoteKeys
Where module is the module that contains the remote interface, and remote is the unscoped IDL name of the remote interface. EAServer defines this typedef as:
typedef sequence < ::key > module::remoteKeys;
Where key is the value of the com.sybase.jaguar.component.key property.
If you have used PowerJ or the EAServer Manager import feature to import an entity bean, the com.sybase.jaguar.component.keys typedef may use a different naming convention.
This property is set to the default when you set the com.sybase.jaguar.component.key property, and the IDL typedef is defined if it does not exist already. Set the property manually to use a value other than the default.
In EAServer Manager, view and set this property using the Advanced tab in the Component Properties window.
com.sybase.jaguar.component.key, com.sybase.jaguar.component.ejb.key
For an EJB 1.0 entity bean, specifies the IDL datatype for a sequence of the remote interface type. In an entity bean’s IDL home interface, methods that return a collection of instances must return the type name specified by this property.
The name of an IDL typedef that specifies a sequence of the remote interface type. The default is an IDL typedef:
module::compList
Where module is the module that contains the remote interface, and comp is the unscoped IDL name of the remote interface. The default typedef is:
typedef sequence < ::remote > module::compList;
Where remote is the value of the com.sybase.jaguar.component.remote property.
In EAServer Manager, set this property on the Advanced tab in the Component Properties dialog box.
When you manually specify a value for the Primary Key field
on the Persistence tab, EAServer Manager sets this property to module::componentList where module is
the module containing the primary key type, and component is
the component name. EAServer Manager defines the type if it does
not exist, using the following structure:
typedef <sequence ri> componentList
where ri is the remote interface name, and component is the component name.
Set the com.sybase.jaguar.component.list property only when you have manually defined a sequence that uses another naming convention or that is located in another module.
If you have used PowerJ or the EAServer Manager import feature to import an entity bean, the com.sybase.jaguar.component.keys typedef may use a different naming convention.
com.sybase.jaguar.component.remote
For message-driven beans (MDBs), specifies the message listener package and component.
The package and component name for the MDB listener; for example:
MDBpackage/MDBcomponent
To specify a thread pool, append the thread pool name in square brackets, for example:
MDBpackage/MDBcomponent[MyThreadPool]
The thread pool must have one or more worker threads. A thread pool with multiple worker threads enables the message listener to process multiple messages at the same time. If you do not specify the name of a thread pool, the message listener uses the <system> default thread pool, which has a single worker thread. You can create thread pools as described in “Thread pools”.
In EAServer Manager, specify the Listener on the MDB Type tab in the Component Properties dialog box.
JMS entity properties, “Listeners”, “Thread pools”
Obsolete.
This property is obsolete.
com.sybase.jaguar.component.store
For EJB 2.0 components, specifies the name of the IDL local interface.
local
Where local is the IDL interface name. For example, examples::LocalQuery. The local interface must be one of the interfaces listed in the com.sybase.jaguar.component.interfaces property. If the component has no local interfaces, set the property to an empty string or remove the setting.
In EAServer Manager, set this property using the File menu for the Interfaces folder displayed beneath the component icon.
com.sybase.jaguar.component.local.home, com.sybase.jaguar.component.remote, com.sybase.jaguar.component.ejb.local
For EJB 2.0 components, specifies the name of the IDL local home interface.
home
Where home is the IDL interface name. For example, examples::LocalQueryHome. If the component has no local interfaces, set the property to an empty string or remove the setting.
In EAServer Manager, set this property using the File menu for the Interfaces folder displayed beneath the component icon.
com.sybase.jaguar.component.local, com.sybase.jaguar.component.home
For EJB components only. Enables the EAServer lightweight container (LWC) for calls to this component from EJBs or servlets and JSPs hosted in the same server. For more information, see “Lightweight container” in the EAServer Performance and Tuning Guide.
true or false.
A value of true enable the
LWC for this component. The default is false disables
LWC.
To enable LWC for components, the server property com.sybase.jaguar.server.lwc must be true.
com.sybase.jaguar.component.lwc.enableSkeletons, com.sybase.jaguar.server.lwc
Enables LWC calls to EJB components from servlets and JSPs hosted in the same server. Such calls are not supported unless this option is set..
true or false.
A value of true enables calls
from the Web tier. The default is false. To enable this setting
for components, the server property com.sybase.jaguar.server.lwc.enableSkeletons must be true.
Regenerate stubs and skeletons for the component after modifying this setting.
com.sybase.jaguar.component.lwc, com.sybase.jaguar.server.lwc.enableSkeletons
When instance pooling is enabled, specifies the maximum pool size.
Specify a positive integer value, or 0 to indicate the pool size has no limit. The default is 0, which means no maximum pool size is in effect.
If the maximum pool size is reached, EAServer destroys excess instances after deactivation. Set this property in EAServer Manager using the Maximum Pooled Instances field on the Resources tab in the Component Properties dialog box.
com.sybase.jaguar.component.pooling, com.sybase.jaguar.component.minpool, com.sybase.jaguar.component.objects
This setting applies only when the com.sybase.jaguar.component.objects property is set to specify a limit on the number of simultaneous active instances.
wait_time
Where wait_time is the time to wait, in seconds.
If a request arrives when the maximum number of instances exist and are all busy, the request blocks, with blocking time constrained by this property. If the blocking time expires, the caller receives a CORBA::NO_RESOURCE_EXCEPTION
In EAServer Manager, set this property using the Maximum Wait field on the Resources tab in the Component Properties dialog box.
com.sybase.jaguar.component.objects
Specifies the acknowledgment mode for MDBs that manage their own transactions.
Allowable values are:
Value |
To indicate |
|---|---|
|
AUTO_ACKNOWLEDGE mode; the session automatically acknowledges messages |
|
DUPS_OK_ACKNOWLEDGE mode; instructs a session to lazily acknowledge messages, which reduces a session’s workload but may lead to duplicate message deliveries |
In EAServer Manager, set the Acknowledge Mode on the MDB Type tab in the Component Properties dialog box.
Chapter 31, “Using the Message Service,” in the EAServer Programmer’s Guide.
Specifies whether the MDB is associated with a JMS topic or message queue.
Allowable values are:
Value |
To indicate |
|---|---|
|
Topic |
|
Message queue |
In EAServer Manager, set the Destination Type on the MDB Type tab in the Component Properties dialog box.
For an MDB associated with a message queue, specifies the message selector for a message queue. The message service uses the selector to filter the message that it delivers to the queue.
topic=’topicString’
In EAServer Manager, define the Message Selector on the MDB Type tab in the Component Properties dialog box.
When the MDB is associated with a topic, specifies whether the topic is durable or nondurable.
Allowable values are:
Value |
To indicate |
|---|---|
|
Durable topic subscriber; guarantees message delivery |
NonDurable |
Nondurable topic subscriber; can receive published messages only while it is connected to EAServer |
In EAServer Manager, set the Topic Subscription Durability on the MDB Type tab in the Component Properties dialog box.
Chapter 31, “Using the Message Service,” in the EAServer Programmer’s Guide.
Used to store the component’s nondefault method properties.
Undocumented. Use the Method entity type and the com.sybase.jaguar.method.* property names to set and retrieve method properties.
When instance pooling is enabled, specifies the minimum pool size.
Specify a 0 or a positive integer value. The default is 0.
Set this property in EAServer Manager using the Minimum Pooled Instances field on the Resources tab in the Component Properties dialog box.
com.sybase.jaguar.component.pooling, com.sybase.jaguar.component.maxpool
Specifies the component model.
Allowable values are:
Value |
To indicate |
|---|---|
|
Enterprise JavaBeans model. |
|
CORBA with control interface CtsComponents::ObjectControl |
|
ActiveX components and CORBA components that use a control interface other than CtsComponents::ObjectControl. |
(none) |
No value required for component types not mentioned above. |
EAServer Manager sets this property correctly when you change the component type. To view the property, use the Advanced tab in the Component Properties dialog box.
com.sybase.jaguar.component.control, com.sybase.jaguar.component.model.version, com.sybase.jaguar.component.type
For an EJB component, specifies the EJB specification version.
Allowable values are “1.0”, “1.1”, and “2.0”. The default is “2.0”.
In EAServer Manager, set this property using the EJB Version control on the General tab in the Component Properties dialog box.
com.sybase.jaguar.component.model, com.sybase.jaguar.component.type
Assigns this component to a thread monitor.
Specify the monitor name.
If you change this setting, you must regenerate and recompile the component skeleton for the change to take effect.
Thread monitor properties, com.sybase.jaguar.method.monitor
Specifies the maximum allowable average response time for the component. If the average method completion time rises above this limit, EAServer blocks creation of additional instances of this component until the average drops below the specified limit.
The maximum allowable average response time for the component, in seconds. The default is -1, which indicates no time limit.
com.sybase.jaguar.component.monitor.MinInstance
Chapter 9, “Using the Performance Monitor,” in the EAServer Performance and Tuning Guide.
When response time monitoring is in effect (com.sybase.jaguar.component.monitor.MaxRespTime is set to a non-negative number), specifies the minimum numer of instances that must be allowed to execute regardless of observed response times.
The minimum numer of instances. The default is -1, which means no new instances are blocked by the Performance Monitor.
com.sybase.jaguar.component.monitor.MaxRespTime
Chapter 9, “Using the Performance Monitor,” in the EAServer Performance and Tuning Guide.
Specifies the name of the component and the package in which it is installed.
package/component
Where:
package is the package in which the component is installed.
component is the name of the component.
In EAServer Manager, the component name is set when defining a new component and cannot be changed.
Specifies the name of the component that implements object caching for entity components that use automatic persistence and EJB CMP entity beans.
The component name, in the form package/component. To use the built-in implementation, enter:
CtsComponents/ObjectCache
com.sybase.jaguar.component.objectCache.sizeCheckInterval
For EJB CMP entity beans that use the object cache, specifies how often EAServer checks the size of the entry before placing it in the cache.
A positive integer. The default is 1. If you specify a size check interval N, EAServer performs the size calculation on only every Nth entry, and uses a running average size for the interim entries.
When writing to the object cache, EAServer checks the size of the entry to see if the cache size would be exceeded. If so, least recently used entries are flushed from the cache until there is room for the new entry. The time spent calculating size can adversely affect performance. However, if the size of the data varies a lot, setting a size check interval may lead to inaccurate cache size estimations, resulting in memory use beyond the configured cache size.
com.sybase.jaguar.component.objectCache
Specifies the maximum number of component instances that can exist at once. For a C++ component that runs as an external process, specifies the maximum number of simultaneously running external processes.
n
Where n is a positive integer.
This property specifies the maximum number of instances that can be created at once. If a request arrives when the maximum number of instances exist and are all busy, the request blocks, with blocking time constrained by the com.sybase.jaguar.component.maxwait property.
In EAServer Manager, set this property in the Maximum Active Instances field on the Resources tab in the Component Properties dialog box.
com.sybase.jaguar.component.cpp.process, com.sybase.jaguar.component.maxwait, com.sybase.jaguar.component.maxpool
Enables the proprietary EJB pass-by-reference in-server invocation mechanism supported by some other J2EE vendors.
true to enable pass-by-reference
semantics or false to disable.
The default is false.
When this property is set to true, EJB stubs and skeletons for the component and its home and remote interfaces use the same parameter passing mode that EAServer normally uses for EJB 2.0 local interfaces. After changing the value, you must regenerate stubs and skeletons.
This feature is not intended for new development, which should use standard EJB 2.0 local interfaces. When used, remote clients will be unable to call the component. The feature cannot be used with components that already have a local interface. If two or more components share the same home and remote interfaces, then all or none of those components must be configured for pass-by-reference.
“Optimizing in-server EJB calls” in Chapter 3, “Component Tuning,” in the EAServer Performance and Tuning Guide.
For PowerBuilder components, the name of the PowerBuilder application that contains the NVO that implements the component.
The name of the PowerBuilder application, as displayed in PowerBuilder.
com.sybase.jaguar.component.pb.class
For PowerBuilder components, specifies the name of the nonvisual object that implements the component’s methods.
The name of the PowerBuilder NVO, as displayed in PowerBuilder.
com.sybase.jaguar.component.pb.appname
For versioned PowerBuilder components, contains version cookie data.
The cookie data.
com.sybase.jaguar.component.pb.appname, com.sybase.jaguar.component.pb.class
For PowerBuilder components, specifies whether the component can be debugged while executing.
true to enable debugging,
or false to disable debugging.
The default is false.
com.sybase.jaguar.component.debug
For PowerBuilder components, specifies library files that are required to run the object.
The list of library files, separated by semicolons. Prefix library names with a dollar sign ($) if they must be included when the component is synchronized or archived. For example:
mylib.pbl;anotherlib.pbl;$utils.pbl
com.sybase.jaguar.component.files, com.sybase.jaguar.component.pb.appname, com.sybase.jaguar.component.pb.class
For PowerBuilder components, enables or disables the live editing feature.
true to enable live editing; false to
disable. The default is false.
This property should be set from the PowerBuilder user interface, as the live editing feature depends on corresponding changes to the component’s project settings. See the PowerBuilder documentation for more information.
com.sybase.jaguar.component.pb.debug
For PowerBuilder components, specifies the required version of the PowerBuilder virtual machine.
This property is set when deploying from PowerBuilder, and should not be edited in any other way. Components that lack this property setting are run in the version 7.0 VM.
com.sybase.jaguar.component.pb.appname, com.sybase.jaguar.component.pb.class
Specifies whether component instances are pooled for reuse by multiple client sessions.
true or false.
The default is true.
When this property is true, component instances are always pooled after deactivation. For components that use the JaguarEJB::ServerBean or JaguarCOM::ObjectControl control interfaces, you can also configure pooling by implementing interfaces with a canReuse (ServerBean) or canBePooled (JaguarCOM) method. If you enable the Pooling option in EAServer Manager, your component is always pooled, and these methods are not called.
In EAServer Manager, set this property with the Pooling check box on the Instances tab in the Component Properties dialog box.
com.sybase.jaguar.component.control, com.sybase.jaguar.component.maxpool, com.sybase.jaguar.component.minpool
For an entity or stateful session component, specifies how persistence is performed.
Allowable values are:
Value |
To indicate |
|---|---|
component |
The implementation manages persistence, via the ejbLoad and ejbStore methods, or ctsLoad and ctsStore. |
automatic |
The server manages persistence with code generated as part of the component skeleton, using mapping properties to map implementation fields to database table columns. |
generated |
A generated class (specified by the com.sybase.jaguar.component.ps.class property) manages persistence. The recommended setting for EJB entity beans that require container-managed persistence. |
serialize |
For Java components only. The component state is serialized and stored in binary form. |
none |
No persistence. |
In EAServer Manager, set this property using the Persistence Type control on the Persistence tab in the Component Properties dialog box.
Chapter 31, “Using the Message Service,” in the EAServer Programmer’s Guide.
For entity components, specifies the generated class to handle component persistence when com.sybase.jaguar.component.ps property is “generated.”
The Java class name.
In EAServer Manager, set this property in the Generated Class field on the Persistence tab in the Component Properties dialog box.
com.sybase.jaguar.component.ps
Minimum quality of protection required to access component.
A QOP identifier. “Securing Component Access,” in the EAServer Security Administration and Programming Guide lists allowable QOP values.
In EAServer Manager, set this property using the Advanced tab in the Component Properties dialog box.
For MDBs associated with a message queue, specifies the name of the message queue.
MyQueue
In EAServer Manager, specify the Name on the MDB Type tab in the Component Properties dialog box.
“Permanent destinations”, Chapter 31, “Using the Message Service,” in the EAServer Programmer’s Guide
For entity components, including EJB entity beans, specifies whether a component can recursively call itself, or participate in an intercomponent call sequence that creates recursion.
true or false.
The default is false.
In EAServer Manager, set this property with the Reentrant check box on the Instances tab in the Component Properties dialog box.
Specifies whether the component can be refreshed, that is, whether a new implementation can be loaded while the server is running.
true or false.
The default is true.
For Java components, disabling the refresh property causes the component and dependent classes to be loaded by the system class loader rather than being custom-loaded. For more information, see these sections in the EAServer Programmer’s Guide:For EJB components,
“Disabling refresh” in Chapter 7, “Creating Enterprise JavaBeans Components”
For CORBA Java comonents, “Disabling component refresh” in Chapter 11, “Creating CORBA Java Components”
In EAServer Manager, set this property using the Advanced tab in the Component Properties dialog box.
com.sybase.jaguar.component.cpp.copy, com.sybase.jaguar.component.java.classes, com.sybase.jaguar.package.java.classes, com.sybase.jaguar.application.java.classes, com.sybase.jaguar.server.java.classes
Specifies the name of the remote (main) IDL interface. EJB components must have a remote interface, and other component types must have one to support access from EJB clients.
remote
Where remote is the IDL interface name. For example, examples::Query. The remote interface must be one of the interfaces listed in the com.sybase.jaguar.component.interfaces property. For an EJB component, the default is set to:
package::component
Where package is the EAServer package name, and component is the EAServer package name. If the component does not have remote interfaces, set the property to an empty string or remove the setting.
For other component types, there is no default.
In EAServer Manager, set this property using the File menu for the Interfaces folder displayed beneath the component icon.
If an EJB component has only local interfaces, that is, no home and remote interface, when you deploy the EJB, EAServer sets the com.sybase.jaguar.component.remote property to match the local IDL interface (com.sybase.jaguar.component.local) and sets the com.sybase.jaguar.component.home property to match the local home IDL interface (com.sybase.jaguar.component.local.home).
com.sybase.jaguar.component.home, com.sybase.jaguar.component.ejb.remote, com.sybase.jaguar.component.local, com.sybase.jaguar.component.interfaces
Resource environment references are logical names applied to objects administered by EAServer.
See Resource environment reference properties.
In EAServer Manager, set this property using the Resource Env Refs tab in the Component Properties dialog box.
Resource environment reference properties.
For EJB components, specifies aliased JNDI names for database connections, JavaMail sessions, and URL factories used by the component.
See Resource reference properties.
In EAServer Manager, set this property using the Resource Refs tab in the Component Properties dialog box.
Resource reference properties.
For an EJB MDB component, specifies how long the server should redeliver a message after the MDB has thrown an exception while processing the message.
Specify the time period in seconds. The default is zero, which
indicates the message should not be redelivered. EAServer does not
retry unless com.sybase.jaguar.component.auto.failover is set to true.
To enable redelivery of messages after your MDB throws an
exception, you must specify a retry timeout by setting this property
and setting com.sybase.jaguar.component.auto.failover is set to true.
EAServer retries at intervals that increase by about one second
after each failure; that is, after one second, again after 3 seconds,
again after 6 seconds, and so forth.
com.sybase.jaguar.component.auto.failover
For component types other than EJB, specifies roles that a user must belong to invoke the component.
role1, role2, ...
Where role1, role2, and so forth are role names defined in the repository.
In EAServer Manager, set this property using the File menu for the Roles folder displayed below the component icon.
Roles are attached to EAServer packages, components, and methods. Attaching a role to a package controls access to all non-EJB components in the package. Attaching a role to a component constrains access to all methods in the component’s interfaces. Attaching a role to a method constrains access to that method.
For EJB components, configure access control at the method level by setting the method property com.sybase.jaguar.method.security-roles for each method.
com.sybase.jaguar.package.roles, com.sybase.jaguar.method.roles, com.sybase.jaguar.method.security-roles
For EJB 1.0 components, specifies an identity name used for intercomponent calls if the com.sybase.jaguar.component.runasmode property is “specified.”
id
Where id is the alias name for an identity. The name used must be aliased to an entity that exists in the EAServer repository by setting a com.sybase.jaguar.package.runasidentity.<id> property for the package that contains this component. For example, if the component’s run-as identity property is “ejbFoo”, create a package property with this name and value:
com.sybase.jaguar.package.runasidentity.ejbFooId=fooId
In EAServer Manager, set this property using the Run As Identity field on the Run As Mode tab in the Component Properties dialog box.
com.sybase.jaguar.component.runasmode, com.sybase.jaguar.package.runasidentity.<id>
For EJB 1.0 components, specifies the user identity that is assumed for intercomponent calls.
Allowable values are:
Value |
Description |
|---|---|
client |
Use the client’s user name and password. This is the default setting. |
system |
Use the system user name and password. The system account effectively belongs to any role, and can execute any method on any component that is installed in the same server or cluster. |
specified |
Use the user name and password associated with the identity name specified by the com.sybase.jaguar.component.runasidentity property. |
In EAServer Manager, set this property using the Run As Mode tab in the Component Properties dialog box.
com.sybase.jaguar.component.runasidentity, com.sybase.jaguar.method.runasmode
Specifies the class name for a custom SAX XML parser factory class.
The class name. Either the class name, or, if the class is in a JAR file, the JAR file name, must be listed in the com.sybase.jaguar.component.java.classes property, and the file must be placed in either the EAServer java/classes or java/lib directory.
com.sybase.jaguar.component.DOMfactory, com.sybase.jaguar.application.XSLTfactory
For EJB 2.0 components, specifies the run-as identity used for intercomponent calls. If this property is not set, intercomponent calls use the client identity.
(specified=id,role=role-name,desc=desc)
Where:
Variable |
Specifies |
|---|---|
id |
Is a logical identity name which must
be mapped to an EAServer identity by setting a corresponding package property, com.sybase.jaguar.package.runasidentity.<id> where |
role-name |
Is a logical role name which must be
mapped to an EAServer role by setting a corresponding package property, com.sybase.jaguar.package.security-role.<j2ee-role> where The mapped EAServer identity should be in the mapped EAServer role. |
desc |
Is an optional description of the run-as authorization requirement. The description can help users when the component is deployed to another server, and the deployer must choose a different identity mapping. |
com.sybase.jaguar.package.runasidentity.<id>, com.sybase.jaguar.package.security-role.<j2ee-role>, com.sybase.jaguar.application.security-role.<j2ee-role>, com.sybase.jaguar.component.runasidentity
For EJB components, maps a role reference specified in the com.sybase.jaguar.component.security-role-refs property to a J2EE role name defined in package or application properties.
com.sybase.jaguar.component.security-role-ref.role-ref=j2ee-role
Where:
j2ee-role is a J2EE role name defined for the package or application that contains the component, using the com.sybase.jaguar.application.security-roles or com.sybase.jaguar.package.security-roles property, respectively.
role-ref is a role name defined in the com.sybase.jaguar.component.security-role-refs property.
Applies to EJB (1.1 or 2.0) components only.
In EAServer Manager, set this property on the Role Refs tab in the Component Properties dialog box.
com.sybase.jaguar.application.security-roles, com.sybase.jaguar.package.security-roles
For EJB components, specifies role reference names used within isCallerInRole method invocations in the component implementation.
A comma-separated list of role reference names. For each role reference specified by this property, you must map the role reference to a J2EE role name by setting the corresponding com.sybase.jaguar.component.security-role-ref.<j2ee-role-ref> property.
Applies to EJB (1.1 or 2.0) components only. Role references are required if the component implementation calls the isCallerInRole Java method to programmatically restrict access.
In EAServer Manager, set this property on the Role Refs tab in the Component Properties dialog box.
com.sybase.jaguar.component.security-role-ref.<j2ee-role-ref>
For components that use automatic persistence, such as EJB CMP entity beans, specifies whether queries create exclusive locks on selected rows.
true or false.
The default is false.
com.sybase.jaguar.component.touchColumn, com.sybase.jaguar.component.ps, com.sybase.jaguar.component.selectWithLock, com.sybase.jaguar.component.timestamp
For components that use automatic persistence, such as EJB CMP entity beans, specifies whether queries create shared locks on selected rows.
true or false.
The default is false.
This property or the com.sybase.jaguar.component.selectForUpdate property enable pessimistic concurrency control, that is, table or row locking to avoid concurrent updates to the same row. The alternative model uses optimistic concurrency control, using value comparison to roll back updates if the selected rows have been updated by another user.
In EAServer Manager, set this property using the Select With Lock option on the Persistence/General tab in the Component Properties dialog box.
com.sybase.jaguar.component.ps, com.sybase.jaguar.component.selectForUpdate, com.sybase.jaguar.component.timestamp
Specifies whether multiple component instances can be created. A shared component serves all client requests with one instance.
true or false.
The default is false.
When this option is enabled, a single, shared instance of the component services all client requests. A shared component can store data in instance variables. However, if the com.sybase.jaguar.component.thread.safe property is true, you must synchronize access to instance variables.
Sharing setting overrides Pooling setting
If both com.sybase.jaguar.component.sharing and com.sybase.jaguar.component.pooling are
enabled (true), the sharing property takes precedence.
In EAServer Manager, set this property using the Sharing check box on the Instances tab in the Component Properties dialog box.
com.sybase.jaguar.component.pooling, com.sybase.jaguar.component.thread.safe
For EJB CMP entity beans that use an isolation level of repeatable_read_with_cache,
enables soft locking.
true or false. true enables
soft locking. The default of false disables
soft locking.
com.sybase.jaguar.component.cmp_iso_level, com.sybase.jaguar.component.softLock.timeout, “Configuring CMP isolation level” in the EAServer Performance and Tuning Guide
When soft locking is enabled, specifies the timeout period for soft-locked rows.
The timeout, in seconds.
com.sybase.jaguar.component.softLock, “Configuring CMP isolation level” in the EAServer Performance and Tuning Guide
Specifies the datatype for component state information. Applies to entity components or stateful components that use automatic storage other than EJB entity beans and stateful session beans.
The name of an IDL structure or serializable Java class that stores component state.
In EAServer Manager, set this property in the State field on the Persistence tab in the Component Properties dialog box.
com.sybase.jaguar.component.ps, Chapter 27, “Creating Entity Components,” and Chapter 28, “Configuring Persistence for Stateful Session Components,” in the EAServer Programmer’s Guide
For entity components or stateful components that use automatic persistence, specifies component methods that set and retrieve component state.
For EJB entity beans and stateful session beans, set the value
to default. For other stateful
component types, set the value to:
getMethod, setMethod
Where getMethod is the name of the method
that returns component state information, and setMethod is
the name of the method that receives component state information
and applies it to instance fields. If you specify no value, the default
is getState,setState. Your
component implementation must contain these methods, but they should
not be listed in the component’s client interfaces. The getState method
returns an instance of the type specified by the State field, and
the setState method accepts a parameter of this
type. For example, if the state type is ShoppingCartState,
the getState and setState methods might
be defined as follows in Java:
private ShoppingCartState data;
ShoppingCartState getState()
{
return data;
}
void setState(ShoppingCartState state)
{
data = state;
}
In EAServer Manager, set this property in the State Methods field on the Persistence tab in the Component Properties dialog box.
com.sybase.jaguar.component.ps, Chapter 27, “Creating Entity Components,” and Chapter 28, “Configuring Persistence for Stateful Session Components,” in the EAServer Programmer’s Guide
For EJB session beans and non-EJB components that use the control interface CtsComponents::ObjectControl, specifies whether the component is stateless, that is, whether an instance should be bound to a client session for its lifetime.
For EJB session beans, this property is set automatically when the component type is set, and must not be changed. For other component types, the option must be set manually.
true or false.
The default is false.
In EAServer Manager, set this property using the Stateless check box on the Instances tab in the Component Properties window.
com.sybase.jaguar.component.control, com.sybase.jaguar.component.tx_vote
For entity or stateful session components that use automatic persistence or failover support, specifies the storage component.
For a stateful session component that uses in-memory state replication, specify:
CtsComponents/HeapStorage
For an entity component or stateful session component that uses persistent (remote database) storage, specify:
storage(cache=cacheName,table=tableName)
For an EJB stateful session between configured for passivation, specify:
storage(cache=cacheName,table=tableName,transient)
Where:
storage is the name of the storage component.
cacheName is the name of the
connection cache to use. The default for new components is JavaCache.
For components that are imported from an EJB-JAR file, the default
is the value of the server property com.sybase.jaguar.server.defaultStorageCache.
tableName is the name of the database table to store component state. If using mapped fields, prefix the table name with “map:”, as in “map:mytable.”
In EAServer Manager, set this property in the Storage Component field on the Persistence tab in the Component Properties dialog box.
com.sybase.jaguar.component.ps, com.sybase.jaguar.component.timestamp, Chapter 27, “Creating Entity Components,” and Chapter 28, “Configuring Persistence for Stateful Session Components,” in the EAServer Programmer’s Guide
Tells the server when to call ejbStore.
store
Where store can be one of, or a comma-separated list of more than one of, these values:
Value |
Description |
|---|---|
|
The server calls ejbStore after it calls ejbPostCreate. |
|
The server calls ejbStore after
it calls each business method. |
|
The server calls ejbStore at the end of a transaction. This option may provide the best performance, but you may get the wrong result in some cases; for example, if two entity beans in one transaction are updating the same table, or if updates from session and entity beans are mixed in one transaction.
|
afterInvoke and beforeCompletion cannot
be used together. The default value is afterCreate,afterInvoke.
The default value of afterCreate,afterInvoke is
required for EJB 2.0 compliance and is safe for all compliant entity
bean implementations
If you insert values in the ejbCreate method,
and do not modify any field values in the ejbPostCreate method,
you can safely remove afterCreate from
the setting. Doing so improves performance by eliminating redundant
updates to the database.
You can use the beforeCompletion setting
rather than afterInvoke if
all updates to one table come from one entity bean, and you do not mind
if finder methods return stale values because updates are deferred
during a transaction. While this setting yields the best performance,
you may get the wrong result with architectures where more than
one component can update a table, for example, if two entity beans
in one transaction update the same table, or if updates from session
and entity beans are mixed in one transaction.
Specifies whether the component is included in the files replicated by a synchronization operation.
true or false.
The default is true.
This property is used to prevent unnecessary replication of built-in EAServer components. You can set it on your own components; however, there is no good reason not to synchronize application components.
Chapter 6, “Clusters and Synchronization”
Specifies whether multiple component instances can execute concurrently, or whether a shared component can execute simultaneously on multiple threads. If this option is disabled, the server serializes all invocations of component methods.
true or false.
The default is true.
Enable this option if the component is thread safe.
If the com.sybase.jaguar.component.sharing and com.sybase.jaguar.component.bind.thread properties are both true, the com.sybase.jaguar.component.thread.safe property is implicitly set to false.
In EAServer Manager, set this property using the Concurrency check box on the Instances tab in the Component Properties dialog box.
com.sybase.jaguar.component.bind.thread, com.sybase.jaguar.component.sharing
Specifies how long, in seconds, an active component instance can remain idle between method calls before the client’s proxy becomes invalid.
time
Where time is the timeout period in seconds. A value of “0” indicates an infinite timeout. The default is specified by the com.sybase.jaguar.server.timeout server property.
If the timeout expires, the instance is automatically deactivated. Instance Timeout is useful for ensuring timely deactivation of stateful components. The setting has no effect for stateless components.
When the timeout period is exceeded, EAServer deactivates the component and invalidates the client’s object reference. If the client attempts another method invocation, the client-side ORB throws the CORBA::OBJECT_NOT_EXIST exception. At this point, the client must create a new proxy instance for the component.
When specifying timeouts, a resolution of 5 seconds is recommended.
Network transport time is not included in the measured timeout period. You may need to configure a larger timeout period if clients connect over slow networks.
In EAServer Manager, set this property using the Instance Timeout field on the Resources tab in the Component Properties dialog box.
com.sybase.jaguar.server.timeout
For entity components that use automatic persistence with mapped table fields, specifies how the server uses optimistic concurrency control to prevent overlapping updates to the same column.
See “Configuring concurrency control” in Chapter 27, “Creating Entity Components,” in the EAServer Programmer’s Guide.
In EAServer Manager, set this property using the Timestamp field on the Persistence tab in the Component Properties dialog box.
com.sybase.jaguar.component.ps, com.sybase.jaguar.component.selectWithLock com.sybase.jaguar.component.ts.length, com.sybase.jaguar.component.tx_retry
For EJB CMP entity beans, specifies that transaction local cache entries for this component should be sorted before ejbStore is called.
true or false.
The default of false indicates
no sorting.
Setting this property to true helps to avoid deadlock when separate transactions concurrently update multiple instances of the same component.
You cannot enable sorting unless the primary key class implements the java.lang.Comparable interface. Most java.lang utility classes implement this interface, such as String, Integer and so forth.
“Configuring transaction local cache settings” in Chapter 4, “EJB CMP Tuning,” in the EAServer Performance and Tuning Guide.
For MDBs associated with a message topic, specifies the name of the topic.
MyTopic
In EAServer Manager, specify the Name on the MDB Type tab in the Component Properties dialog box.
“Permanent destinations”, Chapter 31, “Using the Message Service,” in the EAServer Programmer’s Guide
Used when the com.sybase.jaguar.component.selectForUpdate property is true. For databases such as Sybase Adaptive Server Enterprise that do not support select for update locking syntax, EAServer locks rows by issuing a no-change update statement. This property specifies which column to update.
Specify the column name. If you do not specify a column, the first non-key column is updated. For best performance, specify the column with the datatype that can be updated most quickly. For example, int columns can be updated more quickly than varchar columns.
com.sybase.jaguar.component.selectForUpdate
Enables additional debug tracing for the component, such as logging method names, client IP addresses, and user names for each invocation of a business method.
true or false.
The default is false.
In EAServer Manager, set this property using the Advanced tab in the Component Properties dialog box.
com.sybase.jaguar.component.debug
Applies to stateful components only. Specifies whether instances can be run on multiple servers in a cluster or survive a server restart.
true or false.
The default is true.
If this option is enabled, the server guarantees that proxy references can only be used within the same server process. For EJB stateful session beans, this property must be enabled for the standard EJB passivation and activation to occur. It must be disabled if you want to configure a stateful session bean to support failover.
In EAServer Manager, set this property using the Transient check box on the Instances tab in the Component Properties dialog box.
com.sybase.jaguar.component.ps
When com.sybase.jaguar.component.timestamp specifies a column name, this property specifies the datatype and length.
No value indicates the default, 4-byte integer. Specify binary(16) to
use globally unique 16-byte ID timestamps.
In EAServer Manager, set this property using the Advanced tab in the Component Properties dialog box.
com.sybase.jaguar.component.ps, com.sybase.jaguar.component.timestamp, Chapter 27, “Creating Entity Components,” in the EAServer Programmer’s Guide.
For EJB CMP entity beans that use a table-level timestamp, specifies whether EAServer must create triggers to update the timestamp when a row in the mapped table is inserted, modified, or deleted.
true or false.
The default is false.
com.sybase.jaguar.component.timestamp, Chapter 27, “Creating Entity Components,” in the EAServer Programmer’s Guide.
Specifies whether control interface methods execute in the context of a server-managed transaction.
true or false.
The default is true for EJB
entity beans, and false for
other component types.
In EAServer Manager, set this property using the Advanced tab in the Component Properties dialog box.
com.sybase.jaguar.component.control
Determines whether a CORBA::TRANSACTION_ROLLEDBACK exception is thrown to the client when a transaction is rolled back.
The allowable settings are:
Setting |
Description |
|---|---|
always |
The default. EAServer sends a CORBA::TRANSACTION_ROLLEDBACK exception to the client when a transaction is rolled back. |
failed |
EAServer does not send the CORBA::TRANSACTION_ROLLEDBACK exception to the client when a transaction is rolled back. If you use this setting, you can code your components to raise a different exception with a descriptive message after calling the RollbackWork transaction primitive. With this setting in effect, EAServer may still throw a CORBA system exception if unable to commit a transaction at your component’s request. |
Set this property to failed if
you require that no exceptions are sent to the client for rolled-back
transactions or that an alternate exception is sent. This setting
is useful if you require that the client be able to retrieve output parameters
after a transaction is rolled back: if an exception is thrown, the output
parameters are not available.
In EAServer Manager, set this property using the Advanced tab in the Component Properties dialog box.
For EJB CMP entity beans, determines whether EAServer automatically replays transactions that fail.
true or false.
The default is the value of the server property com.sybase.jaguar.server.tx_retry,
or false if the server property is not set.
This setting applies only to EJB CMP entity beans that use optimistic concurrency control.
EAServer can automatically retry transactions that are rolled back—method calls back to the last transaction boundary are replayed by the server component dispatcher. This feature is useful for For EJB CMP entity beans and entity components that use automatic persistence and optimistic concurrency control. When transaction retry is enabled, transactions that fail due to conflicting updates are automatically retried (replayed).
Auto-retry must be configured for the component that initiates a transaction, which is typically a session bean in EJB applications. Auto-retry works only for intercomponent calls, not for direct invocations of entity beans from the Web tier or base clients.
If retry is enabled, OCC failures throw a CORBA TRANSIENT exception rather than TRANSACTION_ROLLEDBACK. The stub code retries transactions that fail with a CORBA::TRANSIENT exception, up to 10 times.
Auto-retry is not appropriate for all applications. For example, an end user may want to cancel a purchase if the item price has risen. If auto-retry is disabled, clients must be coded to retry or abort transactions that fail because of stale data. The exception thrown is CORBA::TRANSIENT (for EJB clients, this exception is the root cause of the java.rmi.RemoteException thrown by the EJB stub).
com.sybase.jaguar.server.tx_retry, “Concurrency control options” in Chapter 4, “EJB CMP Tuning,” in the EAServer Performance and Tuning Guide.
Specifies the maximum duration of an EAServer transaction begun by the component.
The timeout period, in seconds, with 0 indicating no timeout. EAServer determines the transaction timeout period as follows:
If the component Transaction Timeout property is set to a nonzero value, this is the timeout period.
Otherwise, the server transaction timeout property com.sybase.jaguar.server.tx_timeout is checked. If the server transaction timeout is nonzero, this specifies the timeout period.
Otherwise, the component Instance Timeout propety com.sybase.jaguar.component.timeout is checked. If this value is nonzero, it specifies the transaction timeout period as well as the instance timeout period.
Otherwise, the transaction timeout is infinite.
When specifying timeouts, Sybase recommends a resolution of 5 seconds. EAServer checks for timeouts after each method returns. Your component will not be deactivated in the middle of an invocation because of a timeout. When a transaction times out, the next method invocation in the client-side ORB throws the CORBA::TRANSACTION_ROLLEDBACK system exception.
In EAServer Manager, set this property in the Transaction Timeout field on the Resources tab in the Component Properties dialog box.
com.sybase.jaguar.component.timeout, com.sybase.jaguar.server.tx_timeout
Specifies how methods in your component participate in transactions.
Table B-2 lists allowable values:
The transaction attribute determines how methods in your component participate in transactions; at the component level, the setting affects all methods. You can also set a transaction attribute for methods within a component using the com.sybase.jaguar.method.tx_type method property. Values set at the method level override the component setting.
com.sybase.jaguar.method.tx_type
Specifies whether the component is automatically deactivated after each method invocation, or deactivated at explicit transaction boundaries. For component types to which it applies, setting this property to true effectively marks the component as stateless.
Applies only to components that use a control interface in which the instance activation and deactivation correspond to transaction boundaries. In other words, the option does not apply to EJB components or any component that uses the control interface CtsComponents::ObjectControl.
Allowable values are true and false.
The default for new components is true.
In EAServer Manager, set this property with the Automatic Demarcation / Deactivation check box on the Transactions tab in the Component Properties window.
For EJB session bean components and components that use the CtsComponents::ObjectControl control interface, the com.sybase.jaguar.component.stateless property provides similar behavior.
com.sybase.jaguar.component.control, com.sybase.jaguar.component.stateless
Specifies the component type.
type
Where type is one of:
Type value |
To indicate |
|---|---|
com |
ActiveX/COM |
cpp |
C++, using CORBA C++ language bindings |
cs |
C (using Open Client/Server CS datatypes) |
ejb |
An Enterprise Java bean (EJB) component, conforming to the EJB version indicated by the com.sybase.jaguar.component.model.version property |
java |
A CORBA/Java component, using CORBA Java language bindings |
jdbc |
A Java component using JDBC datatypes for parameters and return values |
pb |
A PowerBuilder component |
library |
A component run by the specified dispatcher library |
In EAServer Manager, set this property using the Component Type field on the General tab in the Component Properties dialog box.
Specifies the class name for a custom XSLT XML parser factory class.
The class name. Either the class name, or, if the class is in a JAR file, the JAR file name, must be listed in the com.sybase.jaguar.component.java.classes property, and the file must be placed in either the EAServer java/classes or java/lib directory.
com.sybase.jaguar.component.DOMfactory, com.sybase.jaguar.component.SAXfactory
Specifies a text description of the component.
desc
Where desc is the descriptive text.
In EAServer Manager, set this property using the Description field on the General tab of the Component Properties dialog box.
