Cluster properties  Connection cache properties

Appendix B: Repository Properties Reference

Component properties

Description

Component property names begin with com.sybase.jaguar.component. In EAServer Manager, configure component properties in the Component Properties dialog box.




com.sybase.jaguar.component.auto.failover

Description

Specifies whether client proxies can transparently fail over to a different server.

Syntax

Allowable values are true and false.

Usage

In EAServer Manager, set this property using the “Automatic failover” check box on the Transactions tab.

See also

Chapter 7, “Load Balancing, Failover, and Component Availability”




com.sybase.jaguar.component.auto.profiles

Description

Obsolete.

Syntax

Not applicable.

Usage

While required to support automatic failover in some earlier EAServer versions, this property is no longer used.

See also

com.sybase.jaguar.component.auto.failover




com.sybase.jaguar.component.bind.naming

Description

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.

Syntax

name

Where name is the name service path, relative to the server or cluster’s initial naming context.

Usage

In EAServer Manager, you can set this property in the Component Properties dialog as follows:

See also

com.sybase.jaguar.server.CosNaming.initialcontext, com.sybase.jaguar.cluster.initialcontext




com.sybase.jaguar.component.bind.object

Description

Specifies whether instances are bound to client’s object reference.

Syntax

true or false. The default is false.

Usage

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.

See also

com.sybase.jaguar.component.thread.safe, com.sybase.jaguar.component.stateless, com.sybase.jaguar.component.tx_vote




com.sybase.jaguar.component.bind.thread

Description

Specifies whether instances are bound to the thread that created them.

Syntax

true or false. The default is false.

Usage

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.




com.sybase.jaguar.component.classloaderpolicy

Description

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.

Syntax

Same as com.sybase.jaguar.application.classloaderpolicy.

See also

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.




com.sybase.jaguar.component.cmp_iso_level

Description

Specifies the effective transaction isolation level for EJB CMP entity beans.

Syntax

See “Configuring CMP isolation level” in the EAServer Performance and Tuning Guide.

See also

com.sybase.jaguar.server.cmp_iso_level




com.sybase.jaguar.component.cmp.version

Description

For EJB 2.0 entity beans that use CMP (automatic persistence), specifies the CMP model version.

Syntax

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.




com.sybase.jaguar.component.code.set

Description

For PowerBuilder, C, or C++ components, specifies the coded character set name used to encode character and string parameter data.

Syntax

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.

Usage

In EAServer Manager, set this property using the Code set field on the General tab in the Component Properties dialog box.

See also

com.sybase.jaguar.package.code.set




com.sybase.jaguar.component.com.progid

Description

Specifies the progid that the component uses in the COM Automation Server Registry.

Syntax

progid

Where progid is the COM progid.

Usage

In EAServer Manager, set this property using the Prog ID field on the General tab in the Component Properties dialog box.




com.sybase.jaguar.component.context

Description

Specifies the name of the component’s context IDL interface: for example, CtsComponents::ObjectContext.

Syntax

context

Where context is the name of the context IDL interface.

Usage

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.

See also

com.sybase.jaguar.component.control




com.sybase.jaguar.component.control

Description

Specifies the name of the component’s control IDL interface, for example CtsComponents::ObjectControl.

Syntax

control

Where control is the name of the control IDL interface.

Usage

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.

See also

com.sybase.jaguar.component.context, com.sybase.jaguar.component.pooling, com.sybase.jaguar.component.stateless, com.sybase.jaguar.component.tx_vote




com.sybase.jaguar.component.cpp.class

Description

For a C++ component, specifies the implementation class name.

Syntax

class

Where class is the name of the implementation class.

Usage

In EAServer Manager, set this property in the C++ Class field on the General tab in the Component Properties dialog box.

See also

com.sybase.jaguar.component.cpp.library




com.sybase.jaguar.component.cpp.copy

Description

For C and C++ components, specifies whether the server should copy the component library before running it.

Syntax

true or false. The default is false.

Usage

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.

See also

com.sybase.jaguar.component.refresh




com.sybase.jaguar.component.cpp.debug

Description

For a C++ component, specifies whether to catch exceptions.

Syntax

true or false. The default is true, which specifies that exceptions are caught in the server.

Usage

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.




com.sybase.jaguar.component.cpp.library

Description

For C and C++ components, specifies the name of the DLL or shared library that contains the implementation class.

Syntax

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.

Usage

In EAServer Manager, set this property in the DLL Name field on the General tab in the Component Properties dialog box.

See also

com.sybase.jaguar.component.cpp.class




com.sybase.jaguar.component.cpp.process

Description

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.

Syntax

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.




com.sybase.jaguar.component.cs.create

Description

For a C component, specifies whether the implementation has a create routine.

Syntax

true or false. The default is false.

Usage

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.

See also

com.sybase.jaguar.component.cs.destroy




com.sybase.jaguar.component.cs.destroy

Description

For a C component, specifies whether the implementation has a destroy routine.

Syntax

true or false. The default is false.

Usage

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.

See also

com.sybase.jaguar.component.cs.create




com.sybase.jaguar.component.db.sequence

Description

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.

Syntax

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.




com.sybase.jaguar.component.debug

Description

Specifies whether the server logs trace information for instance life cycle events such as creation, destruction, pooling, and so forth.

