htservlet(1M)

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | EXAMPLES | EXIT STATUS | ATTRIBUTES | FILES | SEE ALSO | NOTES

NAME

htservlet- Configures the behavior of a servlet engine.

SYNOPSIS

htservlet add [-a init_args] [-b codebase] -c classname -h hostname -i instance -n servlet_name [-p] [-s] -u username [-v]
htservlet delete -h hostname -i instance -n servlet_name [-p] -u username [-v]
htservlet disable -g option [-h hostname] -i instance [-p] -u username [-v]
htservlet enable -g option [-h hostname] -i instance [-p] -u username [-v]
htservlet help
htservlet list -h hostname -i instance [-v]
htservlet load -h hostname -i instance -n servlet_name [-p] -u username [-v]
htservlet log [-f prefix] [-h hostname] -i instance [-m max_num_files] [-p] [-t cycle_time] -u username [-v] [-z file_size]
htservlet reload [-a init_args] -h hostname -i instance -n servlet_name [-p] -u username [-v]
htservlet query -h hostname -i instance [-v]
htservlet security [-h hostname] -i instance [-o permission] [-p] [-r resource] -u username [-v]
htservlet settings [-d servlet_path] [-h hostname] -i instance [-j server_classpath] [-P properties_file] [-p] -u username [-v]
htservlet unload -h hostname -i instance -n servlet_name [-p] -u username [-v]
htservlet version

DESCRIPTION

A servlet engine can be defined on any Sun WebServer server instance or any individual web site. The servlet engine runs a Java^TM virtual machine that loads and executes servlets defined in its servlets.properties file.

The htservlet command defines and modifies servlet engine run time, security, and logging properties; adds or removes entries in the servlets.properties file; and loads or unloads servlets in running servlet engines.

When -h hostname is omitted, the subcommand applies to the shared servlet engine (server-wide setting).

OPTIONS

Subcommands

The following subcommands are supported:

---

Note -

You must restart the server in order for the changes made to the configuration files to take effect.

---

add

Adds a servlet to the servlets.properties file. Adding a servlet does not imply that the servlet is automatically loaded.

delete

Deletes a servlet from the servlet engine and writes changes to the servlets.properties file.

disable

Disables an option on the servlet engine and writes changes to the configuration file.

enable

Enables an option on the servlet engine and writes changes to the configuration file.

help

Displays help on usage.

list

Lists all loaded servlets on the server.

load

Loads a servlet from the servlets.properties file on a running server.

log

Configures the log location and cycling parameters and writes changes to the configuration file.

query

Returns current servlet engine settings on a running server.

reload

Reloads a servlet on a running server.

security

Configures the security settings for the servlet engine and writes changes to the configuration file.

settings

Specifies the settings on the servlet engine and writes changes to the configuration file.

unload

Unloads a servlet from the running web server.

version

Displays the version of htservlet.

Options

The following options are supported:

-a init_args

Specifies the optional initial arguments passed to the servlet. Used in the format name=value [[, name=value...]]. Valid with the add and reload subcommands.

-b codebase

Specifies the URL of the servlet's code base. This URL can be pointing to a directory or a jar file. Used only for remote servlets. Valid with the add subcommand.

-c classname

Specifies the name of the servlet main class file. Valid with the add subcommand.

-d servlet_path

Specifies the directories and jar files for the servlet engine on the local machine. This is a colon-separated list. This option can only prepend the path specified to the original path in the file. Valid with the settings subcommand.

-f prefix

The path name and the file prefix for servlet log files. As new log files are created, they use this prefix and a number suffix. Valid with the log subcommand.

-g option

Specifies a servlet engine option to enable or disable. Valid options are:

chain

Enables or disables servlet chaining. Servlet chains are a sequence of servlets executed in the specified order to fulfill one single servlet request.

jvm

Enables or disables the server to enable a jvm. This is a server-wide setting.

log

Enables or disables servlet error logging.

remote

Enables or disables loading servlets from remote sites in this servlet engine.

se

Enables or disables the servlet engine for server process or web site.

share

Allows all sites on the server to share a single servlet engine. This is a server-wide setting. If this option is disabled, each site is allowed to create its own servlet engine instance.

