Accessing component properties
ContextKeyword service object
You can use the ContextKeyword service object to get component
property values. To retrieve property values, you call the GetContextKeywords function.
Before you can use the ContextKeyword service object, you
need to create a reference to the object by calling the GetContextService
function, using Keyword as the service name.
Jaguar properties for PowerBuilder
This table lists component properties that pertain to PowerBuilder
custom class user objects running as Jaguar components. Component
properties are prefixed with the string com.sybase.jaguar.component.
The values of all component properties are displayed on the All
Properties tab of the Component Properties dialog box in Jaguar
Manager. Some properties also map to items on other tabs in this
dialog box as shown in the table:
| Property | Description | Where displayed | ||
|---|---|---|---|---|
| bind.thread | Indicates whether the component instance must always be invoked on the creating thread. Valid values are true and false. This property must be set to true for a PowerBuilder component that maintains state for a DataStore across method calls |
Instances (Bind Thread option) | ||
| interfaces | Identifies the interfaces that the component implements. This is a comma-separated list of IDL interface names, each of which takes the form module::interface |
General | ||
| name | Specifies the name of the component. The value must take the form package/component |
General (component part only) | ||
| pb.appname | Specifies the name of the PowerBuilder application | General | ||
| pb.class | Specifies the name of the PowerBuilder custom class user object |
General | ||
| pb.cookie | Provides a number used to construct the path for the library list. The path takes this form:
|
All Properties | ||
| pb.isdebuggable | Indicates whether you can debug the component in the PowerBuilder debugger |
All Properties | ||
| pb.librarylist | Specifies the PowerBuilder library list. When a library name has a prepended dollar sign ($), Jaguar assumes that its location is relative to the Jaguar Repository directory. When a library name does not have a prepended dollar sign, Jaguar assumes the name specifies an absolute path |
General | ||
| pb.trace | Specifies trace options for logging activity against the component |
All Properties | ||
| pooling | Indicates whether the component is pooled. When the pooling property is set to true, the component is always pooled and the CanBePooled event is never triggered. When the pooling property is set to false, the CanBePooled event is triggered, allowing to selectively refuse poolingIf the tx_vote property is set to false, the component is pooled after each method; otherwise, it is pooled at the end of the transaction |
Instances | ||
| sharing | Indicates whether this is a shared component. When the sharing property is set to true, all clients share a single component instance. Pooling options do not apply to shared componentsTo make a shared component a service, you need to add it to the list of services specified for the com.jaguar.server.services property |
Instances | ||
| thread.safe | Indicates whether multiple invocations can be processed simultaneously. This property should be set to true unless only one instance of the component can be active at any point in time. Because PowerBuilder is not limited to a single instance, this option should be set to true |
Instances (Concurrency option) | ||
| timeout | Specifies how long an active component instance can remain idle between method calls before being automatically deactivated |
All Properties | ||
| tx_timeout | Specifies the maximum duration of a Jaguar transaction. Jaguar checks for timeouts after each method returns |
All Properties | ||
| tx_type | Indicates whether the component will participate in Jaguar transactions and in what way. Valid values are not_supported, supports, requires, and requires_new |
Transactions | ||
| tx_vote | Indicates whether the component will support automatic demarcation and deactivationWhen tx_vote is set to true, the component must control transaction state and component deactivation by explicitly calling methods of the TransactionServer service objectWhen tx_vote is set to false, Jaguar automatically deactivates the component after each method invocation. You do not need to make explicit calls to SetComplete to cause deactivation because SetComplete is assumed by default. To override the default state, you can call SetAbort |
Transactions (when the Automatic Demarcation/ Deactivation checkbox is checked the value of this property is False) |
||
| type | Specifies the type of component. For PowerBuilder 7 objects, Jaguar sets this property is set to pbTo allow you to deploy components that work with different versions of the PowerBuilder virtual machine, Jaguar will allow you to specify the name of the DLL that supports the virtual machine you want to work with as the component type. For example, for PowerBuilder 7 objects you could specify pbjag70 (instead of pb) as the component type |
General |
The following table lists server properties that pertain to
PowerBuilder custom class user objects running as Jaguar components.
Server properties are prefixed with the string com.sybase.jaguar.server.
The values of all server properties are displayed on the All Properties
tab of the Server Properties dialog box in Jaguar Manager. Some
properties also map to items in the user interface as shown in the
table:
| Property | Description | Where displayed |
|---|---|---|
| packages | Lists the packages deployed on the server | Same as list displayed in the server’s Packages folder |
| services | Provides a comma-separated list of service components that should start up automatically with the server |
All Properties tab, Server Properties dialog box |