Syntax

true or false. The default is false.

In EAServer Manager, set this property using the Advanced tab in the Component Properties dialog box.

See also

com.sybase.jaguar.component.cpp.debug, com.sybase.jaguar.component.pb.debug, com.sybase.jaguar.component.trace




com.sybase.jaguar.component.defer

Description

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.

Syntax

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”.

Usage

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.

See also

“Using CMP JDBC wrapper drivers” in the EAServer Performance and Tuning Guide.




com.sybase.jaguar.component.destroyPooledInstancesOnShutdown

Description

Overrides the com.sybase.jaguar.server.destroyPooledInstancesOnShutdown server property.

Syntax

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.

See also

com.sybase.jaguar.component.destroyPooledInstancesOnShutdownTimeout, com.sybase.jaguar.server.destroyPooledInstancesOnShutdown




com.sybase.jaguar.component.destroyPooledInstancesOnShutdownTimeout

Description

How long to wait for each instance destruction method to return when destroying pooled instances during server shutdown.

Syntax

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.

See also

com.sybase.jaguar.component.destroyPooledInstancesOnShutdown, com.sybase.jaguar.server.destroyPooledInstancesOnShutdown, com.sybase.jaguar.server.destroyPooledInstancesOnShutdownTimeout




com.sybase.jaguar.component.dn.triggers

Description

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.

Syntax

true or false. The default is false.

Usage

In EAServer Manager, set this property using the Create Database Triggers check box on the Persistence/General tab in the Component Properties dialog box.

See also

Chapter 27, “Creating Entity Components,” in the EAServer Programmer’s Guide.




com.sybase.jaguar.component.DOMfactory

Description

Specifies the class name for a custom DOM XML parser factory class.

Syntax

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.

See also

com.sybase.jaguar.application.SAXfactory, com.sybase.jaguar.application.XSLTfactory




com.sybase.jaguar.component.ejb.home

Description

For EJB components, specifies the home interface class name. Derived from com.sybase.jaguar.component.home.

Syntax

class

Where class is the Java class name, for example, com.sybase.jaguar.sample.GlossaryHome.

Usage

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.

See also

com.sybase.jaguar.component.home, com.sybase.jaguar.component.ejb.remote




com.sybase.jaguar.component.ejb.key

Description

For an EJB entity bean component, specifies the class name for the primary key type. Derived from com.sybase.jaguar.component.key.

Syntax

class

Where class is the Java class name; for example, com.sybase.jaguar.sample.GlossaryKey or java.lang.String.

Usage

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.

See also

com.sybase.jaguar.component.key




com.sybase.jaguar.component.ejb.local

Description

For EJB 2.0 components, specifies the Java local interface name.

Syntax

class

Where class is the Java class name; for example, com.sybase.jaguar.sample.LocalGlossary.

Usage

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.

See also

com.sybase.jaguar.component.local, com.sybase.jaguar.component.ejb.local.home, com.sybase.jaguar.component.ejb.remote




com.sybase.jaguar.component.ejb.local.home

Description

For EJB 2.0 components, specifies the Java local home interface name.

Syntax

class

Where class is the Java class name, for example com.sybase.jaguar.sample.LocalGlossaryHome.

Usage

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.

See also

com.sybase.jaguar.component.local, com.sybase.jaguar.component.ejb.home




com.sybase.jaguar.component.ejb.remote

Description

Specifies the remote interface class name for an EJB component. Derived from com.sybase.jaguar.component.remote.

Syntax

class

Where class is the Java class name; for example com.sybase.jaguar.sample.Glossary.

Usage

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.

See also

com.sybase.jaguar.component.remote, com.sybase.jaguar.component.ejb.home




com.sybase.jaguar.component.ejb-local-ref

Description

For EJB components, specifies a list of EJB local references that define aliased JNDI names for local components invoked by this component.

Syntax

ejb-ref1, ejb-ref2, ...

Where ejb-ref1, ejb-ref2, and so forth follow the syntax of EJB local reference properties.

Usage

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.

See also

EJB local reference properties, com.sybase.jaguar.component.ejb-ref




com.sybase.jaguar.component.ejb-ref

Description

For EBJ components, specifies a list of EJB references that define aliased JNDI names for components invoked by this component.

Syntax

ejb-ref1, ejb-ref2, ...

Where ejb-ref1, ejb-ref2, and so forth follow the syntax of EJB reference properties.

Usage

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.

See also

EJB reference properties




com.sybase.jaguar.component.env-entry

Description

For EJB components (EJB version 1.1 or later), specifies environment properties.

Syntax

See Environment properties.

Usage

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.




com.sybase.jaguar.component.external.request.timeout

Description

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.

Syntax

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.

See also

com.sybase.jaguar.component.external.servername, com.sybase.jaguar.server.external.request.timeout




com.sybase.jaguar.component.external.servername

Description

For stateless components, specifies the server name for external component execution.

Syntax

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).

Usage

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.

See also

com.sybase.jaguar.component.external.request.timeout, com.sybase.jaguar.component.external.serverstart.timeout, com.sybase.jaguar.component.stateless




com.sybase.jaguar.component.external.serverstart.timeout

Description

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.

Syntax

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.

See also

