
Chapter 1 Jaguar Configuration
Configuring a Jaguar server
To configure
or modify the properties of an individual Jaguar server:
- From within Jaguar Manager,
display the list of installed servers by double-clicking the Servers
folder.
- Highlight the server you want to configure.
- Select File | Server Properties. You see
the Server Properties window, which contains these tabs:
- General - define general individual server
properties.
- HTTP Config - determine
browser accessibility.
- Transactions - determine
the transaction coordinator for components that participate in Jaguar
transactions.
- Security - see "Administration password and
OS authentication" for security options accessible
from this tab.
- Resources - define
the maximum number of client connections.
- Log/Trace - set
logging and trace options.
- Handlers - define
individual server event handlers.
- Naming Service - set
the Jaguar server's naming service options. See Chapter 2, "Jaguar Naming Services" for additional information about
naming services.
- Servlets - disable
servlet execution in Jaguar and configure additional properties
to control the execution of servlets.
- Java VM - set
the version of the Java virtual machine.
- Dynamo - enable
hosting of PowerDynamo Web sites in Jaguar.
- Hot standby - Enable
hot standby and define the Master and backup servers.
-
All Properties - edit server property settings
in their raw format, that is, as they are stored in the configuration
repository.
If you modify any property, click OK in the Server Properties
sheet to save your changes, or click Cancel to disregard the changes.
When
you modify server properties you must refresh the server for the
changes to take effect. To refresh the server, highlight the server
icon and select File | Refresh.
General
Table 1-1 describes
the general properties that you can configure for individual servers.
Table 1-1: Server general properties
Property
|
Description
|
Comments
|
Description
|
Enter a description of the
server, up to 255 characters in length.
|
|
Codeset
|
Specify the character set
used by the server.
|
By default, the server uses iso_1.
|
Classpath
|
Displays the contents of
the CLASSPATH environment variable for the server that you are connected
to. This setting specifies the directories from which Java class
files can be loaded. It is defined by the start-up script when you
start the server.
The CLASSPATH does not display for servers that you are not
connected to.
|
This setting is read-only and helpful
for debugging various errors. To change the value, you must reset the
environment variable and restart the server.
|
HTTP Config
Clients can access
Jaguar and retrieve HTML pages using a Web browser. You can customize
certain aspects of your server's HTTP behavior by modifying the
HTTP configuration properties listed in Table 1-2.
Table 1-2: HTTP properties
Property
|
Description
|
Default value
|
Comments/example
|
Description
|
A description of this HTTP configuration.
|
N/A
|
The description can be up to 255 characters.
|
Domain Name
|
Domain name in .company.xxx format.
|
N/A
|
.sybase.com
|
Document Root
|
The path to the directory where
documents are served.
|
$JAGUAR/html (UNIX)
%JAGUAR%\html (NT)
|
/work/WWW/
C:\work\WWW\
|
Default HTML File
|
The default HTML file served.
|
index.html
|
/work/WWW/index.html (UNIX)
C:\work\WWW\index.html (NT)
|
Maximum Threads
|
The maximum number of threads
allocated for HTTP requests.
WARNING! | If you increase this value, you must also increase
the maximum number of threads on the Resources tab. See "Resources" for more information.
|
|
25
|
The maximum thread setting allows you
to balance memory resources. A maximum value set too high needlessly
uses memory resources. Monitor the total number of hits listed in
the httpstat.dat file for indications of a
heavily loaded server. Adjust the maximum thread setting as necessary.
|
Log Directory
|
The directory where the httprequest.log and httpstat.dat files
are stored.
|
|
See "HTTP logging and
statistics" for information about these log files.
|
Log File Size
|
The size, in bytes, to which the
log file grows before it is truncated.
|
Unlimited. If you do not
enter a value, log size is unlimited.
|
|
Truncate Log on Startup
|
When this flag is set, the
log truncates every time the server is restarted.
|
The default is not to truncate
on start-up.
|
Keep in mind that if the server crashes and
this flag is set, you will lose the log file and the information
it contains.
|
HTTP logging and statistics
Jaguar maintains two files that allow you to monitor HTTP
events.
Request log information
is recorded in httprequest.log. HTTP statistics are logged
in the file httpstat.dat. Both files are located
by default in the Jaguar bin subdirectory (or devbin if
you are running the debug server version).
The request log records information about each HTTP request.
If you define additional servers, the name of the httprequest.log file
is prepended with the server name. For example, if you create a
server named Test_server, messages for that server are
directed to the Test_serverhttprequest.log file.
The statistics log records the total number of hits on the
server and the total number of hits per page.
For information on viewing these files, see "File Viewer".
Transactions
This section describes the transaction coordinator models
that are available. All components installed in one Jaguar server
share the same transaction coordinator.
Jaguar transaction coordinator models are:
To set the transaction coordinator for your Jaguar server,
select the transaction model from the server's Transactions
tab in the Server Properties window.
For detailed information about components and transactions,
see Chapter 3, "Understanding Transactions and Component
Lifecycles" in the Jaguar CTS Programmer's
Guide.
Resources
The Resources tab allows you to limit the number of concurrent
client sessions and contains configurable properties used by Open
Server applications. Table 1-3 describes the server resource properties.
Table 1-3: Server
resource properties
Property
|
Description
|
Default
|
Maximum Number Client Sessions
|
The maximum number of concurrent client
sessions supported by Jaguar.
This does not include HTTP sessions, which are controlled
by the maximum thread property described in "HTTP Config".
Modify this variable as needed to balance system resources
versus session availability.
WARNING! | If you increase this value, you must also increase
the maximum number of threads.
|
|
30
|
Thread Stack Size (Available
on UNIX platforms only)
|
The stack size for server
threads, specified in bytes as a decimal number.
|
See Configuring server stack
size for information on setting this
property.
|
Message Pool Size The
Open Server property SRV_S_MSGPOOL
|
The number of messages available
to an Open Server application at runtime.
|
These properties are for
Open Server applications. See your Open Server documentation for additional information.
|
Message Queue Size The
Open Server property SRV_S_NUMMSGQUEUES
|
The number of message queues
available to an Open Server application.
|
Network Buffer Size The
Open Server property SRV_S_NETBUFSIZE
|
The maximum size of the
network I/O buffer to be used by client connections.
|
Maximum Number Threads
|
The maximum number of connection threads,
including HTTP and IIOP connections. Set this value equal to, or greater
than, the sum of the maximum number of HTTP connections and the maximum
number of client sessions. See "HTTP Config" for information on the HTTP connections value.
|
50
|
Log/Trace
Tracing provides information about activities carried out
by your application. Trace output is sent to the Jaguar log file.
To establish the level of detail for logging and tracing, select
the Log/Trace tab. Table 1-4 describes the logging and trace properties.
For information on viewing the log file, see "File Viewer".
Table 1-4: Debug/Trace properties
Property
|
Description
|
Log
File Name
|
The
name of the Jaguar log file. This file defaults to srv.log in the
Jaguar bin subdirectory. The srv.log logs
a wide range of information and is helpful in isolating problems.
You can create the log file in an alternate directory by prefixing
a full path to the file name you enter. If you do not enter a full
path, the file is created in the Jaguar bin subdirectory.
You cannot use environment variables when specifying a full path.
|
Log
File Size (Bytes)
|
The size, in bytes, to which the log
file grows before it is truncated.
|
Truncate
Log on Startup
|
When this flag is set, the log truncates
every time the server is restarted. Keep in mind that if the server
crashes and this flag is set, you will lose the log file and the
information it contains.
|
Trace Attentions
|
If set, traces attentions received or
acknowledged by Jaguar.
|
Trace Network Driver APIs
|
If set, traces Net-Lib driver requests.
|
Trace Network Driver Requests
|
If set, traces network layer protocol
requests.
|
Trace Protocol Data
|
If set, traces TDS packet content (the
actual TDS traffic between a client and Jaguar) in hexadecimal and
ASCII format.
|
Protocol Headers
|
If set, traces TDS protocol packet header
information, such as packet type and length.
|
Trace Servlets
|
If set, traces the execution of Jaguar's
servlet execution engine.
|
Handlers
Jaguar supports event-based programming in addition to component-based programming.
In the event-based programming model, the application programmer
creates custom event handlers that extend the way Jaguar responds
to a variety of events. Some of these events are triggered by client requests,
while others originate in Jaguar.
For example, if you have coded a connect event handler, here
is what happens:
- The client
sends a request to connect to Jaguar.
- Jaguar receives the request, which generates a connect
event.
- Jaguar executes the connect event handler code.
To specify an event handler:
-
Select the Handlers tab.
-
Enter the DLL or shared library name and the function
name of the specific event handler being called, separated by a
colon.
The following example illustrates an entry for a connect event
handler:
Platform
|
Entry
|
Solaris, AIX, Digital UNIX, and LINUX
|
libsamp.so:debug_connect
|
HP-UX
|
libsamp.sl:debug_connect
|
NT
|
libsamp.dll:debug_connect
|
where libsamp is the DLL or shared library
name and debug_connect is the function
called whenever a connect event handler is called.
Table 1-5 summarizes
the types of event handlers that you can install. For information
on coding event handlers, see the Jaguar CTS Programmer's Guide.
Table 1-5: Individual server event handlers
Event handler
|
Called
|
Connect
|
Each time a client connects to Jaguar.
|
Disconnect
|
When the client disconnects from Jaguar.
|
Error
|
When a Jaguar server processing error
occurs.
|
Initialization
|
Before starting Jaguar.
|
Start
|
When a request to start the Jaguar server
is made.
|
Stop
|
When a request to stop the Jaguar server
is made.
|
Language
|
When a client sends a language request,
such as a SQL statement.
|
RPC
|
When a client issues a remote procedure
call.
|
Attention
|
When an attention has been received.
An attention is an immediate event; Jaguar services the attention
as soon as it occurs, rather than adding it to the client's
event queue.
|
Cursor
|
When a client sends a cursor request.
|
Dynamic
|
When a client sends a dynamic SQL request.
|
Message
|
When the client sends a message.
|
Option
|
When a client sends an option command.
|
Bulk
|
When a client issues a bulk copy request.
|
Naming Service
Select the Naming Service tab on the Server Properties window
to set the Jaguar server's naming service options. You
can use this property sheet to configure a Jaguar server to be a
name server, or to point to another Jaguar server as its name server.
You can also set the bindpassword server
property to enable password protection for name binding on a Jaguar
name server. For more information, see "Name binding
password security".
For general information about naming services, see Chapter 2, "Jaguar Naming Services".
Initial
Context
- enter the Jaguar server's
default name context. The name server binds any object implementations
on the server to the server's initial name context.
If you use a Jaguar server as a name server, the name context
can be a compound name with each organization level separated with
a forward slash ("/"); for example, /us/sybase/finance.
If you use an external LDAP server to provide persistent storage,
the initial context must match the schema used by the LDAP server.
For example, c=us,o=sybase,ou=finance.
Naming server options
Use these options to specify whether the Jaguar server is
also a name server, or whether it uses another Jaguar server as
its name server.
- Click Enable as a Name Server
to configure the Jaguar server as a name server. If you select this
option, you can then also set the Name Server Strategy options described
below.
- If the Jaguar server uses another Jaguar server
as its name server, unselect Enable as a Name Server. Enter the
URL for the Jaguar server acting as the name server; for example, iiop://localhost:9000.
Naming server strategy
If you enabled the Jaguar server to be a name server, indicate
whether the server provides transient or persistent object name
storage. By itself, a Jaguar name server provides transient storage.
However, you can add persistent storage capabilities to Jaguar by
using an external naming service, such as an LDAP name server.
If you enable persistent storage, enter the following information:
- The URL of the LDAP name server
- A manager DN (distinguished name) for the LDAP server
- The manager DN password
The manager DN provides exclusive access to all objects in
the LDAP server database in order to bind and update the objects
on the name server. The manager DN and its password are part of
the LDAP server configuration properties, set by the server administrator.
See your LDAP server documentation for complete information.
Servlets
On the Servlet tab in the Server Properties window, you can
disable servlet execution in a Jaguar server and configure additional
properties to control the execution of servlets.
See Chapter 23, "Creating Java Servlets" in
the Jaguar CTS Programmer's Guide for
complete information about developing and configuring servlets.
Java VM
You can choose from several Java virtual machines (VMs) to
run with your Jaguar server.
To support multiple Java VMs, a batch file for each supported
Java VM ships with your Jaguar installation. For information on
running Jaguar with the various Java VMs see Jaguar CTS
Getting Started.
You can also set the JAGUAR_JAVAVM variable in Jaguar
Manager. This variable is referenced only when starting a Jaguar
server to determine which Java VM runs with Jaguar and is ignored
if you run one of the batch files listed in Table 1-6 since those files
already have a JAGUAR_JAVAVM variable set. If you start
a Jaguar server with a batch file that does not have the JAGUAR_JAVAVM
variable set then this setting determines which Java VM runs with
Jaguar.
To set the JAGUAR_JAVAVM variable from Jaguar Manager:
- Highlight the server
for which you are setting the Java VM.
- Select File | Server Properties.
- Select the Java VM tab.
- To change from the default of Java Software JDK
1.1.x, where x is the latest
supported version, select the Java VM you want and click OK.
To see which Java VM your Jaguar server is currently using,
view the com.sybase.jaguar.server.java.library
property
from the All Properties tab.
Table 1-6: Java VM options
Java VM
|
JAGUAR_JAVAVM
|
Batch file
|
Java Software JDK 1.1.x (The
default JDK included with Jaguar)
|
jdk11x
|
serverstart.bat (NT) srvstart (UNIX)
|
Java Software JDK 1.2
|
jdk12
|
serverstart_jdk12.bat (NT) srvstart_jdk12 (UNIX)
|
Microsoft SDK 3.2
|
msvm
|
serverstart_msvm.bat (NT)
|
Dynamo
This section discusses how to configure Jaguar to host your
Dynamo Web sites and provide access to those sites from a browser.
Access to Dynamo Web sites is disabled by default.
To host Dynamo Web sites in Jaguar:
-
Install Dynamo version 3.6 or greater and Jaguar
3.6 or greater on your NT or UNIX machine.
-
Update your Jaguar server's environment to
include Dynamo DLL and class files. Depending on your platform,
perform the following:
On NT, depending on the virtual machine you are using, modify
the %JAGUAR%\bin\serverstart.bat file
(JDK 1.1.x VM), %JAGUAR%\bin\serverstart_jdk12.bat file
(JDK 1.2), or %JAGUAR%\bin\serverstart_msvm.bat file
(Microsoft SDK 3.2):
- Add %PDYNAMO%\win32 to
your PATH.
- Add %PDYNAMO%\class03 to
your CLASSPATH.
where %PDYNAMO% is
the root of your Dynamo installation. You do not need to define
a %PDYNAMO% environment variable.
On UNIX, modify your $JAGUAR/bin/SETUP.sh (Bourne
shell) or $JAGUAR/bin/SETUP.csh (C
shell) file:
- Define a PDYNAMO environment variable
and set it to the root of your Dynamo installation. This environment
variable is required on UNIX machines.
- Define a JAGUARCLASSES environment variable and
set it to your Jaguar client zip file, $JAGUAR/client/jagclient.zip.
- Add $PDYNAMO/lib to
your LD_LIBRARY_PATH.
- Add $PDYNAMO/class03 to
your CLASSPATH.
Source these files.
-
Start your Jaguar server and connect to it from Jaguar
Manager. To enable Dynamo support:
- From Jaguar Manager,
open the Servers folder.
- Highlight the Jaguar server.
- Select File | Server Properties.
- Select the Dynamo tab.
- Click Enable Dynamo Execution.
- If you have both a Dynamo mapping and a servlet
alias with the same URL, select Dynamo or Servlets from the Priority
of Jaguar HTTP Services list. This determines whether the Dynamo
Web site or servlet is served to the client.
- Click OK.
Configure your machine so that your Web sites can connect
to and retrieve information from databases that they use. For example,
on NT, if you load a Web site that accesses data from a SQL Anywhere
database, you must include the SQL Anywhere DLLs in your PATH and
set up the ODBC data source properly. See your database software
instructions and the PowerDynamo User's Guide for
detailed information.
WARNING! | If you have a Netscape Web server installed on your
machine, Dynamo loads a Netscape version of ns-httpd30.dll instead
of a Jaguar version of the same DLL. Rename (but do not delete)
Netscape's version of this DLL so that Dynamo loads the
Jaguar version instead.
|
You can now access a Dynamo Web site by entering Jaguar's
HTTP address followed by a Dynamo Web site into your browser. For
example:
http://jaguar_server_host:8080/mapped_url_name/file_name
Connects your browser to:
- Jaguar's HTTP port 8080 on
the host machine identified by jaguar_server_host.
- The mapped_url_name is
the mapping you supply for a Dynamo Web site in the PowerDynamo | Utilities | Configuration | Mappings
folder.
- file_name is the file
you are accessing from the mapped Dynamo Web site.
Hot standby
If you have two Jaguar servers, you can enable hot standby
which allows you to designate one of the servers as a backup server
that accepts client connection requests in case the master server
fails. The master server processes client requests. The backup server
starts in "Admin" mode and does not accept client requests.
If the master server fails or is unreachable, the backup server
sets itself to "Ready" mode and accepts client
requests. Once the master server is up and accepting requests, the
backup server enters "Admin" mode, refusing connections
from clients.
See also
Chapter 4, "Load Balancing, Failover,
and Component Availability"for information
about component failover.
To enable hot standby in Jaguar:
-
You must first enable the
two hot standby servers as name servers. Select the Naming Service
tab and click Enable as a Name Server to configure the Jaguar server
as a name server.
-
Select the Hot Standby tab and click the Enable Hot
Standby check box.
-
Enter the Master Server URL using the format iiop://hostname:port.
For example, iiop://Jaguar_master:9095.
-
Enter the Backup Server URL using the format iiop://hostname:port.
For example, iiop://Jaguar_backup:10000.
The master and backup servers must be valid IIOP or IIOPS
URLs. You can have only one master and one backup server defined
and one of them, but not both, must be defined on the local server.
-
Synchronize the servers using the master as the primary
server. See Synchronization in Chapter 3, "Jaguar Clusters and Synchronization"
You can verify the settings of hot standby by checking these
properties on the All Properties tab:
com.sybase.jaguar.server.CosNaming.nameserver
must
be set to true for both the master and backup servers.
com.sybase.jaguar.server.hotstandby
is
set to true if hot standby is enabled.
com.sybase.jaguar.server.hotstandby.master
is
the URL of the hot standby master server.
com.sybase.jaguar.server.hotstandby.backup
is
the URL of the hot standby backup server.
Licensing requirements
Hot standby requires two server deployment licenses, or a
separately priced hot-standby license. Please contact your Sybase
sales representative for hot-standby licensing and pricing details.
All Properties
For advanced users only. Select this tab to edit server property
settings in the Jaguar configuration repository. Properties are
listed in the generated HTML documentation for the Jaguar::Repository IDL
interface, in the description of the define method.
You can use this tab to edit any property prefixed with "com.sybase.jaguar.server".
Most server properties can be configured on other tabs in the Server
Properties dialog box, except the following:
- com.sybase.jaguar.server.authservice The name of a custom component that authenticates IIOP user
connections. See the Jaguar CTS Programmer's
Guide for information on coding a custom authentication service
component. The default is empty, which means the server's
built in authentication features are used.
- com.sybase.jaguar.server.authorization.service The name of a custom component that authorizes user access
to components and HTTP URLs. See Chapter 35, "Role and
Authorization Service Components" in the Jaguar
CTS Programmer's Guide for information on coding
a custom authorization service component.
- com.sybase.jaguar.server.authorization.permcachetimeout The length of time, in seconds, that the server can cache
authorization data for a user's access to a resource. The
default is 7200 seconds, which is equivalent to 2 hours.
- com.sybase.jaguar.server.bindrefresh Must be set to "start" to allow service
components to perform intercomponent calls in their start method. The
default is "run", which indicates intercomponent
calls cannot be made until the service's run method
executes. See Chapter 33, "Creating Service Components" in
the Jaguar CTS Programmer's Guide for
more information.
- com.sybase.jaguar.server.http.force.close If you are debugging proxy configurations, you can set this
property to true to close the HTTP-tunnelled connection after sending
a response to each IIOP request. The default is false; setting it
to true degrades server performance, and we suggest that you use
it only for debugging purposes.
- com.sybase.jaguar.server.masp.zero-success Configures the return codes from MASP method executions. A
value of false, the default, specifies that method invocations return
1 for success and 0 for error. A value of true indicates that the
meanings of 0 and 1 are reversed. See Appendix A1, "Executing
Methods as Stored Procedures" in the Jaguar CTS
Programmer's Guide for more information on MASP.
- com.sybase.jaguar.server.roleservice The name of a custom component that evaluates user's
role membership to control access to components and HTTP URLs. See
Chapter 35, "Role and Authorization Service Components" in
the Jaguar CTS Programmer's Guide for information
on coding a custom authorization service component.
- com.sybase.jaguar.server.services A list of components that run as service components in the
server. See Chapter 33, "Creating Service Components" in
the Jaguar CTS Programmer's Guide for
more information.
- com.sybase.jaguar.server.timeout Specifies the default instance timeout for stateful components
running in the server. See Chapter 5, "Defining Components" in
the Jaguar CTS Programmer's Guide for
more information.
- com.sybase.jaguar.server.tx_timeout Specifies the default transaction timeout for components running
in the server. See Chapter 5, "Defining Components" in
the Jaguar CTS Programmer's Guide for
more information.
Copyright © 2000 Sybase, Inc. All rights reserved.
|
|