Component properties

auto.failover

<automaticFailover> property.

Yes.

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

auto.profiles

Not applicable.

No.

Obsolete.

bind.naming

Not needed for EJB/MDB.

Not needed.

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.

bind.object

Not needed for EJB/MDB.

Yes.

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

bind.thread

Not needed for EJB/MDB.

Yes.

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

classloaderpolicy

<parentFirst> property for EJB’s ClassLoader.

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.

cmp_iso_level

“isolationLevel” attribute of <persistentObject> property.

Not needed.

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

cmp.version

<cmp-version> in ejb-jar.xml.

Not needed.

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

code.set

Not needed for EJB/MDB.

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

com.progid

Not needed for EJB/MDB.

COM components not supported.

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

context

Not needed for EJB/MDB.

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

control

Not needed for EJB/MDB.

Yes.

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

cpp.class

Not needed for EJB/MDB.

Yes.

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

cpp.copy

Not needed for EJB/MDB.

Yes.

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

cpp.debug

Not needed for EJB/MDB.

Yes.

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

cpp.library

Not needed for EJB/MDB.

Yes.

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

cpp.process

Not needed for EJB/MDB.

Yes.

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.

cs.create

Not needed for EJB/MDB.

C components not supported.

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

cs.destroy

Not needed for EJB/MDB.

C components not supported.

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

db.sequence

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

debug

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

defer

Not needed.

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.

destroyPooledInstancesOnShutdown

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

destroyPooledInstancesOnShutdownTimeout

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

dn.triggers

Not needed.

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.

DOMfactory

Not applicable. (Use standard JAXP procedures to specify).

Not needed.

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

ejb.home

<home> in ejb-jar.xml.

Not needed.

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

ejb.key

<prim-key-class> in ejb-jar.xml.

Not needed.

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

ejb.local

<local> in ejb-jar.xml.

Not needed.

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

ejb.local.home

<local-home> in ejb-jar.xml.

Not needed.

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

ejb.remote

<remote> in ejb-jar.xml.

Not needed.

Specifies the remote interface class name for an EJB component.

ejb-local-ref

<ejb-local-ref> in ejb-jar.xml.

Not needed.

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

ejb-ref

<ejb-ref> in ejb-jar.xml.

Not needed.

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

env-entry

<env-entry> in ejb-jar.xml.

Not needed.

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

external.request.timeout

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.

external.servername

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

external.serverstart.timeout

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.

files

Not needed for EJB/MDB.

Yes.

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

files.corbastubs

Not needed for EJB/MDB.

Not needed.

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

files.ejbstubs

Not needed for EJB/MDB.

Not needed.

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

generateKey

Not needed for EJB/MDB.

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.

home

Not needed for EJB/MDB.

Not needed.

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

Not needed for EJB/MDB.

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

identitytype

Not needed for EJB/MDB.

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

ids

Not needed for EJB/MDB.

Specifies repository IDs for the component's IDL interfaces.

instancePool

Not needed for EJB/MDB.

Yes.

Constrains the component to run in the specified instance pool (system or bindThread).

interfaces

Not needed for EJB/MDB.

Yes.

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

iso_level

Not supported.

Not needed.

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

java.class

<ejb-class> in ejb-jar.xml.

Yes.

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

java.classes

Not needed.

Not needed.

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

key

Not needed for EJB/MDB.

Yes.

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

key.tc

Not needed for EJB/MDB.

Specifies the type code string for the primary key IDL type.

keys

Not needed for EJB/MDB.

Yes.

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.

list

Not needed for EJB/MDB.

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.

listener

Not needed for EJB/MDB.

Not needed.

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

load

Not needed for EJB/MDB.

Not supported.

Obsolete.

local

Not needed for EJB/MDB.

Not needed.

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

local.home

Not needed for EJB/MDB.

Not needed.

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

lwc

Not supported.

Not needed.

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.

lwc.enableSkeletons

Not supported.

Not needed.

Enables LWC calls to EJB components from the servlets and JSPs hosted in the same server. Such calls are not supported unless this option is set.

maxpool

Not supported.

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