com.sybase.jaguar.component.external.servername, com.sybase.jaguar.server.external.serverstart.timeout




com.sybase.jaguar.component.files

Description

Specifies additional files that are included when the component is archived with the package export feature or replicated with the synchronize feature.

Syntax

Same as for com.sybase.jaguar.applicationclient.files

Usage

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:

In EAServer Manager, set this property using the Additional Files tab in the Component Properties dialog box.

NoteJava 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.

See also

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




com.sybase.jaguar.component.files.corbastubs

Description

Specifies the files that implement the component’s Java/CORBA stubs.

Syntax

Set when Java/CORBA stubs are generated. Do not modify.

See also

com.sybase.jaguar.component.files, com.sybase.jaguar.component.files.ejbstubs, com.sybase.jaguar.package.files.corbastubs




com.sybase.jaguar.component.files.ejbstubs

Description

Specifies the files that implement the component’s EJB stubs.

Syntax

Set when EJB stubs are generated. Do not modify.

See also

com.sybase.jaguar.component.files, com.sybase.jaguar.component.files.corbastubs, com.sybase.jaguar.package.files.ejbstubs




com.sybase.jaguar.component.generateKey

Description

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.

Syntax

true or false. The default is false.

See also

“Enabling automatic key generation” in Chapter 27, “Creating Entity Components,” in the EAServer Programmer’s Guide.




com.sybase.jaguar.component.home

Description

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.

Syntax

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.

Usage

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.

See also

com.sybase.jaguar.component.remote, com.sybase.jaguar.component.ejb.home, com.sybase.jaguar.component.local, com.sybase.jaguar.component.local.home




com.sybase.jaguar.component.home.ids

Description

Specifies repository IDs for the component’s home IDL interface. Derived from com.sybase.jaguar.component.home.

Syntax

A comma-separated list of repository IDs.

Usage

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.

See also

com.sybase.jaguar.component.home




com.sybase.jaguar.component.identitytype

Description

Specifies whether to use the connection user name or SSL certificate for role-based authorization.

Syntax

Allowable values are:

Value

To indicate

jaguar

Authorize based on the EAServer connection user name

ssl

Authorize based on the SSL certificate digital ID

Usage

In EAServer Manager, set this property on the Advanced tab in the Component Properties dialog box.




com.sybase.jaguar.component.ids

Description

Specifies repository IDs for the component’s IDL interfaces. Derived from com.sybase.jaguar.component.interfaces.

Syntax

A comma-separated list of repository identifiers.

Usage

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.

See also

com.sybase.jaguar.component.interfaces




com.sybase.jaguar.component.instancePool

Description

Constrains the component to run in the specified instance pool.

Syntax

The name of the instance pool. Table B-7 describes the default used when this property is not set.

See also

Instance pool properties




com.sybase.jaguar.component.interfaces

Description

Specifies the IDL interfaces that the component supports for client use.

Syntax

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.

Usage

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.

See also

com.sybase.jaguar.component.remote




com.sybase.jaguar.component.iso_level

Description

For EJB 1.0 components, specifies the isolation level for transactions begun by the component’s methods.

Syntax

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.

Table B-1: Transaction isolation level property values

Value

Transaction isolation level

undefined