-h hostname

Specifies the name of the virtual host. Valid with all subcommands.

-i instance

The name of the server instance. Valid with all subcommands.

-j server_classpath

Specifies the class path for the jvm which may include the location of classes.zip file of JDK, JSDK, and the servlet engine. This is a colon separated list (for example, usr/lib/java/ [[:/usr/java/lib...]]). This command only prepends to the existing path. It is a server-level setting. Valid with the settings subcommand.

---

Note -

Do not put the servlets directories in the server classpath.

---

-m max_num_files

Specifies the maximum number of log files. When the log suffix exceeds this number, the next log file is created overwrites the first log file. The default number is 7 files. Valid with the log subcommand.

-n servlet_name

Specifies the name of the servlet. Valid with the add, delete, load, reload, and unload subcommands.

-o permission

Specifies the access settings used in conjunction with the -r option. Valid with the security subcommand.

all

Allows local and remote servlets to access resources.

local

Allows access only to resources on the same host.

none

Allows no access.

remote

Allows access only to resources on servlets with a code base.

-P properties_file

Specifies the full path to the properties file for the servlet engine. Valid with the settings subcommand.

-p

Disables password prompting, and password is piped ("|") to the command. Valid with the add, delete, disable, enable, load, log, reload, unload, security, and settings subcommands.

-r resource

Specifies the resource settings used in conjunction with the -o option for access control. Valid with the security subcommand.

file

Sets access permissions for file resources such as read/write a file on local disk.

link

Sets access permissions for links to dynamic libraries.

network

Sets access permissions for network resources.

security

Sets access permissions for security resources such as classLoaders.

system

Sets access permissions for system resources such as System.Exec ().

-s

Indicates that the servlet will be loaded at startup. Valid with the add subcommand.

-t cycle_time

The log cycle time measured in minutes. When the log cycle time exceeds this number, a new log file is created with an incremented suffix. The default time is 1440 minutes (1 day). Valid with the log subcommand.

-u username

Specifies user name. Valid with the add, delete, disable, enable, load, log, reload, unload, security, and settings subcommands.

-v

Specifies verbose mode for more detailed messages. Valid with all subcommands.

-z file_size

Specifies the maximum log file size measured in bytes. When the log file size exceeds this number of bytes, a new log file is created with an incremented suffix. The default file size is 1048576 bytes (1 MB). Valid with the log subcommand.

EXAMPLES

---

Example 1




To enable servlets on a server:

# htservlet enable -g jvm -i sws_server -u admin

---

---

Example 2




To load a declared servlets on a server:

# htservlet load -i sws_server -h www.A.com -n foo -u http

---

---

Example 3




To add servlets to be loaded at startup:

# htservlet add -i sws_server -h www.A.com -n foo \\
-c FooServlet -b http://x.eng/ -a counter=1 -s \\
-u http

---

---

Example 4




To add a servlet declaration (in verbose mode):

# htservlet add -i sws_server -h www.A.com -n foo \\
-c FooServlet -b http://x.eng/ -a counter=1 -v \\
-u http

---

---

Example 5




To set the server classpath:

# htservlet settings -i sws_server -j /usr/jdk/lib/classes/zip:. \\
-u http

---

EXIT STATUS

The following exit values are returned:

0

Successful completion.

>0

An error occurred.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE	ATTRIBUTE VALUE
Availability	SUNWhtsvl
Interface Stability	Evolving

FILES

The following files are used by this utility:

site_path/conf/site_name.httpd.conf

Contains the web site servlet engine configuration if the servlet engine is not shared.

/etc/http/httpd.conf

Contains the server instance servlet engine configuration if all web sites share the servlet engine.

site_path/conf/servlets.properties

Defines each servlet that can be loaded by a web site.

SEE ALSO

httpd.conf(4), httpd.site.conf(4), servlets.properties(4)

NOTES

If the command is run by root user, then the username and password of an administrator are not required.

Users other than root must use the -z option and pass the user name and password of a valid administrator to the command.

Sun WebServer 2.0  Last Revised 17 July 1998

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | EXAMPLES | EXIT STATUS | ATTRIBUTES | FILES | SEE ALSO | NOTES