maxwait

Not supported.

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

mdb.acknowledge-mode

<acknowledge-mode> in ejb-jar.xml.

Not needed.

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

mdb.destination-type

<destination-type> in ejb-jar.xml.

Not needed.

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

mdb.message-selector

<message-selector> in ejb-jar.xml.

Not needed.

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.

mdb.subscription-durability

<subscription-durability> in ejb-jar.xml.

Not needed.

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

methods

Not applicable.

Yes.

Used to store the component’s nondefault method properties.

minpool

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

model

Not needed.

Specifies the component model (ejb, cts, mts).

model.version

For an EJB component, specifies the EJB specification version.

monitor

Yes.

Assigns this component to a thread monitor.

monitor.MaxRespTime

Yes.

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.

monitor.MinInstance

Yes.

When response time monitoring is in effect (com.sybase.jaguar.component.monitor.MaxRespTime is set to a non-negative number), specifies the minimum number of instances that must be allowed to execute regardless of observed response times.

name

Not needed.

Yes.

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

objectCache

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

objectCache.sizeCheckInterval

Not needed.

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.

objects

No.

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.

passByReference

Not needed.

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

pb.appname

Not for EJB/MDB.

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

pb.class

Not for EJB/MDB.

Yes.

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

pb.cookie

Not for EJB/MDB.

Yes.

For versioned PowerBuilder components, contains version cookie data.

pb.debug

Not for EJB/MDB.

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

pb.librarylist

Not for EJB/MDB.

Yes.

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

pb.live_edit

Not for EJB/MDB.

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

pb.version

Not for EJB/MDB.

Only PB 10 and above are Supported.

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

pooling

Yes.

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

ps

Yes.

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

ps.class

Not needed.

Yes.

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

qop

Not for EJB/MDB.

Minimum quality of protection required to access component.

queue

Not needed.

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

reentrant

<reentrant> in ejb-jar.xml

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.

refresh

Always refreshable.

Always refreshable.

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

remote

Not needed.

Not needed.

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.

resource-env-ref

<resource-env-ref> in ejb-jar.xml.

Not needed.

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

resource-ref

<resource-ref> in ejb-jar.xml.

Not needed.

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

retry.timeout

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.

roles

Not for EJB/MDB.

Yes.

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

runasidentity

Not needed.

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

runasmode

Not needed.

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

SAXfactory

Not applicable. (Use standard JAXP procedures to specify).

Not needed.

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

security.runasidentity

<run-as> in ejb-jar.xml.

Not needed.

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.

security-role-ref.<j2ee-role-ref>

<security-role-ref> in ejb-jar.xml.

Not needed.

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.

security-role-refs

<security-role-ref> elements in ejb-jar.xml.

Not needed.

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

selectForUpdate

No.

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

selectWithLock

No.

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

sharing

Yes.

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

softLock

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

softLock.timeout

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

state

Yes.

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.

state.gs

Yes.

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

stateless

<session-type> in ejb-jar.xml.

Yes.

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.

storage

<persistentObject> property

Yes.

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

store

Tells the server when to call ejbStore.

sync

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

thread.safe

Not for EJB/MDB

Yes.

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.

timeout

Yes.

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

timestamp

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.

tlc.sort

Not needed.

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

topic

Not needed.

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

touchColumn

No.

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.

trace

<tracePublicMethods> property.

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.

transient

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

ts.length

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

ts.triggers

Not needed.

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.

tx_control

Not needed.

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

tx_outcome

Not needed.

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

tx_retry

“retry” attribute of <transaction> property.

Not needed.

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

tx_timeout

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

tx_type

<transaction-type> and <tran-attribute> in ejb-jar.xml.

Yes.

Specifies how methods in your component participate in transactions.

tx_vote

Yes.

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.

type

Not needed, derived from ejb-jar.xml.

Yes.

Specifies the component type.

XSLTfactory

Not applicable. (Use standard JAXP procedures to specify).

Not needed.

Specifies an XSLT Parser factory class name.

description

<description> in ejb-jar.xml.

Yes.

Specifies a text description of the component.