(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 uncommitted.

read_committed

Read committed.

repeatable_read

Repeatable read.

serializable

Serializable.

Usage

In EAServer Manager, you can set this property using the Transaction Isolation Level field on the Transactions tab in the Component Properties dialog box.

See also

com.sybase.jaguar.component.tx_type, com.sybase.jaguar.method.iso_level




com.sybase.jaguar.component.java.class

Description

For Java components (CORBA and EJB), specifies the name of the Java implementation class.

Syntax

The Java class name. For example, com.sybase.jaguar.sample.GlossaryImpl. There is no default.

Usage

In EAServer Manager, set this property in the Java Class field on the General tab in the Component Properties dialog box.

See also

com.sybase.jaguar.component.java.classes




com.sybase.jaguar.component.java.classes

Description

For Java components (CORBA and EJB), specifies additional classes to be loaded by the component class loader.

Syntax

Same as for com.sybase.jaguar.application.java.classes.

Usage

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.

See also

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




com.sybase.jaguar.component.key

Description

For an entity component, specifies the IDL datatype for the primary key.

Syntax

The value can be one of the following:

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.

NoteInteroperability and key types Use an IDL structure or string if other types of clients besides Java will use the bean.

Usage

In EAServer Manager, set this property in the Primary Key field on the Persistence tab in the Component Properties dialog box.

See also

com.sybase.jaguar.component.ejb.key, com.sybase.jaguar.component.list




com.sybase.jaguar.component.key.tc

Description

Specifies the type code string for the primary key IDL type. Derived from com.sybase.jaguar.component.key.

Syntax

The type code string.

Usage

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.

See also

com.sybase.jaguar.component.key




com.sybase.jaguar.component.keys

Description

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.

Syntax

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.

Usage

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.

See also

com.sybase.jaguar.component.key, com.sybase.jaguar.component.ejb.key




com.sybase.jaguar.component.list

Description

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.

Syntax

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.

Usage

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.

See also

com.sybase.jaguar.component.remote




com.sybase.jaguar.component.listener

Description

For message-driven beans (MDBs), specifies the message listener package and component.

Syntax

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”.

Usage

In EAServer Manager, specify the Listener on the MDB Type tab in the Component Properties dialog box.

See also

JMS entity properties, “Listeners”, “Thread pools”




com.sybase.jaguar.component.load

Description

Obsolete.

Syntax

This property is obsolete.

See also

com.sybase.jaguar.component.store




com.sybase.jaguar.component.local

Description

For EJB 2.0 components, specifies the name of the IDL local interface.

Syntax

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.

Usage

In EAServer Manager, set this property using the File menu for the Interfaces folder displayed beneath the component icon.

See also

com.sybase.jaguar.component.local.home, com.sybase.jaguar.component.remote, com.sybase.jaguar.component.ejb.local




com.sybase.jaguar.component.local.home

Description

For EJB 2.0 components, specifies the name of the IDL local home interface.

Syntax

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.

Usage

In EAServer Manager, set this property using the File menu for the Interfaces folder displayed beneath the component icon.

See also

com.sybase.jaguar.component.local, com.sybase.jaguar.component.home




com.sybase.jaguar.component.lwc

Description

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.

Syntax

true or false. A value of true enable the LWC for this component. The default is false disables LWC.

Usage

To enable LWC for components, the server property com.sybase.jaguar.server.lwc must be true.

See also

com.sybase.jaguar.component.lwc.enableSkeletons, com.sybase.jaguar.server.lwc




com.sybase.jaguar.component.lwc.enableSkeletons

Description

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..

Syntax

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.

See also

com.sybase.jaguar.component.lwc, com.sybase.jaguar.server.lwc.enableSkeletons




com.sybase.jaguar.component.maxpool

Description

When instance pooling is enabled, specifies the maximum pool size.

Syntax

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.

Usage

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.

See also

com.sybase.jaguar.component.pooling, com.sybase.jaguar.component.minpool, com.sybase.jaguar.component.objects




com.sybase.jaguar.component.maxwait

Description

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.

Syntax

wait_time

Where wait_time is the time to wait, in seconds.

Usage

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.

See also

com.sybase.jaguar.component.objects




com.sybase.jaguar.component.mdb.acknowledge-mode

Description

Specifies the acknowledgment mode for MDBs that manage their own transactions.

Syntax

Allowable values are:

Value

To indicate

Auto-acknowledge

AUTO_ACKNOWLEDGE mode; the session automatically acknowledges messages

Dups-ok-acknowledge

DUPS_OK_ACKNOWLEDGE mode; instructs a session to lazily acknowledge messages, which reduces a session’s workload but may lead to duplicate message deliveries

Usage

In EAServer Manager, set the Acknowledge Mode on the MDB Type tab in the Component Properties dialog box.

See also

Chapter 31, “Using the Message Service,” in the EAServer Programmer’s Guide.




com.sybase.jaguar.component.mdb.destination-type

Description

Specifies whether the MDB is associated with a JMS topic or message queue.

Syntax

Allowable values are:

Value

To indicate

javax.jms.Topic

Topic

javax.jms.Queue

Message queue

Usage

In EAServer Manager, set the Destination Type on the MDB Type tab in the Component Properties dialog box.




com.sybase.jaguar.component.mdb.message-selector

Description

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.

Syntax

topic=’topicString

Usage

In EAServer Manager, define the Message Selector on the MDB Type tab in the Component Properties dialog box.

See also

“Message selectors”.




com.sybase.jaguar.component.mdb.subscription-durability

Description

When the MDB is associated with a topic, specifies whether the topic is durable or nondurable.

Syntax

Allowable values are:

Value

To indicate

Durable

Durable topic subscriber; guarantees message delivery

NonDurable

Nondurable topic subscriber; can receive published messages only while it is connected to EAServer

Usage

In EAServer Manager, set the Topic Subscription Durability on the MDB Type tab in the Component Properties dialog box.

See also

Chapter 31, “Using the Message Service,” in the EAServer Programmer’s Guide.




com.sybase.jaguar.component.methods

Description

Used to store the component’s nondefault method properties.

Syntax

Undocumented. Use the Method entity type and the com.sybase.jaguar.method.* property names to set and retrieve method properties.

See also

Method properties




com.sybase.jaguar.component.minpool

Description

When instance pooling is enabled, specifies the minimum pool size.

Syntax

Specify a 0 or a positive integer value. The default is 0.

Usage

Set this property in EAServer Manager using the Minimum Pooled Instances field on the Resources tab in the Component Properties dialog box.

See also

com.sybase.jaguar.component.pooling, com.sybase.jaguar.component.maxpool




com.sybase.jaguar.component.model

Description

Specifies the component model.

Syntax

Allowable values are:

Value

To indicate

ejb

Enterprise JavaBeans model.

cts

CORBA with control interface CtsComponents::ObjectControl

mts

ActiveX components and CORBA components that use a control interface other than CtsComponents::ObjectControl.

(none)

No value required for component types not mentioned above.

Usage

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.

See also

com.sybase.jaguar.component.control, com.sybase.jaguar.component.model.version, com.sybase.jaguar.component.type




com.sybase.jaguar.component.model.version

Description

For an EJB component, specifies the EJB specification version.

Syntax

Allowable values are “1.0”, “1.1”, and “2.0”. The default is “2.0”.

Usage

In EAServer Manager, set this property using the EJB Version control on the General tab in the Component Properties dialog box.

See also

com.sybase.jaguar.component.model, com.sybase.jaguar.component.type




com.sybase.jaguar.component.monitor

Description

Assigns this component to a thread monitor.

Syntax

Specify the monitor name.

Usage

If you change this setting, you must regenerate and recompile the component skeleton for the change to take effect.

See also

Thread monitor properties, com.sybase.jaguar.method.monitor




com.sybase.jaguar.component.monitor.MaxRespTime

Description

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.

Syntax

The maximum allowable average response time for the component, in seconds. The default is -1, which indicates no time limit.

See also

com.sybase.jaguar.component.monitor.MinInstance

Chapter 9, “Using the Performance Monitor,” in the EAServer Performance and Tuning Guide.




com.sybase.jaguar.component.monitor.MinInstance

Description

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.

Syntax

The minimum numer of instances. The default is -1, which means no new instances are blocked by the Performance Monitor.

See also

com.sybase.jaguar.component.monitor.MaxRespTime

Chapter 9, “Using the Performance Monitor,” in the EAServer Performance and Tuning Guide.




com.sybase.jaguar.component.name

Description

Specifies the name of the component and the package in which it is installed.

Syntax

package/component

Where:

Usage

In EAServer Manager, the component name is set when defining a new component and cannot be changed.




com.sybase.jaguar.component.objectCache

Description

Specifies the name of the component that implements object caching for entity components that use automatic persistence and EJB CMP entity beans.

Syntax

The component name, in the form package/component. To use the built-in implementation, enter:

CtsComponents/ObjectCache

See also

com.sybase.jaguar.component.objectCache.sizeCheckInterval




com.sybase.jaguar.component.objectCache.sizeCheckInterval

Description

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.

Syntax

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.

Usage

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.

See also

com.sybase.jaguar.component.objectCache




com.sybase.jaguar.component.objects

Description

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.

Syntax

n

Where n is a positive integer.

Usage

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.

See also

com.sybase.jaguar.component.cpp.process, com.sybase.jaguar.component.maxwait, com.sybase.jaguar.component.maxpool




com.sybase.jaguar.component.passByReference

Description

Enables the proprietary EJB pass-by-reference in-server invocation mechanism supported by some other J2EE vendors.

Syntax

true to enable pass-by-reference semantics or false to disable. The default is false.

Usage

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.

See also

“Optimizing in-server EJB calls” in Chapter 3, “Component Tuning,” in the EAServer Performance and Tuning Guide.




com.sybase.jaguar.component.pb.appname

Description

For PowerBuilder components, the name of the PowerBuilder application that contains the NVO that implements the component.

Syntax

The name of the PowerBuilder application, as displayed in PowerBuilder.

See also

com.sybase.jaguar.component.pb.class




com.sybase.jaguar.component.pb.class

Description

For PowerBuilder components, specifies the name of the nonvisual object that implements the component’s methods.

Syntax

The name of the PowerBuilder NVO, as displayed in PowerBuilder.

See also

com.sybase.jaguar.component.pb.appname




com.sybase.jaguar.component.pb.cookie

Description

For versioned PowerBuilder components, contains version cookie data.

Syntax

The cookie data.

See also

com.sybase.jaguar.component.pb.appname, com.sybase.jaguar.component.pb.class




com.sybase.jaguar.component.pb.debug

Description

For PowerBuilder components, specifies whether the component can be debugged while executing.

Syntax

true to enable debugging, or false to disable debugging. The default is false.

See also

com.sybase.jaguar.component.debug




com.sybase.jaguar.component.pb.librarylist

Description

For PowerBuilder components, specifies library files that are required to run the object.

Syntax

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

See also

com.sybase.jaguar.component.files, com.sybase.jaguar.component.pb.appname, com.sybase.jaguar.component.pb.class




com.sybase.jaguar.component.pb.live_edit

Description

For PowerBuilder components, enables or disables the live editing feature.

Syntax

true to enable live editing; false to disable. The default is false.

Usage

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.

See also

com.sybase.jaguar.component.pb.debug




com.sybase.jaguar.component.pb.version

Description

For PowerBuilder components, specifies the required version of the PowerBuilder virtual machine.

Syntax

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.

See also

com.sybase.jaguar.component.pb.appname, com.sybase.jaguar.component.pb.class




com.sybase.jaguar.component.pooling

Description

Specifies whether component instances are pooled for reuse by multiple client sessions.

Syntax

true or false. The default is true.

Usage

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.

See also

com.sybase.jaguar.component.control, com.sybase.jaguar.component.maxpool, com.sybase.jaguar.component.minpool




com.sybase.jaguar.component.ps

Description

For an entity or stateful session component, specifies how persistence is performed.

Syntax

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.

Usage

In EAServer Manager, set this property using the Persistence Type control on the Persistence tab in the Component Properties dialog box.

See also

Chapter 31, “Using the Message Service,” in the EAServer Programmer’s Guide.




com.sybase.jaguar.component.ps.class

Description

For entity components, specifies the generated class to handle component persistence when com.sybase.jaguar.component.ps property is “generated.”

Syntax

The Java class name.

Usage

In EAServer Manager, set this property in the Generated Class field on the Persistence tab in the Component Properties dialog box.

See also

com.sybase.jaguar.component.ps




com.sybase.jaguar.component.qop

Description

Minimum quality of protection required to access component.

Syntax

A QOP identifier. “Securing Component Access,” in the EAServer Security Administration and Programming Guide lists allowable QOP values.

Usage

In EAServer Manager, set this property using the Advanced tab in the Component Properties dialog box.




com.sybase.jaguar.component.queue

Description

For MDBs associated with a message queue, specifies the name of the message queue.

Syntax

MyQueue

Usage

In EAServer Manager, specify the Name on the MDB Type tab in the Component Properties dialog box.

See also

“Permanent destinations”, Chapter 31, “Using the Message Service,” in the EAServer Programmer’s Guide




com.sybase.jaguar.component.reentrant

Description

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.

Syntax

true or false. The default is false.

Usage

In EAServer Manager, set this property with the Reentrant check box on the Instances tab in the Component Properties dialog box.




com.sybase.jaguar.component.refresh

Description

Specifies whether the component can be refreshed, that is, whether a new implementation can be loaded while the server is running.

Syntax

true or false. The default is true.

Usage

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,

In EAServer Manager, set this property using the Advanced tab in the Component Properties dialog box.

See also

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




com.sybase.jaguar.component.remote

Description

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.

Syntax

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.

Usage

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).

