Appendix B Repository Properties Reference
Component
property names begin with com.sybase.jaguar.component
.
In Jaguar Manager, configure component properties in the Component
Properties dialog box.
Specifies whether client proxies can transparently fail over to a different server.
Allowable values are true
and false
.
In Jaguar Manager, set this property using the "Automatic failover" check box on the Transactions tab.
Chapter 7, "Load Balancing, Failover, and Component Availability"
Chapter 25, "Managing Persistent Component State," in the EAServer Programmer's Guide.
Specifies the name with which the component is bound to the name service. If not specified, the default is package/component where package is the EAServer package name, and component is the component name.
name
Where name is the name service path, relative to the server or cluster's initial naming context.
In Jaguar Manager, you can set this property in the Component Properties dialog as follows:
com.sybase.jaguar.server.CosNaming.initialcontext,
com.sybase.jaguar.cluster.initialcontext
Specifies whether instances are bound to client's object reference.
true
or false
.
The default is false
.
This property cannot be enabled unless the component is stateful and thread-safe.
In Jaguar Manager, set this property using the Bind Object check box on the Instances tab in the Component Properties dialog box.
com.sybase.jaguar.component.thread.safe,
com.sybase.jaguar.component.stateless,
com.sybase.jaguar.component.tx_vote
Specifies whether instances are bound to the thread that created them.
true
or false
.
The default is false
.
Set this property to true if your component uses thread-local storage. This property must be enabled for ActiveX components.
In Jaguar Manager, set this property using the Bind Thread check box on the Instances tab in the Component Properties dialog box.
For EJB 2.0 entity beans that use CMP (automatic persistence), specifies the CMP model version.
Allowable values are:
| Value | To indicate |
|---|---|
1.1
(the
default)
|
CMP according to the EJB 1.1 specification. |
2.0
|
CMP according to the EJB 2.0 specification. |
If no value is specified, the default is 1.1.
For a C or C++ component, specifies the coded character set name used to encode character and string parameter data.
codeset
Where codeset is the coded character set name. The default is the package character set specified by com.sybase.jaguar.package.code.set.
In Jaguar Manager, set this property using the Code set field on the General tab in the Component Properties dialog box.
com.sybase.jaguar.package.code.set
Specifies the progid that the component uses in the COM Automation Server Registry.
progid
Where progid is the COM progid.
In Jaguar Manager, set this property using the COM Progid field on the General tab in the Component Properties dialog box.
Specifies the name of the component's context IDL interface: for example, CtsComponents::ObjectContext.
context
Where context is the name of the context IDL interface.
The context interface must match the context interface used in the component's control interface. For example, if the control interface is CtsComponents::ObjectControl, specify CtsComponents::ObjectContext.
In Jaguar Manager, set this property using the All Properties tab in the Component Properties dialog box.
com.sybase.jaguar.component.control
Specifies the name of the component's control IDL interface, for example CtsComponents::ObjectControl.
control
Where control is the name of the control IDL interface.
The control interface defines methods called by EAServer in response to changes in the instance lifecycle. 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 lifecycle 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 lifecycle 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 Jaguar Manager, set this property using the All Properties tab in the Component Properties dialog box. For EJB components, the control interface is set correctly when you specify the component type property in Jaguar Manager, and should not be changed.
com.sybase.jaguar.component.context,
com.sybase.jaguar.component.pooling,
com.sybase.jaguar.component.stateless,
com.sybase.jaguar.component.tx_vote
For a C++ component, specifies the implementation class name.
class
Where class is the name of the implementation class.
In Jaguar Manager, set this property in the C++ Class field on the General tab in the Component Properties dialog box.
com.sybase.jaguar.component.cpp.library
For C and C++ components, specifies whether the server should copy the component library before running it.
true
or false
.
The default is false
.
Set this property to true to allow updates to the implementation on operating systems that do not allow overwriting a DLL or shared library while the library is in use.
In Jaguar Manager, set this property using the All Properties tab in the Component Properties dialog box.
com.sybase.jaguar.component.refresh
For a C++ component, specifies whether to catch exceptions.
true
or false
.
The default is true
, which
specifies that exceptions are caught in the server.
When debugging an executing component, set this property to false to allow exceptions to reach your debugger. You must set this property to true to debug an executing C++ component in Microsoft Visual C++. Other C++ debuggers may require the same setting as well.
In a production server, set the property to true so exceptions thrown by component code do not terminate the server process.
In Jaguar Manager, set this property using the All Properties tab in the Component Properties dialog box.
For C and C++ components, specifies the name of the DLL or shared library that contains the implementation class.
library
Where library is the library name, minus
platform extensions such as .dll for Windows
or .so for Solaris. You can append ${JAGUAR_PLATFORM}
to the
name. ${JAGUAR_PLATFORM}
indicates
that this part of the name should be replaced with the EAServer
platform identifier (specified by the JAGUAR_PLATFORM
variable
set in the generated makefile). This substitution allows you to
deploy libraries for multiple platforms to support multiplatform
clusters.
The library must be located in the EAServer cpplib directory to support component refresh.
In Jaguar Manager, set this property in the DLL Name field on the General tab in the Component Properties dialog box.
com.sybase.jaguar.component.cpp.class
For C++ components, specifies the name of an external process to run the component. If the property is not set, the component executes within the EAServer process.
executable
Where executable is the name of the executable file, minus platform extensions (such as .exe for Windows). The executable must be located in the EAServer cpplib subdirectory.
In Jaguar Manager, set this property in the C++ Executable field on the General tab in the Component Properties dialog box.
For a C component, specifies whether the implementation has a create routine.
true
or false
.
The default is false
.
The Jaguar server calls create when creating a new instance of the component. The signature for create is:
CS_RETCODE CS_PUBLIC create()
create must return CS_SUCCEED.
In Jaguar Manager, set this property using the All Properties tab in the Component Properties dialog box.
com.sybase.jaguar.component.cs.destroy
For a C component, specifies whether the implementation has a destroy routine.
true
or false
.
The default is false
.
The Jaguar server calls destroy when destroying an instance of the component. The signature for destroy is:
CS_RETCODE CS_PUBLIC destroy()
destroy must return CS_SUCCEED.
In Jaguar Manager, set this property using the All Properties tab in the Component Properties dialog box.
com.sybase.jaguar.component.cs.create
Specifies whether the server logs trace information for instance lifecycle events such as creation, destruction, pooling, and so forth.
true
or false
.
The default is false
.
In Jaguar Manager, set this property using the All Properties tab in the Component Properties dialog box.
com.sybase.jaguar.component.cpp.debug,
com.sybase.jaguar.component.pb.debug,
com.sybase.jaguar.component.trace
For EJB components, specifies the home interface class name. Derived from com.sybase.jaguar.component.home.
class
Where class is the Java class name, for example com.sybase.jaguar.sample.GlossaryHome.
This property is read-only. It is automatically set when you specify the component's IDL home interface with the com.sybase.jaguar.component.home property.
In Jaguar Manager, view this property in the Home Interface field on the General tab in the Component Properties window.
com.sybase.jaguar.component.home,
com.sybase.jaguar.component.ejb.remote
For an EJB entity bean component, specifies the class name for the primary key type. Derived from com.sybase.jaguar.component.key.
class
Where class is the Java class name; for example, com.sybase.jaguar.sample.GlossaryKey or java.lang.String.
This property is read-only. It is automatically set when you specify the component's IDL primary key type with the com.sybase.jaguar.component.key property.
In Jaguar Manager, view this property in the Primary Key field on the General tab in the Component Properties window.
com.sybase.jaguar.component.key
For EJB 2.0 components, specifies the Java local interface name.
class
Where class is the Java class name; for example, com.sybase.jaguar.sample.LocalGlossary.
This property is read-only. It is automatically set when you specify the component's IDL remote interface with the com.sybase.jaguar.component.local property.
In Jaguar Manager, view this property in the Local Interface field on the General tab in the Component Properties window.
com.sybase.jaguar.component.local,
com.sybase.jaguar.component.ejb.local.home,
com.sybase.jaguar.component.ejb.remote
For EJB 2.0 components, specifies the Java local home interface name.
class
Where class is the Java class name, for example com.sybase.jaguar.sample.LocalGlossaryHome.
This property is read-only. It is automatically set when you specify the component's IDL local home interface with the com.sybase.jaguar.component.local.home property.
In Jaguar Manager, view this property in the Local Home Interface field on the General tab in the Component Properties window.
com.sybase.jaguar.component.local,
com.sybase.jaguar.component.ejb.home
Specifies the remote interface class name for an EJB component. Derived from com.sybase.jaguar.component.remote.
class
Where class is the Java class name, for example com.sybase.jaguar.sample.Glossary.
This property is read-only. It is automatically set when you specify the component's IDL remote interface with the com.sybase.jaguar.component.remote property.
In Jaguar Manager, view this property in the Remote Interface field on the General tab in the Component Properties window.
com.sybase.jaguar.component.remote,
com.sybase.jaguar.component.ejb.home
For EJB components (EJB version 1.1 or later), specifies environment properties.
In Jaguar Manager, configure environment properties on the Environment tab in the Component Properties dialog box.
EJB 1.0 components do not use this property. Any property whose name does not begin with com.sybase.jaguar.component is considered an environment property for an EJB 1.0 component.
For EBJ components, specifies a list of EJB local references that define aliased JNDI names for local components invoked by this component.
ejb-ref1, ejb-ref2, ...
Where ejb-ref1, ejb-ref2, and so forth follow the syntax of EJB local reference properties.
Use this property if aliased beans are invoked using local interfaces. If you are using remote interfaces, use the com.sybase.jaguar.component.ejb-ref property.
EJB local reference
properties,
com.sybase.jaguar.component.ejb-ref
For EBJ components, specifies a list of EJB references that define aliased JNDI names for components invoked by this component.
ejb-ref1, ejb-ref2, ...
Where ejb-ref1, ejb-ref2, and so forth follow the syntax of EJB reference properties.
Use this property if aliased beans are invoked using remote interfaces. If you are using local interfaces, use the com.sybase.jaguar.component.ejb-local-ref property.
Specifies additional files that are included when the component is archived with the package export feature or replicated with the synchronize feature.
Same as for com.sybase.jaguar.applicationclient.files
The com.sybase.jaguar.component.files property specifies a list of files that are 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 Jaguar Manager, set this property using the Additional Files tab in the Component Properties dialog box.
com.sybase.jaguar.component.java.classes,
com.sybase.jaguar.component.pb.librarylist
Specifies the component's home IDL interface. EJB components must have a home interface, and other component types must have one to support access from EJB clients.
home
Where home is the IDL interface name. For example, examples::QueryHome. For an EJB component, the default is:
package::componentHome
Where package is the EAServer package name, and component is the EAServer package name. For other component types, there is no default.
EJB components must have a home interface. A component of any type must have a home interface to be invoked from EJB clients or EJB components.
In Jaguar Manager, set this property using the File menu for the component's Interfaces folder. See the EAServer Programmer's Guide for more information.
com.sybase.jaguar.component.remote,
com.sybase.jaguar.component.ejb.home,
com.sybase.jaguar.component.local.home
Specifies repository IDs for the component's home IDL interface. Derived from com.sybase.jaguar.component.home.
A comma-separated list of repository IDs.
This property is read-only. It is set automatically when you set the com.sybase.jaguar.component.home property. In Jaguar Manager, view the property using the All Properties tab in the Component Properties dialog box.
com.sybase.jaguar.component.home
Specifies whether to use the connection user name or SSL certificate for role-based authorization.
Allowable values are:
| Value | To indicate |
|---|---|
| jaguar | Authorize based on the EAServer connection user name |
| ssl | Authorize based on the SSL certificate digital ID |
In Jaguar Manager, set this property on the All Properties tab in the Component Properties dialog box.
Specifies repository IDs for the component's IDL interfaces. Derived from com.sybase.jaguar.component.interfaces.
A comma-separated list of repository identifiers.
This property is read-only. It is set automatically when you set the com.sybase.jaguar.component.interfaces property. In Jaguar Manager, view the property using the All Properties tab in the Component Properties dialog box.
com.sybase.jaguar.component.interfaces
Specifies the IDL interfaces that the component supports for client use.
A comma-separated list of IDL interface names. For example:
MyModule::iFace1,MyModule::iFace2
The default is:
package::component
Where package is the package name, and component is the component name.
In Jaguar Manager, the component's interfaces can be modified using the Interfaces folder displayed beneath the component icon. See the EAServer Programmer's Guide for more information.
com.sybase.jaguar.component.remote
For Java components (CORBA and EJB), specifies the name of the Java implementation class.
The Java class name. For example, com.sybase.jaguar.sample.GlossaryImpl. There is no default.
In Jaguar Manager, set this property in the Java Class field on the General tab in the Component Properties dialog box.
com.sybase.jaguar.component.java.classes
For Java components (CORBA and EJB), specifies additional classes to be loaded by the component class loader.
Same as for com.sybase.jaguar.application.java.classes.
EAServer uses custom class loaders at the server, application, package, and component level. The custom class loader allows you to refresh your implementation without restarting the host server.
Add classes to this property so that:
Java classes for components can be specified in the component, package, and server class lists. If a class is specified at multiple levels, it is loaded at the highest lever. For example, if com.sybase.FooImpl is in the component and package lists, it is loaded by the package class loader.
Custom class loading can be disabled If the com.sybase.jaguar.component.refresh property is set to false, the component implementation is not custom loaded, and all classes and JAR files required by the component must be in the server's CLASSPATH (and BOOTCLASSPATH for JDK 1.2 or later servers).
In Jaguar Manager, set this property using the Java Classes tab in the Component Properties dialog box.
com.sybase.jaguar.component.java.class,
com.sybase.jaguar.component.refresh,
com.sybase.jaguar.application.java.classes,
com.sybase.jaguar.package.java.classes,
com.sybase.jaguar.server.java.classes
For an entity component, specifies the IDL datatype for the primary key.
The value can be 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.
Interoperability and key types Use an IDL structure or string if other types of clients besides Java will use the bean.
In Jaguar Manager, set this property in the Primary Key field on the Persistence tab in the Component Properties dialog box.
com.sybase.jaguar.component.ejb.key,
com.sybase.jaguar.component.list
Specifies the type code string for the primary key IDL type. Derived from com.sybase.jaguar.component.key.
The type code string.
This property is read-only. It is set automatically when you set the com.sybase.jaguar.component.key property. In Jaguar Manager, view the value on the All Properties tab in the Component Properties dialog box.
com.sybase.jaguar.component.key
For entity components, specifies the name of an IDL typedef for a sequence of the component's primary key datatype. This type is used when generating the skeleton and implementation classes for the component.
The name of an IDL typedef that specifies a sequence of primary key type. The default is an IDL typedef:
module::remoteKeys
Where module is the module that contains the remote interface, and remote is the unscoped IDL name of the remote interface. EAServer defines this typedef as:
typedef sequence < ::key > module::remoteKeys;
Where key is the value of the com.sybase.jaguar.component.key property.
If you have used PowerJ or the Jaguar Manager import feature to import an entity bean, the com.sybase.jaguar.component.keys typedef may use a different naming convention.
This property is set to the default when you set the com.sybase.jaguar.component.key property, and the IDL typedef is defined if it does not exist already. Set the property manually to use a value other than the default.
In Jaguar Manager, view and set this property using the All Properties tab in the Component Properties window.
com.sybase.jaguar.component.key,
com.sybase.jaguar.component.ejb.key
For an EJB 1.0 entity bean, specifies the IDL datatype for a sequence of the remote interface type. In an entity bean's IDL home interface, methods that return a collection of instances must return the type name specified by this property.
The name of an IDL typedef that specifies a sequence of the remote interface type. The default is an IDL typedef:
module::compList
Where module is the module that contains the remote interface, and comp is the unscoped IDL name of the remote interface. The default typedef is:
typedef sequence < ::remote > module::compList;
Where remote is the value of the com.sybase.jaguar.component.remote property.
In Jaguar Manager, set this property on the All Properties tab in the Component Properties dialog box.
When you manually specify a value for the Primary Key field
on the Persistence tab, Jaguar Manager sets this property to module::componentList
where module is
the module containing the primary key type, and component is
the component name. Jaguar Manager defines the type if it does not
exist, using the following structure:
typedef <sequence ri> componentListwhere 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 Jaguar Manager import feature to import an entity bean, the com.sybase.jaguar.component.keys typedef may use a different naming convention.
com.sybase.jaguar.component.remote
For message-driven beans (MDBs), specifies the message listener package and component.
MDBpackage/MDBcomponent
In Jaguar Manager, specify the Listener on the MDB Type tab in the Component Properties dialog box.
Tells the server when to call ejbLoad.
load
Where load can be one of, or a comma-separated list of more than one of, these values:
| Value | Description |
|---|---|
| beforeInvoke | The server calls ejbLoad before calling each business method. |
| beforeRemove | The server calls ejbLoad before calling ejbRemove. |
| afterBegin | The server calls ejbLoad at the beginning 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. |
The default value is beforeInvoke,beforeRemove
.
com.sybase.jaguar.component.store
For EJB 2.0 components, specifies the name of the IDL local interface.
local
Where local is the IDL interface name. For example, examples::LocalQuery. The local interface must be one of the interfaces listed in the com.sybase.jaguar.component.interfaces property. There is no default.
In Jaguar Manager, set this property using the File menu for the Interfaces folder displayed beneath the component icon.
com.sybase.jaguar.component.local.home,
com.sybase.jaguar.component.remote,
com.sybase.jaguar.component.ejb.local
For EJB 2.0 components, specifies the name of the IDL local home interface.
home
Where home is the IDL interface name. For example, examples::LocalQueryHome. There is no default.
In Jaguar Manager, set this property using the File menu for the Interfaces folder displayed beneath the component icon.
com.sybase.jaguar.component.local,
com.sybase.jaguar.component.home
When instance pooling is enabled, specifies the maximum pool size.
Specify a positive integer value, or 0 to indicate the pool size has no limit. The default is 0, which means no maximum pool size is in effect.
If the maximum pool size is reached, EAServer destroys excess instances after deactivation. Set this property in Jaguar Manager using the Maximum Pooled Instances field on the Resources tab in the Component Properties dialog box.
com.sybase.jaguar.component.pooling,
com.sybase.jaguar.component.minpool,
com.sybase.jaguar.component.objects
Specifies the maximum wait time for method execution to complete.
wait_time
Where wait_time is the time to wait, in seconds.
If the method does not complete in time, EAServer returns a CORBA::NO_RESOURCE_EXCEPTION to the caller. Network latency between client and server is not included in the measured method execution time. For C++ components running in an external process, the measured time includes interprocess communication latency.
In Jaguar Manager, set this property using the Maximum Wait field on the Resources tab in the Component Properties dialog box.
com.sybase.jaguar.component.timeout,
com.sybase.jaguar.component.tx_timeout,
com.sybase.jaguar.component.cpp.process
Specifies the acknowledgment mode for MDBs that manage their own transactions.
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 |
In Jaguar Manager, set the Acknowledge Mode on the MDB Type tab in the Component Properties dialog box.
Chapter 29, "Using the Message Service," in the EAServer Programmer's Guide.
Specifies whether the MDB is associated with a JMS topic or message queue.
Allowable values are:
| Value | To indicate |
|---|---|
javax.jms.Topic
|
Topic |
javax.jms.Queue
|
Message queue |
In Jaguar Manager, set the Destination Type on the MDB Type tab in the Component Properties dialog box.
For an MDB associated with a message queue, specifies the message selector for a message queue. The message service uses the selector to filter the message that it delivers to the queue.
topic='topicString'
In Jaguar Manager, define the Message Selector on the MDB Type tab in the Component Properties dialog box.
When the MDB is associated with a topic, specifies whether the topic is durable or nondurable.
Allowable values are:
| Value | To indicate |
|---|---|
Durable
|
Durable topic subscriber; guarantees message delivery |
| NonDurable | Nondurable topic subscriber; can receive published messages only while it is connected to EAServer |
In Jaguar Manager, set the Topic Subscription Durability on the MDB Type tab in the Component Properties dialog box.
Chapter 29, "Using the Message Service," in the EAServer Programmer's Guide.
Used to store the component's nondefault method properties.
Undocumented. Use the Method entity type and the com.sybase.jaguar.method.* property names to set and retrieve method properties.
When instance pooling is enabled, specifies the minimum pool size.
Specify a 0 or a positive integer value. The default is 0.
Set this property in Jaguar Manager using the Minimum Pooled Instances field on the Resources tab in the Component Properties dialog box.
com.sybase.jaguar.component.pooling,
com.sybase.jaguar.component.maxpool
Specifies the component model.
Allowable values are:
| Value | To indicate |
|---|---|
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. |
Jaguar Manager sets this property correctly when you change the component type. To view the property, use the All Properties tab in the Component Properties dialog box.
com.sybase.jaguar.component.control,
com.sybase.jaguar.component.model.version,
com.sybase.jaguar.component.type
For an EJB component, specifies the EJB specification version.
Allowable values are "1.0", "1.1", and "2.0". The default is "2.0".
In Jaguar Manager, set this property using the EJB Version control on the General tab in the Component Properties dialog box.
com.sybase.jaguar.component.model,
com.sybase.jaguar.component.type
Specifies the name of the component and the package in which it is installed.
package/component
Where:
In Jaguar Manager, the component name is set when defining a new component and cannot be changed.
Specifies the maximum number of component instances that can exist at once. For a C++ component that runs as an external process, specifies the maximum number of simultaneously running external processes.
n
Where n is a positive integer.
This property specifies the maximum number of instances that can be created at once. If a request arrives when the maximum number of instances exist and are all busy, the request blocks, with blocking time constrained by the com.sybase.jaguar.component.maxwait property.
In Jaguar Manager, set this property in the Maximum Active Instances field on the Resources tab in the Component Properties dialog box.
com.sybase.jaguar.component.cpp.process,
com.sybase.jaguar.component.maxwait,
com.sybase.jaguar.component.maxpool
For PowerBuilder components, the name of the PowerBuilder application that contains the NVO that implements the component.
The name of the PowerBuilder application, as displayed in PowerBuilder.
com.sybase.jaguar.component.pb.class
For PowerBuilder components, specifies the name of the nonvisual object that implements the component's methods.
The name of the PowerBuilder NVO, as displayed in PowerBuilder.
com.sybase.jaguar.component.pb.appname
For versioned PowerBuilder components, contains version cookie data.
The cookie data.
com.sybase.jaguar.component.pb.appname,
com.sybase.jaguar.component.pb.class
For PowerBuilder components, specifies whether the component can be debugged while executing.
true
to enable debugging,
or false
to disable debugging.
The default is false
.
com.sybase.jaguar.component.debug
For PowerBuilder components, specifies library files that are required to run the object.
The list of library files, separated by semicolons. Prefix library names with a dollar sign ($) if they must be included when the component is synchronized or archived. For example:
mylib.pbl;anotherlib.pbl;$utils.pbl
com.sybase.jaguar.component.files,
com.sybase.jaguar.component.pb.appname,
com.sybase.jaguar.component.pb.class
For PowerBuilder components, enables or disables the live editing feature.
true
to enable live editing; false
to
disable. The default is false
.
This property should be set from the PowerBuilder user interface, as the live editing feature depends on corresponding changes to the component's project settings. See the PowerBuilder documentation for more information.
com.sybase.jaguar.component.pb.debug
For PowerBuilder components, specifies the required version of the PowerBuilder virtual machine.
This property is set when deploying from PowerBuilder, and should not be edited in any other way. Components that lack this property setting are run in the version 7.0 VM.
com.sybase.jaguar.component.pb.appname,
com.sybase.jaguar.component.pb.class
Specifies whether component instances are pooled for reuse by multiple client sessions.
true
or false
.
The default is true
.
When this property is true, component instances are always pooled after deactivation. For components that use the JaguarEJB::ServerBean or JaguarCOM::ObjectControl control interfaces, you can also configure pooling by implementing interfaces with a canReuse (ServerBean) or canBePooled (JaguarCOM) method. If you enable the Pooling option in Jaguar Manager, your component is always pooled, and these methods are not called.
In Jaguar Manager, set this property with the Pooling check box on the Instances tab in the Component Properties dialog box.
com.sybase.jaguar.component.control,
com.sybase.jaguar.component.maxpool,
com.sybase.jaguar.component.minpool
For an entity or stateful session component, specifies how persistence is performed.
Allowable values are:
| Value | To indicate |
|---|---|
| component | The implementation manages persistence, via the ejbLoad and ejbStore methods, or ctsLoad and ctsStore. |
| automatic | The server manages persistence with code generated as part of the component skeleton, using mapping properties to map implementation fields to database table columns. |
| generated | A generated class (specified by the com.sybase.jaguar.component.ps.class property) manages persistence. |
| serialize | For Java components only. The component state is serialized and stored in binary form. |
| none | No persistence. |
In Jaguar Manager, set this property using the Persistence Type control on the Persistence tab in the Component Properties dialog box.
Chapter 25, "Managing Persistent Component State," in the EAServer Programmer's Guide.
For entity components, specifies the generated class to handle component persistence when com.sybase.jaguar.component.ps property is "generated."
The Java class name.
In Jaguar Manager, set this property in the Generated Class field on the Persistence tab in the Component Properties dialog box.
com.sybase.jaguar.component.ps
Minimum quality of protection required to access component.
A QOP identifier. "Securing Component Access," in the EAServer Security Administration and Configuration Guide lists allowable QOP values.
In Jaguar Manager, set this property using the All Properties tab in the Component Properties dialog box.
For MDBs associated with a message queue, specifies the name of the message queue.
MyQueue
In Jaguar Manager, specify the Name on the MDB Type tab in the Component Properties dialog box.
"Permanent destinations",
Chapter
29, "Using the Message Service," in the EAServer
Programmer's Guide
For entity components, including EJB entity beans, specifies whether a component can recursively call itself, or participate in an intercomponent call sequence that creates recursion.
true
or false
.
The default is false
.
In Jaguar Manager, set this property with the Reentrant check box on the Instances tab in the Component Properties dialog box.
Specifies whether the component can be refreshed, that is, whether a new implementation can be loaded while the server is running.
true
or false
.
The default is true
.
For Java components, disabling the refresh property causes the component and dependent classes to be loaded by the system class loader rather than being custom-loaded. When refresh is disabled, the BOOTCLASSPATH and CLASSPATH environment variables must specify the locations of component classes and dependent classes. Classes and JAR files that are specified in the com.sybase.jaguar.component.java.classes property must be added to the BOOTCLASSPATH and CLASSPATH environment variables.
For applications with many Java components, disabling refresh is one method to improve server performance by reducing the resource overhead incurred by using a class-loader per component. Another method to improve performance is to define the component's custom class lists at the package, application, or server level.
In Jaguar Manager, set this property using the All Properties tab in the Component Properties dialog box.
com.sybase.jaguar.component.cpp.copy,
com.sybase.jaguar.component.java.classes,
com.sybase.jaguar.package.java.classes,
com.sybase.jaguar.application.java.classes,
com.sybase.jaguar.server.java.classes
Specifies the name of the remote (main) IDL interface. EJB components must have a remote interface, and other component types must have one to support access from EJB clients.
remote
Where remote is the IDL interface name. For example, examples::Query. The remote interface must be one of the interfaces listed in the com.sybase.jaguar.component.interfaces property. For an EJB component, the default is:
package::component
Where package is the EAServer package name, and component is the EAServer package name. For other component types, there is no default.
In Jaguar Manager, set this property using the File menu for the Interfaces folder displayed beneath the component icon.
com.sybase.jaguar.component.home,
com.sybase.jaguar.component.ejb.remote,
com.sybase.jaguar.component.local,
com.sybase.jaguar.component.interfaces
Resource environment references are logical names applied to objects administered by EAServer.
See Resource environment reference properties.
In Jaguar Manager, set this property using the Resource Env Refs tab in the Component Properties dialog box.
Resource environment reference properties.
For EJB components, specifies aliased JNDI names for database connections, JavaMail sessions, and URL factories used by the component.
See Resource reference properties.
In Jaguar Manager, set this property using the Resource Refs tab in the Component Properties dialog box.
Resource reference properties.
For component types other than EJB, specifies roles that a user must belong to invoke the component.
role1, role2, ...
Where role1, role2, and so forth are role names defined in the repository.
In Jaguar Manager, set this property using the File menu for the Roles folder displayed below the component icon.
Roles are attached to EAServer packages, components, and methods. Attaching a role to a package controls access to all non-EJB components in the package. Attaching a role to a component constrains access to all methods in the component's interfaces. Attaching a role to a method constrains access to that method.
For EJB components, configure access control at the method level by setting the method property com.sybase.jaguar.method.security-roles for each method.
com.sybase.jaguar.package.roles,
com.sybase.jaguar.method.roles,
com.sybase.jaguar.method.security-roles
For EJB 1.0 components, specifies an identity name used for intercomponent calls if the com.sybase.jaguar.component.runasmode property is "specified."
id
Where id is the alias name for an identity. The name used must be aliased to an entity that exists in the EAServer repository by setting a com.sybase.jaguar.package.runasidentity.<id> property for the package that contains this component. For example, if the component's run-as identity property is "ejbFoo", create a package property with this name and value:
com.sybase.jaguar.package.runasidentity.ejbFooId=fooId
In Jaguar Manager, set this property using the Run As Identity field on the Run As Mode tab in the Component Properties dialog box.
com.sybase.jaguar.component.runasmode,
com.sybase.jaguar.package.runasidentity.<id>
For EJB 1.0 components, specifies the user identity that is assumed for intercomponent calls.
Allowable values are:
| Value | Description |
|---|---|
| client | Use the client's user name and password. This is the default setting. |
| system | Use the system user name and password. The system account effectively belongs to any role, and can execute any method on any component that is installed in the same server or cluster. |
| specified | Use the user name and password associated with the identity name specified by the com.sybase.jaguar.component.runasidentity property. |
In Jaguar Manager, set this property using the Run As Mode tab in the Component Properties dialog box.
com.sybase.jaguar.component.runasidentity,
com.sybase.jaguar.method.runasmode
For EJB 2.0 components, specifies the run-as identity used for intercomponent calls. If this property is not set, intercomponent calls use the client identity.
(specified=id,role=role-name,desc=desc)
Where:
| 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. |
com.sybase.jaguar.package.runasidentity.<id>,
com.sybase.jaguar.package.security-role.<j2ee-role>,
com.sybase.jaguar.application.security-role.<j2ee-role>,
com.sybase.jaguar.component.runasidentity
For EJB components, maps a role reference specified in the com.sybase.jaguar.component.security-role-refs property to a J2EE role name defined in package or application properties.
com.sybase.jaguar.component.security-role-ref.role-ref=j2ee-role
Where:
Applies to EJB (1.1 or 2.0) components only.
In Jaguar Manager, set this property on the Role Refs tab in the Component Properties dialog box.
com.sybase.jaguar.application.security-roles,
com.sybase.jaguar.package.security-roles
For EJB components, specifies role reference names used within isCallerInRole method invocations in the component implementation.
A comma-separated list of role reference names. For each role reference specified by this property, you must map the role reference to a J2EE role name by setting the corresponding com.sybase.jaguar.component.security-role-ref.<j2ee-role-ref> property.
Applies to EJB (1.1 or 2.0) components only. Role references are required if the component implementation calls the isCallerInRole Java method to programmatically restrict access.
In Jaguar Manager, set this property on the Role Refs tab in the Component Properties dialog box.
com.sybase.jaguar.component.security-role-ref.<j2ee-role-ref>
Specifies whether multiple component instances can be created. A shared component serves all client requests with one instance.
true
or false
.
The default is false
.
When this option is enabled, a single, shared instance of the component services all client requests. A shared component can store data in instance variables. However, if the com.sybase.jaguar.component.thread.safe property is true, you must synchronize access to instance variables.
Sharing setting overrides Pooling setting If both com.sybase.jaguar.component.sharing and com.sybase.jaguar.component.pooling are enabled (true), the sharing property takes precedence.
In Jaguar Manager, set this property using the Sharing check box on the Instances tab in the Component Properties dialog box.
com.sybase.jaguar.component.pooling,
com.sybase.jaguar.component.thread.safe
For entity components or stateful components that use automatic storage, specifies the datatype for the component's state information.
The name of an IDL structure or serializable Java class that stores component state.
In Jaguar Manager, set this property in the State field on the Persistence tab in the Component Properties dialog box.
com.sybase.jaguar.component.ps,
Chapter
25, "Managing Persistent Component State," in
the EAServer Programmer's Guide
For entity components or stateful components that use automatic persistence, specifies component methods that set and retrieve component state.
For EJB entity beans, set the value to "default."
For component types other than EJB entity beans, set the value to:
getMethod, setMethod
Where getMethod is the name of the method
that returns component state information, and setMethod is
the name of the method that receives component state information
and applies it to instance fields. If you specify no value, the
default is getState,setState
.
Your component implementation must contain these methods, but they
should not be listed in the component's client interfaces.
The getState method returns an instance of the
type specified by the State field, and the setState method accepts
a parameter of this type. For example, if the State type is ShoppingCartState,
the getState and setState methods
might be defined as follows in Java:
private ShoppingCartState data;
ShoppingCartState getState()
{
return data;
}
void setState(ShoppingCartState state)
{
data = state;
}
In Jaguar Manager, set this property in the State Methods field on the Persistence tab in the Component Properties dialog box.
com.sybase.jaguar.component.ps,
Chapter
25, "Managing Persistent Component State," in
the EAServer Programmer's Guide.
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.
The value can be one of the following:
binary(16)
. In Jaguar Manager, set this property using the Timestamp field on the Persistence tab in the Component Properties dialog box.
com.sybase.jaguar.component.ps,
com.sybase.jaguar.component.ts.length,
Chapter
25, "Managing Persistent Component State," in
the EAServer Programmer's Guide
For EJB session beans and non-EJB components that use the control interface CtsComponents::ObjectControl, specifies whether the component is stateless, that is, whether an instance should be bound to a client session for its lifetime.
For EJB session beans, this property is set automatically when the component type is set, and must not be changed. For other component types, the option must be set manually.
true
or false
.
The default is false
.
In Jaguar Manager, set this property using the Stateless check box on the Instances tab in the Component Properties window.
com.sybase.jaguar.component.control,
com.sybase.jaguar.component.tx_vote
For entity or stateful session components that use automatic persistence or failover support, specifies the Storage component.
For a stateful session component that uses in-memory state replication, specify:
CtsComponents/HeapStorage
For an entity component or stateful session component that uses persistent (remote database) storage, specify:
storage(cache=cacheName,table=tableName)
Where:
| Storage component name | Detailed description |
|---|---|
| CtsComponents/JdbcStorage | Uses a JDBC connection cache to provide persistent storage of component state. This component has the Requires transaction attribute. The component's state is saved in the context of any existing transaction associated with the component. |
| CtsComponents/JdbcStorageReqNew | A copy of the CtsComponents/JDBCStorage component that has the RequiresNew transaction attribute. The component's state is saved using a separate transaction from that used to manage any database work performed by the component. |
| package/component | A custom storage component. The package
must be installed on all servers where your component is installed.
Customers and partners can implement custom storage components. The component must implement the CtsComponents::Storage interface and must have the Bind Object option enabled on the Instances tab. Due to the thread-safe instance requirement for the Bind Object option, only C++ and Java are suitable for coding storage components. |
In Jaguar Manager, set this property in the Storage Component field on the Persistence tab in the Component Properties dialog box.
com.sybase.jaguar.component.ps,
com.sybase.jaguar.component.state.ts,
Chapter
25, "Managing Persistent Component State," in
the EAServer Programmer's Guide
Tells the server when to call ejbStore.
store
Where store can be one of, or a comma-separated list of more than one of, these values:
| Value | Description |
|---|---|
| afterCreate | The server calls ejbStore after it calls ejbPostCreate. |
| afterInvoke | The server calls ejbStore after it calls each business method. |
| 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. |
The default value is afterCreate,afterInvoke
.
com.sybase.jaguar.component.load
Specifies whether multiple component instances can execute concurrently, or whether a shared component can execute simultaneously on multiple threads. If this option is disabled, the server serializes all invocations of component methods.
true
or false
.
The default is true
.
Enable this option if the component is thread safe.
If the com.sybase.jaguar.component.sharing and com.sybase.jaguar.component.bind.thread properties are both true, the com.sybase.jaguar.component.thread.safe property is implicitly set to false.
In Jaguar Manager, set this property using the Concurrency check box on the Instances tab in the Component Properties dialog box.
com.sybase.jaguar.component.bind.thread,
com.sybase.jaguar.component.sharing
Specifies how long, in seconds, an active component instance can remain idle between method calls before the client's proxy becomes invalid.
time
Where time is the timeout period in seconds. A value of "0" indicates an infinite timeout. The default is specified by the com.sybase.jaguar.server.timeout server property.
If the timeout expires, the instance is automatically deactivated. Instance Timeout is useful for ensuring timely deactivation of stateful components. The setting has no effect for stateless components.
When the timeout period is exceeded, EAServer deactivates the component and invalidates the client's object reference. If the client attempts another method invocation, the client-side ORB throws the CORBA::OBJECT_NOT_EXIST exception. At this point, the client must create a new proxy instance for the component.
When specifying timeouts, a resolution of 5 seconds is recommended.
Network transport time is not included in the measured timeout period. You may need to configure a larger timeout period if clients connect over slow networks.
In Jaguar Manager, set this property using the Instance Timeout field on the Resources tab in the Component Properties dialog box.
com.sybase.jaguar.server.timeout
Applies to entity components that use automatic persistence. Specifies whether the server can use state information cached by the storage component.
true
or false
.
The default is false
.
Setting this property to true can improve performance by avoiding unnecessary database read operations.
com.sybase.jaguar.component.ps
For MDBs associated with a message topic, specifies the name of the topic.
MyTopic
In Jaguar Manager, specify the Name on the MDB Type tab in the Component Properties dialog box.
"Permanent destinations",
Chapter
29, "Using the Message Service," in the EAServer
Programmer's Guide
Enable additional debug tracing for the component.
true
or false
.
The default is false
.
In Jaguar Manager, set this property using the All Properties tab in the Component Properties dialog box.
com.sybase.jaguar.component.debug
Applies to stateful components only. Specifies whether instances can be run on multiple servers in a cluster or survive a server restart.
true
or false
.
The default is true
.
If this option is enabled, the server guarantees that proxy references can only be used within the same server process. For EJB stateful session beans, this property must be enabled for the standard EJB passivation and activation to occur. It must be disabled if you want to configure a stateful session bean to support failover.
In Jaguar Manager, set this property using the Transient check box on the Instances tab in the Component Properties dialog box.
com.sybase.jaguar.component.ps
When com.sybase.jaguar.component.state.ts specifies a column name, this property specifies the datatype and length.
No value indicates the default, 4-byte integer. Specify binary(16)
to
use globally unique 16-byte ID timestamps.
In Jaguar Manager, set this property using the All Properties tab in the Component Properties dialog box.
com.sybase.jaguar.component.ps,
com.sybase.jaguar.component.state.ts,
Chapter
25, "Managing Persistent Component State," in
the EAServer Programmer's Guide.
Specifies whether control interface methods execute in the context of a server-managed transaction.
true
or false
.
The default is true
for EJB
entity beans, and false
for other
component types.
In Jaguar Manager, set this property using the All Properties tab in the Component Properties dialog box.
com.sybase.jaguar.component.control
Determines whether a CORBA::TRANSACTION_ROLLEDBACK exception is thrown to the client when a transaction is rolled back.
The allowable settings are:
| Setting | Description |
|---|---|
| always | The default. EAServer sends a CORBA::TRANSACTION_ROLLEDBACK exception to the client when a transaction is rolled back. |
| failed | EAServer does not send the CORBA::TRANSACTION_ROLLEDBACK exception
to the client when a transaction is rolled back. If you use this
setting, you can code your components to raise a different exception
with a descriptive message after calling the RollbackWork transaction primitive.
With this setting in effect, EAServer may still throw a CORBA system exception if unable to commit a transaction at your component's request. |
Set this property to failed
if
you require that no exceptions are sent to the client for rolled-back
transactions or that an alternate exception is sent. This setting
is useful if you require that the client be able to retrieve output parameters
after a transaction is rolled back: if an exception is thrown, the output
parameters are not available.
In Jaguar Manager, set this property using the All Properties tab in the Component Properties dialog box.
Specifies the maximum duration of an EAServer transaction begun by the component.
The timeout period, in seconds, with 0 indicating no timeout. EAServer determines the transaction timeout period as follows:
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 Jaguar Manager, set this property in the Transaction Timeout field on the Resources tab in the Component Properties dialog box.
com.sybase.jaguar.component.timeout, com.sybase.jaguar.server.tx_timeout
Specifies how methods in your component participate in transactions.
Table 15-2 lists allowable values:
The transaction attribute determines how methods in your component participate in transactions; at the component level, the setting affects all methods. You can also set a transaction attribute for methods within a component using the com.sybase.jaguar.method.tx_type method property. Values set at the method level override the component setting.
com.sybase.jaguar.method.tx_type
Specifies whether the component is automatically deactivated after each method invocation, or deactivated at explicit transaction boundaries. For component types to which it applies, setting this property to true effectively marks the component as stateless.
Applies only to components that use a control interface in which the instance activation and deactivation correspond to transaction boundaries. In other words, the option does not apply to EJB components or any component that uses the control interface CtsComponents::ObjectControl.
Allowable values are true
and false
.
The default for new components is true
.
In Jaguar 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 provides similar behavior.
com.sybase.jaguar.component.control,
com.sybase.jaguar.component.stateless
Specifies the component type.
type
Where type is one of:
| Type value | To indicate |
|---|---|
com
|
ActiveX/COM |
cpp
|
C++, using CORBA C++ language bindings |
cs
|
C (using Open Client/Server CS datatypes) |
ejb
|
An Enterprise Java bean (EJB) component, conforming to the EJB version indicated by the com.sybase.jaguar.component.model.version property |
java
|
A CORBA/Java component, using CORBA Java language bindings |
jdbc
|
A Java component using JDBC datatypes for parameters and return values |
pb
|
A PowerBuilder component |
| library | A component run by the specified dispatcher library |
In Jaguar Manager, set this property using the Component Type field on the General tab in the Component Properties dialog box.
Specifies a text description of the component.
desc
Where desc is the descriptive text.
In Jaguar Manager, set this property using the Description field on the General tab of the Component Properties dialog box.
| Copyright © 2002 Sybase, Inc. All rights reserved. |
| |