Sun Java System Application Server Platform Edition 8.1 2005Q2 Update 2 Reference Manual

## create-http-listener(1)

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | OPERANDS | EXAMPLES | EXIT STATUS | SEE ALSO

#### NAME

create-http-listener– adds a new HTTP listener socket

#### SYNOPSIS

`create-http-listener` ––user admin_user [––passwordfile filename] [––host host_name] [––port port_number] [––secure|`–s`] [––terse=false] [––echo=false] [––interactive=true] [––help] [––target server] ––listeneraddress address ––listenerport listener_port ––defaultvs virtual_server ––servername server_name [––acceptorthreads 1] [––securityenabled=false] [––redirectport redirect_port] [––xpowered=true] [––enabled=true] listener_id

#### DESCRIPTION

The `create-http-listener` command creates an HTTP listener. This command is supported in remote mode only.

#### OPTIONS

`–u` `––user`

  The authorized domain application server administrative username.

`–w` `––password`

  The `––password` option is deprecated. Use `––passwordfile` instead.

`––passwordfile`

  This option replaces the `–– password` option. Using the `––password` option on the command line or through the environment is deprecated. The `––passwordfile` option specifies the name of a file containing the password entries in a specified format. The entry for the password must have the AS_ADMIN_ prefix followed by the password name in capital letters. For example, to specify the domain application server password, use an entry with the following format: `AS_ADMIN_PASSWORD`=password, where password is the actual administrator password. Other passwords that can be specified include AS_ADMIN_MAPPEDPASSWORD, AS_ADMIN_USERPASSWORD, AS_ADMIN_SAVEDMASTERPASSWORD, AS_ADMIN_MQPASSWORD, AS_ADMIN_ALIASPASSWORD, and so on.

`–H` `––host`

  The machine name where the domain application server is running. The default value is localhost.

`–p` `––port`

  The port number of the domain application server listening for administration requests. The default port number for Platform Edition is 4848. The default port number for Enterprise Edition is 4849.

`–s` `––secure`

  If set to true, uses SSL/TLS to communicate with the domain application server.

`–t` `––terse`

  Indicates that any output data must be very concise, typically avoiding human-friendly sentences and favoring well-formatted data for consumption by a script. Default is false.

`–e` `––echo`

  Setting to true will echo the command line statement on the standard output. Default is false.

`–I` `––interactive`

  If set to true (default), only the required password options are prompted.

`–h` `––help`

  Displays the help text for the command.

`––target`

  In Enterprise Edition, specifies the target for which you are creating the HTTP listener. Valid values are

  - `server`, which creates the listener for the default server instance `server` and is the default value

  - configuration_name, which creates the listener for the named configuration

  - cluster_name, which creates the listener for every server instance in the cluster

  - instance_name, which creates the listener for a particular server instance

`––listeneraddress`

  The IP address of the listener address (resolvable by DNS).

`––listenerport`

  The port number to create the listen socket on. Legal values are 1–65535. On UNIX, creating sockets that listen on ports 1–1024 requires superuser privileges. Configuring an SSL listen socket to listen on port 443 is recommended.

`––defaultvs`

  The ID attribute of the default virtual server for this listener.

`––servername`

  Tells the server what to put in the host name section of any URLs it sends to the client. This affects URLs the server automatically generates; it doesn't affect the URLs for directories and files stored in the server. This name should be the alias name if your server uses an alias. If a colon and port number are appended, that port will be used in URLs that the server sends to the client.

`––acceptorthreads`

  The number of acceptor threads for the listen socket. The recommended value is the number of processors in the machine. The default value is 1.

`––securityenabled`

  If set to true, the HTTP listener runs SSL. You can turn SSL2 or SSL3 ON or OFF and set ciphers using an SSL element. The security setting globally enables or disables SSL by making certificates available to the server instance. The default value is false.

`––redirectport`

  Port number for redirects. If the HTTP listener is supporting non-SSL requests, and a request is received for which a matching security-constraint requires SSL transport, the Application Server will automatically redirect the request to this port number. This option is valid for Enterprise Edition only.

`––xpowered`

  If set to `true`, adds the `X-Powered-By: Servlet/2.4` and `X-Powered-By: JSP/2.0` headers to the appropriate responses. The Servlet 2.4 specification defines the `X-Powered-By: Servlet/2.4` header, which containers may add to servlet-generated responses. Similarly, the JSP 2.0 specification defines the `X-Powered-By: JSP/2.0` header, which containers may add to responses that use JSP technology. The goal of these headers is to aid in gathering statistical data about the use of Servlet and JSP technology.

`––enabled`

  If set to true, the listener is enabled at runtime.

#### OPERANDS

listener_id

  The listener ID of the HTTP listener.

#### EXAMPLES

##### Example 1 Using the create-http-listener command

The following command creates an HTTP listener named `sampleListener` that uses a nondefault number of acceptor threads and is not enabled at runtime:

    asadmin> create-http-listener --user admin1
    --passwordfile passwords.txt --host pigeon --port 5001
    --listeneraddress 0.0.0.0 --listenerport 7272
    --defaultvs server --servername pigeon.red.planet.com
    --acceptorthreads 100 --securityenabled=false
    --enabled=false sampleListener
    Command create-http-listener executed successfully.

#### EXIT STATUS

0

  command executed successfully

1

  error in executing the command

#### SEE ALSO

delete-http-listener(1), list-http-listeners(1), create-virtual-server(1), create-ssl(1)

J2EE SDK 1.4 Last Revised 31 Jan 2005

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | OPERANDS | EXAMPLES | EXIT STATUS | SEE ALSO

- © 2010, Oracle Corporation and/or its affiliates