See also

com.sybase.jaguar.component.home, com.sybase.jaguar.component.ejb.remote, com.sybase.jaguar.component.local, com.sybase.jaguar.component.interfaces




com.sybase.jaguar.component.resource-env-ref

Description

Resource environment references are logical names applied to objects administered by EAServer.

Syntax

See Resource environment reference properties.

Usage

In EAServer Manager, set this property using the Resource Env Refs tab in the Component Properties dialog box.

See also

Resource environment reference properties.




com.sybase.jaguar.component.resource-ref

Description

For EJB components, specifies aliased JNDI names for database connections, JavaMail sessions, and URL factories used by the component.

Syntax

See Resource reference properties.

Usage

In EAServer Manager, set this property using the Resource Refs tab in the Component Properties dialog box.

See also

Resource reference properties.




com.sybase.jaguar.component.retry.timeout

Description

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.

Syntax

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.

Usage

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.

See also

com.sybase.jaguar.component.auto.failover




com.sybase.jaguar.component.roles

Description

For component types other than EJB, specifies roles that a user must belong to invoke the component.

Syntax

role1, role2, ...

Where role1, role2, and so forth are role names defined in the repository.

Usage

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.

See also

com.sybase.jaguar.package.roles, com.sybase.jaguar.method.roles, com.sybase.jaguar.method.security-roles




com.sybase.jaguar.component.runasidentity

Description

For EJB 1.0 components, specifies an identity name used for intercomponent calls if the com.sybase.jaguar.component.runasmode property is “specified.”

Syntax

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

Usage

In EAServer Manager, set this property using the Run As Identity field on the Run As Mode tab in the Component Properties dialog box.

See also

com.sybase.jaguar.component.runasmode, com.sybase.jaguar.package.runasidentity.<id>




com.sybase.jaguar.component.runasmode

Description

For EJB 1.0 components, specifies the user identity that is assumed for intercomponent calls.

Syntax

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.

Usage

In EAServer Manager, set this property using the Run As Mode tab in the Component Properties dialog box.

See also

com.sybase.jaguar.component.runasidentity, com.sybase.jaguar.method.runasmode




com.sybase.jaguar.component.SAXfactory

Description

Specifies the class name for a custom SAX XML parser factory class.

Syntax

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.

See also

com.sybase.jaguar.component.DOMfactory, com.sybase.jaguar.application.XSLTfactory




com.sybase.jaguar.component.security.runasidentity

Description

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.

Syntax

(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 <id> is the logical identity name.

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 <j2ee-role> is the logical role name. The mapping can also be established by setting the com.sybase.jaguar.application.security-role.<j2ee-role> property.

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.

See also

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




com.sybase.jaguar.component.security-role-ref.<j2ee-role-ref>

Description

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.

Syntax

com.sybase.jaguar.component.security-role-ref.role-ref=j2ee-role

Where:

Usage

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.

See also

com.sybase.jaguar.application.security-roles, com.sybase.jaguar.package.security-roles




com.sybase.jaguar.component.security-role-refs

Description

For EJB components, specifies role reference names used within isCallerInRole method invocations in the component implementation.

Syntax

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.

Usage

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.

See also

com.sybase.jaguar.component.security-role-ref.<j2ee-role-ref>




com.sybase.jaguar.component.selectForUpdate

Description

For components that use automatic persistence, such as EJB CMP entity beans, specifies whether queries create exclusive locks on selected rows.

Syntax

true or false. The default is false.

See also

com.sybase.jaguar.component.touchColumn, com.sybase.jaguar.component.ps, com.sybase.jaguar.component.selectWithLock, com.sybase.jaguar.component.timestamp




com.sybase.jaguar.component.selectWithLock

Description

For components that use automatic persistence, such as EJB CMP entity beans, specifies whether queries create shared locks on selected rows.

Syntax

true or false. The default is false.

Usage

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.

See also

com.sybase.jaguar.component.ps, com.sybase.jaguar.component.selectForUpdate, com.sybase.jaguar.component.timestamp




com.sybase.jaguar.component.sharing

Description

Specifies whether multiple component instances can be created. A shared component serves all client requests with one instance.

Syntax

true or false. The default is false.

Usage

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.

NoteSharing 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.

See also

com.sybase.jaguar.component.pooling, com.sybase.jaguar.component.thread.safe




com.sybase.jaguar.component.softLock

Description

For EJB CMP entity beans that use an isolation level of repeatable_read_with_cache, enables soft locking.

Syntax

true or false. true enables soft locking. The default of false disables soft locking.

See also

com.sybase.jaguar.component.cmp_iso_level, com.sybase.jaguar.component.softLock.timeout, “Configuring CMP isolation level” in the EAServer Performance and Tuning Guide




com.sybase.jaguar.component.softLock.timeout

Description

When soft locking is enabled, specifies the timeout period for soft-locked rows.

Syntax

The timeout, in seconds.

See also

com.sybase.jaguar.component.softLock, “Configuring CMP isolation level” in the EAServer Performance and Tuning Guide




com.sybase.jaguar.component.state

Description

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.

Syntax

The name of an IDL structure or serializable Java class that stores component state.

Usage

In EAServer Manager, set this property in the State field on the Persistence tab in the Component Properties dialog box.

See also

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




com.sybase.jaguar.component.state.gs

Description

For entity components or stateful components that use automatic persistence, specifies component methods that set and retrieve component state.

Syntax

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;
}

Usage

In EAServer Manager, set this property in the State Methods field on the Persistence tab in the Component Properties dialog box.

See also

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




com.sybase.jaguar.component.stateless

Description

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.

Syntax

true or false. The default is false.

Usage

In EAServer Manager, set this property using the Stateless check box on the Instances tab in the Component Properties window.

See also

com.sybase.jaguar.component.control, com.sybase.jaguar.component.tx_vote




com.sybase.jaguar.component.storage

Description

For entity or stateful session components that use automatic persistence or failover support, specifies the storage component.

Syntax

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:

In EAServer Manager, set this property in the Storage Component field on the Persistence tab in the Component Properties dialog box.

See also

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




com.sybase.jaguar.component.store

Description

Tells the server when to call ejbStore.

Syntax

store

Where store can be one of, or a comma-separated list of more than one of, these values:

Value

Description

afterCreate

The server calls ejbStore after it calls ejbPostCreate.

afterInvoke

The server calls ejbStore after it calls each business method. afterInvoke and beforeCompletion cannot be used together.

beforeCompletion

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.

afterInvoke and beforeCompletion cannot be used together. The default value is afterCreate,afterInvoke.

Usage

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.




com.sybase.jaguar.component.sync

Description

Specifies whether the component is included in the files replicated by a synchronization operation.

Syntax

true or false. The default is true.

Usage

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.

See also

Chapter 6, “Clusters and Synchronization”




com.sybase.jaguar.component.thread.safe

Description

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.

Syntax

true or false. The default is true.

Usage

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.

See also

com.sybase.jaguar.component.bind.thread, com.sybase.jaguar.component.sharing




com.sybase.jaguar.component.timeout

Description

Specifies how long, in seconds, an active component instance can remain idle between method calls before the client’s proxy becomes invalid.

Syntax

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.

Usage

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.

See also

com.sybase.jaguar.server.timeout




com.sybase.jaguar.component.timestamp

Description

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.

Syntax

See “Configuring concurrency control” in Chapter 27, “Creating Entity Components,” in the EAServer Programmer’s Guide.

Usage

In EAServer Manager, set this property using the Timestamp field on the Persistence tab in the Component Properties dialog box.

See also

com.sybase.jaguar.component.ps, com.sybase.jaguar.component.selectWithLock com.sybase.jaguar.component.ts.length, com.sybase.jaguar.component.tx_retry




com.sybase.jaguar.component.tlc.sort

Description

For EJB CMP entity beans, specifies that transaction local cache entries for this component should be sorted before ejbStore is called.

Syntax

true or false. The default of false indicates no sorting.

Usage

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.

See also

“Configuring transaction local cache settings” in Chapter 4, “EJB CMP Tuning,” in the EAServer Performance and Tuning Guide.




com.sybase.jaguar.component.topic

Description

For MDBs associated with a message topic, specifies the name of the topic.

Syntax

MyTopic

Usage

In EAServer Manager, specify the Name on the MDB Type tab in the Component Properties dialog box.

See also

“Permanent destinations”, Chapter 31, “Using the Message Service,” in the EAServer Programmer’s Guide




com.sybase.jaguar.component.touchColumn

Description

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.

Syntax

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.

See also

com.sybase.jaguar.component.selectForUpdate




com.sybase.jaguar.component.trace

Description

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.

Syntax

true or false. The default is false.

Usage

In EAServer Manager, set this property using the Advanced tab in the Component Properties dialog box.

See also

com.sybase.jaguar.component.debug




com.sybase.jaguar.component.transient

Description

Applies to stateful components only. Specifies whether instances can be run on multiple servers in a cluster or survive a server restart.

Syntax

true or false. The default is true.

Usage

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.

See also

com.sybase.jaguar.component.ps




com.sybase.jaguar.component.ts.length

Description

When com.sybase.jaguar.component.timestamp specifies a column name, this property specifies the datatype and length.

Syntax

No value indicates the default, 4-byte integer. Specify binary(16) to use globally unique 16-byte ID timestamps.

Usage

In EAServer Manager, set this property using the Advanced tab in the Component Properties dialog box.

See also

com.sybase.jaguar.component.ps, com.sybase.jaguar.component.timestamp, Chapter 27, “Creating Entity Components,” in the EAServer Programmer’s Guide.




com.sybase.jaguar.component.ts.triggers

Description

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.

Syntax

true or false. The default is false.

See also

com.sybase.jaguar.component.timestamp, Chapter 27, “Creating Entity Components,” in the EAServer Programmer’s Guide.




com.sybase.jaguar.component.tx_control

Description

Specifies whether control interface methods execute in the context of a server-managed transaction.

Syntax

true or false. The default is true for EJB entity beans, and false for other component types.

Usage

In EAServer Manager, set this property using the Advanced tab in the Component Properties dialog box.

See also

com.sybase.jaguar.component.control




com.sybase.jaguar.component.tx_outcome

Description

Determines whether a CORBA::TRANSACTION_ROLLEDBACK exception is thrown to the client when a transaction is rolled back.

Syntax

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.

Usage

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.




com.sybase.jaguar.component.tx_retry

Description

For EJB CMP entity beans, determines whether EAServer automatically replays transactions that fail.

Syntax

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.

Usage

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).

See also

com.sybase.jaguar.server.tx_retry, “Concurrency control options” in Chapter 4, “EJB CMP Tuning,” in the EAServer Performance and Tuning Guide.




com.sybase.jaguar.component.tx_timeout

Description

Specifies the maximum duration of an EAServer transaction begun by the component.

Syntax

The timeout period, in seconds, with 0 indicating no timeout. EAServer determines the transaction timeout period as follows:

Usage

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.

See also

com.sybase.jaguar.component.timeout, com.sybase.jaguar.server.tx_timeout




com.sybase.jaguar.component.tx_type

Description

Specifies how methods in your component participate in transactions.

Syntax

Table B-2 lists allowable values:

Table B-2: tx_type values

Value

To indicate

not_supported

The component-level default. The component’s methods never execute as part of a transaction. If the component is activated by another component that is executing within a transaction, the new instance’s work is performed outside of the existing transaction.

supports

The component can execute in the context of an EAServer transaction, but a connection is not required to execute the component’s methods. If the component is instantiated directly by a base client, EAServer does not begin a transaction. If component A is instantiated by component B, and component B is executing within a transaction, component A executes in the same transaction.

requires

The component always executes in a transaction. When the component is instantiated directly by a base client, a new transaction begins. If component A is activated by component B, and B is executing within a transaction, then A executes within the same transaction; if B is not executing in a transaction, then A executes in a new transaction.

requires_new

Whenever the component is instantiated, a new transaction begins. If component A is activated by component B, and B is executing within a transaction, then A begins a new transaction that is unaffected by the outcome of B’s transaction; if B is not executing in a transaction, then A executes in a new transaction.

mandatory

Methods may only be invoked by a client that has an outstanding transaction.

user_managed

The component implementation explicitly begins and ends transactions.

For EJB session bean components The component can explicitly begin, commit, and roll back new, independent transactions by using the javax.transaction.UserTransaction interface. Transactions begun by the component execute independently of the client’s transaction. If the component has not begun a transaction, the component’s database work is performed independently of any EAServer transaction.

Stateless session beans can use this attribute, but transactions begun in a method must be committed or rolled back before that method returns. Otherwise, EAServer logs an error and returns an exception to the client. Stateful session beans can create transactions that remain open across several method calls.

For components of other types The component can inherit a client’s transaction. If called without a transaction, the component can explicitly begin, commit, and roll back transactions by using the CORBA CosTransactions::Current interface.

never

The component’s methods never execute as part of a transaction, and the component cannot be called in the context of a transaction. If a client or another component calls the component with an outstanding transaction, EAServer throws an exception.

Usage

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.

See also

com.sybase.jaguar.method.tx_type




com.sybase.jaguar.component.tx_vote

Description

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.

Syntax

Allowable values are true and false. The default for new components is true.

Usage

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.

See also

com.sybase.jaguar.component.control, com.sybase.jaguar.component.stateless




com.sybase.jaguar.component.type

Description

Specifies the component type.

Syntax

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

Usage

In EAServer Manager, set this property using the Component Type field on the General tab in the Component Properties dialog box.




com.sybase.jaguar.component.XSLTfactory

Description

Specifies the class name for a custom XSLT XML parser factory class.

Syntax

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.

See also

com.sybase.jaguar.component.DOMfactory, com.sybase.jaguar.component.SAXfactory




com.sybase.jaguar.description

Description

Specifies a text description of the component.

Syntax

desc

Where desc is the descriptive text.

Usage

In EAServer Manager, set this property using the Description field on the General tab of the Component Properties dialog box.





Copyright © 2005. Sybase Inc. All rights reserved. Connection cache properties