Chapter 4. abConsole Tools

Table of Contents

4.1. Overview
4.2. jeusadmin
4.2.1. Starting and Terminating Commands
4.2.2. Local Commands
4.2.3. Server Management Commands
4.2.4. Domain Configuration Commands
4.2.5. Thread Management Commands
4.2.6. Application Commands
4.2.7. EJB Engine Commands
4.2.8. Web Engine Commands
4.2.9. JMS Engine Commands
4.2.10. Data Source Commands
4.2.11. Connection Pool Controlling and Monitoring Commands
4.2.12. Transaction Commands
4.2.13. Security Commands
4.2.14. Node Management Commands
4.2.15. Node Manager Commands
4.2.16. Executing Commands Using JSON
4.3. appcompiler
4.4. ejbddinit
4.5. webddgen
4.6. encryption
4.7. wsgen
4.8. wsimport
4.9. java2wsdl
4.10. wsdl2java
4.11. wsdl2uddi
4.12. xjc
4.13. schemagen
4.14. tcpmon
4.14.1. Execution
4.14.2. Using the Listener Mode
4.14.3. Using the Proxy Mode
4.14.4. Other functions

This chapter describes the console tools that are used in JEUS and how to use them.

The following describe the console tools used in JEUS.

  • Admin Tool

    Console ToolDescription
    jeusadmin JEUS management tool.
  • Other Tools

    Console ToolDescription
    appcompiler Compiles EJB interface impl, skeleton, stub classes, and JSP of an application to create servlet classes and web service endpoint classes.
    ejbddinit Creates JEUS EJB DD files from EJB module DD files (jeus-ejb-dd.xml) by using the information in ejb-jar.xml and previously created property files.
    webddgenCreates or updates the WEB module DD file (jeus-web-dd.xml).
    encryption Encrypts or decrypts strings.
    wsgen Tool for JAX-WS web services that creates WSDL and JAX-RPC mapping files from Java classes. This tool also creates the web service policy configuration file.
    wsimport Creates Java source code stubs for clients, Java web service interface source codes for servers from the WSDL file, and the web service policy configuration file.
    java2wsdl Creates WSDL and JAX-RPC mapping files from Java classes.
    wsdl2java Creates Java source code stubs for clients and Java web service interface source codes for servers from the WSDL file.
    wsdl2uddi Publishes web services exposed by WSDL to a UDDI registry.
    xjc Converts XML schema files to JAXB Content classes in the Java programming language.
    schemagen Creates a schema file for each namespace in the Java classes.
    tcpmon Checks for transmitted TCP packets. This can also check for SOAP messages over HTTP.

This section describes the jeusadmin (JEUS management console tool) and its usage.

jeusadmin is a console tool used to directly manage JEUS. This tool can be used to perform basic management of JEUS servers like startup, termination, and application management including deployment/undeployment, changing logger levels, and checking the JMX Mbean list.

The following is the basic syntax of the commands used in jeusadmin.

COMMAND [COMMAND_OPTIONS] 
        [GLOBAL_OPTIONS] 
        (>|>>) FILENAME
  • COMMAND

    Name or alias of the command.

  • COMMAND_OPTIONS

    Command options.

  • GLOBAL_OPTIONS

    Common options that apply to all commands.

    OptionDescription
    -verboseOutputs the stack trace if an error occurs.
    -repeat <count>Number of times to execute the command.
    -interval <seconds>

    Interval for commands to repeat (Unit: sec).

    If this option is used without setting the -repeat option, an error is thrown.

  • (>|>>) FILENAME

    Name of the file in which command execution results are saved.

    Usage:

    offline>help > result.txt
    or
    offline>help >> result.txt

Additions to JEUS 7

The jeusadmin tool can be executed without connecting to the server. The current connection status is displayed at the prompt.

  • (1) Not connected

    offline>
  • (2) Connected to DAS

    [DAS]domainName.serverName>
  • (3) Connected to Managed Server

    domainName.serverName>

The help command output varies depending on the connection state. The help command displays help for the available commands.

The commands in JEUS 7 are different from previous versions. Use the help command or refer to this guide when using a command because commands with similar or equivalent functions to the previous versions may have changed.

When giving parameter values to options, if the parameter value contains a blank space, wrap the value with double quotes (" ") or single quotes (' ').

ex) jeusadmin -u jeus -p jeus "help deploy"

The following describes the commands that start and terminate jeusadmin.

CommandDescription
jeusadminStart jeusadmin.
exitTerminate jeusadmin.

Executes jeusadmin. The file is in the 'JEUS_HOME/bin' directory.

  • Usage

    jeusadmin [-u,--username <username>]
             [-p,--password <password>]
             [-f <filename>]
             [-cachelogin]
             [-host <server address>]
             [-port <server port>]
             [-verbose]
             [-help]
             [<target command>]
             [-version]
             [-fullversion]
             [-buildversion]
             [-licensedue]
             [-licenseinfo]
             [-debug]
  • Parameters

    ParameterDescription
    [-u, --username <username>]

    User name.

    If set, jeusadmin tries to access the server when it starts.

    [-p, ---password <password>]

    Password.

    If set, jeusadmin tries to access the server when it starts.

    -f <filename>File that contains the user name and password required to access the server.
    -cacheloginOption to cache the user name and password used to access a specific domain or the default domain.
    [-host <server address>

    Server address to connect to.

    If the [-u] and [-p] options are set without the host option, jeusadmin tries to connect to the localhost.

    [-port <server port>]

    Port number to connect to.

    If the [-u] and [-p] options are set without the port option, jeusadmin tries to connect through port 9736.

    [-verbose]Option to display details when an error occurs.
    [-help]Option to display help for jeusadmin.
    [<target command>]

    Option to re-execute the <target command>. This is useful when using a script.

    If the command requires a connection to the server, required options, such as [-u], [-p], [-host], and [-port], must be provided.

    [-version]Option to display the major version of JEUS.
    [-fullversion]Option to display major and minor versions of JEUS.
    [-buildversion]Option to display major and build versions of JEUS.
    [-licensedue]Option to display the number of days the license is valid. If the number is 0, JEUS can no longer run, and a new license must be issued by TmaxSoft.
    [-licenseinfo]Option to display the current license information.
    [-debug]Option to display the log messages in jeusadmin through Jeus Logger.
  • Example

    The following example assumes that the user name is 'administrator' and password is 'jeus'.

    • Executing jeusadmin

      The following is an example of executing jeusadmin.

      user1@host1:~/jeus/bin$jeusadmin
      JEUS7 Administration Tool
      To view help, use the 'help' command.
      offline>
      
    • Connecting to the server at startup - Method 1

      The following is an example of connecting to the server at localhost:9736.

      user1@host1:~/jeus/bin$jeusadmin -u administrator -p jeus
      Attempting to connect to 127.0.0.1:9736.
      The connection has been established to Domain Administration Server adminServer in the domain domain1.
      JEUS7 Administration Tool
      To view help, use the 'help' command.
      [DAS]domain1.adminServer>
      
    • Connecting to a server when starting up, Method 2

      The following is an example of connecting to the server by specifying the IP address and port number.

      user1@host1:~/jeus/bin$jeusadmin -u administrator -p jeus -host 192.168.0.1 -port 9746
      Attempting to connect 192.168.0.1:9746
      The connection has been established to Domain Administration Server adminServer in the domain domain1.
      JEUS7 Administration Tool
      To view help, use the 'help' command.
      [DAS]domain1.adminServer>
    • Checking the license information

      The following is an example of checking for the JEUS license.

      user1@host1:~/jeus/bin$jeusadmin -licensedue
      Unlimited
      
      user1@host1:~/jeus/bin$jeusadmin -licenseinfo
      =====================  LICENSE INFORMATION =====================
      === EDITION : Enterprise (Trial License)
      === ISSUE-DAY : 2007/1/16
      ================================================================
      
  • Connecting to jeusadmin using SSL

    In order to connect to jeusadmin using SSL, configure the following system properties in the jeusadmin execution script file. The values of system properties depend on the SSL configuration of the server.

    . . . 
    # execute jeusadmin
     "${JAVA_HOME}/bin/java" -classpath "${BOOTSTRAP_CLASSPATH}" ${TOOL_OPTION}     
          -Djmx.remote.x.request.timeout=600000                                     
          -Djava.library.path="${JEUS_LIBPATH}"                                     
          -Djeus.home="${JEUS_HOME}"                                                
          -Djeus.baseport=${JEUS_BASEPORT}                                          
          -Djeus.tool.console.useJLine="false"                                      
          -Djava.endorsed.dirs="${JEUS_HOME}/lib/endorsed"                          
          -Djava.naming.factory.initial=jeus.jndi.JEUSContextFactory                
          -Djava.naming.factory.url.pkgs=jeus.jndi.jns.url                          
          -Djava.util.logging.config.file="${JEUS_HOME}/bin/logging.properties"     
          -Djeus.net.client.use-ssl=true                                            
          -Djavax.net.ssl.trustStore=${JEUS_HOME}/domains/domain1/config/truststore 
          -Djavax.net.ssl.trustStorePassword=changeit                               
          -Djavax.net.ssl.trustStoreType=JKS                                        
          -Dssl.TrustManagerFactory.algorithm=SunX509                               
          ${JAVA_ARGS}                                                              
          jeus.tool.console.ConsoleBootstrapper ${BOOT_PARAMETER}

The following is a list of common commands used in jeusadmin.

CommandsDescription
helpDisplays command help information.
historyDisplays the history of entered commands.
pExecutes a previously entered command. If no option is specified, the previous command is executed.
connectTries to access DAS or Managed Server.
disconnectDisconnects and returns to an offline state.
verboseDisplays details when executing a command.
remove-login-cacheRemoves specified user login information from the cache file stored via the cachelogin function.
set-server-optionSpecifies values for server options.
unset-server-optionDeletes the values set by set-server-option.

Displays command help information. If the command is executed without any other options, a list of commands and an explanation of the basic syntax of the commands are displayed.

  • Usage

    help [-g,--group <group name> | <command name> | -l,--list]
  • Parameters

    ParameterDescription
    [-g,--group <group name>]

    Displays a list of commands and simple descriptions that belong to the given group name.

    [<command name>]

    Displays help information of the specified command (command name).

    Displays information about the command such as command name, alias, usage, and options.

    Options can be omitted.

    [-l,--list]Displays a simple description of all commands.
  • Example

    • When only the help command is used

      offline>help
      LIST OF AVAILABLE COMMANDS
      [ Local]____________________________________________________________________
        connect                             disconnect                            
        exit                                help                                  
        history                             p                                     
        remove-login-cache                  set-server-option                     
        unset-server-option                 verbose                               
      
      [ Server Management]________________________________________________________
        local-shutdown                      local-start-server                    
      
      [ Domain Configuration]_____________________________________________________
        apply-configuration-plan            create-domain                         
        delete-domain                       list-domains                          
        pack-domain                         unpack-domain                         
      
      [ Application]______________________________________________________________
        install-application                 install-deployment-plan               
        redeploy-application                
      
      [ Web]______________________________________________________________________
        precompile-jsp                      
      
      [ NodeManager]______________________________________________________________
        connect-nodemanager                 disconnect-nodemanager                
        nm-start-server                     nm-state-server                       
        nm-stop-server                      stop-nodemanager                      
      
      COMMAND GRAMMAR
          Command Usage
              COMMAND [COMMAND_OPTIONS] [GLOBAL_OPTIONS] [(>|>>) FILENAME]
          Details
              COMMAND: target command to execute.
              [COMMAND_OPTIONS]: Options for target command.
              [GLOBAL_OPTIONS]: Common options for all commands.
                  -verbose
                      Prints the stack trace for errors.
                  -repeat <count>
                      Repeats the target command X times.
                  -interval <seconds>
                      Specifies the interval at which to repeat execution, in 
                      seconds.
              [(>|>>) FILENAME]
                  Prints the result of the target command to the specified file.
          Examples
              help -l -repeat 3 -interval 10 > result.txt
      
      To show detailed information for a command, use 'help [COMMAND_NAME]'.
      ex) help connect
      offline>
      
    • When the help command is used with the [-l] option

      offline>help -l
      [ Local]____________________________________________________________________
        connect                  Attempting to authenticate with the target
                                 server.
        disconnect               Disconnects from the currently connected server.
      
        ......
      
      [ Server Management]________________________________________________________
        local-shutdown           Shuts down the currently connected server.
        local-start-server       A. Start managed server via SSH (off-line mode).
                                 B. Start managed server which is in STANDBY.
                                 For B, you "SHOULD" connect to the managed server
                                 by using [connect] command.
      
        ......
      
      [ NodeManager]______________________________________________________________
        connect-nodemanager      Connects to the node manager.
        disconnect-nodemanager   Closes the connection to the node manager.
        nm-start-server          Starts a server using the node manager.
        nm-state-server          Shows the state of a server using node manager.
        nm-stop-server           Stops a server using the node manager.
        stop-nodemanager         Stops the node manager.
      
      To show detailed information for a command, use 'help [COMMAND_NAME]'.
      ex) help connect
      offline>
      
      
    • When the help command is used with the [-g] option

      The following is an example of displaying a list of the 'Server Management' group commands.

      offline>help -g "Server Management"
      [ Server Management]________________________________________________________
        local-shutdown     Shuts down the currently connected server.
        local-start-server A. Start managed server via SSH (off-line mode).
                           B. Start managed server which is in STANDBY.
                           For B, you "SHOULD" connect to the managed server by 
                           using [connect] command.
      
      To show detailed information for a command, use 'help [COMMAND_NAME]'.
      ex) help connect
      offline>
      
    • When the help command is used with the [<command name>] option, help information for the specified command is displayed.

      The following is an example of displaying the help information of the add-server command.

      [DAS]domain1.adminServer>help add-server
      NAMES
          add-server
              Adds a new server to the domain configuration. If a server name is 
              not provided, the current server list in this domain will be shown.
      ALIAS
          addserver
      USAGE
          add-server [<server-name>]
                     [-port,--baseport <base-port>]
                     [-addr,--baseaddr <base-addr>]
                     [-node,--nodeName <node-name>]
                     [-jvm,--jvmOptions <jvm-options>]
                     [-logdir,--logHomeDirectory <server-log-home-directory>]
                     [-a,--actionOnResourceLeak <action-on-resource-leak>]
                     [-l,--logStdoutToRawFormat <print-stdout-to-raw-format>]
                     [-m,--mejb <enable-MEJB>]
                     [-c,--classFtp <enable-class-ftp-service>]
                     [-f,--force]
                     [-detail]
      OPTIONS
          [<server-name>]
              name of the server you want to add
      
          [-port,--baseport <base-port>]
              base service listen port of the server
      
          [-addr,--baseaddr <base-addr>]
              base service listen address of the server
      
          [-node,--nodeName <node-name>]
              name of the node this server is located
      
          [-jvm,--jvmOptions <jvm-options>]
              jvm configurations applied to this server jvm
      
          [-logdir,--logHomeDirectory <server-log-home-directory>]
              the log directory which has all the log files created by this server
      
          [-a,--actionOnResourceLeak <action-on-resource-leak>]
              strategy when resource leak is detected. it must be one of 
              AutoClose, NoAction, Warning
      
          [-l,--logStdoutToRawFormat <print-stdout-to-raw-format>]
              [Dynamic] whether stdout is printed in row format or in JEUS Logger 
              format.
      
          [-m,--mejb <enable-MEJB>]
              [Dynamic] whether using MEJB or not .true, false
      
          [-c,--classFtp <enable-class-ftp-service>]
              [Dynamic] whether using class ftp service or not .true, false
      
          [-f,--force]
              Acquires the configuration lock forcibly.  
      
          [-detail]
              show detail results
      
      [DAS]domain1.adminServer>
      

  • Note

    This command can be used without being connected to the server.

Displays a list of previously executed commands.

The list of commands is stored in {$user.home}/.jeusadmin/commandHistory. Use the p command to re-execute a command. The maximum number of commands in the list is 100.

  • Usage

    history [-clear | <size>]
  • Parameters

    ParameterDescription
    [-clear]Resets the list of commands.
    [<size>]Number of commands to display. Displays as many commands as size, in chronological order.
  • Example

    offline>history
    1 : help history
    2 : connect
    3 : disconnect
    
    To execute a command in the history, please use '!' command (e.g. ! 7)
    offline>history 1
    3 : disconnect
    
    To execute a command in the history, please use '!' command (e.g. ! 7)
    offline>history -clear
    The command history has been cleared.
    offline>
    
  • Note

    This command can be used without being connected to the server.

Re-executes a previous command. Use the history command to view the list of previously executed commands.

  • Aliases

    !

  • Usage

    p [<history number>]
  • Parameters

    ParameterDescription
    [<history number>]History number of the command to be re-executed.
  • Example

    offline>history
    1 : connect -u jeus -p jeus
    2 : disconnect
    
    To execute a command in the history, please use '!' command (e.g. ! 7)
    offline>p 1
    connect -u jeus -p jeus
    Enter the server address: 
    Attempting to connect to 127.0.0.1:9736.
    The connection has been established to Domain Administration Server adminServer in the domain domain1.
    [DAS]domain1.adminServer>! 2
    disconnect
    The connection has been closed.
    offline>
    
  • Note

    This command can be used without being connected to the server.

Connects to a server. If no options are specified, the system prompts for missing information.

  • Aliases

    login

  • Usage

    connect [-u,--username <username>]
            [-p,--password <password>]
            [-f <filename>]
            [-cachelogin]
            [-h,--host <server address>]
            [-port <server port>]
    
  • Parameters

    ParameterDescription
    [-u, --username <username>]User name.
    [-p, --password <password>]Password.
    [-f <filename>]File that contains the user name and password, which are required to access the server.
    [-cachelogin]Records the user name and password in a file.
    [-h, --host <server address>]Server address to connect to. If the user tries to connect to the server without this option, the system prompts for the address. If nothing is entered, jeusadmin tries to connect to the localhost.
    [-port <server port>Server port to connect to. If not specified, the default value is used. (Default: 9736)
  • Example

    • When executing without the options, the system prompts for required information.

      offline>connect
      Enter the server address: 
      User name: administrator
      Password: 
      Attempting to connect to 127.0.0.1:9736.
      The connection has been established to Domain Administration Server adminServer in the domain domain1.
      [DAS]domain1.adminServer>
      
    • When executing with only the [-u] option, the system prompts for required information.

      offline>connect -u administrator
      Enter the server address: 
      Password: 
      Attempting to connect to 127.0.0.1:9736.
      The connection has been established to Domain Administration Server adminServer in the domain domain1.
      [DAS]domain1.adminServer>
      
    • When accessing through the specified port with the [-port] option:

      offline>connect -u administrator -p jeus -h 127.0.0.1 -port 9736
      Attempting to connect to 127.0.0.1:9736.
      The connection has been established to Domain Administration Server adminServer in the domain domain1.
      [DAS]domain1.adminServer>
      
  • Note

    This command can be used without being connected to the server.

The following is a list of server management commands.

CommandDescription
add-custom-resource-to-serversDynamically registers a custom resource to servers.
add-data-sources-to-serverDynamically registers data sources to a server.
add-external-resource-to-serversDynamically registers an external resource to servers.
add-jvm-optionAdds JVM to a server.
add-listenerAdds a listener to a server.
add-log-handlerAdds a handler to a server logger.
add-loggerAdds a logger to a server.
disable-engine-init-on-bootSets the initialization point of the internal engines (Servlet, EJB, JMS) of the servers to when the application was deployed.
disable-enginesSelectively disables the use of the internal engines (Servlet, EJB, JMS) of a server.
disable-json-commandDisables JsonCommand.
disable-to-resynchronize-applicationsDisables the synchronization of applications when the MS state changes from INDEPENDENT to DEPENDENT.
disable-webadminDisables the WebAdmin service.
dumpOutputs the thread dump(s) of a server or servers that belongs to a cluster.
enable-engine-init-on-bootSets the initialization point of the internal engines (Servlet, EJB, JMS) of the servers to when the server boots.
enable-enginesSelectively enables the use of the internal engines (Servlet, EJB, JMS) of a server.
enable-json-commandEnables JsonCommand.
enable-to-resynchronize-applicationsEnables the synchronization of applications when the MS state changes from INDEPENDENT to DEPENDENT.
enable-webadminEnables the WebAdmin service.
jndi-infoDisplays a list of binding names of objects bound to the JNDI context of a server.
list-jvm-optionsDisplays the JVM configuration of a server.
list-log-handlersDisplays the information of the handlers registered to a server logger.
list-loggersDisplays the information of the loggers registered to a server.
list-server-listenersDisplays the configuration of listeners of a server.
local-shutdownTerminates the currently connected server.
local-start-serverStarts the server if the currently connected server is in STANDBY. In offline mode, starts a Managed Server through SSH.
log-levelChecks for a logger registered to a specific server and the levels of the handlers registered to the logger.
mbean-infoDisplays a list of Mbeans registered to a server.
memory-infoDisplays the memory information of a specific server or a server that belongs to a specific cluster.
modify-jvm-optionChanges the JVM configuration of a server.
modify-listenerChanges a listener configuration of a server.
modify-log-handlerChanges a handler registered to a server logger.
modify-loggerChanges a logger registered to a server.
remove-custom-resource-from-serversDynamically deletes a custom resource registered to servers.
remove-data-sources-from-serverDynamically deletes a data sources registered to a server.
remove-external-resource-from-serversDynamically deletes an external resource registered to servers.
remove-jvm-optionDeletes the JVM configuration from a server.
remove-listenerDeletes a listener from a server.
remove-log-handlerDeletes a hander registered to a server logger.
remove-loggerDeletes a logger registered to a server.
resume-serverResumes a temporarily suspended server or cluster.
rollback-configRolls back to a backup file.
run-garbage-collectionExecutes full gc on a server or servers that belong to a cluster.
server-infoDisplays the current status of a server.
show-configDisplays the current configuration file and a list of backup configuration files.
start-clusterStarts the Managed Servers that belong to a cluster.
start-domainStarts all the Managed Servers that belong to the current domain.
start-serverStarts a Managed Server.
stop-clusterTerminates Managed Servers that belong to a cluster.
stop-domainTerminates Managed Servers that belong to the current domain.
stop-serverTerminates a Managed Server.
suspend-serverTemporarily suspends a running server.
system-infoDisplays the system information of a server.
server-logChecks the logs of a server.

Adds a listener to a server.

  • Aliases

    addlistener, createlistener

  • Usage

    add-listener -server <server-name>
                 [-name <listener-name>]
                 [-addr <address>]
                 -port <port>
                 [-block,--useblockingio]
                 [-selectors <selectors>]
                 [-dual]
                 [-backlog <backlog>]
                 [-timeout <read-timeout>]
                 [-rt,--reservedthreads <reserved-threads>]                  
  • Parameters

    ParameterDescription
    -server <server-name> Server name.
    [-name <listener-name>]Listener name to be added.
    [-addr <address>]Address of the listener to be added.
    -port <port>Port number of the listener to be added. The value must be between 1 ~ 65535, and the port number cannot conflict with the port numbers of other listeners.
    [-block,--useblockingio]Listener type to be added. If this option is set, the listener operates in blocking I/O.
    [-selectors <selectors>]Number of selectors to use, if the listener to be added is the non-blocking I/O type.
    [-dual]Uses separate selectors for reading and writing, if the listener to be added is the nonblocking I/O type.
    [-backlog <backlog>]Backlog of the listener to be added.
    [-timeout <read-timeout>]Read timeout of the listener to be added.
    [-rt,--reservedthreads <reserved-threads>]Number of reserved threads used by the listener to be added.
  • Example

    [DAS]domain1.adminServer>add-listener -server server1 -name Test -port 10000
    Executed Successfully
    Check the result using 'list-server-listeners -server server1 -name Test.
    [DAS]domain1.adminServer>list-server-listeners -server server1 -name Test
    ===============================================================
    Test
    
    +---------------------------------------------------+---------+
    |                   Attribute name                  |  Value  |
    +---------------------------------------------------+---------+
    | address                                           | not-set |
    | port                                              |   10000 |
    | blocking                                          | false   |
    | selectors                                         |       1 |
    | dual-selector                                     | false   |
    | backlog                                           |     128 |
    | read-timeout                                      |   30000 |
    | reserved-threads                                  |       0 |
    +---------------------------------------------------+---------+
    ===============================================================

Adds a handler to a server logger.

  • Aliases

    addloghandler, add-handler, addhandler

  • Usage

    add-log-handler -server <server-name>
                    -logger <logger-name>
                    [<handler-name>]
                    [-level <handler-level>]
                    [-filter <filter-class>]
                    [-encoding <encoding>]
                    [-filename <file-name>]
                    [-enable <enable-rotation>]
                    [-count <rotation-count>]
                    [-dir <rotation-dir>]
                    [-buffer <buffer-size>]
                    [-append <append>]
                    [-hour <hour> | -day <day> | -size <size>]
                    [-f,--forceLock]
                    [-detail]
  • Parameters

    ParameterDescription
    -server <server-name>Server name.
    -logger <logger-name>Name of the logger that adds the handler.
    [<handler-name>]Handler name to be added.
    [-level <handler-level>]Log level of the handler (Default value: FINEST).
    [-filter <filter-class>]Class name of the filter for log messages.
    [-encoding <encoding>]Encoding value for log messages.
    [-filename <file-name>]

    File name where logs are recorded.

    (Default value: loggerName.log. JeusServer.log for the JEUS logger)

    [-enable <enable-rotation>]Option to enable file rotation (Default value: true).
    [-count <rotation-count>]Maximum number of log files for backup.
    [-dir <rotation-dir>]Path to the directory that stores backup log files.
    [-buffer <buffer-size>]Size of the buffer used to record log messages to a file.
    [-append <append>]

    Option to append logs to the previous file if the server reboots.

    Input either true or false. (Default value: true).

    [-hour <hour>]Writes a new log file every hour an entry is made.
    [-day <day>]Writes a new log file each day an entry is made.
    [-size <size>]Writes a new log file according to the input size.
    [-f,--forceLock]Forcibly applies configuration changes.
    [-detail]Displays detailed results of the dynamic changes.
  • Example

    [DAS]domain1.adminServer>add-log-handler -server server1 -logger jeus.jndi 
    fileHandler -day 10 -detail
    Successfully performed the ADD operation for The handler for the logger(jeus.jndi) 
    on the server(server1)., but all changes were non-dynamic. They will be applied 
    after restarting.
    Check the results using "list-log-handlers or add-log-handler"

Selectively disables the use of the internal engines (Servlet, EJB, JMS) of a server. To apply changes, restart the server.

  • Related schema

    jeus-domain.xsd

  • Aliases

    engineoff

  • Usage

    disable-engines <server-list> 
                       [-all]
                       [-web]
                       [-ejb]
                       [-jms]
                       [-f,--forceLock]
  • Parameters

    ParameterDescription
    <server-list>Server name. To specify multiple servers, separate each server with a comma (,).
    [-all]Apply to all web, ejb, jms engines.
    [-web]Apply to the web engine.
    [-ejb]Apply to the ejb engine.
    [-jms]Apply to the jms engine.
    [-f,--forceLock]Forcibly applies configuration changes.
  • Example

    [DAS]domain1.adminServer>disable-engines adminServer -all
    All engine(s) was(were) successfully disabled.
    The configuration was changed.
    ================================================================================
    +------------------------------------------------------------------------------+
    |                                    Result                                    |
    +------------------------------------------------------------------------------+
    | Successfully changed only the XML.                                           |
    | Restart the server to apply the changes.                                     |
    +------------------------------------------------------------------------------+
    ================================================================================
    ...
    [DAS]domain1.adminServer>disable-engines adminServer -web -ejb
    Web EJB engine(s) was(were) successfully disabled.
    The configuration was changed.
    ================================================================================
    +------------------------------------------------------------------------------+
    |                                    Result                                    |
    +------------------------------------------------------------------------------+
    | Successfully changed only the XML.                                           |
    | Restart the server to apply the changes.                                     |
    +------------------------------------------------------------------------------+
    ================================================================================
    ...

Selectively enables the use of the internal engines (Servlet, EJB, JMS) of a server. To apply the changes, restart the server.

  • Related Schema

    jeus-domain.xsd

  • Aliases

    engineon

  • Usage

    enable-engines <server-list> 
                       [-all]
                       [-web]
                       [-ejb]
                       [-jms]
                       [-f,--forceLock]
  • Parameters

    ParameterDescription
    <server-list>Server name. To specify multiple servers, separate each server with a comma (,).
    [-all]Apply to all web, ejb, jms engines.
    [-web]Apply to the web engine.
    [-ejb]Apply to the ejb engine.
    [-jms]Apply to the jms engine.
    [-f,--forceLock]Forcibly applies the configuration changes.
  • Example

    [DAS]domain1.adminServer>diable-engines radminServer -all
    All engine(s) was(were) successfully enabled.
    The configuration was changed.
    ================================================================================
    +------------------------------------------------------------------------------+
    |                                    Result                                    |
    +------------------------------------------------------------------------------+
    | Successfully applied part of the changes.                                    |
    | Restart the server to apply the remaining changes.                           |
    +------------------------------------------------------------------------------+
    ================================================================================
    ...
    [DAS]domain1.adminServer>diable-engines adminServer -web -ejb
    Web EJB engine(s) was(were) successfully enabled.
    The configuration was changed.
    ================================================================================
    +------------------------------------------------------------------------------+
    |                                    Result                                    |
    +------------------------------------------------------------------------------+
    | Successfully applied part of the changes.                                    |
    | Restart the server to apply the remaining changes.                           |
    +------------------------------------------------------------------------------+
    ================================================================================
    ...

Displays a list of binding names of the objects bound to the JNDI context of a server.

  • Aliases

    jndiinfo, jndilist

  • Usage

    jndi-info -server <server-name> 
              [<context-name>]
  • Parameters

    ParameterDescription
    -server <server-name>Server name.
    [<context-name>]

    JNDI context name.

    If <context-name> is a context, all objects bound to the context are displayed. If <context-name> is a leaf node, details of the object are displayed.

  • Context example

    [DAS]domain1.adminServer>jndi-info -server server1  
    The JNDI list on the server1
    List of the context /
    ================================================================================
    +--------------------+-----------------------------------------+---------------+
    |        Name        |                  Value                  | Local Binding |
    +--------------------+-----------------------------------------+---------------+
    | Count              | jeus.ejb.client.BusinessHome            | false         |
    +--------------------+-----------------------------------------+---------------+
    | Count#_remote_biz_h| jeus.ejb.client.RemoteBusinessHomeClient| false         |
    |ome                 |Handler                                  |               |
    +--------------------+-----------------------------------------+---------------+
    | Count#my.ejb3.tx.Co| jeus.ejb.client.BusinessHome            | false         |
    |unt                 |                                         |               |
    +--------------------+-----------------------------------------+---------------+
    | java:global        | jeus.jndi.JNSContext                    | false         |
    +--------------------+-----------------------------------------+---------------+
    | JEUSMQ_DLQ         | jeus.jms.common.destination.JeusQueue   | false         |
    +--------------------+-----------------------------------------+---------------+
    | mgmt               | jeus.jndi.JNSContext                    | false         |
    +--------------------+-----------------------------------------+---------------+
    ================================================================================
    [DAS]domain1.adminServer>jndi-info -server server1 java:global 
    The JNDI list on the server1
    List of the context /java:global
    ================================================================================
    +---------------------------------+----------------------------+---------------+
    |               Name              |            Value           | Local Binding |
    +---------------------------------+----------------------------+---------------+
    | /countermod/Count               |jeus.ejb.client.BusinessHome| false         |
    +---------------------------------+----------------------------+---------------+
    | /countermod/Count!my.ejb3.tx.Cou|jeus.ejb.client.BusinessHome| false         |
    |nt                               |                            |               |
    +---------------------------------+----------------------------+---------------+
    ================================================================================
  • Leaf node example

    [DAS]domain1.adminServer>jndi-info -server server1 java:global/countermod/Count 
    The JNDI list on the server1
    List of the context /java:global/countermod/Count
    ================================================================================
    +-------------------------------+------------------------------+---------------+
    |              Name             |             Value            | Local Binding |
    +-------------------------------+------------------------------+---------------+
    | java:global/countermod/Count  | jeus.ejb.client.BusinessHome | false         |
    +-------------------------------+------------------------------+---------------+
    
    Reference class name : jeus.ejb.client.BusinessHome
    Reference Factory class name : jeus.ejb.client.BusinessObjectFactory
            [0] StringRefAddr : Count#_remote_biz_home, RefAddr type : home.jndiname
            [1] StringRefAddr : my.ejb3.tx.Count, RefAddr type : interface
            end of RefAddr
    
    ================================================================================

Displays a list of Mbeans registered to a server.

  • Aliases

    mbeaninfo

  • Usage

    mbean-info -server <server-name>
               [<object-name>]
  • Parameters

    ParameterDescription
    -server <server-name>Server name
    [<object-name>]

    Query for an object name. Displays a list of MBeans with the specified object name.

    For more information about queried object names, refer to "JEUS JMX Guide".

  • Example

    [DAS]domain1.adminServer>mbean-info -server server1 
    The object names of MBeans on the server [server1].
    ================================================================================
    +------------------------------------------------------------------------------+
    | JEUS:j2eeType=JeusService,jeusType=ServerNodeManagerService,JMXManager=server|
    |1,J2EEServer=server1,name=server1                                             |
    | JEUS:j2eeType=J2EEServer,JMXManager=server1,isTargetable=true,J2EEDomain=doma|
    |in1,name=server1                                                              |
    | JEUS:j2eeType=JMSResource,JMXManager=server1,J2EEServer=server1,name=server1_|
    |jms                                                                           |
    | JEUS:j2eeType=JeusService,jeusType=SecurityDomain,JMXManager=server1,J2EEDoma|
    |in=domain1,SecurityService=SecurityService,name=SYSTEM_DOMAIN                 |
    | JEUS:j2eeType=JeusService,jeusType=JEUSMPConnector,JMXManager=server1,J2EESer|
    |ver=server1,name=server1                                                      |
    | JEUS:j2eeType=JeusService,jeusType=ThreadPool,JMXManager=server1,J2EEServer=s|
    |erver1,name=threadpool.System                                                 |
    | JEUS:j2eeType=JeusService,jeusType=WebListener,JMXManager=server1,WebEngine=s|
    |erver1_servlet,J2EEServer=server1,name=ADMIN-HTTP                             |
    | JEUS:j2eeType=JeusService,jeusType=ThreadPool,JMXManager=server1,J2EEServer=s|
    |erver1,name=EJBTimerService                                                   |
    | JEUS:j2eeType=JDBCResource,JMXManager=server1,J2EEServer=server1,name=server1|
    | JEUS:j2eeType=JeusService,jeusType=ThreadPool_WEBC,JMXManager=server1,WebEngi|
    |ne=server1_servlet,J2EEServer=server1,WebListener=ADMIN-HTTP,name=ADMIN-HTTP  |
    | JEUS:j2eeType=JeusService,jeusType=EJBEngine,JMXManager=server1,J2EEServer=se|
    |rver1,name=server1_ejb                                                        |
    | JEUS:j2eeType=JeusService,jeusType=JNDIResourceService,JMXManager=server1,J2E|
    |EServer=server1,name=server1                                                  |
    | JEUS:j2eeType=JeusService,jeusType=SecurityService,JMXManager=server1,J2EEDom|
    |ain=domain1,J2EEServer=server1,name=SecurityService                           |
    | JEUS:j2eeType=JeusService,jeusType=WebEngine,JMXManager=server1,J2EEServer=se|
    |rver1,name=server1_servlet                                                    |
    | JEUS:j2eeType=JeusService,jeusType=SecuritySubject,JMXManager=server1,J2EEDom|
    |ain=domain1,SecurityDomain=SYSTEM_DOMAIN,name=Subject                         |
    | JEUS:j2eeType=JeusService,jeusType=ThreadPool,JMXManager=server1,J2EEServer=s|
    |erver1,name=server1                                                           |
    | JEUS:j2eeType=JeusService,jeusType=JMSServiceChannel,JMXManager=server1,J2EES|
    |erver=server1,JMSResource=server1_jms,name=JMSServiceChannel-default          |
    | JEUS:j2eeType=Console,JMXManager=server1,J2EEServer=server1,name=server1     |
    | JEUS:j2eeType=JeusService,jeusType=JDBCResourceService,JMXManager=server1,J2E|
    |EServer=server1,name=server1                                                  |
    | JEUS:j2eeType=JVM,JMXManager=server1,J2EEServer=server1,name=server1         |
    | JEUS:j2eeType=JTAResource,JMXManager=server1,J2EEServer=server1,name=server1 |
    | JEUS:j2eeType=JeusService,jeusType=JMSEngine,JMXManager=server1,J2EEServer=se|
    |rver1,name=server1_jms                                                        |
    | JEUS:j2eeType=JeusService,jeusType=JMSDestinationResource,JMXManager=server1,|
    |J2EEServer=server1,JMSResource=server1_jms,name=JEUSMQ_DLQ                    |
    | JEUS:j2eeType=JeusService,jeusType=SecurityPolicy,JMXManager=server1,J2EEDoma|
    |in=domain1,SecurityDomain=SYSTEM_DOMAIN,name=Policy                           |
    +------------------------------------------------------------------------------+
    ================================================================================
    

Changes the listener configuration of a server.

  • Aliases

    modifylistener, editlistener

  • Usage

    modify-listener -server <server-name>
                    -name <listener-name>
                    [-addr <address>]
                    [-port <port>]
                    [-block,--useblockingio]
                    [-selectors <selectors>]
                    [-dual]
                    [-backlog <backlog>]
                    [-timeout <read-timeout>]
                    [-rt,--reservedthreads <reserved-threads>]                  
  • Parameters

    ParameterDescription
    -server <server-name>Server name.
    -name <listener-name>Listener name to be changed.
    [-addr <address>]Address of the listener to be changed.
    [-port <port>]Port number of the listener to be changed. The value must be between 1 ~ 65535. The port number cannot conflict with the ports of other listeners.
    [-block,--useblockingio]New listener type. If this option is set, the listener operates in blocking I/O.
    [-selectors <selectors>]Number of selectors to use if the listener to be changed is the non-blocking I/O type.
    [-dual]Uses separate selectors for reading and writing if the listener to be changed is the nonblocking I/O type.
    [-backlog <backlog>]Backlog of the listener to be changed.
    [-timeout <read-timeout>]Read timeout for the listener to be changed.
    [-rt,--reservedthreads <reserved-threads>]Number of reserved threads used by the listener to be changed.
  • Example

    [DAS]domain1.adminServer>modify-listener -server adminServer -name base -dual -b
    acklog 250
    Executed successfully, but some configurations were not applied dynamically. It
    might be necessary to restart the server.
    Check the result using 'list-server-listeners -server adminServer -name base.
    [DAS]domain1.adminServer>list-server-listeners -server adminServer -name base
    ===============================================================
    base
    
    +---------------------------------------------------+---------+
    | address                                           | 0.0.0.0 |
    | port                                              |    9736 |
    | blocking                                          | false   |
    | selectors                                         |         |
    | dual-selector                                     | true    |
    | backlog                                           |     250 |
    | read-timeout                                      |   30000 |
    | reserved-threads                                  |       0 |
    +---------------------------------------------------+---------+
    ===============================================================

Changes a handler registered to a server logger.

  • Aliases

    modifyloghandler, modify-handler, modifyhandler

  • Usage

    modify-log-handler -server <server-name>
                      -logger <logger-name>
                      <handler-name>
                      [-level <handler-level>]
                      [-filter <filter-class>]
                      [-encoding <encoding>]
                      [-filename <file-name>]
                      [-enable <enable-rotation>]
                      [-count <rotation-count>]
                      [-dir <rotation-dir>]
                      [-buffer <buffer-size>]
                      [-append <append>]
                      [-hour <hour> | -day <day> | -size <size>]
                      [-f,--forceLock]
                      [-detail]
  • Parameters

    ParameterDescription
    -server <server-name>Server name.
    -logger <logger-name>Logger name.
    <handler-name>Name of the handler to be changed.
    [-level <handler-level>]Log level of the handler (Default value: FINEST)
    [-filter <filter-class>]Class name of the filter for log messages.
    [-encoding <encoding>]Encoding value for log messages.
    [-filename <file-name>]

    File name where logs are recorded.

    (Default value: loggerName.log. JeusServer.log for the JEUS logger)

    [-enable <enable-rotation>]Option to enable file rotation (Default value: true).
    [-count <rotation-count>]Maximum number of log files for backup.
    [-dir <rotation-dir>]Path to the directory that stores backup log files.
    [-buffer <buffer-size>]Size of the buffer used to record log messages to a file.
    [-append <append>]

    Option to append logs to the previous file if the server reboots.

    Input either true or false. (Default value: true).

    [-hour <hour>]Writes a new log file every hour an entry is made.
    [-day <day>]Writes a new log file each day an entry is made.
    [-size <size>]Writes a new log file according to the input size.
    [-f,--forceLock]Forcibly applies configuration changes.
    [-detail]Displays detailed results of the dynamic changes.
  • Example

    [DAS]domain1.adminServer>modify-log-handler -server server1 -logger jeus newHand
    ler -level CONFIG
    Successfully performed the MODIFY operation for The handler(FileHandler) for the
     logger(jeus) in server (server1).
    Check the results using "modify-log-handler"

Deletes a listener from a server. The base listener and listeners used in other configurations cannot be deleted.

  • Aliases

    removelistener, deletelistener

  • Usage

    remove-listener -server <server-name>
                    -name <listener-name>                  
  • Parameters

    ParameterDescription
    -server <server-name>Server name.
    -name <listener-name>Listener name to be deleted.
  • Example

    [DAS]domain1.adminServer>list-server-listeners -server adminServer
    ========================================================
    +------------------------------------+---------+-------+
    |            listener-name           | address |  port |
    +------------------------------------+---------+-------+
    | base                               | 0.0.0.0 |  9736 |
    | jms                                | 0.0.0.0 |  9741 |
    | http-lisetner                      | not-set |  8088 |
    | Test                               | not-set | 10000 |
    +------------------------------------+---------+-------+
    ========================================================
    [DAS]domain1.adminServer>remove-listener -server adminServer -name Test
    Executed Successfully, but some configurations were not applied dynamically. It
    might be necessary to restart the server.
    Check the result using 'list-server-listeners -server adminServer.
    [DAS]domain1.adminServer>list-server-listeners -server adminServer
    =========================================================
    +--------------------------------------+---------+------+
    |             listener-name            | address | port |
    +--------------------------------------+---------+------+
    | base                                 | 0.0.0.0 | 9736 |
    | jms                                  | 0.0.0.0 | 9741 |
    | http-lisetner                        | not-set | 8088 |
    +--------------------------------------+---------+------+
    =========================================================

Displays the current status of a server.

  • Aliases

    serverinfo, svrinfo

  • Usage

    server-info [-cluster <cluster-name> | -server <server-name>]
                [-state | -pid]
  • Parameters

    ParameterDescription
    [-cluster <cluster-name>]Cluster name.
    [-server <server-name>]Server name.
    [-state]Displays the server status.
    [-pid]Displays the server PID.
  • Example

    [DAS]domain1.adminServer>server-info
    
    Information about Domain (domain1)
    ==============================================================================================
    +--------+---------+-----+-------+-----+----------------+--------+-------------+-------------+
    | Server |  Status | Node|  PID  | Clus|     Latest     | Need to| Listen Ports| Running     |
    |        |         |Name |       | ter | StartTime/Shut |Restart |             | Engines     |
    |        |         |     |       |     |   downTime     |        |             |             |
    +--------+---------+-----+-------+-----+----------------+--------+-------------+-------------+
    | adminSe| RUNNING | N/A | 12154 | N/A | Sun May 20     | false  | base-0.0.0.0| jms,        |
    |rver(*) |(326 sec)|     |       |     |19:39:44 KST    |        |:9736        | ejb, web    |
    |        |         |     |       |     |2012            |        | http-server-|             |
    |        |         |     |       |     |                |        |0.0.0.0:8088 |             |
    +--------+---------+-----+-------+-----+----------------+--------+-------------+-------------+
    | server1| RUNNING |node1| 12171 | clus| Sun May 20     | false  | base-192.167| jms,        |
    |        |(286 sec)|     |       |ter1 |19:40:43 KST    |        |.0.124:9836  | ejb, web    |
    |        |         |     |       |     |2012            |        |             |             |
    +--------+---------+-----+-------+-----+----------------+--------+-------------+-------------+
    | server2| RUNNING | N/A | 12172 | clus| Sun May 20     | false  | base-192.167| jms         |
    |        |(283 sec)|     |       |ter1 |19:40:47 KST    |        |.0.124:9936  | ejb, web    |
    |        |         |     |       |     |2012            |        |             |             |
    +--------+---------+-----+-------+-----+----------------+--------+-------------+-------------+
    ==============================================================================================

Terminates the Managed Servers that belong to the current domain. The local-shutdown command can be used to terminate DAS.

  • Aliases

    stopdomain, shutdownall, downall

  • Usage

    stop-domain [-to,--shutdowntimeout <timeout> | -f, --force | -g,--graceful]
  • Parameters

    ParameterDescription
    [-to,--shutdowntimeout <time-out>]

    Sets the timeout to terminate servers gracefully.

    The server waits the specified period for the current request to complete. (Unit: second)

    [-f, --force]Forcibly shuts down the servers instead of gracefully shutting down.
    [-g, --graceful]Option to shut down servers gracefully. If set, the system waits indefinitely for a server to complete the current request.
  • Example

    [DAS]domain1.adminServer>stop-domain
    All managed servers in the domain were successfully stopped.
    Unable to shut down Domain Administration Server. To shutdown Domain Administrat
    ion Server, use the local-shutdown command instead.

The following is a list of domain configuration commands.

CommandDescription
add-clusterDynamically adds a cluster.
add-custom-resourceDynamically adds a custom resource.
add-custom-resource-to-clustersDynamically adds a custom resource to clusters.
add-data-sources-to-clusterDynamically adds data sources to a cluster.
add-external-resourceDynamically adds an external resource.
add-external-resource-to-clustersDynamically adds an external resource to clusters.
add-serverDynamically adds a server.
add-servers-to-clusterDynamically adds a server to a cluster.
apply-configuration-planOffline command that creates a new domain.xml file, which is created by applying a configuration plan to the current domain.xml file.
create-domainCreates a new domain. This is a offline command. For a user created by default, the password must be entered separately.
delete-domainDeletes a domain. This is an offline command.
list-clustersDisplays information about clusters in the current domain.
list-custom-resourcesDisplays the custom resources defined in the current domain.
list-domainsDisplays a list of domains.
list-external-resourcesChecks the external resources defined in the current domain.
list-serversDisplays the configuration information about servers in the current domain.
modify-group-communication-infoModifies the GMS services in a domain.
modify-clusterDynamically modifies a cluster.
modify-serverDynamically modifies a server.
remove-clusterDynamically deletes a cluster.
remove-custom-resourceDynamically deletes a custom resource.
remove-custom-resource-from-clustersDynamically deletes a custom resource from clusters.
remove-data-sources-from-clusterDynamically deletes the data sources registered in a cluster.
remove-external-resourceDynamically deletes an external resource.
remove-external-resource-from-clustersDynamically deletes a registered external resource from clusters.
remove-serverDynamically deletes a server.
remove-servers-from-clusterDynamically deletes servers from a cluster.
pack-domainPacks a domain directory. This is an offline command.
set-domain-backupModifies a DAS backup.
unpack-domainUnpacks the files packed by the pack-domain command. This is an offline command.

Dynamically adds a server.

  • Aliases

    addserver

  • Usage

    add-server [<server-name>]
               [-target,--duptargetserver <target-server>]
               [-port,--baseport <base-port>]
               [-addr,--baseaddr <base-addr>]
               [-node,--nodeName <node-name>]
               [-jvm,--jvmOptions <jvm-options>]
               [-logdir,--logHomeDirectory <server-log-home-directory>]
               [-a,--actionOnResourceLeak <action-on-resource-leak>]
               [-l,--logStdoutToRawFormat <print-stdout-to-raw-format>]
               [-m,--mejb <enable-MEJB>]
               [-c,--classFtp <enable-class-ftp-service>]
               [-f,--forceLock]
               [-detail]
  • Parameters

    ParameterDescription
    [<server-name>]Server name.
    [-target,--duptargetserver <target-server>]Target server name to which the server configurations are copied.
    [-port,--baseport <base-port>]

    Base port of the server.

    9736 is the default value. If multiple servers run on the same machine, each port must be unique to avoid conflicts.

    [-addr,--baseaddr <base-addr>]Address of the server.
    [-node,--nodeName <node-name>]

    Node name of the machine on which the server is running.

    Information about nodes can be checked using list-nodes.

    [-jvm,--jvmOptions <jvm-options>]

    JVM options that apply to the server.

    If the option contains whitespace, wrap the option with double quotes (" ").

    [-logdir,--logHomeDirectory <server-log-home-directory>]

    Log directory in which logs created by the server are located.

    [-a,--actionOnResourceLeak <action-on-resource-leak>]

    Action to take when a resource leak occurs.

    Input options:

    • AutoClose

    • NoAction

    • Warning

    [-l,--logStdoutToRawFormat <print-stdout-to-raw-format>]

    Option to print stdout as is or in JEUS logger format.

    Input options are 'true' and 'false'.

    [-m,--mejb <enable-MEJB>]

    Option to use MEJB.

    Input options are 'true' and 'false'.

    [-c,--classFtp <enable-class-ftp-service>]

    Option to use the FTP service class.

    Input options are 'true' and 'false'.

    [-f,--forceLock]Forcibly applies configuration changes.
    [-detail]Displays detailed results of the dynamic changes.
  • Checking the server list.

    [DAS]domain1.adminServer>list-servers
    ================================================================================================
    +------+---------+--------+-----+-----------+-----------+----------+-----+-----+---------------+
    |Server|   Base  |  Base  | Node|JVM Configs| Action On | Stdout to| MEJB|Class| Server        |
    |      | Listen  | Listen |     |           | Resource  |Row Format|     | FTP | Log Home      |
    |      | Address |  Port  |     |           |   Leak    |          |     |     | Directory     |
    +------+---------+--------+-----+-----------+-----------+----------+-----+-----+---------------+
    | admin| 0.0.0.0 | 9736   |     | -Xmx256m  | Warning   | true     |false| true| none          |
    |Server|         |        |     |-XX:MaxPerm|           |          |     |     |               |
    |      |         |        |     |Size=128m  |           |          |     |     |               |
    |      |         |        |     | -Xdebug   |           |          |     |     |               |
    |      |         |        |     |-Xrunjdwp:t|           |          |     |     |               |
    |      |         |        |     |ransport=dt|           |          |     |     |               |
    |      |         |        |     |_socket,ser|           |          |     |     |               |
    |      |         |        |     |ver=y,suspe|           |          |     |     |               |
    |      |         |        |     |nd=n,addres|           |          |     |     |               |
    |      |         |        |     |s=5005     |           |          |     |     |               |
    +------+---------+--------+-----+-----------+-----------+----------+-----+-----+---------------+
    | serve| 192.167.| 9836   |node1|           | Warning   | false    |false|false| none          |
    |r1    |0.124    |        |     |           |           |          |     |     |               |
    +------+---------+--------+-----+-----------+-----------+----------+-----+-----+---------------+
    ================================================================================================
  • Adding a server with a new name.

    [DAS]domain1.adminServer>add-server server2 -port 10000 -node node1 -m false 
    Successfully performed the ADD operation for server (server2).
    Check the results using "list-servers or add-server"

Creates a new domain. For a user created by default, the password must be entered separately. To encrypt the password, AES is used. The default value of the option is set in JEUS_HOME\setup\domain-config-template.properties.

  • Aliases

    createdomain

  • Usage

    create-domain -domain <domain-name>
                  [-das <das-name>]
                  [-baseport <das-base-port>]
                  [-baseaddress <das-base-address>]
                  [-jmsport <jms-port>]
                  [-user <user-name>]
                  [-httpport <http-port>]
                  [-jvmconfig <jvm-config>]
                  [-node <node-name>]
                  [-pw,--password]
                  [-uvm,--usevirtualmulticast]
                  [-productionmode,--productionmode]
                  [-ha,--heartbeataddress <heart-beat-address>]
                  [-hp,--heartbeatport <heart-beat-port>]        
  • Parameters

    ParameterDescription
    -domain <domain-name>Domain name.
    [-das <das-name>]DAS name that manages the domain.
    [-baseport <das-base-port>]DAS base port.
    [-baseaddress <das-base-address>]DAS base address.
    [-jmsport <jms-port>]JMS port of DAS.
    [-user <user-name>]Domain user name.
    [-httpport <http-port>]HTTP port of DAS.
    [-jvmconfig <jvm-config>]JVM configurations to be applied to DAS.
    [-node <node-name>]Node name to be applied to DAS.
    [-pw,--password]Receive password only from the console regardless of the template property file configuration.
    [-uvm,--usevirtualmulticast]Option for GMS to use the virtual multicast via TCP.
    [-productionmode,--productionmode]Option to use the created JEUS domain in production mode.
    [-ha,--heartbeataddress <heart-beat-address>]

    Address for heartbeat used by GMS.

    The setting --usevirtualmulticast must not be set.

    [-hp,--heartbeatport <heart-beat-port>]

    Port for heartbeat used by GMS.

    The setting --usevirtualmulticast must not be set.

  • Example

    offline>create-domain -domain domain1 -das adminServer -baseport 9763 -ha 
    230.30.1.1 -hp 3030 -jvmconfig "-Xmx1024m -XX:MaxPermSize=256m"
    Enter the password for [administrator]: ********** 
    Confirm the password: **********
    Do you want to encrypt the password? (y/n): y
    ================================================================================
    The domain [domain1] was created successfully.
    
    +-------------------------+----------------------------------------------------+
    |         Property        |                        Value                       |
    +-------------------------+----------------------------------------------------+
    | Domain name             | domain1                                            |
    | Das Name                | adminServer                                        |
    | Das Base Listen Port    | 9736                                               |
    | Das Base Listen Address | 0.0.0.0                                            |
    | JMS Internal Port       | 9741                                               |
    | HTTP Port               | 8088                                               |
    | User Name               | administrator                                      |
    | Node Name               | node1                                              |
    | Password                | {AES}lBljYlIlBrujFDC7v3NSoHZQprgnncVmdBbkt4oxDRg=  |
    | JVM Option              | -Xmx1024m -XX:MaxPermSize=256m                     |
    | Production Mode         | true                                               |
    | Heart beat address      | 230.30.1.1                                         |
    | Heart beat port         | 3030                                               |
    +-------------------------+----------------------------------------------------+
    ================================================================================
  • Note

    This command can be used without being connected to the server.

Displays the configuration information about servers in the current domain. Use the server-info command to display server state information.

  • Aliases

    None

  • Usage

    list-servers [<server-name>]
  • Parameters

    ParameterDescription
    [<server-name>]Server name.
  • Example

    [DAS]domain1.adminServer>list-servers
    ================================================================================================
    +------+---------+--------+-----+-----------+-----------+----------+-----+-----+---------------+
    |Server|   Base  |  Base  | Node|JVM Configs| Action On | Stdout to| MEJB|Class| Server        |
    |      | Listen  | Listen |     |           | Resource  |Row Format|     | FTP | Log Home      |
    |      | Address |  Port  |     |           |   Leak    |          |     |     | Directory     |
    +------+---------+--------+-----+-----------+-----------+----------+-----+-----+---------------+
    | admin| 0.0.0.0 | 9736   |     | -Xmx256m  | Warning   | true     |false| true| none          |
    |Server|         |        |     |-XX:MaxPerm|           |          |     |     |               |
    |      |         |        |     |Size=128m  |           |          |     |     |               |
    |      |         |        |     | -Xdebug   |           |          |     |     |               |
    |      |         |        |     |-Xrunjdwp:t|           |          |     |     |               |
    |      |         |        |     |ransport=dt|           |          |     |     |               |
    |      |         |        |     |_socket,ser|           |          |     |     |               |
    |      |         |        |     |ver=y,suspe|           |          |     |     |               |
    |      |         |        |     |nd=n,addres|           |          |     |     |               |
    |      |         |        |     |s=5005     |           |          |     |     |               |
    +------+---------+--------+-----+-----------+-----------+----------+-----+-----+---------------+
    | serve| 192.167.| 9836   |node1|           | Warning   | false    |false|false| none          |
    |r1    |0.124    |        |     |           |           |          |     |     |               |
    +------+---------+--------+-----+-----------+-----------+----------+-----+-----+---------------+
    | serve| 192.167.| 9936   |     |           | Warning   | false    |false|false| none          |
    |r2    |0.124    |        |     |           |           |          |     |     |               |
    +------+---------+--------+-----+-----------+-----------+----------+-----+-----+---------------+
    ================================================================================================

Dynamically modifies a server.

  • Aliases

    serverconf, serverconfig

  • Usage

    modify-server <server-name>
                  [-removelogdir,--removeLogHomeDirectory]
                  [-node,--nodeName <node-name>]
                  [-jvm,--jvmOptions <jvm-options>]
                  [-logdir,--logHomeDirectory <server-log-home-directory>]
                  [-a,--actionOnResourceLeak <action-on-resource-leak>]
                  [-l,--logStdoutToRawFormat <print-stdout-to-raw-format>]
                  [-m,--mejb <enable-MEJB>]
                  [-c,--classFtp <enable-class-ftp-service>]
                  [-f,--forceLock]
                  [-detail]
  • Parameters

    ParameterDescription
    <server-name>Server name.

    [-removelogdir, --removeLogHomeDirectory]

    Option to delete the log directory that contains logs created by the server.

    [-node,--nodeName <node-name>]

    Node name of the machine on which the server is running.

    Information about nodes can be checked using list-nodes.

    [-jvm,--jvmOptions <jvm-options>]

    JVM options that apply to the server.

    If the option contains whitespace, wrap the option with double quotes (" ").

    [-logdir,--logHomeDirectory <server-log-home-directory>]

    Log directory in which logs created by the server are located.

    [-a,--actionOnResourceLeak <action-on-resource-leak>]

    Action to take when a resource leak occurs.

    Input options:

    • AutoClose

    • NoAction

    • Warning

    [-l,--logStdoutToRawFormat <print-stdout-to-raw-format>]

    Option to print stdout as is or in JEUS logger format.

    Input options are 'true' and 'false'.

    [-m,--mejb <enable-MEJB>]

    Option to use MEJB.

    Input options are 'true' and 'false'.

    [-c,--classFtp <enable-class-ftp-service>]

    Option to use the FTP service class.

    Input options are 'true' and 'false'.

    [-f,--forceLock]Forcibly applies configuration changes.
    [-detail]Displays detailed results of the dynamic changes.
  • Example

    [DAS]domain1.adminServer>modify-server server1 -a AutoClose -l false
    Successfully performed the MODIFY operation for server (server1).
    Check the results using "list-servers server1 or modify-server server1"

Dynamically deletes a server.

  • Aliases

    None

  • Usage

    remove-server [<server-name>]
                  [-f,--forceLock]
                  [-detail]
  • Parameters

    ParameterDescription
    [<server-name>]Server name.
    [-f,--forceLock]Forcibly applies configuration changes.
    [-detail]Displays detailed results of the dynamic changes.
  • Example

    • Checking the list of servers.

      [DAS]domain1.adminServer>server-info
      
      Information about Domain (domain1)
      ==============================================================================================
      +--------+---------+-----+-------+-----+----------------+--------+-------------+-------------+
      | Server |  Status | Node|  PID  | Clus|     Latest     | Need to|  Listeners  | Running     |
      |        |         |Name |       | ter | Start/Shutdown |Restart |             | Engines     |
      |        |         |     |       |     |      Time      |        |             |             |
      +--------+---------+-----+-------+-----+----------------+--------+-------------+-------------+
      | adminSe| RUNNING | N/A | 12154 | N/A | Sun May 20     | false  | base-0.0.0.0| jms,        |
      |rver(*) |(931 sec)|     |       |     |19:39:44 KST    |        |:9736        | ejb, web    |
      |        |         |     |       |     |2012            |        | http-server-|             |
      |        |         |     |       |     |                |        |0.0.0.0:8088 |             |
      +--------+---------+-----+-------+-----+----------------+--------+-------------+-------------+
      | server1| RUNNING |node1| 12171 | clus| Sun May 20     | false  | base-192.167| jms,        |
      |        |(891 sec)|     |       |ter1 |19:40:43 KST    |        |.0.124:9836  | ejb, web    |
      |        |         |     |       |     |2012            |        |             |             |
      +--------+---------+-----+-------+-----+----------------+--------+-------------+-------------+
      | server2| SHUTDOWN| N/A | N/A   | N/A | Sun May 20     | N/A    | N/A         | jms,        |
      |        |(1 sec)  |     |       |     |19:55:41 KST    |        |             | ejb, web    |
      |        |         |     |       |     |2012            |        |             |             |
      +--------+---------+-----+-------+-----+----------------+--------+-------------+-------------+
      ==============================================================================================
    • Deletes a server after checking if the server terminated.

      [DAS]domain1.adminServer>remove-server server2 
      Successfully performed the REMOVE operation for server (server1).
      Check the results using "list-servers or remove-server"

The following is a list of thread management commands.

CommandDescription
interrupt-threadSends an interrupt signal to a servlet or an EJB RMI thread.
modify-service-thread-poolDynamically changes the thread pool dedicated to a server.
modify-system-thread-poolDynamically changes the system thread pool.
print-stack-traceDisplays stack traces of a servlet thread or an EJB RMI thread.
show-service-thread-poolDisplays information about a service thread pool that uses the system thread pool of a server.
show-system-thread-poolDisplays the system thread pool information of a server.
thread-infoDisplays information about servlet threads or EJB RMI threads that handle requests.

Sends an interrupt signal to a servlet or an EJB RMI thread. For more information about the result of sending an interrupt signal to a thread, refer to JEUS Server Guide. "3.3.1. Thread Monitoring".

Caution

This function only sends an interrupt signal. It does not guarantee that the thread stops its operation.

  • Aliases

    interruptthread, interrupt, intthread

  • Usage

    interrupt-thread -server <server-name>
                    -li <listener-id> | <thread-id>
  • Parameters

    ParameterDescription
    -server <server-name>Server name.
    -li <listener-id>Web listener name. Sends an interrupt signal to all threads in the thread pools of the web listener.
    <thread-id>ID of the thread that sends the signal.
  • Example

    [DAS]domain1.adminServer>interrupt-thread -server server1 50 
    Sent an interrupt hint signal to the thread [tid=50] on the server server1. 

Dynamically changes the thread pool dedicated to a server. This command applies only for the naming server, scheduler, and the transaction thread pool that use the current integrated configuration. If the configuration is unspecified, this command displays the current configuration.

  • Aliases

    modify-svctp, modifysvctp, svctpconfig, svctpconf

  • Usage

    modify-service-thread-pool -service <service name> 
                       <server-name> 
                       [-min <min>]
                       [-max <max>]
                       [-k,--keepalivetime <keep-alive-time>]
                       [-q,--queuesize <queue-size>]
                       [-m,--maxstuckthreadtime <max-stuck-thread-time>]
                       [-a,--actiononstuckthread <action-on-stuck-thread>]
                       [-stcp,--stuckthreadcheckperiod <stuck-thread-check-period>]
                       [-f,--forceLock]
                       [-detail]
  • Parameters

    ParameterDescription
    -service <service name>

    Service name that uses the system thread pool.

    Input options:

    • transaction

    • scheduler

    • namingserver

    <server-name>Server name.
    [-min <min>]Minimum number of threads in the thread pool.
    [-max <max>]Maximum number of threads in the thread pool.
    [-k,--keepalivetime <keep-alive-time>]If the number of threads is greater than the minimum number, threads idle for a specified period of time are deleted.
    [-q,--queuesize <queue-size>]Maximum number of worker threads in a queue.
    [-m,--maxstuckthreadtime <max-stuck-thread-time>]Determines a thread to be in the STUCK state if the execution time of the thread exceeds the specified period.
    [-a,--actiononstuckthread <action-on-stuck-thread>]

    Method for handling threads in the STUCK state.

    Input options:

    • IgnoreAndReplace

    • Interrupt

    • None

    [-stcp,--stuckthreadcheckperiod <stuck-thread-check-period>]

    Sets the interval at which to check threads in the STUCK state. (Unit: ms)

    [-f,--forceLock]Forcibly applies the configuration changes.
    [-detail]Displays detailed results of the dynamic changes.
  • Example

    [DAS]domain1.adminServer>modify-service-thread-pool server1 -service transaction -min 10 -max 20 
    Successfully performed the MODIFY operation for The transaction thread pool of the server (server1)., but all changes were non-dynamic. They will be applied
    after restarting.
    Check the results using "show-service-thread-pool server1 -service transaction or modify-service-thread-pool server1 -service transaction"

Dynamically changes the system thread pool. This command can modify the number of threads allocated to services that use the system thread pool.

  • Aliases

    modify-systp, modifysystp, systpconfig, systpconf

  • Usage

    modify-system-thread-pool <server-name>
             [-min <min>]
             [-max <max>]
             [-k,--keepalivetime <keep-alive-time>]
             [-q,--queuesize <queue-size>]
             [-m,--maxstuckthreadtime <max-stuck-thread-time>]
             [-a,--actiononstuckthread <action-on-stuck-thread>]
             [-stcp,--stuckthreadcheckperiod <stuck-thread-check-period>]
             [-service <service name>]
             [-r,--reservednum <reserved-number>]
             [-f,--forceLock]
             [-detail]
  • Parameters

    ParameterDescription
    <server-name>Server name.
    [-min <min>]Minimum number of threads in the thread pool.
    [-max <max>]Maximum number of threads in the thread pool.
    [-k,--keepalivetime <keep-alive-time>]If the number of threads is greater than the minimum number, threads idle for a specified period of time are deleted.
    [-q,--queuesize <queue-size>]Maximum number of worker threads in a queue.
    [-m,--maxstuckthreadtime <max-stuck-thread-time>]Determines a thread to be in the STUCK state if the execution time of the thread exceeds the specified period.
    [-a,--actiononstuckthread <action-on-stuck-thread>]

    Method for handling threads in the STUCK state.

    Input options:

    • IgnoreAndReplace

    • Interrupt

    • None

    [-stcp,--stuckthreadcheckperiod <stuck-thread-check-period>]

    Sets the interval at which to check threads in the STUCK state. (Unit: ms)

    [-service <service-name>]

    Service name that uses the system thread pool.

    Input options:

    • transaction

    • scheduler

    • namingserver

    [-r,--reservednum <reserved-number>]Minimum number of threads allocated to services that use the system thread pool.
    [-f,--forceLock]Forcibly applies the configuration changes.
    [-detail]Displays detailed results of the dynamic changes.
  • Example

    [DAS]domain1.adminServer>modify-system-thread-pool server1 -min 10 -max 60 
    -service transaction -reservednum 20 -detail
    Successfully performed the MODIFY operation for the system thread pool of the server (server1).
    ================================================================================
    +-----------------------------------------------------------+-------+----------+
    | servers.server.{? name == 'server1' }.systemThreadPool    | MODIFY| ACTIVATED|
    | servers.server.{? name == 'server1' }.tmConfig            | MODIFY| ACTIVATED|
    +-----------------------------------------------------------+-------+----------+
    ================================================================================
    Check the results using "modify-system-thread-pool server1 or show-system-thread
    -pool server1"
    ------------------details-------------------
    servers.server.{? name == 'server1' }.tmConfig : ACTIVATED 
    servers.server.{? name == 'server1' }.tmConfig.pooling : ACTIVATED 
    servers.server.{? name == 'server1' }.tmConfig.pooling.shared : ACTIVATED 
    servers.server.{? name == 'server1' }.tmConfig.pooling.shared.reservedThreadNum : ACTIVATED
      previous value : 0, edited value : 20, result value : 20 
    
    servers.server.{? name == 'server1' }.systemThreadPool : ACTIVATED 
    servers.server.{? name == 'server1' }.systemThreadPool.min : ACTIVATED 
      previous value : 0, edited value : 10, result value : 10 
    servers.server.{? name == 'server1' }.systemThreadPool.max : ACTIVATED 
      previous value : 100, edited value : 60, result value : 60

Displays information about servlet threads or EJB RMI threads that handle requests and about other JEUS thread pools. For servlets, information about the listener's thread pool and each worker thread can be checked. For EJB RMI threads, information about EJB RMI threads that handle remote requests can be checked. From the server, information about basic server thread pools can be checked by default. According to the option, information about all pools can be checked.

  • Aliases

    threadinfo, ti

  • Usage

    thread-info -server <server-name>
                [-type <thread-type>] 
                [-li <listener-id> | -ctx <context-name>] 
                [-r,--request | -a,--all] 
                [-s <thread-state>]
                [-os,--only-stats]
                [-st,--stacktrace]
  • Parameters

    ParameterDescription
    -server <server-name>Server name.
    [-type <thread-type>]

    Input options:

    • servlet: Servlet Thread

    • ejb: EJB RMI Thread

    • server: Server Thread Pool

    If the -ctx option is specified, enter the following values.

    • webasync: Thread pool for servlet 3.0 async processing

    • websocket: Thread pool for Asyn Send of WebSocket Container

    [-li <listener-id>]Listener ID. This option only applies to servlet threads.
    [-ctx <context-name>]Web context name. This option only applies to servlet threads. If asynchronous servlet is specified, thread pool information for asynchronous processing is displayed.
    [-r,--request ]

    Displays servlet thread request information.

    This option only applies to servlet threads.

    [ -a,--all]Display all information about servlet threads. This option only applies to servlet threads.
    [-s <thread-state>]

    To search for threads in a specific state, enter the state.

    • active

    • idle

    • blocked

    • reconn

    [-os,--only-stats]Servlet only displays statistical information by listener. Server displays only statistical information of pools.
    [-st,--stacktrace]Searches the traces of all active threads (thread currently running for actual tasks) that belong to the pools searched by the server. This option only applies to servers.
  • Example

    [DAS]domain1.adminServer>thread-info -server server1
    
    Thread information for the server [server1]
    There are no EJB RMI threads for the server [server1].
    =============================================================
    The web container threads for 'ADMIN-HTTP' listener.
    
    +----+------------------------------+--------+---------+----+
    | tid|             name             |  state | elapsed | uri|
    +----+------------------------------+--------+---------+----+
    | 45 | ADMIN-HTTP-w00               | waiting| 48521870|    |
    +----+------------------------------+--------+---------+----+
    
    elsapsed: Elapsed time (ms)
    =============================================================
    
    ===================================================================
    Thread statistics for the 'ADMIN-HTTP' listener.
    
    +---------------------------+------+-------+-----+--------+-------+
    |                           | total| active| idle| blocked| reconn|
    +---------------------------+------+-------+-----+--------+-------+
    | The number of threads.    |    1 |     0 |   1 |      0 |     0 | 
    +---------------------------+------+-------+-----+--------+-------+
    
    total = active + idle, reconn: reconnecting
    ===================================================================
    
    =====================================================
    The web container threads for 'http1' listener.
    
    +------+--------------------+--------+---------+----+
    |  tid |        name        |  state | elapsed | uri|
    +------+--------------------+--------+---------+----+
    |   46 | http1-w00          | waiting| 48521873|    |
    |   47 | http1-w01          | waiting| 48521868|    |
    |   48 | http1-w02          | waiting| 48521868|    |
    |   49 | http1-w03          | waiting| 48521868|    |
    |   51 | http1-w05          | waiting| 48521862|    |
    |   52 | http1-w06          | waiting| 48521858|    |
    |   53 | http1-w07          | waiting| 48521858|    |
    |   54 | http1-w08          | waiting| 48521857|    |
    |   55 | http1-w09          | waiting| 48521857|    |
    | 21203| http1-w10          | waiting|   37629 |    |
    +------+--------------------+--------+---------+----+
    
    elsapsed: Elapsed time (ms)
    =====================================================
    
    ===================================================================
    +---------------------------+------+-------+-----+--------+-------+
    |                           | total| active| idle| blocked| reconn|
    +---------------------------+------+-------+-----+--------+-------+
    | The number of threads.    |   10 |     0 |  10 |      0 |     0 |
    +---------------------------+------+-------+-----+--------+-------+
    
    total = active + idle, reconn: reconnecting
    ===================================================================
    
    ======================================================================
    The threads for the 'threadpool.System' thread pool.
    
    +-----+------------------------------+---------------+---------------+
    | tid |             name             |  thread state | active thread |
    +-----+------------------------------+---------------+---------------+
    |  93 | threadpool.System-2          | TIMED_WAITING | false         |
    |  92 | threadpool.System-1          | TIMED_WAITING | false         |
    |  94 | JMXMP [adminServer-94]       | RUNNABLE      | true          |
    +-----+------------------------------+---------------+---------------+
    ======================================================================
    
    ================================================================================
    The statistics for the 'threadpool.System' thread pool.
    
    +-----------+-----------+-----------+-----------+----------+-------------------+
    | pool name |  minimum  |  maximum  |  current  |   work   |   remaining work  |
    |           | pool size | pool size | pool size |queue size|    queue size     |
    +-----------+-----------+-----------+-----------+----------+-------------------+
    | threadpool|         0 |       100 |         3 |     4096 |              4096 |
    |.System    |           |           |           |          |                   |
    +-----------+-----------+-----------+-----------+----------+-------------------+
    ================================================================================
    

The following is a list of application commands.

CommandDescription
add-application-repositoryAdds a new application repository to the domain.
add-application-targetAdds a server or cluster as a target of a deployed application. Deploys the application to a server or cluster.
application-infoDisplays information about applications in the domain.
deploy-applicationDeploys an application installed on DAS to the target servers. If deployment fails on a single server, applications are undeployed from all successful servers.
deployment-plan-infoDisplays the deployment plan information installed on a domain.
distribute-applicationDistributes an application installed on DAS to each server or cluster. In order to run the service, the application must be started using the start-application command.
install-applicationInstalls an application on DAS. The application ID can be set.
install-deployment-planInstalls a deployment plan on DAS. At this time, the deployment plan identifier can be defined.
list-application-repositoriesDisplays the application repository information registered to the domain.
redeploy-applicationRedeploys an application.
remove-application-repositoryDeletes the application repository registered to the domain.
remove-application-targetDeletes an application deployed or distributed on a server or cluster from the server or cluster.
start-applicationStarts the deployed application.
stop-applicationSuspends a running application.
undeploy-applicationUndeploys a deployed application.
uninstall-applicationDeletes installed applications from DAS.
uninstall-deployment-planDeletes the installed deployment plan from DAS.

Displays information about applications in the domain.

  • Aliases

    appinfo, list-applications

  • Usage

    application-info[-server <server-name>]
                    [-id <application-id> | -state <application-state>]
                    [-type <application-type>]
                    [-module <module-name>]
                    [-bean <bean-name>]
                    [-jndi <jndi-context>]
                    [-mod <jndi-module-name>]
                    [-comp <jndi-component-name>]
                    [-detail,--detail]
  • Parameters

    ParameterDescription
    [-server <server-name>]Name of the server in which the application information is displayed in detail.
    [-id <application-id>]Application ID.
    [-state <application-state>]Displays information about applications in the specified state.
    [-type <application-type>]

    Displays information about applications of the specified type.

    Input options:

    • EAR

    • EJB

    • WAR

    • CAR

    • RAR

    [-module <module-name>]Displays the module information of EAR.
    [-bean <bean-name>]

    Displays detailed information about an EJB Bean.

    Server, ID, and module information are required.

    [-jndi <jndi-context>]

    Displays the JNDI information about an application.

    Server and ID information are required.

    [-mod <jndi-module-name>]Displays the JNDI namespace of a module.
    [-comp <jndi-component-name>]Displays the namespace of a component.
    [-detail,--detail]

    Displays detailed information about a stand-alone module.

    For a web module, lists of servlets, filters, listeners, WebSocket Server Endpoints, and EJB Bean (EJB in a .war) are displayed.

  • Example

    [DAS]domain1.adminServer>application-info
    Application information for the domain [domain1].
    ================================================================================
    +------------+----------+---------+---------+---------+------------------------+
    | Application| Applicati|  State  |  Server | Cluster |    Application Path    |
    |     ID     | on Type  |         | Targets | Targets |                        |
    +------------+----------+---------+---------+---------+------------------------+
    | deployment_| EAR      | RUNNING | server1,|         | ${INSTALL_HOME}/deploym|
    |helloear    |          |         |server2  |         |ent_helloear/deployment_|
    |            |          |         |         |         |helloear.ear            |
    +------------+----------+---------+---------+---------+------------------------+
    ================================================================================

Deploys an application installed on DAS to the target servers. If deployment fails on a single server, application are undeployed from all successful servers.

  • Aliases

    deployapp, deploy

  • Usage

    deploy-application [<application-id>]
                   [-path,--applicationPath <path>]
                   [-servers <server-list>]
                   [-clusters <cluster-list>]
                   [-all]
                   [-vh,--virtualHost <virtual-host>]
                   [-type,--applicationType <application-type>]
                   [-cl,--classloading <classloading-mode>]
                   [-auto,--autoRedeployCheckInterval <auto-redeploy-check-interval>]
                   [-security,--securityDomainName <security-domain-name>]
                   [-fast,--fastDeploy]
                   [-keep,--keepGenerated]
                   [-shared,--sharedDisk]
                   [-u,--upgrade]
                   [-plan,--deploymentPlanName <deployment-plan-name>]
                   [-ctxp,--contextPath <context-path>]
                   [-staging]
                   [-con,--concurrent]
  • Parameters

    ParameterDescription
    [<application-id>]Application ID entered when the application was installed on DAS. To specify multiple application IDs, separate each ID with a comma (,). An ID can be given to an application when a file path is used for distribution. When using a file path, only one ID and one path can be entered.
    [-path,--applicationPath <path>]Path to application files. This option can be used when using the file path without installing the application on DAS. This is possible only when the files are in the same machine as DAS.
    [-servers <server-list>]Servers to which the application is to be deployed. To specify multiple servers, separate each server with a comma (,).
    [-clusters <cluster-list>]Clusters to which the application is to be deployed. To specify multiple clusters, separate each cluster with a comma (,).
    [-all]Deploys to all the servers in the domain.
    [-vh,--virtualHost <virtual-host>]Virtual host address. A virtual host name defined in the web engine can be selected. This option only operates in a web module.
    [-type,--applicationType <application-type>]

    Sets the application type.

    Input options:

    • EAR

    • EJB

    • WAR

    • CAR

    • RAR

    If not specified, this option can be set automatically through DD or annotation.

    [-cl,--classloading <classloading-mode>]

    Sets the class loading type.

    Input options:

    • SHARED

    • ISOLATED (Default value)

    [-auto,--autoRedeployCheckInterval <auto-redeploy-check-interval>]

    Interval at which to check for automatic application redeployment. (Unit: ms)

    [-security,--securityDomainName <security-domain-name>]

    Security domain name to be applied to the application.

    By default, the value set in default-application-domain of the domain configuration is used.

    [-fast,--fastDeploy]Option to use previously created files (if any exists) to speed up the deployment process.
    [-keep,--keepGenerated]Option to keep the files generated during deployment.
    [-shared,--sharedDisk]Uses NAS to avoid copying the application file.
    [-u,--upgrade]Changes the DD format of JEUS 6 or lower to JEUS 7 for compatibility.
    [-plan,-deploymentPlanName <deployment-plan-name>]Sets the deployment plan file name.
    [-ctxp,--contextPath <context-path>]Sets the context for web applications.
    [-staging]Compresses applications in an exploded module type to send to other machines.
    [-con, --concurrent]Option to deploy multiple applications simultaneously during deployment.
  • Example

    [DAS]domain1.adminServer>deploy-application deployment_helloear -servers server1 
    deploy the application for the application [deployment_helloear] succeeded.       

Distributes an application installed on DAS to each server or cluster. In order to run the service, the application must be started using the start-application command.

  • Aliases

    distributeapp, distapp, distribute

  • Usage

    distribute-application [<application-id>]
                   [-path,--applicationPath <path>]
                   [-servers <server-list>]
                   [-clusters <cluster-list>]
                   [-all]
                   [-vh,--virtualHost <virtual-host>]
                   [-type,--applicationType <application-type>]
                   [-cl,--classloading <classloading-mode>]
                   [-auto,--autoRedeployCheckInterval <auto-redeploy-check-interval>]
                   [-security,--securityDomainName <security-domain-name>]
                   [-fast,--fastDeploy]
                   [-keep,--keepGenerated]
                   [-shared,--sharedDisk]
                   [-u,--upgrade]
                   [-plan,--deploymentPlanName <deployment-plan-name>]
                   [-ctxp,--contextPath <context-path>]
                   [-staging]
                   [-con,--concurrent]
  • Parameters

    ParameterDescription
    [<application-id>]Application ID entered when the application was installed on DAS. To specify multiple application IDs, separate each ID with a comma (,). An ID can be given to an application when a file path is used for distribution. When using a file path, only one ID and one path can be entered.
    [-path,--applicationPath <path>]Path to application files. This option can be used when using the file path without installing the application on DAS. This is possible only when the files are in the same machine as DAS.
    [-servers <server-list>]Servers to which the application is to be deployed. To specify multiple servers, separate each server with a comma (,).
    [-clusters <cluster-list>]Clusters to which the application is to be deployed. To specify multiple clusters, separate each cluster with a comma (,).
    [-all]Installs onto all servers in the domain.
    [-vh,--virtualHost <virtual-host>]Virtual host address. A virtual host name defined in the web engine can be selected. This option only operates in a web module.
    [-type,--applicationType <application-type>]

    Sets the application type.

    Input options:

    • EAR

    • EJB

    • WAR

    • CAR

    • RAR

    If not specified, this option can be set automatically through DD or annotation.

    [-cl,--classloading <classloading-mode>]

    Sets the class loading type.

    Input options:

    • SHARED

    • ISOLATED (Default value)

    [-auto,--autoRedeployCheckInterval <auto-redeploy-check-interval>]

    Interval at which to check for automatic application redeployment. (Unit: ms)

    [-security,--securityDomainName <security-domain-name>]

    Security domain name to be applied to the application.

    By default, the value set in default-application-domain of the domain configuration is used.

    [-fast,--fastDeploy]Option to use previously created files (if any exists) to speed up the deployment process.
    [-keep,--keepGenerated]Option to keep the files generated during deployment.
    [-shared,--sharedDisk]Uses NAS to avoid copying the application file.
    [-u,--upgrade]Changes the DD format of JEUS 6 or lower to JEUS 7 for compatibility.
    [-plan,-deploymentPlanName <deployment-plan-name>]Sets the deployment plan file name.
    [-ctxp,--contextPath <context-path>]Sets the context for web applications.
    [-staging]Compresses applications in an exploded module type to send to other machines.
    [-con, --concurrent]Option to deploy multiple applications simultaneously during deployment.
  • Example

    [DAS]domain1.adminServer>distribute-application deployment_helloear -servers server1
    distribute the application for the application [deployment_helloear] succeeded.

The following is a list of EJB engine commands.

CommandDescription
cancel-ejb-timerCancels the EJB timer of a server.
ejb-timer-infoDisplays the EJB timer information of a server.
modify-active-managementChanges the active management of a server.
modify-check-resolutionChanges the resolution of a server.
show-active-managementDisplays the active management information of a server.
show-check-resolutionDisplays the resolution information of a server.

The following list two types of web engine commands.

Adds an HTTP Cookie Policy to the web engine. The changes only apply to the domain.xml file. In order to apply changes to the actual service, the server must be restarted.

  • Related Schema

    web-engine.xsd - web-engine/cookie-policy

  • Aliases

    addcookie

  • Usage

    add-web-cookie-policy [-cluster <cluster-name> | -server <server-name>]
                      [-f, -forceLock]
                      [-auer,--apply-url-encoding-rule <apply-url-encoding-rule>]
                      [-enc,--charset-encoding <charset-encoding>]
                      [-vh <virtual-host-name>]
  • Parameters

    ParameterDescription
    [-f, --forceLock]Forcibly applies the configuration changes.
    [-auer,--apply-url-encoding-rule <apply-url-encoding-rule>]Option to apply URL Encoding Rule.
    [-enc,--charset-encoding <charset-encoding>]Charset Encoding, which is used to apply the URL Encoding Rule. If not set, the Request Encoding value is used.
    [-vh <virtual-host-name>]Virtual host.
  • Example

    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -cp
    Cookie Policy configuration for [server1] 
    ================================================================================
    +------------------------------------------------------------------------------+
    |                                    Result                                    |
    +------------------------------------------------------------------------------+
    | The Cookie Policy configuration does not exist.                              |
    +------------------------------------------------------------------------------+
    ================================================================================
    
    [DAS]domain1.adminServer>add-web-cookie-policy -server server1 -auer true
    Successfully applied part of the changes.
    Restart the server to apply the remaining changes.
    For detailed cookie policy information, use the 'show-web-engine-configuration -cp' command.
    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -cp 
    Cookie policy configuration for [server1]
    ================================================================================
    +----------------------------------------------------------------------+-------+
    |                                 Name                                 | Value |
    +----------------------------------------------------------------------+-------+
    | write-value-on-header-policy.apply-url-encoding-rule                 | true  |
    | write-value-on-header-policy.charset-encoding                        |       |
    +----------------------------------------------------------------------+-------+
    ================================================================================
    
    [DAS]domain1.adminServer>add-web-cookie-policy -server server1 -enc EUC-KR
    The given charset name EUC-KRR is not a supported encoding.
    
    [DAS]domain1.adminServer>add-web-cookie-policy -server server1 -enc EUC-KR
    Successfully applied part of the changes.
    Restart the server to apply the remaining changes.
    For detailed cookie policy information, use the 'show-web-engine-configuration -cp' command.
    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -cp
    Cookie policy configuration for [server1]
    ================================================================================
    +---------------------------------------------------------------------+--------+
    |                                 Name                                |  Value |
    +---------------------------------------------------------------------+--------+
    | write-value-on-header-policy.apply-url-encoding-rule                | true   |
    | write-value-on-header-policy.charset-encoding                       | EUC-KR |
    +---------------------------------------------------------------------+--------+
    ================================================================================

Adds a Character Set Encoding to the web engine. The changes only apply to the domain.xml file. In order to apply changes to the actual service, the server must be restarted.

(To add an encoding, delete the existing encoding first. When encoding is changed, the change applies after the server restarts.)

  • Related Schema

    web-engine.xsd - web-engine/encoding

  • Aliases

    addenc

  • Usage

    add-web-encoding [-cluster <cluster-name> | -server <server-name>]
                    [-f, -forceLock]
                    <charset encoding>
                    -co | -default | -forced
                    [-url]
                    [-req]
                    [-res]
                    [-vh <virtual-host-name>]
  • Parameters

    ParameterDescription
    [-f, --forceLock]Forcibly applies the configuration changes.
    <charset encoding>Character set encoding name to be set. If an invalid value is entered, an error message is displayed and the command fails.
    -co | -default | -forcedSets the entered encoding to either default or forced. For a request encoding (not including the two values), client-override can be set.
    [-url]Character set encoding of Request URL.
    [-req]Character set encoding of requests.
    [-res]Character set encoding of responses.
    [-vh <virtual-host-name>]Virtual host.
  • Example

    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -enc
    Encoding configuration for [server1]
    ================================================================================
    +------------------------------------------------------------------------------+
    |                                    Result                                    |
    +------------------------------------------------------------------------------+
    | encoding configuration does not exist.                                       |
    +------------------------------------------------------------------------------+
    ================================================================================
    
    [DAS]domain1.adminServer>add-web-encoding -server server1 -default -url INVALID-ENCODING
    The given charset name INVALID-ENCODING is not a supported encoding.
    
    [DAS]domain1.adminServer>add-web-encoding -server server1 -default
    A required argument is missing: <charset encoding>
    
    [DAS]domain1.adminServer>add-web-encoding -server server1 UTF-8 -default
    Either req, url, or res must be specified.
    
    [DAS]domain1.adminServer>add-web-encoding -server server1 -default -url UTF-8
    Successfully changed only the XML.
    Restart the server to apply the changes.
    For detailed encoding information, use the 'show-web-engine-configuration -enc' command.
    
    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -enc
    Encoding configuration for [server1]
    ================================================================================
    +----------------------------------------------------------------------+-------+
    |                                 Name                                 | Value |
    +----------------------------------------------------------------------+-------+
    | encoding.request-url-encoding.default                                | UTF-8 |
    | encoding.request-encoding                                            |       |
    | encoding.response-encoding                                           |       |
    +----------------------------------------------------------------------+-------+
    ================================================================================
    
    [DAS]domain1.adminServer>addenc -server server1 UTF-8 -forced -req -res
    Successfully applied part of the changes.
    Restart the server to apply the remaining changes.
    For detailed encoding information, use the 'show-web-engine-configuration -enc' command.
    
    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -enc
    Encoding configuration for [server1]
    ================================================================================
    +----------------------------------------------------------------------+-------+
    |                                 Name                                 | Value |
    +----------------------------------------------------------------------+-------+
    | encoding.request-url-encoding.default                                | UTF-8 |
    | encoding.request-encoding.forced                                     | UTF-8 |
    | encoding.response-encoding.forced                                    | UTF-8 |
    +----------------------------------------------------------------------+-------+
    ================================================================================

Adds property configurations to the web engine. The added property is case sensitive. The changes only apply to the domain.xml file. In order to apply changes to the actual service, the server must be restarted.

  • Related Schema

    web-engine.xsd - web-engine/properties

  • Aliases

    addwebpr

  • Usage

    add-web-properties [-cluster <cluster-name> | -server <server-name>]
                       [-f, -forceLock]
                       [-p,--properties <properties>] 
                       [-vh <virtual-host-name>]
  • Parameters

    ParameterDescription
    [-f, --forceLock]Forcibly applies the configuration changes.
    [-p,--properties <properties>]

    Properties to be added to the web engine.

    To set a property, use an equal sign ("="). E.g., "key=value".

    To specify multiple properties, separate each property with a comma (,).

    [-vh <virtual-host-name>]Virtual host.
  • Example

    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -pr
    Properties configuration for [server1] 
    ================================================================================
    +------------------------------------------------------------------------------+
    |                                    Result                                    |
    +------------------------------------------------------------------------------+
    | The Properties configuration does not exist.                                 |
    +------------------------------------------------------------------------------+
    ================================================================================
    
    [DAS]domain1.adminServer>add-web-properties -server server1
    The following options are missing: p
    
    [DAS]domain1.adminServer>add-web-properties -server server1 -p jeus.servlet.x
    jeus.servlet.x is a invalid property. The property name and value must be separated by the "=" character.
    [DAS]domain1.adminServer>add-web-properties -server server1 -p jeus.servlet.jsp.compile-java-source-concurrently=true
    Successfully applied part of the changes.
    Restart the server to apply the remaining changes.
    For detailed web engine property information, use the 'show-web-engine-configuration -pr' command.
    
    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -pr
    Properties configuration for [server1]
    ================================================================================
    +----------------------------------------------------------------------+-------+
    |                                 Name                                 | Value |
    +----------------------------------------------------------------------+-------+
    | jeus.servlet.jsp.compile-java-source-concurrently                    | true  |
    +----------------------------------------------------------------------+-------+
    ================================================================================
    
    [DAS]domain1.adminServer>add-web-properties -server server1 -p jeus.servlet.jsp.compile-java-source-concurreltly1=false
    Adding the web engine property jeus.servlet.jsp.compile-java-source-concurreltly1=false failed because it already exist.
    
    [DAS]domain1.adminServer>add-web-properties -server server1 -p jeus.servlet.jsp.compile-java-source-concurrently1=false,
    jeus.servlet.jsp.assure-utf8-file-encoding-detection=true
    Successfully applied part of the changes.
    Restart the server to apply the remaining changes.
    For detailed web engine property information, use the 'show-web-engine-configuration -pr' command.
    
    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -pr
    Properties configuration for [server1]
    ================================================================================
    +----------------------------------------------------------------------+-------+
    |                                 Name                                 | Value |
    +----------------------------------------------------------------------+-------+
    | jeus.servlet.jsp.compile-java-source-concurrently1                   | false |
    | jeus.servlet.jsp.assure-utf8-file-encoding-detection                 | true  |
    | jeus.servlet.jsp.compile-java-source-concurrently                    | true  |
    +----------------------------------------------------------------------+-------+
    ================================================================================
    [DAS]domain1.adminServer>

Adds an HTTP Response Header configuration to the web engine. The Response Header is not case sensitive. The changes only apply to the domain.xml file. In order to apply changes to the actual service, the server must be restarted.

  • Related Schema

    web-engine.xsd - web-engine/response-header

  • Aliases

    addwebrh

  • Usage

    add-response-header [-cluster <cluster-name> | -server <server-name>]
                        [-f, --forceLock]
                        [-n,--name <header-name>]
                        [-v,--value <header-value>]
  • Parameters

    ParameterDescription
    [-f, --forceLock]Forcibly applies the configuration changes.
    [-n,--name <header-name>]Name of HTTP Response Header to be added. The name is case insensitive. Each header name must be unique.
    [-v,--value <header-value>]Value of HTTP Response Header to be added. The value is case insensitive.
  • Example

    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -rh
    Response Custom Header configuration for [server1]
    ================================================================================
    +------------------------------------------------------------------------------+
    |                                    Result                                    |
    +------------------------------------------------------------------------------+
    | The Response Custom Header configuration does not exist.                     |
    +------------------------------------------------------------------------------+
    ================================================================================
    [DAS]domain1.adminServer>add-response-header -server server1
    The header-name option and the header-value option must both be specified.
    [DAS]domain1.adminServer>add-response-header -server server1 -n testHeader
    The header-name option and the header-value option must both be specified.
    [DAS]domain1.adminServer>add-response-header -server server1 -v testValue
    The header-name option and the header-value option must both be specified.
    [DAS]domain1.adminServer>add-response-header -server server1 -n testHeader -v testValue
    Successfully applied part of the changes.
    Restart the server to apply the remaining changes.
    For detailed custom response header information, use the 'show-web-engine-configuration -rh' command.
    
    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -rh
    Response custom header configuration for [server1]
    ======================================================
    +----------------------------------------+-----------+
    |                  Name                  |   Value   |
    +----------------------------------------+-----------+
    | testheader                             | testvalue |
    +----------------------------------------+-----------+
    ======================================================
    
    [DAS]domain1.adminServer>add-response-header -server server1 -n testHeader -v testValue2
    Adding the custom response header testheader=testvalue2 failed because the header testheader=testvalue already exists.
    [DAS]domain1.adminServer>add-response-header -server server1 -n testHeader2 -v testValue2
    Successfully applied part of the changes.
    Restart the server to apply the remaining changes.
    For detailed custom response header information, use the 'show-web-engine-configuration -rh' command.
    
    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -rh
    Response custom header configuration for [server1]
    =======================================================
    +----------------------------------------+------------+
    |                  Name                  |    Value   |
    +----------------------------------------+------------+
    | testheader                             | testvalue  |
    | testheader2                            | testvalue2 |
    +----------------------------------------+------------+
    =======================================================

Adds a Tmax connector. The changes only apply to the domain.xml file. In order to apply changes to the actual service, the server must be restarted.

  • Related Schema

    web-engine.xsd - web-engine/web-connections/tmax-connector

  • Aliases

    addtmaxcon

  • Usage

    add-tmax-connector [-cluster <cluster-name> | -server <server-name>]
                       [-f, --forceLock]
                       -name <web-connection-name>
                       -tmin <minimum-thread-num>
                       [-tmax <maximum-thread-num>]
                       -addr <server-address>
                       -port <server-port>
                       -svrg <server-group-name>
                       -svr <server-name>
                       -dcc <dispatcher-config-class>
  • Parameters

    ParameterDescription
    [-f, --forceLock]Forcibly applies the configuration changes.
    -name <web-connection-name>Tmax Connector name.
    -tmin <minimum-thread-num>Minimum number of threads in the thread pools.
    [-tmax <maximum-thread-num>]Maximum number of threads in the thread pools.
    -addr <server-address>Tmax server address.
    -port <server-port>Tmax server port.
    -svrg <server-group-name>Tmax server group name.
    -svr <server-name>Tmax server name.
    -dcc <dispatcher-config-class>Class name that implements the jeus.servlet.tcp.TCPDispatcherConfig interface.
  • Example

    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -cn
    Http listener[ADMIN-HTTP] configuration for [server1]
    ================================================================================
    +-----------------------------------------------------------------+------------+
    |                               Name                              |    Value   |
    +-----------------------------------------------------------------+------------+
    | name                                                            | ADMIN-HTTP |
    | server-listener-ref                                             | base       |
    | max-keep-alive-request                                          |            |
    | server-access-control                                           | false      |
    | allowed-server                                                  |            |
    | connection-type                                                 |            |
    | output-buffer-size                                              |       8192 |
    | postdata-read-timeout                                           |      30000 |
    | max-post-size                                                   | unlimited  |
    | max-parameter-count                                             | unlimited  |
    | max-header-count                                                | unlimited  |
    | max-header-size                                                 | unlimited  |
    | max-querystring-size                                            |       8192 |
    | threadpool.min                                                  |          1 |
    | threadpool.max                                                  |         32 |
    | threadpool.max-idle-time                                        |     300000 |
    | threadpool.max-queue                                            | unlimited  |
    | threadpool.thread-state-notify                                  |            |
    +-----------------------------------------------------------------+------------+
    ================================================================================
    
    [DAS]domain1.adminServer>add-tmax-connector -name tmax1 -tmin 20 -tmax 20 -addr 5.0.1.2 -port 1024 
    -svrg group1 -svr server1 -server server1 -dcc serice.DispatcherConfig
    Successfully changed only the XML.
    Restart the server to apply the changes.
    For detailed web connection information, use the 'show-web-engine-configuration -cn' command.
    
    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -cn
    Tmax connector[tmax1] configuration for [server1]
    ================================================================================
    +-------------------------------------------+----------------------------------+
    |                    Name                   |               Value              |
    +-------------------------------------------+----------------------------------+
    | name                                      | tmax1                            |
    | port                                      |                             1024 |
    | server-group-name                         | group1                           |
    | server-name                               | server1                          |
    | dispatcher-config-class                   | service.DispatcherConfig         |
    | reconnect-interval                        |                             5000 |
    | reconnect-count-for-backup                |                               12 |
    | tmax-address                              | 5.0.1.2                          |
    | tmax-version                              |                                  |
    | server-type                               |                                  |
    | xaresource-class                          |                                  |
    | tmax-backup-address                       |                                  |
    | tmax-backup-port                          |                                  |
    | use-nio                                   | false                            |
    | selector-count                            |                                1 |
    | connection-type                           |                                  |
    | output-buffer-size                        |                             8192 |
    | postdata-read-timeout                     |                            30000 |
    | max-post-size                             | unlimited                        |
    | max-parameter-count                       | unlimited                        |
    | max-header-count                          | unlimited                        |
    | max-header-size                           | unlimited                        |
    | max-querystring-size                      |                             8192 |
    | threadpool.min                            |                               20 |
    | threadpool.max                            |                               20 |
    | threadpool.max-idle-time                  |                           300000 |
    | threadpool.max-queue                      | unlimited                        |
    | threadpool.thread-state-notify            |                                  |
    +-------------------------------------------+----------------------------------+
    ================================================================================
    
    Http listener[ADMIN-HTTP] configuration for [server1]
    ================================================================================
    +-----------------------------------------------------------------+------------+
    |                               Name                              |    Value   |
    +-----------------------------------------------------------------+------------+
    | name                                                            | ADMIN-HTTP |
    | server-listener-ref                                             | base       |
    | max-keep-alive-request                                          |            |
    | server-access-control                                           | false      |
    | allowed-server                                                  |            |
    | connection-type                                                 |            |
    | output-buffer-size                                              |       8192 |
    | postdata-read-timeout                                           |      30000 |
    | max-post-size                                                   | unlimited  |
    | max-parameter-count                                             | unlimited  |
    | max-header-count                                                | unlimited  |
    | max-header-size                                                 | unlimited  |
    | max-querystring-size                                            |       8192 |
    | threadpool.min                                                  |          1 |
    | threadpool.max                                                  |         32 |
    | threadpool.max-idle-time                                        |     300000 |
    | threadpool.max-queue                                            | unlimited  |
    | threadpool.thread-state-notify                                  |            |
    +-----------------------------------------------------------------+------------+
    ================================================================================

Adds a virtual host. The changes only apply to the domain.xml file. In order to apply changes to the actual service, the server must be restarted.

  • Related Schema

    web-engine.xsd - web-engine/virtual-host

  • Aliases

    addvh

  • Usage

    add-virtual-host [-cluster <cluster-name> | -server <server-name>]
                     [-f, --forceLock]
                     <virtual-host-name>
                     -list <host-name-list>
  • Parameters

    ParameterDescription
    [-f, --forceLock]Forcibly applies the configuration changes.
    <virtual-host-name>Virtual host name.
    -list <host-name-list>Domain name or IP address to be registered in the virtual host.
  • Example

    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -vh
    Virtual Host configuration for [server1]
    ================================================================================
    +------------------------------------------------------------------------------+
    |                                    Result                                    |
    +------------------------------------------------------------------------------+
    | The Virtual Host configuration does not exist.                               |
    +------------------------------------------------------------------------------+
    ================================================================================
    [DAS]domain1.adminServer>add-virtual-host -server server1 host2 -list www.foo.com,192.168.1.2
    Successfully changed only the XML.
    Restart the server to apply the changes.
    For detailed virtual-host information, use the 'show-web-engine-configuration -vh' command.
    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -vh
    Virtual host[host2] configuration for [server1]
    ================================================================================
    +-------------------------------------+----------------------------------------+
    |                 Name                |                  Value                 |
    +-------------------------------------+----------------------------------------+
    | virtual-host-name                   | host2                                  |
    +-------------------------------------+----------------------------------------+
    | host-name                           | www.foo.com                            |
    |                                     | 192.168.1.2                            |
    +-------------------------------------+----------------------------------------+
    | access-log.enable                   | true                                   |
    +-------------------------------------+----------------------------------------+
    | access-log.format                   | default                                |
    +-------------------------------------+----------------------------------------+
    | access-log.exclude-ext              |                                        |
    +-------------------------------------+----------------------------------------+
    | access-log.use-parent-handlerst     | true                                   |
    +-------------------------------------+----------------------------------------+
    | access-log.formatter-class          | jeus.util.logging.SimpleFormatter      |
    +-------------------------------------+----------------------------------------+
    | properties                          |                                        |
    +-------------------------------------+----------------------------------------+
    ================================================================================

Adds the HTTP, TCP, and AJP listeners. The changes to the TCP listener only apply to the domain.xml file. In order to apply changes to the actual service, the server must be restarted.

  • Related Schema

    web-engine.xsd - web-engine/web-connections/http-listener, ajp13-listener, tcp-listener

  • Aliases

    addwebl

  • Usage

    add-web-listener [-cluster <cluster-name> | -server <server-name>]
                     [-f, --forceLock]
                     -name <web-connection-name>
                     -tmin <minimum-thread-num>
                     [-tmax <maximum-thread-num>]
                     [-ajp | -http | -tcp]
                     -slref <server-listener-ref-name>
                     [-dcc <dispatcher-config-class>]
  • Parameters

    ParameterDescription
    [-f, --forceLock]Forcibly applies the configuration changes.
    -name <web-connection-name>Listener name.
    -tmin <minimum-thread-num>Minimum number of threads in the thread pools.
    [-tmax <maximum-thread-num>]Maximum number of threads in the thread pools.
    [-ajp | -http | -tcp]Listener type. If not specified, -http is used.
    -slref <server-listener-ref-name>Service listener name registered to the server.
    [-dcc <dispatcher-config-class>]Class name that implements the jeus.servlet.tcp.TCPDispatcherConfig interface. It is required for a TCP listener.
  • Example

    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -cn
    
    Http listener[ADMIN-HTTP] configuration for [server1]
    ================================================================================
    +-----------------------------------------------------------------+------------+
    |                               Name                              |    Value   |
    +-----------------------------------------------------------------+------------+
    | name                                                            | ADMIN-HTTP |
    | server-listener-ref                                             | base       |
    | max-keep-alive-request                                          |            |
    | server-access-control                                           | false      |
    | allowed-server                                                  |            |
    | connection-type                                                 |            |
    | output-buffer-size                                              |       8192 |
    | postdata-read-timeout                                           |      30000 |
    | max-post-size                                                   | unlimited  |
    | max-parameter-count                                             | unlimited  |
    | max-header-count                                                | unlimited  |
    | max-header-size                                                 | unlimited  |
    | max-querystring-size                                            |       8192 |
    | threadpool.min                                                  |          1 |
    | threadpool.max                                                  |         32 |
    | threadpool.max-idle-time                                        |     300000 |
    | threadpool.max-queue                                            | unlimited  |
    | threadpool.thread-state-notify                                  |            |
    +-----------------------------------------------------------------+------------+
    ================================================================================
    
    [DAS]domain1.adminServer>add-web-listener -name http1 -tmin 10 -tmax 20 -server server1 -slref srvl1
    The server listener was not found. Add a server listener first.
    
    [DAS]domain1.adminServer>list-server-listeners -server server1
    ========================================================
    +------------------------------------+---------+-------+
    |            listener-name           | address |  port |
    +------------------------------------+---------+-------+
    | base                               | not-set | 19376 |
    | http-server                        | not-set | 18088 |
    | ajp                                | not-set | 18089 |
    | tcp                                | not-set | 18090 |
    | jms-internal                       | not-set | 19741 |
    +------------------------------------+---------+-------+
    ========================================================
    
    [DAS]domain1.adminServer>add-web-listener -name http1 -tmin 10 -tmax 20 -server server1 -slref http-server
    Successfully changed only the XML.
    Restart the server to apply the changes.
    For detailed web connection information, use the 'show-web-engine-configuration -cn' command.
    
    [DAS]domain1.adminServer>add-web-listener -name ajp -ajp -tmin 10 -tmax 20 -server server1 -slref ajp
    Successfully changed only the XML.
    Restart the server to apply the changes.
    For detailed web connection information, use the 'show-web-engine-configuration -cn' command.
    
    [DAS]domain1.adminServer>add-web-listener -name tcp1 -tcp -tmin 10 -tmax 20 -slref tcp -server server1 -dcc tcp.DispatcherConfigImpl
    Successfully changed only the XML.
    Restart the server to apply the changes.
    For detailed web connection information, use the 'show-web-engine-configuration -cn' command.
    
    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -cn
    Ajp13 listener[ajp] configuration for [server1]
    ================================================================================
    +------------------------------------------------------------------+-----------+
    |                               Name                               |   Value   |
    +------------------------------------------------------------------+-----------+
    | name                                                             | ajp       |
    | server-listener-ref                                              | ajp       |
    | read-timeout                                                     |         0 |
    | server-access-control                                            | false     |
    | allowed-server                                                   |           |
    | output-buffer-size                                               |      8192 |
    | postdata-read-timeout                                            |     30000 |
    | max-post-size                                                    | unlimited |
    | max-parameter-count                                              | unlimited |
    | max-header-count                                                 | unlimited |
    | max-header-size                                                  | unlimited |
    | max-querystring-size                                             |      8192 |
    | threadpool.min                                                   |        10 |
    | threadpool.max                                                   |        20 |
    | threadpool.max-idle-time                                         |    300000 |
    | threadpool.max-queue                                             | unlimited |
    | threadpool.thread-state-notify                                   |           |
    +------------------------------------------------------------------+-----------+
    ================================================================================
    
    Http listener[ADMIN-HTTP] configuration for [server1]
    ================================================================================
    +-----------------------------------------------------------------+------------+
    |                               Name                              |    Value   |
    +-----------------------------------------------------------------+------------+
    | name                                                            | ADMIN-HTTP |
    | server-listener-ref                                             | base       |
    | max-keep-alive-request                                          |            |
    | server-access-control                                           | false      |
    | allowed-server                                                  |            |
    | connection-type                                                 |            |
    | output-buffer-size                                              |       8192 |
    | postdata-read-timeout                                           |      30000 |
    | max-post-size                                                   | unlimited  |
    | max-parameter-count                                             | unlimited  |
    | max-header-count                                                | unlimited  |
    | max-header-size                                                 | unlimited  |
    | max-querystring-size                                            |       8192 |
    | threadpool.min                                                  |          1 |
    | threadpool.max                                                  |         32 |
    | threadpool.max-idle-time                                        |     300000 |
    | threadpool.max-queue                                            | unlimited  |
    | threadpool.thread-state-notify                                  |            |
    +-----------------------------------------------------------------+------------+
    ================================================================================
    
    Http listener[http1] configuration for [server1]
    ======================================================================
    +------------------------------------------------------+-------------+
    |                         Name                         |    Value    |
    +------------------------------------------------------+-------------+
    | name                                                 | http1       |
    | server-listener-ref                                  | http-server |
    | max-keep-alive-request                               |             |
    | server-access-control                                | false       |
    | allowed-server                                       |             |
    | connection-type                                      |             |
    | output-buffer-size                                   |        8192 |
    | postdata-read-timeout                                |       30000 |
    | max-post-size                                        | unlimited   |
    | max-parameter-count                                  | unlimited   |
    | max-header-count                                     | unlimited   |
    | max-header-size                                      | unlimited   |
    | max-querystring-size                                 |        8192 |
    | threadpool.min                                       |          10 |
    | threadpool.max                                       |          20 |
    | threadpool.max-idle-time                             |      300000 |
    | threadpool.max-queue                                 | unlimited   |
    | threadpool.thread-state-notify                       |             |
    +------------------------------------------------------+-------------+
    ======================================================================
    
    TCP listener[tcp1] configuration for [server1]
    ================================================================================
    +-------------------------------------------+----------------------------------+
    |                    Name                   |               Value              |
    +-------------------------------------------+----------------------------------+
    | name                                      | tcp1                             |
    | server-listener-ref                       | tcp                              |
    | dispatcher-config-class                   | tcp.DispatcherConfigImpl         |
    | server-access-control                     | false                            |
    | allowed-server                            |                                  |
    | connection-type                           |                                  |
    | output-buffer-size                        |                             8192 |
    | postdata-read-timeout                     |                            30000 |
    | max-post-size                             | unlimited                        |
    | max-parameter-count                       | unlimited                        |
    | max-header-count                          | unlimited                        |
    | max-header-size                           | unlimited                        |
    | max-querystring-size                      |                             8192 |
    | threadpool.min                            |                               10 |
    | threadpool.max                            |                               20 |
    | threadpool.max-idle-time                  |                           300000 |
    | threadpool.max-queue                      | unlimited                        |
    | threadpool.thread-state-notify            |                                  |
    +-------------------------------------------+----------------------------------+
    ================================================================================

Adds a WebtoB connector. The added WebtoB connector can be used for the actual service. Once added, the WebtoB address and port cannot be changed.

  • Related Schema

    web-engine.xsd - web-engine/web-connections/webtob-connector

  • Aliases

    addwebtobcon

  • Usage

    add-webtob-connector [-cluster <cluster-name> | -server <server-name>]
                         [-f, --forceLock]
                         -name <web-connection-name>
                         -num <thread-number>
                         [-ver <wjp-version>]
                         [-addr <server-address>]
                         -port <server-port> | -dsocket
                         -regid <registration-id>
                         [-wbhome <webtob-home>]
                         [-ipcport <ipc-base-port>]
                         [-sndbuf <send-buffer-size>]
                         [-rcvbuf <receive-buffer-size>]
  • Parameters

    ParameterDescription
    [-f, --forceLock]Forcibly applies the configuration changes.
    -name <web-connection-name>WebtoB Connector name.
    -num <thread-number>Number of threads in the thread pools.
    -ver <wjp-version>Protocol version used for communication with WebtoB. Input options are 1 and 2.
    -addr <server-address>WebtoB server address. If -port is used, this option is required.
    -port <server-port>WebtoB server port.
    -regid <registration-id>Registration ID in WebtoB.
    -dsocketOption to use Unix Domain Socket (Pipe) for communication between JEUS and WebtoB.
    -wbhome <webtob-home>Absolute path to WebtoB when WebtoB is installed on the same machine as JEUS.
    -ipcport <ipc-base-port>Default port number used for communication between internal processes of WebtoB in a Windows environment.
    -sndbuf <send-buffer-size>SO_SNDBUF. The size of the send buffer of the TCP socket or the Unix Domain Socket. If set to 0, the default value of the OS is used.
    -rcvbuf <receive-buffer-size>SO_RCVBUF. The size of the receive buffer of the TCP Socket or the Unix Domain Socket. If set to 0, the default value of the OS is used.
  • Example

    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -cn
    Http listener[ADMIN-HTTP] configuration for [server1]
    ================================================================================
    +-----------------------------------------------------------------+------------+
    |                               Name                              |    Value   |
    +-----------------------------------------------------------------+------------+
    | name                                                            | ADMIN-HTTP |
    | server-listener-ref                                             | base       |
    | max-keep-alive-request                                          |            |
    | server-access-control                                           | false      |
    | allowed-server                                                  |            |
    | connection-type                                                 |            |
    | output-buffer-size                                              |       8192 |
    | postdata-read-timeout                                           |      30000 |
    | max-post-size                                                   | unlimited  |
    | max-parameter-count                                             | unlimited  |
    | max-header-count                                                | unlimited  |
    | max-header-size                                                 | unlimited  |
    | max-querystring-size                                            |       8192 |
    | threadpool.min                                                  |          1 |
    | threadpool.max                                                  |         32 |
    | threadpool.max-idle-time                                        |     300000 |
    | threadpool.max-queue                                            | unlimited  |
    | threadpool.thread-state-notify                                  |            |
    +-----------------------------------------------------------------+------------+
    ================================================================================
    
    [DAS]domain1.adminServer>add-webtob-connector -server server1 -name webtob1 -num 10 -regid MyGroup -port 9999
    Specify the server-address option with the server-port option.
    [DAS]domain1.adminServer>add-webtob-connector -server server1 -name webtob1 -num 10 -regid MyGroup -port 9999 -addr localhost
    Successfully applied the configuration changes.
    For detailed web connection information, use the 'show-web-engine-configuration -cn' command.
    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -cn
    ================================================================================
    +-----------------------------------------------------------------+------------+
    |                               Name                              |    Value   |
    +-----------------------------------------------------------------+------------+
    | name                                                            | ADMIN-HTTP |
    | server-listener-ref                                             | base       |
    | max-keep-alive-request                                          |            |
    | server-access-control                                           | false      |
    | allowed-server                                                  |            |
    | connection-type                                                 |            |
    | output-buffer-size                                              |       8192 |
    | postdata-read-timeout                                           |      30000 |
    | max-post-size                                                   | unlimited  |
    | max-parameter-count                                             | unlimited  |
    | max-header-count                                                | unlimited  |
    | max-header-size                                                 | unlimited  |
    | max-querystring-size                                            |       8192 |
    | threadpool.min                                                  |          1 |
    | threadpool.max                                                  |         32 |
    | threadpool.max-idle-time                                        |     300000 |
    | threadpool.max-queue                                            | unlimited  |
    | threadpool.thread-state-notify                                  |            |
    +-----------------------------------------------------------------+------------+
    ================================================================================
    
    WebtoB connector[webtob1] configuration for [server1]
    ================================================================================
    +------------------------------------------------------------------+-----------+
    |                               Name                               |   Value   |
    +------------------------------------------------------------------+-----------+
    | name                                                             | webtob1   |
    | port                                                             |      9999 |
    | ip-address                                                       | localhost |
    | hth-count                                                        |         1 |
    | request-prefetch                                                 | false     |
    | registration-id                                                  | MyGroup   |
    | read-timeout                                                     |         0 |
    | reconnect-interval                                               |      5000 |
    | connection-type                                                  |           |
    | output-buffer-size                                               |      8192 |
    | postdata-read-timeout                                            |     30000 |
    | max-post-size                                                    | unlimited |
    | max-parameter-count                                              | unlimited |
    | max-header-count                                                 | unlimited |
    | max-header-size                                                  | unlimited |
    | max-querystring-size                                             |      8192 |
    | threadpool.number                                                |        10 |
    | threadpool.thread-state-notify                                   |           |
    | send-buffer-size                                                 |           |
    | receive-buffer-size                                              |           |
    +------------------------------------------------------------------+-----------+
    ================================================================================

Changes the HTTP Cookie Policy configurations of the web engine. The changes only apply to the domain.xml file. In order to apply changes to the actual service, the server must be restarted.

  • Related Schema

    web-engine.xsd - web-engine/cookie-policy

  • Aliases

    modcookie

  • Usage

    modify-web-cookie-policy [-cluster <cluster-name> | -server <server-name>]
                         [-auer,--apply-url-encoding-rule <apply-url-encoding-rule>]
                         [-enc,--charset-encoding <charset-encoding>]
                         [-vh <virtual-host-name>]
  • Parameters

    ParameterDescription
    [-f, --forceLock]Forcibly applies the configuration changes.
    [-auer,--apply-url-encoding-rule <apply-url-encoding-rule>]Option to apply URL Encoding Rule.
    [-enc,--charset-encoding <charset-encoding>]Charset encoding used when applying URL Encoding Rule.
    [-vh <virtual-host-name>]Virtual host.
  • Example

    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -cp
    Cookie policy configuration for [server1]
    ================================================================================
    +---------------------------------------------------------------------+--------+
    |                                 Name                                |  Value |
    +---------------------------------------------------------------------+--------+
    | write-value-on-header-policy.apply-url-encoding-rule                | true   |
    | write-value-on-header-policy.charset-encoding                       | EUC-KR |
    +---------------------------------------------------------------------+--------+
    ================================================================================
    
    [DAS]domain1.adminServer>modify-web-cookie-policy -server server1 -auer false
    Successfully applied part of the changes.
    Restart the server to apply the remaining changes.
    For detailed cookie policy information, use the 'show-web-engine-configuration -cp' command.
    
    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -cp
    Cookie policy configuration for [server1]
    ================================================================================
    +---------------------------------------------------------------------+--------+
    |                                 Name                                |  Value |
    +---------------------------------------------------------------------+--------+
    | write-value-on-header-policy.apply-url-encoding-rule                | false  |
    | write-value-on-header-policy.charset-encoding                       | EUC-KR |
    +---------------------------------------------------------------------+--------+
    ================================================================================
    
    [DAS]domain1.adminServer>modify-web-cookie-policy -server server1 -enc UTF-88
    The given charset name UTF-88 is not a supported encoding.
    [DAS]domain1.adminServer>modify-web-cookie-policy -server server1 -enc UTF-8
    Successfully applied part of the changes.
    Restart the server to apply the remaining changes.
    For detailed cookie policy information, use the 'show-web-engine-configuration -cp' command.
    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -cp
    Cookie policy configuration for [server1]
    ================================================================================
    +----------------------------------------------------------------------+-------+
    |                                 Name                                 | Value |
    +----------------------------------------------------------------------+-------+
    | write-value-on-header-policy.apply-url-encoding-rule                 | false |
    | write-value-on-header-policy.charset-encoding                        | UTF-8 |
    +----------------------------------------------------------------------+-------+
    ================================================================================

Changes the property configurations of the web engine. The changes only apply to the domain.xml file. In order to apply changes to the actual service, the server must be restarted.

  • Related Schema

    web-engine.xsd - web-engine/encoding

  • Aliases

    modenc

  • Usage

    modify-web-encoding [-cluster <cluster-name> | -server <server-name>]
                        [-f, --forceLock]
                        <charset encoding>
                        -co | -default | -forced
                        [-url]
                        [-req]
                        [-res]
                        [-vh <virtual-host-name>]
  • Parameters

    ParameterDescription
    [-f, --forceLock]Forcibly applies the configuration changes.
    <charset encoding>Character set encoding name to be changed. If an invalid value is entered, an error message is displayed and the command fails.
    -co | -default | -forcedSets the encoding to either default or forced. For a request encoding, besides the two values, client-override can be set.
    [-url]Character set encoding of Request URL.
    [-req]Character set encoding of requests.
    [-res]Character set encoding of responses.
    [-vh <virtual-host-name>]Virtual host.
  • Example

    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -enc
    Encoding configuration for [server1]
    ================================================================================
    +----------------------------------------------------------------------+-------+
    |                                 Name                                 | Value |
    +----------------------------------------------------------------------+-------+
    | encoding.request-url-encoding.default                                | UTF-8 |
    | encoding.request-encoding.forced                                     | UTF-8 |
    | encoding.response-encoding.forced                                    | UTF-8 |
    +----------------------------------------------------------------------+-------+
    ================================================================================
    [DAS]domain1.adminServer>modify-web-encoding -server server1 EUC-KRR -forced -url
    The given charset name EUC-KRR is not a supported encoding.
    [DAS]domain1.adminServer>modify-web-encoding -server server1 EUC-KR -default
    Either req, url, or res must be specified.
    [DAS]domain1.adminServer>modify-web-encoding -server server1 EUC-KR -forced -url
    Successfully applied part of the changes.
    Restart the server to apply the remaining changes.
    For detailed encoding information, use the 'show-web-engine-configuration -enc' command.
    
    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -enc
    Encoding configuration for [server1]
    ================================================================================
    +---------------------------------------------------------------------+--------+
    |                                 Name                                |  Value |
    +---------------------------------------------------------------------+--------+
    | encoding.request-url-encoding.forced                                | EUC-KR |
    | encoding.request-encoding.forced                                    | UTF-8  |
    | encoding.response-encoding.forced                                   | UTF-8  |
    +---------------------------------------------------------------------+--------+
    ================================================================================
    
    [DAS]domain1.adminServer>modify-web-encoding -server server1 ISO-8859-1 -default -url -res -req
    Successfully applied part of the changes.
    Restart the server to apply the remaining changes.
    For detailed encoding information, use the 'show-web-engine-configuration -enc' command.
    
    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -enc
    Encoding configuration for [server1]
    ================================================================================
    +-----------------------------------------------------------------+------------+
    |                               Name                              |    Value   |
    +-----------------------------------------------------------------+------------+
    | encoding.request-url-encoding.default                           | ISO-8859-1 |
    | encoding.request-encoding.default                               | ISO-8859-1 |
    | encoding.response-encoding.default                              | ISO-8859-1 |
    +-----------------------------------------------------------------+------------+
    ================================================================================

Changes property configurations of the web engine. The changed properties are case sensitive. The changes only apply to the domain.xml file. In order to apply changes to the actual service, the server must be restarted.

  • Related Schema

    web-engine.xsd - web-engine/properties

  • Aliases

    modwebpr

  • Usage

    modify-web-properties [-cluster <cluster-name> | -server <server-name>]
                          [-f, --forceLock]
                          [-p,--properties <properties>] 
                          [-vh <virtual-host-name>]
  • Parameters

    ParameterDescription
    [-f, --forceLock]Forcibly applies the configuration changes.
    [-p,--properties <properties>]

    Properties to be changed in the web engine.

    To set a property, use an equal sign ("="). E.g., "key=value".

    To specify multiple properties, separate each property with a comma (,).

    [-vh <virtual-host-name>]Virtual host.
  • Example

    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -pr
    Properties configuration for [server1]
    ================================================================================
    +----------------------------------------------------------------------+-------+
    |                                 Name                                 | Value |
    +----------------------------------------------------------------------+-------+
    | jeus.servlet.jsp.compile-java-source-concurrently                    | true  |
    | jeus.servlet.jsp.compile-java-source-concurrently1                   | false |
    | jeus.servlet.jsp.assure-utf8-file-encoding-detection                 | true  |
    +----------------------------------------------------------------------+-------+
    ================================================================================
    
    [DAS]domain1.adminServer>modify-web-properties -server server1 -p jeus.servlet.jsp.compile-java-source-concurrently
    jeus.servlet.jsp.compile-java-source-concurrently is a invalid property. The property name and value must be separated by the "=" character.
    [DAS]domain1.adminServer>modify-web-properties -server server1 -p jeus.servlet.jsp.compile-java-source-concurrently=true
    Modifying the property jeus.servlet.jsp.compile-java-source-concurrently=true failed because it is the same.
    [DAS]domain1.adminServer>modify-web-properties -server server1 -p jeus.servlet.jsp.compile-java-source-concurrently=false
    Successfully applied part of the changes.
    Restart the server to apply the remaining changes.
    For detailed web engine property information, use the 'show-web-engine-configuration -pr' command.
    
    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -pr
    Properties configuration for [server1]
    ================================================================================
    +----------------------------------------------------------------------+-------+
    |                                 Name                                 | Value |
    +----------------------------------------------------------------------+-------+
    | jeus.servlet.jsp.compile-java-source-concurrently                    | false |
    | jeus.servlet.jsp.compile-java-source-concurrently1                   | false |
    | jeus.servlet.jsp.assure-utf8-file-encoding-detection                 | true  |
    +----------------------------------------------------------------------+-------+
    ================================================================================
    [DAS]domain1.adminServer>modify-web-properties -server server1 -p jeus.servlet.jsp.compile-java-source-concurrently=true,
    jeus.servlet.jsp.assure-utf8-file-encoding-detection=false
    Successfully applied part of the changes.
    Restart the server to apply the remaining changes.
    For detailed web engine property information, use the 'show-web-engine-configuration -pr' command.
    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -pr
    Properties configuration for [server1]
    ================================================================================
    +----------------------------------------------------------------------+-------+
    |                                 Name                                 | Value |
    +----------------------------------------------------------------------+-------+
    | jeus.servlet.jsp.compile-java-source-concurrently                    | true  |
    | jeus.servlet.jsp.compile-java-source-concurrently1                   | false |
    | jeus.servlet.jsp.assure-utf8-file-encoding-detection                 | false |
    +----------------------------------------------------------------------+-------+
    ================================================================================

Changes the HTTP Response Custom Header configuration. The changed Response Header is case insensitive. The changes only apply to the domain.xml file. In order to apply changes to the actual service, the server must be restarted.

  • Related Schema

    web-engine.xsd - web-engine/response-header

  • Aliases

    modwebrh

  • Usage

    modify-response-header [-cluster <cluster-name> | -server <server-name>]
                           [-f, --forceLock]
                           [-n,--name <header-name>]
                           [-v,--value <header-value>]
  • Parameters

    ParameterDescription
    [-f, --forceLock]Forcibly applies the configuration changes.
    [-n,--name <header-name>]Name of the HTTP Response Header to be changed. The name is case insensitive. Each header name must be unique.
    [-v,--value <header-value>]Value of the HTTP Response Header to be changed. The value is case insensitive.
  • Example

    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -rh
    Response Custom header configuration for [server1]
    =======================================================
    +----------------------------------------+------------+
    |                  Name                  |    Value   |
    +----------------------------------------+------------+
    | testheader                             | testvalue  |
    | testheader2                            | testvalue2 |
    +----------------------------------------+------------+
    =======================================================
    
    [DAS]domain1.adminServer>modify-response-header -server server1
    The header-name option and the header-value option must both be specified.
    [DAS]domain1.adminServer>modify-response-header -server server1 -n TestHeader1
    The header-name option and the header-value option must both be specified.
    [DAS]domain1.adminServer>modify-response-header -server server1 -n TestHeader -v testValue
    Modifying the custom header response header testheader=testvalue failed because the header was not changed.
    [DAS]domain1.adminServer>modify-response-header -server server1 -n testheader -v testvalue3
    Successfully applied part of the changes.
    Restart the server to apply the remaining changes.
    For detailed custom response header information, use the 'show-web-engine-configuration -rh' command.
    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -rh
    Response custom header configuration for [server1]
    =======================================================
    +----------------------------------------+------------+
    |                  Name                  |    Value   |
    +----------------------------------------+------------+
    | testheader                             | testvalue3 |
    | testheader2                            | testvalue2 |
    +----------------------------------------+------------+
    =======================================================
    
    [DAS]domain1.adminServer>modify-response-header -server server1 -n testheader4 -v testvalue4
    Modifying the custom response header testheader4=testvalue4 failed because the header does not exist.

Changes the JSP engine configurations of the web engine. The changes only apply to the domain.xml file. In order to apply changes to the actual service, the server must be restarted.

  • Related Schema

    web-engine.xsd - web-engine/jsp-engine

  • Aliases

    modjsp

  • Usage

    modify-jsp-engine [-cluster <cluster-name> | -server <server-name>]
       [-f, --forceLock]
       [-rjwd,--remove-jsp-work-dir | -jwd,--jsp-work-dir <jsp-work-dir>]
       [-javac,--java-compiler <java-compiler>]
       [-cod,--compile-output-dir <compile-output-dir> | 
        -rcod,--remove-compile-output-dir]
       [-rcopt,--remove-compile-option | -copt,--compile-option <compile-option>]
       [-renc,--remove-compile-encoding | -enc,--compile-encoding <compile-encoding>]
       [-cij,--check-included-jspfile <check-included-jspfile>]
       [-kg,--keep-generated <keep-generated>]
       [-gjr,--graceful-jsp-reloading <graceful-jsp-reloading>]
       [-gjrp,--graceful-jsp-reloading-period <graceful-jsp-reloading-period>]
       [-umc,--use-in-memory-compilation <use-in-memory-compilation>]
  • Parameters

    ParameterDescription
    [-f, --forceLock]Forcibly applies the configuration changes.
    [-rjwd,--remove-jsp-work-dir | -jwd,--jsp-work-dir <jsp-work-dir>]

    The -jwd,--jsp-work-dir <jsp-work-dir> sets the location of the files created in Java from JSP and the class files created by compiling the files. The value must be a absolute path.

    The configuration can be deleted using -rjwd,--remove-jsp-work-dir. If deleted, the default value of the engine is used.

    [-javac,--java-compiler <java-compiler>]

    Java compiler, which is used to compile Java source files of JSP to servlet class files.

    Input options: (Refer to schema for a description of each value)

    • java6 (Default value)

    • sun.tools.javac

    • javac

    • com.sun.tools.javac

    The default value is recommended because it is the most efficient.

    [-cod,--compile-output-dir <compile-output-dir> | -rcod,--remove-compile-output-dir]

    The -cod,--compile-output-dir <compile-output-dir> stores class files created from JSP files to a different directory instead of the JSP Work Dir. If not set, class files are located in the JSP Work Dir.

    The configuration can be deleted using -rcod,--remove-compile-output-dir. If deleted, the default value of the engine is used.

    [-rcopt,--remove-compile-option | -copt,--compile-option <compile-option>]

    Options used in the servlet compiler.

    The value can be deleted using -rcopt,--remove-compile-option.

    [-renc,--remove-compile-encoding | -enc,--compile-encoding <compile-encoding>]

    The -enc,--compile-encoding <compile-encoding> sets values for encoding options used when compiling servlet source files, which are created by parsing JSP files.

    The encoding can be deleted using -renc,--remove-compile-encoding.

    [-cij,--check-included-jspfile <check-included-jspfile>]Checks if the included JSP file and Tag files are changed. If the file are changed, this option determines whether to recompile the JSP files.
    [-kg,--keep-generated <keep-generated>]Compiles Java source files created from JSP pages to create servlet class files, and then determines whether to store the Java source files.
    [-gjr,--graceful-jsp-reloading <graceful-jsp-reloading>]

    Compiles JSP files, which are exclusive on a JVM, into a batch type Java file. The JSP sources and compiled class files are shared.

    This option only works when a shared directory is specified in JSP Work Dir.

    [-gjrp,--graceful-jsp-reloading-period <graceful-jsp-reloading-period>]Interval at which to perform Graceful JSP reloading.
    [-umc,--use-in-memory-compilation <use-in-memory-compilation>]

    When recompiling JSP files that are in use, 'java' and '.class' files are created in memory and compiled. '.class' files are written on a file system using a background thread so they are not recompiled during reboot.

    If <keep-generated> is true, '.java' files are written on a file system using a background thread.

  • Example

    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -jsp
    JSP engine configuration for [server1]
    ================================================================================
    +----------------------------------------------------------------------+-------+
    |                                 Name                                 | Value |
    +----------------------------------------------------------------------+-------+
    | jsp-work-dir                                                         |       |
    | java-compiler                                                        | java6 |
    | compile-output-dir                                                   |       |
    | compile-option                                                       |       |
    | compile-encoding                                                     |       |
    | check-included-jspfile                                               | false |
    | keep-generated                                                       | true  |
    | graceful-jsp-reloading                                               | false |
    | graceful-jsp-reloading-period                                        | 30000 |
    | use-in-memory-compilation                                            | true  |
    +----------------------------------------------------------------------+-------+
    ================================================================================
    
    [DAS]domain1.adminServer>modify-jsp-engine -server server1 -jwd /home/jeus/jsp
    Successfully applied part of the changes.
    Restart the server to apply the remaining changes.
    For detailed JSP engine information, use the 'show-web-engine-configuration -jsp' command.
    
    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -jsp
    JSP engine configuration for [server1]
    =====================================================================
    +--------------------------------------------------+----------------+
    |                       Name                       |      Value     |
    +--------------------------------------------------+----------------+
    | jsp-work-dir                                     | /home/jeus/jsp |
    | java-compiler                                    | java6          |
    | compile-output-dir                               |                |
    | compile-option                                   |                |
    | compile-encoding                                 |                |
    | check-included-jspfile                           | false          |
    | keep-generated                                   | true           |
    | graceful-jsp-reloading                           | false          |
    | graceful-jsp-reloading-period                    |          30000 |
    | use-in-memory-compilation                        | true           |
    +--------------------------------------------------+----------------+
    =====================================================================
    
    [DAS]domain1.adminServer>modify-jsp-engine -server server1 -rjwd
    Successfully applied part of the changes.
    Restart the server to apply the remaining changes.
    For detailed JSP engine information, use the 'show-web-engine-configuration -jsp' command.
    
    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -jsp
    JSP engine configuration for [server1]
    ================================================================================
    +----------------------------------------------------------------------+-------+
    |                                 Name                                 | Value |
    +----------------------------------------------------------------------+-------+
    | jsp-work-dir                                                         |       |
    | java-compiler                                                        | java6 |
    | compile-output-dir                                                   |       |
    | compile-option                                                       |       |
    | compile-encoding                                                     |       |
    | check-included-jspfile                                               | false |
    | keep-generated                                                       | true  |
    | graceful-jsp-reloading                                               | false |
    | graceful-jsp-reloading-period                                        | 30000 |
    | use-in-memory-compilation                                            | true  |
    +----------------------------------------------------------------------+-------+
    ================================================================================
    
    [DAS]domain1.adminServer>modify-jsp-engine -server server1 -javac javac
    Successfully applied part of the changes.
    Restart the server to apply the remaining changes.
    For detailed JSP engine information, use the 'show-web-engine-configuration -jsp' command.
    
    [DAS]domain1.adminServer>modify-jsp-engine -server server1 -cod /home/jeus/jsp/output
    Successfully applied part of the changes.
    Restart the server to apply the remaining changes.
    For detailed JSP engine information, use the 'show-web-engine-configuration -jsp' command.
    
    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -jsp
    JSP engine configuration for [server1]
    ================================================================================
    +---------------------------------------------+--------------------------------+
    |                     Name                    |              Value             |
    +---------------------------------------------+--------------------------------+
    | jsp-work-dir                                |                                |
    | java-compiler                               | javac                          |
    | compile-output-dir                          | /home/jeus/jsp/output          |
    | compile-option                              |                                |
    | compile-encoding                            |                                |
    | check-included-jspfile                      | false                          |
    | keep-generated                              | true                           |
    | graceful-jsp-reloading                      | false                          |
    | graceful-jsp-reloading-period               |                          30000 |
    | use-in-memory-compilation                   | true                           |
    +---------------------------------------------+--------------------------------+
    ================================================================================
    
    [DAS]domain1.adminServer>modify-jsp-engine -server server1 -rcod
    Successfully applied part of the changes.
    Restart the server to apply the remaining changes.
    For detailed JSP engine information, use the 'show-web-engine-configuration -jsp' command.
    
    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -jsp
    JSP engine configuration for [server1]
    ================================================================================
    +----------------------------------------------------------------------+-------+
    |                                 Name                                 | Value |
    +----------------------------------------------------------------------+-------+
    | jsp-work-dir                                                         |       |
    | java-compiler                                                        | javac |
    | compile-output-dir                                                   |       |
    | compile-option                                                       |       |
    | compile-encoding                                                     |       |
    | check-included-jspfile                                               | false |
    | keep-generated                                                       | true  |
    | graceful-jsp-reloading                                               | false |
    | graceful-jsp-reloading-period                                        | 30000 |
    | use-in-memory-compilation                                            | true  |
    +----------------------------------------------------------------------+-------+
    ================================================================================
    
    [DAS]domain1.adminServer>modify-jsp-engine -server server1 -enc EUC-KRR
    The given charset name EUC-KRR is not a supported encoding.
    [DAS]domain1.adminServer>modify-jsp-engine -server server1 -enc EUC-KR
    Successfully applied part of the changes.
    Restart the server to apply the remaining changes.
    For detailed JSP engine information, use the 'show-web-engine-configuration -jsp' command.
    
    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -jsp
    JSP engine configuration for [server1]
    ================================================================================
    +---------------------------------------------------------------------+--------+
    |                                 Name                                |  Value |
    +---------------------------------------------------------------------+--------+
    | jsp-work-dir                                                        |        |
    | java-compiler                                                       | javac  |
    | compile-output-dir                                                  |        |
    | compile-option                                                      |        |
    | compile-encoding                                                    | EUC-KR |
    | check-included-jspfile                                              | false  |
    | keep-generated                                                      | true   |
    | graceful-jsp-reloading                                              | false  |
    | graceful-jsp-reloading-period                                       |  30000 |
    | use-in-memory-compilation                                           | true   |
    +---------------------------------------------------------------------+--------+
    ================================================================================
    
    [DAS]domain1.adminServer>modify-jsp-engine -server server1 -renc
    Successfully applied part of the changes.
    Restart the server to apply the remaining changes.
    For detailed JSP engine information, use the 'show-web-engine-configuration -jsp' command.
    
    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -jsp
    JSP engine configuration for [server1]
    ================================================================================
    +----------------------------------------------------------------------+-------+
    |                                 Name                                 | Value |
    +----------------------------------------------------------------------+-------+
    | jsp-work-dir                                                         |       |
    | java-compiler                                                        | javac |
    | compile-output-dir                                                   |       |
    | compile-option                                                       |       |
    | compile-encoding                                                     |       |
    | check-included-jspfile                                               | false |
    | keep-generated                                                       | true  |
    | graceful-jsp-reloading                                               | false |
    | graceful-jsp-reloading-period                                        | 30000 |
    | use-in-memory-compilation                                            | true  |
    +----------------------------------------------------------------------+-------+
    ================================================================================
    
    [DAS]domain1.adminServer>modify-jsp-engine -server server1 -cij true -kg false -gjr true -gjrp 45000 -umc false
    Successfully applied part of the changes.
    Restart the server to apply the remaining changes.
    For detailed JSP engine information, use the 'show-web-engine-configuration -jsp' command.
    
    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -jsp
    JSP engine configuration for [server1]
    ================================================================================
    +----------------------------------------------------------------------+-------+
    |                                 Name                                 | Value |
    +----------------------------------------------------------------------+-------+
    | jsp-work-dir                                                         |       |
    | java-compiler                                                        | javac |
    | compile-output-dir                                                   |       |
    | compile-option                                                       |       |
    | compile-encoding                                                     |       |
    | check-included-jspfile                                               | true  |
    | keep-generated                                                       | false |
    | graceful-jsp-reloading                                               | true  |
    | graceful-jsp-reloading-period                                        | 45000 |
    | use-in-memory-compilation                                            | false |
    +----------------------------------------------------------------------+-------+
    ================================================================================

Changes the session configurations.

  • Related Schema

    jeus-session-server.xsd, jeus-session-domain.xsd

  • Aliases

    setsc, msc

  • Usage

    modify-session-configuration [-server <server-name>][-cluster <cluster-name>]
           [-f, --forceLock]
           [-hsc,--http-session-config <string mode : add or remove or modify>] 
           [-to,--timeout <int timeout>]
           [-sh,--shared <boolean shared>]
           [-rp,--reload-persistent <boolean reload-persistent>]
           [-tmc,--tracking-mode.cookie <boolean enable-cookie>]
           [-tmu,--tracking-mode.url <boolean enable-url>]
           [-tms,--tracking-mode.ssl <boolean enable-ssl>]
           [-scn,--session-cookie.cookie-name <string cookie-name>]
           [-scv,--session-cookie.version <int version(1 or 0)>]
           [-scd,--session-cookie.domain <string domain-scope>]
           [-scp,--session-cookie.path <string path-scope>]
           [-scm,--session-cookie.max-age <int max-age>]
           [-scs,--session-cookie.secure <boolean secure>]
           [-sch,--session-cookie.http-only <boolean http-only>]
           [-scc,--session-cookie.comment <string comment>]
           [-tn,--reserved-thread-num <int thread-num>]
           [-ct,--connection-timeout <long connection-timeout>]
           [-rt,--read-timeout <long read-timeout>]
           [-bl,--backup-level <string backup-level>]
           [-fd,--failover-delay <long failover delays(s)>]
           [-rd,--restart-delay <long restart delays(s)>]
           [-dpa,--file-db.path <string db-path>]
           [-dmh,--file-db.min-hole <long min-hole>]
           [-dpt,--file-db.passivation-timeout <int passivation-timeout>]
           [-dpr,--file-db.packing-rate <float packing-rate>]
  • Parameters

    ParameterDescription
    [-f, --forceLock]Forcibly applies the configuration changes.
    [-hsc,--http-session-config <string mode>]Select to add, modify, or remove the http-session-config.
    [-to,--timeout <int timeout>]Session timeout of session-config.
    [-sh,--shared <boolean shared>]SHARED mode of session-config.
    [-rp,--reload-persistent <boolean reload-persistent>]Reload persistent of session-config.
    [-tmc,--tracking-mode.cookie <boolean enable-cookie>]Cookie for the session-config tracking mode.
    [-tmu,--tracking-mode.url <boolean enable-url>]URL rewriting for the session-config tracking mode.
    [-tms,--tracking-mode.ssl <boolean enable-ssl>]SSL for the session-config tracking mode.
    [-scn,--session-cookie.cookie-name <string cookie-name>]Session cookie name.
    [-scv,--session-cookie.version <int version(1 or 0)>]Compilation version of session cookies.
    [-scd,--session-cookie.domain <string domain-scope>]Determines the domain scope of session cookies.
    [-scp,--session-cookie.path <string path-scope>]Determines the path scope of session cookies.
    [-scm,--session-cookie.max-age <int max-age>]Determines the length of time to keep session cookies on a browser.
    [-scs,--session-cookie.secure <boolean secure>]Determines if a browser sends cookies only over SSL.
    [-sch,--session-cookie.http-only <boolean http-only>]Determines if a browser uses session cookies only for HTTP requests.
    [-scc,--session-cookie.comment <string comment>]Session cookie description when the cookie version is 1.
    [-tn,--reserved-thread-num <int thread-num>]Minimum number of threads allocated to handle requests in distributed session servers.
    [-ct,--connection-timeout <long connection-timeout>]Determines the socket connection reset timeout of distributed session servers.
    [-rt,--read-timeout <long read-timeout>]Timeout for request responses of distributed session servers.
    [-bl,--backup-level <string backup-level>]Determines the update conditions of distributed session servers.
    [-dpa,--file-db.path <string db-path>]File DB location of distributed session servers.
    [-dmh,--file-db.min-hole <long min-hole>]Determines the packing condition (number) of the file DB of distributed session servers.
    [-dpt,--file-db.passivation-timeout <int passivation-timeout>]Determines the time when sessions move from memory to the file DB in distributed session servers.
    [-dpr,--file-db.packing-rate <float packing-rate>]Determines the packing condition (ratio) of the file DB of distributed session servers.
  • Example

    • [-server <server-name>] is used

      [DAS]domain1.adminServer>modify-session-configuration -server server1 -to 40 -sh true -scs true
      Modifies the session configuration: [server1].
      ================================================================
      +--------------------------------------------+--------+--------+
      |                   target                   | before |  after |
      +--------------------------------------------+--------+--------+
      | timeout                                    | 30 min | 40 min |
      | shared                                     | false  | true   |
      | session-cookie.secure                      | false  | true   |
      +--------------------------------------------+--------+--------+
      
      The changes will be applied after the next restart.
      ================================================================
      
      Session-config configuration for server [server1]
      ================================================================================
      +----------------------------------------------------+------------+------------+
      |                        name                        |   default  |    value   |
      +----------------------------------------------------+------------+------------+
      | (to) timeout                                       | 30 min     | 40 min     |
      | (sh) shared                                        | false      | true       |
      | (rp) reload-persistent                             | false      | false      |
      | tracking-mode                                      |            |            |
      |    - (tmc) tracking-mode.cookie                    | true       | true       |
      |    - (tmu) tracking-mode.url                       | false      | false      |
      |    - (tms) tracking-mode.ssl                       | false      | false      |
      | session-cookie                                     |            |            |
      |    - (scn) session-cookie.cookie-name              | JSESSIONID | JSESSIONID |
      |    - (scv) session-cookie.version                  | 0 (0 or 1) |          0 |
      |    - (scd) session-cookie.domain                   |            |            |
      |    - (scp) session-cookie.path                     |            |            |
      |    - (scm) session-cookie.max-age                  |         -1 |         -1 |
      |    - (scs) session-cookie.secure                   | false      | true       |
      |    - (sch) session-cookie.http-only                | true       | true       |
      +----------------------------------------------------+------------+------------+
      
      (opt) is used for the modify-session-config command.
      ================================================================================
    • [-cluster <cluster-name>] is used

      [DAS]domain1.adminServer>modify-session-configuration -cluster distribute -tn 1 -ct 3000 -dmh 200
       Modifies the session router configuration: [distribute].
      ===============================================================
      +--------------------------------------+-----------+----------+
      |                target                |   before  |   after  |
      +--------------------------------------+-----------+----------+
      | reserved-thread-num                  |         0 |        1 |
      | connection-timeout                   | 5000 msec | 300 msec |
      | file-db.min-hole                     |       100 |      200 |
      +--------------------------------------+-----------+----------+
      
      The changes will be applied after the next restart.
      ===============================================================
      
      Session-route-config configuration for cluster [distribute]
      ================================================================================
      +----------------------------------------------------+------------+------------+
      |                        name                        |   default  |    value   |
      +----------------------------------------------------+------------+------------+
      | (tn) reserved-thread-num                           |          0 |          1 |
      | (ct) connection-timeout                            | 5000 msec  | 300 msec   |
      | (rt) read-timeout                                  | 20000 msec | 20000 msec |
      | (bl) backup-level                                  | set        | get        |
      | (fd) failover-delay                                | 600 sec    | 1000 sec   |
      | (rd) restart-delay                                 | 600 sec    | 2000 sec   |
      | file-db                                            |            |            |
      |    - (dpa) file-db.path                            |            |            |
      |    - (dmh) file-db.min-hole                        |        100 |        200 |
      |    - (dpt) file-db.passivation-timeout             | -1 msec    | -1 msec    |
      |    - (dpr) file-db.packing-rate                    |        0.5 |        0.5 |
      +----------------------------------------------------+------------+------------+
      
      The default file-db path(unset): $(SERVER_HOME)/.workspace/session/distributed/
      (opt) is used for the modify-session-config command.
      ================================================================================
      

Changes the thread pool configuration of a Tmax connector. The number of threads in the thread pools changes during the thread pool check cycle.

  • Related Schema

    web-engine.xsd - web-engine/web-connections/tmax-connector

  • Aliases

    modtmaxcon

  • Usage

    modify-tmax-connector [-cluster <cluster-name> | -server <server-name>]
                          [-f, --forceLock]
                          -name <web-connection-name>
                          [-tmin <minimum-thread-num>]
                          [-tmax <maximum-thread-num>]
                          [-tidle <max-idle-time>]
                          [-obuf <output-buffer-size>]
                          [-addr <server-address>]
                          [-port <server-port>]
                          [-svrg <server-group-name>]
                          [-svr <server-name>]
  • Parameters

    ParameterDescription
    [-f, --forceLock]Forcibly applies the configuration changes.
    -name <web-connection-name>Tmax connector name.
    [-tmin <minimum-thread-num>][Dynamic change] Minimum number of threads in the thread pools.
    [-tmax <maximum-thread-num>][Dynamic change] Maximum number of threads in the thread pools.
    [-tidle <max-idle-time>][Dynamic change] Maximum idle time of threads in the thread pools.
    [-obuf <output-buffer-size>]Servlet response buffer size.
    [-addr <server-address>]Tmax server address.
    [-port <server-port>]Tmax server port number.
    [-svrg <server-group-name>]Server group name of Tmax server.
    [-svr <server-name>]Tmax server name.
  • Example

    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -cn
    Tmax Connector[tmax1] configuration for [server1]
    ================================================================================
    +-------------------------------------------+----------------------------------+
    |                    Name                   |               Value              |
    +-------------------------------------------+----------------------------------+
    | name                                      | tmax1                            |
    | port                                      |                             1024 |
    | server-group-name                         | group1                           |
    | server-name                               | server1                          |
    | dispatcher-config-class                   | service.DispatcherConfig         |
    | reconnect-interval                        |                             5000 |
    | reconnect-count                           |                               -1 |
    | tmax-address                              | 5.0.1.2                          |
    | tmax-version                              |                                  |
    | server-type                               |                                  |
    | xaresource-class                          |                                  |
    | tmax-backup-address                       |                                  |
    | tmax-backup-port                          |                                  |
    | use-nio                                   | false                            |
    | selector-count                            |                                1 |
    | connection-type                           |                                  |
    | output-buffer-size                        |                             8192 |
    | postdata-read-timeout                     |                            30000 |
    | max-post-size                             |                      unlimited   |
    | max-parameter-count                       |                      unlimited   |
    | max-header-count                          |                      unlimited   |
    | max-header-size                           |                      unlimited   |
    | max-querystring-size                      |                             8192 |
    | threadpool.min                            |                               20 |
    | threadpool.max                            |                               20 |
    | threadpool.max-idle-time                  |                           300000 |
    | threadpool.max-queue                      |                      unlimited   |
    | threadpool.thread-state-notify            |                                  |
    +-------------------------------------------+----------------------------------+
    ================================================================================
    
    [DAS]domain1.adminServer>modify-tmax-connector -name tmax1 -tmin 30 -server server1 -tmax 30
    Successfully changed only the XML.
    Restart the server to apply the changes.
    For detailed web connection information, use the 'show-web-engine-configuration -cn' command.
    
    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -cn
    Tmax Connector[tmax1] configuration for [server1]
    ================================================================================
    +-------------------------------------------+----------------------------------+
    |                    Name                   |               Value              |
    +-------------------------------------------+----------------------------------+
    | name                                      | tmax1                            |
    | port                                      |                             1024 |
    | server-group-name                         | group1                           |
    | server-name                               | server1                          |
    | dispatcher-config-class                   | service.DispatcherConfig         |
    | reconnect-interval                        |                             5000 |
    | reconnect-count                           |                               -1 |
    | tmax-address                              | 5.0.1.2                          |
    | tmax-version                              |                                  |
    | server-type                               |                                  |
    | xaresource-class                          |                                  |
    | tmax-backup-address                       |                                  |
    | tmax-backup-port                          |                                  |
    | use-nio                                   | false                            |
    | selector-count                            |                                1 |
    | connection-type                           |                                  |
    | output-buffer-size                        |                             8192 |
    | postdata-read-timeout                     |                            30000 |
    | max-post-size                             |                      unlimited   |
    | max-parameter-count                       |                      unlimited   |
    | max-header-count                          |                      unlimited   |
    | max-header-size                           |                      unlimited   |
    | max-querystring-size                      |                             8192 |
    | threadpool.min                            |                               30 |
    | threadpool.max                            |                               30 |
    | threadpool.max-idle-time                  |                           300000 |
    | threadpool.max-queue                      |                      unlimited   |
    | threadpool.thread-state-notify            |                                  |
    +-------------------------------------------+----------------------------------+
    ================================================================================
    
    [DAS]domain1.adminServer>modify-tmax-connector -name tmax1 -server server1 -tmin 20
    Successfully changed only the XML.
    Restart the server to apply the changes.
    For detailed web connection information, use the 'show-web-engine-configuration -cn' command.
    
    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -cn
    Tmax Connector[tmax1] configuration for [server1]
    ================================================================================
    +-------------------------------------------+----------------------------------+
    |                    Name                   |               Value              |
    +-------------------------------------------+----------------------------------+
    | name                                      | tmax1                            |
    | port                                      |                             1024 |
    | server-group-name                         | group1                           |
    | server-name                               | server1                          |
    | dispatcher-config-class                   | service.DispatcherConfig         |
    | reconnect-interval                        |                             5000 |
    | reconnect-count                           |                               -1 |
    | tmax-address                              | 5.0.1.2                          |
    | tmax-version                              |                                  |
    | server-type                               |                                  |
    | xaresource-class                          |                                  |
    | tmax-backup-address                       |                                  |
    | tmax-backup-port                          |                                  |
    | use-nio                                   | false                            |
    | selector-count                            |                                1 |
    | connection-type                           |                                  |
    | output-buffer-size                        |                             8192 |
    | postdata-read-timeout                     |                            30000 |
    | max-post-size                             |                      unlimited   |
    | max-parameter-count                       |                      unlimited   |
    | max-header-count                          |                      unlimited   |
    | max-header-size                           |                      unlimited   |
    | max-querystring-size                      |                             8192 |
    | threadpool.min                            |                               20 |
    | threadpool.max                            |                               30 |
    | threadpool.max-idle-time                  |                           300000 |
    | threadpool.max-queue                      |                      unlimited   |
    | threadpool.thread-state-notify            |                                  |
    +-------------------------------------------+----------------------------------+
    ================================================================================
    
    [DAS]domain1.adminServer>modify-tmax-connector -name tmax1 -server server1 -tmax 25
    Successfully changed only the XML.
    Restart the server to apply the changes.
    For detailed web connection information, use the 'show-web-engine-configuration -cn' command.
    
    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -cn
    Tmax Connector[tmax1] configuration for [server1]
    ================================================================================
    +-------------------------------------------+----------------------------------+
    |                    Name                   |               Value              |
    +-------------------------------------------+----------------------------------+
    | name                                      | tmax1                            |
    | port                                      |                             1024 |
    | server-group-name                         | group1                           |
    | server-name                               | server1                          |
    | dispatcher-config-class                   | service.DispatcherConfig         |
    | reconnect-interval                        |                             5000 |
    | reconnect-count                           |                               -1 |
    | tmax-address                              | 5.0.1.2                          |
    | tmax-version                              |                                  |
    | server-type                               |                                  |
    | xaresource-class                          |                                  |
    | tmax-backup-address                       |                                  |
    | tmax-backup-port                          |                                  |
    | use-nio                                   | false                            |
    | selector-count                            |                                1 |
    | connection-type                           |                                  |
    | output-buffer-size                        |                             8192 |
    | postdata-read-timeout                     |                            30000 |
    | max-post-size                             |                      unlimited   |
    | max-parameter-count                       |                      unlimited   |
    | max-header-count                          |                      unlimited   |
    | max-header-size                           |                      unlimited   |
    | max-querystring-size                      |                             8192 |
    | threadpool.min                            |                               20 |
    | threadpool.max                            |                               25 |
    | threadpool.max-idle-time                  |                           300000 |
    | threadpool.max-queue                      |                      unlimited   |
    | threadpool.thread-state-notify            |                                  |
    +-------------------------------------------+----------------------------------+
    ================================================================================

Changes the access log format configuration of virtual hosts. If the access log of a virtual host is not in the ENABLE state, the server must be restarted to apply the command to the actual service.

  • Related Schema

    web-engine.xsd - web-engine/virtual-host

  • Aliases

    modvh

  • Usage

    modify-virtual-host [-cluster <cluster-name> | -server <server-name>]
                        [-f, --forceLock]
                        <virtual-host-name>
                        [-aluph <access-log-use-parent-handler (true/false)>|
                         -alf <access-log-format> | 
                         -aluse <use-access-log (true/false)> |
                         -alhnl <access-log-enable-host-name-lookup> |
                         -alext <access-log-excluded-extensions>]
                        [-hnrm <host-name> | -hnadd <host-name>]
                        [-ast <attach-stacktrace-on-error>]

  • Parameters

    ParameterDescription
    [-f, --forceLock]Forcibly applies the configuration changes.
    <virtual-host-name>Virtual host name.
    -aluph <access-log-use-parent-handler >

    [Dynamic change] Option to record a web engine access log.

    Input options are true and false. t or f can also be entered.

    [-alf <access-log-format>]

    [Dynamic change] Access log format. If the option contains whitespace, wrap the option with double quotes (" ").

    For more information about log formats, refer to JEUS Web Engine Guide. Section 1.6.10, “Formatting Access Logs”.

    -aluse <use-access-log>

    [Dynamic change] Option to use access logs.

    Input options are true and false. t or f can also be entered.

    -alhnl <access-log-enable-host-name-lookup>

    Option to use DNS Resolution for the IP address when logging in the %h format.

    Input options are true and false. t or f can also be entered.

    -alext <access-log-excluded-extensions>

    Extensions that do not leave any records in the access logs.

    To specify multiple extensions, separate each extension with a comma(,). E.g., '.gif', '.jpg'.

    Enter only a comma for no entry.

    -hnrm <host-name>

    Deletes a host name registered to the virtual host.

    -hnadd <host-name>

    Registers a new host name to the virtual host.

    [-ast <attach-stacktrace-on-error>]Option to attach the stack trace to the error page sent by JEUS.
  • Example

    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -vh
    Virtual host[vhost1] configuration for [server1]
    ================================================================================
    +-------------------------------------+----------------------------------------+
    |                 Name                |                  Value                 |
    +-------------------------------------+----------------------------------------+
    | virtual-host-name                   | vhost1                                 |
    | host-name                           | tmax.co.kr                             |
    |                                     | tmax.com                               |
    | access-log.enable                   | true                                   |
    | access-log.format                   | common                                 |
    | access-log.exclude-ext              |                                        |
    | access-log.use-parent-handlerst     | true                                   |
    | access-log.formatter-class          | jeus.util.logging.SimpleFormatter      |
    | properties.vk1                      | vv1                                    |
    +-------------------------------------+----------------------------------------+
    ================================================================================
    Virtual host[host2] configuration for [server1]
    ================================================================================
    +-------------------------------------+----------------------------------------+
    |                 Name                |                  Value                 |
    +-------------------------------------+----------------------------------------+
    | virtual-host-name                   | host2                                  |
    +-------------------------------------+----------------------------------------+
    | host-name                           | www.foo.com                            |
    |                                     | 192.168.1.2                            |
    +-------------------------------------+----------------------------------------+
    | access-log.enable                   | true                                   |
    +-------------------------------------+----------------------------------------+
    | access-log.format                   | default                                |
    +-------------------------------------+----------------------------------------+
    | access-log.exclude-ext              |                                        |
    +-------------------------------------+----------------------------------------+
    | access-log.use-parent-handlerst     | true                                   |
    +-------------------------------------+----------------------------------------+
    | access-log.formatter-class          | jeus.util.logging.SimpleFormatter      |
    +-------------------------------------+----------------------------------------+
    | properties                          |                                        |
    +-------------------------------------+----------------------------------------+
    ================================================================================
    
    
    [DAS]domain1.adminServer>modify-virtual-host -server server1 vhost1 -alf "common %I" 
    Successfully changed only the XML.
    Restart the server to apply the changes.
    For detailed virtual-host information, use the 'show-web-engine-configuration -vh' command.
    
    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -vh
    Virtual host[vhost1] configuration for [server1]
    ================================================================================
    +-------------------------------------+----------------------------------------+
    |                 Name                |                  Value                 |
    +-------------------------------------+----------------------------------------+
    | virtual-host-name                   | vhost1                                 |
    | host-name                           | tmax.co.kr                             |
    |                                     | tmax.com                               |
    | access-log.enable                   | true                                   |
    | access-log.format                   | common %I                              |
    | access-log.exclude-ext              |                                        |
    | access-log.use-parent-handlerst     | true                                   |
    | access-log.formatter-class          | jeus.util.logging.SimpleFormatter      |
    | properties.vk1                      | vv1                                    |
    +-------------------------------------+----------------------------------------+
    ================================================================================
    
    [DAS]domain1.adminServer>modify-virtual-host -server server1 vhost1 -alf combined
    Successfully changed only the XML.
    Restart the server to apply the changes.
    For detailed virtual-host information, use the 'show-web-engine-configuration -vh' command.
    
    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -vh
    Virtual host[vhost1] configuration for [server1]
    ================================================================================
    +-------------------------------------+----------------------------------------+
    |                 Name                |                  Value                 |
    +-------------------------------------+----------------------------------------+
    | virtual-host-name                   | vhost1                                 |
    | host-name                           | tmax.co.kr                             |
    |                                     | tmax.com                               |
    | access-log.enable                   | true                                   |
    | access-log.format                   | combined                               |
    | access-log.exclude-ext              |                                        |
    | access-log.use-parent-handlerst     | true                                   |
    | access-log.formatter-class          | jeus.util.logging.SimpleFormatter      |
    | properties.vk1                      | vv1                                    |
    +-------------------------------------+----------------------------------------+
    ================================================================================
    [DAS]domain1.adminServer>modify-virtual-host -server server1 vhost1 -alf "%h %l %u %t \"%r\" %>s %b"
    Successfully changed only the XML.
    Restart the server to apply the changes.
    For detailed virtual-host information, use the 'show-web-engine-configuration -vh' command.
    
    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -vh
    Virtual host[vhost1] configuration for [server1]
    ================================================================================
    +-------------------------------------+----------------------------------------+
    |                 Name                |                  Value                 |
    +-------------------------------------+----------------------------------------+
    | virtual-host-name                   | vhost1                                 |
    | host-name                           | tmax.co.kr                             |
    |                                     | tmax.com                               |
    | access-log.enable                   | true                                   |
    | access-log.format                   | %h %l %u %t \"%r\" %>s %b              |
    | access-log.exclude-ext              |                                        |
    | access-log.use-parent-handlerst     | true                                   |
    | access-log.formatter-class          | jeus.util.logging.SimpleFormatter      |
    | properties.vk1                      | vv1                                    |
    +-------------------------------------+----------------------------------------+
    ================================================================================

Changes the web engine configuration dynamically. The command can only change the configurations that apply to the actual service. The monitoring cycle and the access log format information can be updated.

  • Related Schema

    web-engine.xsd - web-engine

  • Aliases

    setwebcfg, setwebconf, set-web-engine-configuration, modwebcfg, modwebconf

  • Usage

    modify-web-engine-configuration [-cluster <cluster-name> | -server <server-name>]
                                    [-f, --forceLock]
                                    [-tpp <monitoring/check-thread-pool>]
                                    [-crp <monitoring/check-class-reload>]
                                    [-sp <monitoring/check-session>]
                                    [-alf <access-log-format> | 
                                     -aluse <use-access-log> | 
                                     -alhnl <access-log-enable-host-name-lookup> |
                                     -alext <access-log-excluded-extensions>]
                                    [-ast <attach-stacktrace-on-error>]
                                    [-att <async-timeout-min-threads>]
                                    [-rerp | -erp <default-error-page>]

  • Parameters

    ParameterDescription
    [-f, --forceLock]Forcibly applies the configuration changes.
    [-tpp <monitoring/check-thread-pool>][Dynamic change] Thread Pool check cycle.
    [-crp <monitoring/check-class-reload>][Dynamic change] Web context reloading check cycle.
    [-sp <monitoring/check-session>][Dynamic change] Session check cycle.
    [-alf <access-log-format>]

    [Dynamic change] Access log format. If the format name contains whitespace, wrap the format with double quotes (" ").

    For more information about log formats, refer to JEUS Web Engine Guide. Section 1.6.10, “Formatting Access Logs”.

    [-aluse <use-access-log >]

    [Dynamic change] Option to use the access logs.

    Enter true or false. Or enter t or f.

    -alhnl <access-log-enable-host-name-lookup>

    Option to use DNS Resolution for the IP address when logging in the %h format.

    Enter true or false. Or enter t or f.

    [-alext <access-log-excluded-extensions>]

    Extensions that do not leave any records in the access logs.

    To specify multiple extensions, separate each extension with a comma(,). E.g., '.gif', '.jpg'.

    Enter only a comma for no entry.

    [-ast <attach-stacktrace-on-error>]Option to attach a stack trace to the error page sent by JEUS.
    [-att <async-timeout-min-threads>]

    Minimum number of threads pools used to handle timeout when asynchronous servlets in Servlet 3.0 are used.

    Set a value greater than or equal to 1. Otherwise, timeout may not be handled correctly.

    [-rerp | -erp <default-error-page>]

    -erp <default-error-page> sets the error page used when an error page is not set in web applications. Only a static page (HTML, HTM) can be set. Use an absolute path.

    The configuration can be deleted using -rerp.

  • Example

    • [-alf <access-log-format>] option is used

      yy[DAS]domain1.adminServer>show-web-engine-configuration -server server1 -al
      Access-log configuration for [server1]
      ================================================================================
      +----------------------+-------------------------------------------------------+
      |         Name         |                         Value                         |
      +----------------------+-------------------------------------------------------+
      | enable               | true                                                  |
      | format               | default                                               |
      | use-parent-handlerst | false                                                 |
      | formatter-class      | jeus.util.logging.SimpleFormatter                     |
      +----------------------+-------------------------------------------------------+
      ================================================================================
      [DAS]domain1.adminServer>modify-web-engine-configuration -server server1 -alf "common %I"
      Successfully applied the configuration changes.
      For detailed web engine configuration, use the 'show-web-engine-configuration' command.
      
      [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -al
      Access-log configuration for [server1]
      ================================================================================
      +----------------------+-------------------------------------------------------+
      |         Name         |                         Value                         |
      +----------------------+-------------------------------------------------------+
      | enable               | true                                                  |
      | format               | common %I                                             |
      | use-parent-handlerst | false                                                 |
      | formatter-class      | jeus.util.logging.SimpleFormatter                     |
      +----------------------+-------------------------------------------------------+
      ================================================================================
      
      [DAS]domain1.adminServer>modify-web-engine-configuration -server server1 -alf combined
      Successfully applied the configuration changes.
      For detailed web engine configuration, use the 'show-web-engine-configuration' command.
      
      [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -al
      Access log configuration for [server1]
      ========================================================================
      +---------------------+------------------------------------------------+
      |         Name        |                      Value                     |
      +---------------------+------------------------------------------------+
      | enable              | true                                           |
      | format              | combined                                       |
      | use-parent-handlerst| true                                           |
      | formatter-class     | jeus.util.logging.SimpleFormatter              |
      +---------------------+------------------------------------------------+
      ========================================================================
      
      [DAS]domain1.adminServer>modify-web-engine-configuration -server server1 -alf "%h %l %u %t \"%r\" %>s %b"
      Successfully applied the configuration changes.
      For detailed web engine configuration, use the 'show-web-engine-configuration' command.
      
      [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -al
      Access log configuration for [server1]
      ========================================================================
      +---------------------+------------------------------------------------+
      |         Name        |                      Value                     |
      +---------------------+------------------------------------------------+
      | enable              | true                                           |
      | format              | %h %l %u %t \"%r\" %>s %b                      |
      | use-parent-handlerst| true                                           |
      | formatter-class     | jeus.util.logging.SimpleFormatter              |
      +---------------------+------------------------------------------------+
      ========================================================================
    • [-aluse <use-access-log >] option is used

      [DAS]domain1.adminServer>modify-web-engine-configuration -server server1 -aluse false
      Successfully applied the configuration changes.
      For detailed web engine configuration, use the 'show-web-engine-configuration' command.
      
      [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -al
      Access log configuration for [server1]
      ========================================================================
      +---------------------+------------------------------------------------+
      |         Name        |                      Value                     |
      +---------------------+------------------------------------------------+
      | enable              | false                                          |
      | format              | %h %l %u %t \"%r\" %>s %b                      |
      | use-parent-handlerst| true                                           |
      | formatter-class     | jeus.util.logging.SimpleFormatter              |
      +---------------------+------------------------------------------------+
      ========================================================================
    • [-alext <access-log-excluded-extensions>] option is used

      [DAS]domain1.adminServer>modify-web-engine-configuration -server server1 -alext .gif
      Successfully applied the configuration changes.
      For detailed web engine configuration, use the 'show-web-engine-configuration' command.
      
      [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -al
      Access log configuration for [server1]
      ========================================================================
      +---------------------+------------------------------------------------+
      |         Name        |                      Value                     |
      +---------------------+------------------------------------------------+
      | enable              | false                                          |
      | format              | %h %l %u %t \"%r\" %>s %b                      |
      | exclude-ext         | .gif                                           |
      | use-parent-handlerst| true                                           |
      | formatter-class     | jeus.util.logging.SimpleFormatter              |
      +---------------------+------------------------------------------------+
      ========================================================================
      
      [DAS]domain1.adminServer>modify-web-engine-configuration -server server1 -alext .gif,.jpg
      Successfully applied the configuration changes.
      For detailed web engine configuration, use the 'show-web-engine-configuration' command.
      
      [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -al
      Access log configuration for [server1]
      ========================================================================
      +---------------------+------------------------------------------------+
      |         Name        |                      Value                     |
      +---------------------+------------------------------------------------+
      | enable              | false                                          |
      | format              | %h %l %u %t \"%r\" %>s %b                      |
      | exclude-ext         | .gif,.jpg                                      |
      | use-parent-handlerst| true                                           |
      | formatter-class     | jeus.util.logging.SimpleFormatter              |
      +---------------------+------------------------------------------------+
      ========================================================================
      
      [DAS]domain1.adminServer>modify-web-engine-configuration -server server1 -alext ,
      Successfully applied the configuration changes.
      For detailed web engine configuration, use the 'show-web-engine-configuration' command.
      
      [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -al
      Access log configuration for [server1]
      ========================================================================
      +---------------------+------------------------------------------------+
      |         Name        |                      Value                     |
      +---------------------+------------------------------------------------+
      | enable              | false                                          |
      | format              | %h %l %u %t \"%r\" %>s %b                      |
      | use-parent-handlerst| true                                           |
      | formatter-class     | jeus.util.logging.SimpleFormatter              |
      +---------------------+------------------------------------------------+
      ========================================================================
    • [-tpp <monitoring/check-thread-pool>], [-crp <monitoring/check-class-reload>], and [-sp <monitoring/check-session>] options are used

      [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -mo
      Monitoring configuration for [server1]
      ===================================================================
      +---------------------------------------------------------+-------+
      |                           Name                          | Value |
      +---------------------------------------------------------+-------+
      | check-thread-pool                                       | 300000|
      | check-class-reload                                      | 300000|
      | check-session                                           | 300000|
      +---------------------------------------------------------+-------+
      ===================================================================
      
      [DAS]domain1.adminServer>modify-web-engine-configuration -tpp 10000 -crp 20000 -server server1 -sp 25000
      Successfully applied the configuration changes.
      For detailed web engine configuration, use the 'show-web-engine-configuration' command.
      
      [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -mo
      Monitoring configuration for [server1]
      ====================================================================
      +-----------------------------------------------------------+------+
      |                            Name                           | Value|
      +-----------------------------------------------------------+------+
      | check-thread-pool                                         | 10000|
      | check-class-reload                                        | 20000|
      | check-session                                             | 25000|
      +-----------------------------------------------------------+------+
      ====================================================================
    • [-ast <attach-stacktrace-on-error>] option is used

      [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -ast
      Webengine basic configuration for [server1]
      ================================================================================
      +----------------------------------------------------------------------+-------+
      |                                 Name                                 | Value |
      +----------------------------------------------------------------------+-------+
      | default-error-page                                                   |       |
      | attach-stacktrace-on-error                                           | false |
      | async-timeout-min-threads                                            |     1 |
      +----------------------------------------------------------------------+-------+
      ================================================================================
      
      [DAS]domain1.adminServer>modify-web-engine-configuration -server server1 -ast true
      Successfully applied the configuration changes.
      For detailed web engine configuration, use the 'show-web-engine-configuration' command.
      
      [DAS]domain1.adminServer>webcfg -server server1 -ast
      Webengine basic configuration for [server1]
      ================================================================================
      +----------------------------------------------------------------------+-------+
      |                                 Name                                 | Value |
      +----------------------------------------------------------------------+-------+
      | default-error-page                                                   |       |
      | attach-stacktrace-on-error                                           | true  |
      | async-timeout-min-threads                                            |     1 |
      +----------------------------------------------------------------------+-------+
      ================================================================================
    • [-att <async-timeout-min-threads>] option is used

      [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -att
      Basic configuration for [server1]
      ================================================================================
      +----------------------------------------------------------------------+-------+
      |                                 Name                                 | Value |
      +----------------------------------------------------------------------+-------+
      | default-error-page                                                   |       |
      | attach-stacktrace-on-error                                           | false |
      | async-timeout-min-threads                                            |     1 |
      +----------------------------------------------------------------------+-------+
      ================================================================================
      
      [DAS]domain1.adminServer>modify-web-engine-configuration -server server1 -att -1
      The value for asynchronous timeout minimum threads must be greater than 0.
      [DAS]domain1.adminServer>modify-web-engine-configuration -server server1 -att 10
      Successfully changed only the XML.
      Restart the server to apply the changes.
      For detailed web engine configuration, use the 'show-web-engine-configuration' command.
      [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -att
      Basic configuration for [server1]
      ================================================================================
      +----------------------------------------------------------------------+-------+
      |                                 Name                                 | Value |
      +----------------------------------------------------------------------+-------+
      | default-error-page                                                   |       |
      | attach-stacktrace-on-error                                           | false |
      | async-timeout-min-threads                                            |    10 |
      +----------------------------------------------------------------------+-------+
      ================================================================================
    • [-rerp | -erp <default-error-page>] option is used

      [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -erp
      Basic configuration for [server1]
      ================================================================================
      +----------------------------------------------------------------------+-------+
      |                                 Name                                 | Value |
      +----------------------------------------------------------------------+-------+
      | default-error-page                                                   |       |
      | attach-stacktrace-on-error                                           | false |
      | async-timeout-min-threads                                            |    10 |
      +----------------------------------------------------------------------+-------+
      ================================================================================
      
      [DAS]domain1.adminServer>modify-web-engine-configuration -server server1 -erp /home/jeus/error/error.html
      Successfully changed only the XML.
      Restart the server to apply the changes.
      For detailed web engine configuration, use the 'show-web-engine-configuration' command.
      
      [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -erp
      Basic configuration for [server1]
      ================================================================================
      +-------------------------------------+----------------------------------------+
      |                 Name                |                  Value                 |
      +-------------------------------------+----------------------------------------+
      | default-error-page                  | /home/jeus/error/error.html            |
      | attach-stacktrace-on-error          | false                                  |
      | async-timeout-min-threads           |                                     10 |
      +-------------------------------------+----------------------------------------+
      ================================================================================
      
      [DAS]domain1.adminServer>modify-web-engine-configuration -server server1 -rerp
      Successfully changed only the XML.
      Restart the server to apply the changes.
      For detailed web engine configuration, use the 'show-web-engine-configuration' command.
      [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -erp
      Basic configuration for [server1]
      ================================================================================
      +----------------------------------------------------------------------+-------+
      |                                 Name                                 | Value |
      +----------------------------------------------------------------------+-------+
      | default-error-page                                                   |       |
      | attach-stacktrace-on-error                                           | false |
      | async-timeout-min-threads                                            |    10 |
      +----------------------------------------------------------------------+-------+
      ================================================================================

Changes the thread pool configurations of the HTTP, TCP, and AJP listeners. The number of threads in the thread pools changes during the thread pool check cycle.

  • Related Schema

    web-engine.xsd - web-engine/web-connections/http-listener, ajp13-listener, tcp-listener

  • Aliases

    modwebl

  • Usage

    modify-web-listener [-cluster <cluster-name> | -server <server-name>]
                        [-f, --forceLock]
                        -name <web-connection-name>
                        [-tmin <minimum-thread-num>]
                        [-tmax <maximum-thread-num>]
                        [-tidle <max-idle-time>]
                        [-obuf <output-buffer-size>]
  • Parameters

    ParameterDescription
    [-f, --forceLock]Forcibly applies the configuration changes.
    -name <web-connection-name>Listener name.
    [-tmin <minimum-thread-num> ][Dynamic change] Minimum number of threads in the thread pools.
    [-tmax <maximum-thread-num>][Dynamic change] Maximum number of threads in the thread pools.
    [-tidle <max-idle-time>][Dynamic change] Maximum idle time of each thread in the thread pools.
    -obuf <output-buffer-size>Response buffer size used by servlets.
  • Example

    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -cn
    Http Listener[ADMIN-HTTP] configuration for [server1]
    ================================================================================
    +-----------------------------------------------------------------+------------+
    |                               Name                              |    Value   |
    +-----------------------------------------------------------------+------------+
    | name                                                            | ADMIN-HTTP |
    | server-listener-ref                                             | base       |
    | max-keep-alive-request                                          |        100 |
    | server-access-control                                           | false      |
    | allowed-server                                                  |            |
    | connection-type                                                 |            |
    | output-buffer-size                                              |       8192 |
    | postdata-read-timeout                                           |      30000 |
    | max-post-size                                                   | unlimited  |
    | max-parameter-count                                             | unlimited  |
    | max-header-count                                                | unlimited  |
    | max-header-size                                                 | unlimited  |
    | max-querystring-size                                            |       8192 |
    | threadpool.min                                                  |          1 |
    | threadpool.max                                                  |         32 |
    | threadpool.max-idle-time                                        |     300000 |
    | threadpool.max-queue                                            | unlimited  |
    | threadpool.thread-state-notify                                  |            |
    +-----------------------------------------------------------------+------------+
    ================================================================================
    
    Ajp13 Listener[ajp1] configuration for [server1]
    =========================================================================
    +---------------------------------------------------------------+-------+
    |                              Name                             | Value |
    +---------------------------------------------------------------+-------+
    | name                                                          | ajp1  |
    | server-listener-ref                                           | ajp   |
    | read-timeout                                                  |     0 |
    | server-access-control                                         | false |
    | allowed-server                                                |       |
    | output-buffer-size                                            |  8192 |
    | postdata-read-timeout                                         | 30000 |
    | max-post-size                                                 |    -1 |
    | max-parameter-count                                           |    -1 |
    | max-header-count                                              |    -1 |
    | max-header-size                                               |    -1 |
    | max-querystring-size                                          |  8192 |
    | threadpool.min                                                |    10 |
    | threadpool.max                                                |    20 |
    | threadpool.max-idle-time                                      | 300000|
    | threadpool.max-queue                                          |    -1 |
    | threadpool.thread-state-notify                                |       |
    +---------------------------------------------------------------+-------+
    =========================================================================
    
    Http Listener[http1] configuration for [server1]
    =======================================================================
    +--------------------------------------------------------+------------+
    |                          Name                          |    Value   |
    +--------------------------------------------------------+------------+
    | name                                                   | http1      |
    | server-listener-ref                                    | http-server|
    | max-keep-alive-request                                 |        100 |
    | server-access-control                                  | false      |
    | allowed-server                                         |            |
    | connection-type                                        |            |
    | output-buffer-size                                     |       8192 |
    | postdata-read-timeout                                  |      30000 |
    | max-post-size                                          | unlimited  |
    | max-parameter-count                                    | unlimited  |
    | max-header-count                                       | unlimited  |
    | max-header-size                                        | unlimited  |
    | max-querystring-size                                   |       8192 |
    | threadpool.min                                         |         10 |
    | threadpool.max                                         |         20 |
    | threadpool.max-idle-time                               |     300000 |
    | threadpool.max-queue                                   | unlimited  |
    | threadpool.thread-state-notify                         |            |
    +--------------------------------------------------------+------------+
    =======================================================================
    
    TCP Listener[tcp1] configuration for [server1]
    ================================================================================
    +-------------------------------------------+----------------------------------+
    |                    Name                   |               Value              |
    +-------------------------------------------+----------------------------------+
    | name                                      | tcp1                             |
    | server-listener-ref                       | tcp                              |
    | dispatcher-config-class                   | tcp.DispatcherConfigImpl         |
    | server-access-control                     | false                            |
    | allowed-server                            |                                  |
    | connection-type                           |                                  |
    | output-buffer-size                        |                             8192 |
    | postdata-read-timeout                     |                            30000 |
    | max-post-size                             |                      unlimited   |
    | max-parameter-count                       |                      unlimited   |
    | max-header-count                          |                      unlimited   |
    | max-header-size                           |                      unlimited   |
    | max-querystring-size                      |                             8192 |
    | threadpool.min                            |                               10 |
    | threadpool.max                            |                               20 |
    | threadpool.max-idle-time                  |                           300000 |
    | threadpool.max-queue                      |                      unlimited   |
    | threadpool.thread-state-notify            |                                  |
    +-------------------------------------------+----------------------------------+
    ================================================================================
    
    [DAS]domain1.adminServer>modify-web-listener -name http1 -tmin 30 -server server1 -tmax 30
    Successfully applied the configuration changes.
    For detailed web connection information, use the 'show-web-engine-configuration -cn' command.
    
    [DAS]domain1.adminServer>modify-web-listener -name ajp1 -server server1 -tmin 20
    Successfully applied the configuration changes.
    For detailed web connection information, use the 'show-web-engine-configuration -cn' command.
    
    [DAS]domain1.adminServer>modify-web-listener -name tcp1 -server server1 -tmax 25
    Successfully applied the configuration changes.
    For detailed web connection information, use the 'show-web-engine-configuration -cn' command.
    
    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -cn
    Http Listener[ADMIN-HTTP] configuration for [server1]
    ================================================================================
    +-----------------------------------------------------------------+------------+
    |                               Name                              |    Value   |
    +-----------------------------------------------------------------+------------+
    | name                                                            | ADMIN-HTTP |
    | server-listener-ref                                             | base       |
    | max-keep-alive-request                                          |        100 |
    | server-access-control                                           | false      |
    | allowed-server                                                  |            |
    | connection-type                                                 |            |
    | output-buffer-size                                              |       8192 |
    | postdata-read-timeout                                           |      30000 |
    | max-post-size                                                   | unlimited  |
    | max-parameter-count                                             | unlimited  |
    | max-header-count                                                | unlimited  |
    | max-header-size                                                 | unlimited  |
    | max-querystring-size                                            |       8192 |
    | threadpool.min                                                  |          1 |
    | threadpool.max                                                  |         32 |
    | threadpool.max-idle-time                                        |     300000 |
    | threadpool.max-queue                                            | unlimited  |
    | threadpool.thread-state-notify                                  |            |
    +-----------------------------------------------------------------+------------+
    ================================================================================
    
    Ajp13 Listener[ajp1] configuration for [server1]
    =========================================================================
    +---------------------------------------------------------------+-------+
    |                              Name                             | Value |
    +---------------------------------------------------------------+-------+
    | name                                                          | ajp1  |
    | server-listener-ref                                           | ajp   |
    | read-timeout                                                  |     0 |
    | server-access-control                                         | false |
    | allowed-server                                                |       |
    | output-buffer-size                                            |  8192 |
    | postdata-read-timeout                                         | 30000 |
    | max-post-size                                                 |    -1 |
    | max-parameter-count                                           |    -1 |
    | max-header-count                                              |    -1 |
    | max-header-size                                               |    -1 |
    | max-querystring-size                                          |  8192 |
    | threadpool.min                                                |    20 |
    | threadpool.max                                                |    20 |
    | threadpool.max-idle-time                                      | 300000|
    | threadpool.max-queue                                          |    -1 |
    | threadpool.thread-state-notify                                |       |
    +---------------------------------------------------------------+-------+
    =========================================================================
    
    Http Listener[http1] configuration for [server1]
    =======================================================================
    +--------------------------------------------------------+------------+
    |                          Name                          |    Value   |
    +--------------------------------------------------------+------------+
    | name                                                   | http1      |
    | server-listener-ref                                    | http-server|
    | max-keep-alive-request                                 |        100 |
    | server-access-control                                  | false      |
    | allowed-server                                         |            |
    | connection-type                                        |            |
    | output-buffer-size                                     |       8192 |
    | postdata-read-timeout                                  |      30000 |
    | max-post-size                                          | unlimited  |
    | max-parameter-count                                    | unlimited  |
    | max-header-count                                       | unlimited  |
    | max-header-size                                        | unlimited  |
    | max-querystring-size                                   |       8192 |
    | threadpool.min                                         |         30 |
    | threadpool.max                                         |         30 |
    | threadpool.max-idle-time                               |     300000 |
    | threadpool.max-queue                                   | unlimited  |
    | threadpool.thread-state-notify                         |            |
    +--------------------------------------------------------+------------+
    =======================================================================
    
    TCP Listener[tcp1] configuration for [server1]
    ================================================================================
    +-------------------------------------------+----------------------------------+
    |                    Name                   |               Value              |
    +-------------------------------------------+----------------------------------+
    | name                                      | tcp1                             |
    | server-listener-ref                       | tcp                              |
    | dispatcher-config-class                   | tcp.DispatcherConfigImpl         |
    | server-access-control                     | false                            |
    | allowed-server                            |                                  |
    | connection-type                           |                                  |
    | output-buffer-size                        |                             8192 |
    | postdata-read-timeout                     |                            30000 |
    | max-post-size                             |                      unlimited   |
    | max-parameter-count                       |                      unlimited   |
    | max-header-count                          |                      unlimited   |
    | max-header-size                           |                      unlimited   |
    | max-querystring-size                      |                             8192 |
    | threadpool.min                            |                               10 |
    | threadpool.max                            |                               25 |
    | threadpool.max-idle-time                  |                           300000 |
    | threadpool.max-queue                      |                      unlimited   |
    | threadpool.thread-state-notify            |                                  |
    +-------------------------------------------+----------------------------------+
    ================================================================================

Changes the thread pool configuration of a WebtoB connector. The number of threads in the thread pools changes during the thread pool check cycle.

  • Related Schema

    web-engine.xsd - web-engine/web-connections/webtob-connector

  • Aliases

    modwebtobcon

  • Usage

    modify-webtob-connector [-cluster <cluster-name> | -server <server-name>]
                            [-f,--forceLock]
                            -name <web-connection-name>
                            -num <thread-number>
                            [-obuf <output-buffer-size>]
                            [-addr <server-address>]
                            [-port <server-port>]
                            [-regid <registration-id>]
                            [-sndbuf <send-buffer-size>]
                            [-rcvbuf <receive-buffer-size>]
  • Parameters

    ParameterDescription
    [-f, --forceLock]Forcibly applies the configuration changes.
    -name <web-connection-name>WebtoB connector name.
    -num <thread-number>[Dynamic change] Number of threads in the thread pools.
    [-obuf <output-buffer-size>]Servlet response buffer size.
    [-addr <server-address>]WebtoB server address.
    [-port <server-port>]WebtoB server port.
    [-regid <registration-id>]WebtoB ID.
    -sndbuf <send-buffer-size>SO_SNDBUF. The size of the send buffer of the TCP Socket or the Unix Domain Socket. If set to 0, the default value of the OS is used.
    -rcvbuf <receive-buffer-size>SO_RCVBUF. The size of the receive buffer of the TCP Socket or the Unix Domain Socket. If set to 0, the default value of the OS is used.
  • Example

    [DAS]domain1.adminServer>show-web-engine-configuration -server -server1 -cn-cn
    WebtoB Connector[webtob1] configuration for [server1]
    ================================================================================
    +------------------------------------------------------------------+-----------+
    |                               Name                               |   Value   |
    +------------------------------------------------------------------+-----------+
    | name                                                             | webtob1   |
    | port                                                             |      9999 |
    | ip-address                                                       | localhost |
    | hth-count                                                        |         1 |
    | request-prefetch                                                 | false     |
    | registration-id                                                  | MyGroup   |
    | read-timeout                                                     |         0 |
    | reconnect-interval                                               |      5000 |
    | connection-type                                                  |           |
    | output-buffer-size                                               |      8192 |
    | postdata-read-timeout                                            |     30000 |
    | max-post-size                                                    | unlimited |
    | max-parameter-count                                              | unlimited |
    | max-header-count                                                 | unlimited |
    | max-header-size                                                  | unlimited |
    | max-querystring-size                                             |      8192 |
    | threadpool.number                                                |        10 |
    | threadpool.thread-state-notify                                   |           |
    | send-buffer-size                                                 |           |
    | receive-buffer-size                                              |           |
    +------------------------------------------------------------------+-----------+
    ================================================================================
    
    [DAS]domain1.adminServer>modify-webtob-connector -name webtob1 -num 30 -sndbuf 1200 -rcvbuf 2400 -server server1
    Successfully applied the configuration changes.
    For detailed web connection information, use the 'show-web-engine-configuration -cn' command.
    
    [DAS]domain1.adminServer>show-web-engine-configuration -server -server1 -cn-cn
    WebtoB Connector[webtob1] configuration for [server1]
    ================================================================================
    +------------------------------------------------------------------+-----------+
    |                               Name                               |   Value   |
    +------------------------------------------------------------------+-----------+
    | name                                                             | webtob1   |
    | port                                                             |      9999 |
    | ip-address                                                       | localhost |
    | hth-count                                                        |         1 |
    | request-prefetch                                                 | false     |
    | registration-id                                                  | MyGroup   |
    | read-timeout                                                     |         0 |
    | reconnect-interval                                               |      5000 |
    | connection-type                                                  |           |
    | output-buffer-size                                               |      8192 |
    | postdata-read-timeout                                            |     30000 |
    | max-post-size                                                    | unlimited |
    | max-parameter-count                                              | unlimited |
    | max-header-count                                                 | unlimited |
    | max-header-size                                                  | unlimited |
    | max-querystring-size                                             |      8192 |
    | threadpool.number                                                |        30 |
    | threadpool.thread-state-notify                                   |           |
    | send-buffer-size                                                 |      1200 |
    | receive-buffer-size                                              |      2400 |
    +------------------------------------------------------------------+-----------+
    ================================================================================

Precompiles the JSP files of deployed web contexts.

JSP files are generally compiled when the web engine receives JSP file requests from web browsers. Initial JSP file requests consume a large amount of resources for parsing and compiling, which lengthens the response time.

If there is a large number of JSP files and frequent web user requests, the time and resources required to handle the initial request can affect overall service. To prevent this effect, the precompile-jsp command is used, and the JSP source files are compiled in advance before the service starts.

The precompile-jsp command compiles the deployed modules after JEUS boots up. To use the command when JEUS is not started, refer to "4.3. appcompiler".

Note

1. precompile-jsp does not offer cluster as an option.

2. In JEUS 6, the jspc command is used under the $JEUS_HOME/bin directory as a batch compiler. In JEUS 7, an internal jeusadmin command is used.

  • Related Schema

    web-engine.xsd

  • Aliases

    jspc

  • Usage

    precompile-jsp [-server <server-name>]
                   -ctx <context-name>
                   [-e <excluded-jsp-list-file> | -l <included-jsp-list-file>]
  • Parameters

    ParameterDescription
    -ctx <context-name>Web context name. If the context is in EAR, the input format must be ear-name#context-name.
    [-e <excluded-jsp-list-file>]

    Text file that describes paths that are not compiled based on a web context. JSP paths must be relative paths from the context root and must start with a slash (/).

    Use an absolute path to jsp-list-file.

    [-l <included-jsp-list-file>]

    Text file that describes paths compiled based on a web context. JSP paths must be relative paths from the context root and must start with a slash (/).

    Use an absolute path to jsp-list-file.

  • Example

    [DAS]domain1.adminServer>precompile-jsp -server server1 -ctx myctx
    ==========Precompile result=========
    ================================================================================
    +-----------------+------------------------------------------------------------+
    |     JSP file    |                       compile result                       |
    +-----------------+------------------------------------------------------------+
    | /error.jsp      | success                                                    |
    +-----------------+------------------------------------------------------------+
    | /tmaxTitle.jsp  | success                                                    |
    +-----------------+------------------------------------------------------------+
    | /cookie.jsp     | success                                                    |
    +-----------------+------------------------------------------------------------+
    | /locale2.jsp    | success                                                    |
    +-----------------+------------------------------------------------------------+
    | /test_too_long.j| org.apache.jasper.JasperException: Unable to compile class |
    |sp               |for JSP:                                                    |
    |                 |                                                            |
    |                 | An error occurred at line: 10 in the jsp file: /test_too_lo|
    |                 |ng.jsp                                                      |
    |                 | /home/data/source_repository/jeus/jeus7/target/jeus/domains|
    |                 |/domain1/servers/server1/.workspace/deployed/_generated_/te|
    |                 |st/__jspwork/jeus_jspwork/_700_test_5ftoo_5flong_5fjsp.java:|
    |                 |93: constant string too long                                |
    |                 | 7: <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitiona|
    |                 |l//EN">                                                     |
    |                 | 8: <html>                                                  |
    |                 | 9:   <head>                                                |
    |                 | 10:     <base href="<%=basePath%>">                        |
    |                 | 11:                                                        |
    |                 | 12:     <title>My JSP 'MyJsp.jsp' starting page</title>    |
    |                 | 13:                                                        |
    |                 |                                                            |
    |                 |                                                            |
    |                 | Stacktrace:                                                |
    +-----------------+------------------------------------------------------------+
    | /sleep1.jsp     | success                                                    |
    +-----------------+------------------------------------------------------------+
    | /result.jsp     | success                                                    |
    +-----------------+------------------------------------------------------------+
    | /locale.jsp     | success                                                    |
    +-----------------+------------------------------------------------------------+
    | /web/index.jsp  | success                                                    |
    +-----------------+------------------------------------------------------------+
    | /form.jsp       | success                                                    |
    +-----------------+------------------------------------------------------------+
    | /senderror.jsp  | success                                                    |
    +-----------------+------------------------------------------------------------+
    | /index.jsp      | success                                                    |
    +-----------------+------------------------------------------------------------+
    | /kortest.jsp    | success                                                    |
    +-----------------+------------------------------------------------------------+
    | /jira2540.jsp   | success                                                    |
    +-----------------+------------------------------------------------------------+
    | /parameter.jsp  | success                                                    |
    +-----------------+------------------------------------------------------------+
    | /error_test.jsp | success                                                    |
    +-----------------+------------------------------------------------------------+
    | /test.jsp       | success                                                    |
    +-----------------+------------------------------------------------------------+
    | /jira2875.jsp   | org.apache.jasper.JasperException: /jira2875.jsp (line: 2, |
    |                 |column: 3) Invalid directive                                |
    +-----------------+------------------------------------------------------------+
    
    total : 18  success: 16  fail : 2
    ================================================================================
    
    ...
    > cat /home/jeus/exclude.txt 
    /test_too_long.jsp
    /jira2875.jsp
    >
    ...
    
    [DAS]domain1.adminServer>precompile-jsp -server server1 -ctx myctx -e /home/jeus/exclude.txt
    ==========Precompile result=========
    ================================================================================
    +----------------------------------------+-------------------------------------+
    |                JSP file                |            compile result           |
    +----------------------------------------+-------------------------------------+
    | /error.jsp                             | success                             |
    +----------------------------------------+-------------------------------------+
    | /tmaxTitle.jsp                         | success                             |
    +----------------------------------------+-------------------------------------+
    | /cookie.jsp                            | success                             |
    +----------------------------------------+-------------------------------------+
    | /locale2.jsp                           | success                             |
    +----------------------------------------+-------------------------------------+
    | /sleep1.jsp                            | success                             |
    +----------------------------------------+-------------------------------------+
    | /result.jsp                            | success                             |
    +----------------------------------------+-------------------------------------+
    | /locale.jsp                            | success                             |
    +----------------------------------------+-------------------------------------+
    | /web/index.jsp                         | success                             |
    +----------------------------------------+-------------------------------------+
    | /form.jsp                              | success                             |
    +----------------------------------------+-------------------------------------+
    | /senderror.jsp                         | success                             |
    +----------------------------------------+-------------------------------------+
    | /index.jsp                             | success                             |
    +----------------------------------------+-------------------------------------+
    | /kortest.jsp                           | success                             |
    +----------------------------------------+-------------------------------------+
    | /jira2540.jsp                          | success                             |
    +----------------------------------------+-------------------------------------+
    | /parameter.jsp                         | success                             |
    +----------------------------------------+-------------------------------------+
    | /error_test.jsp                        | success                             |
    +----------------------------------------+-------------------------------------+
    | /test.jsp                              | success                             |
    +----------------------------------------+-------------------------------------+
    
    total : 16  success: 16  fail : 0
    ================================================================================
    
    ...
    
    > cat /home/jeus/compile.txt
    /index.jsp
    /error.jsp
    
    
    [DAS]domain1.adminServer>precompile-jsp -server server1 -ctx myctx -l /home/jeus/compile.txt
    ==========Precompile result=========
    ================================================================================
    +--------------------------------+---------------------------------------------+
    |            JSP file            |                compile result               |
    +--------------------------------+---------------------------------------------+
    | /index.jsp                     | success                                     |
    +--------------------------------+---------------------------------------------+
    | /error.jsp                     | success                                     |
    +--------------------------------+---------------------------------------------+
    
    total : 2  success: 2  fail : 0
    ================================================================================
  • Note

    This command can be used without being connected to the server.

Removes an HTTP Cookie Policy configuration from the web engine. The changes only apply to the domain.xml file. In order to apply changes to the actual service, the server must be restarted.

  • Related Schema

    web-engine.xsd - web-engine/cookie-policy

  • Aliases

    rmcp, rmcookie

  • Usage

    remove-web-cookie-policy [-cluster <cluster-name> | -server <server-name>]
                             [-f,--forceLock]
                             [-auer,--apply-url-encoding-rule]
                             [-enc,--charset-encoding]
                             [-vh <virtual-host-name>]
  • Parameters

    ParameterDescription
    [-f, --forceLock]Forcibly applies the configuration changes.
    [-auer,--apply-url-encoding-rule]Deletes the configuration that determines whether to apply URL Encoding Rule.
    [-enc,--charset-encoding]Deletes Charset Encoding, which is used when applying URL Encoding Rule.
    [-vh <virtual-host-name>]Virtual host.
  • Example

    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -cp
    Cookie Policy configuration for [server1]
    ================================================================================
    +----------------------------------------------------------------------+-------+
    |                                 Name                                 | Value |
    +----------------------------------------------------------------------+-------+
    | write-value-on-header-policy.apply-url-encoding-rule                 | false |
    | write-value-on-header-policy.charset-encoding                        | UTF-8 |
    +----------------------------------------------------------------------+-------+
    ================================================================================
    
    [DAS]domain1.adminServer>remove-web-cookie-policy -server server1 -auer
    Successfully applied part of the changes.
    Restart the server to apply the remaining changes.
    For detailed cookie policy information, use the 'show-web-engine-configuration -cp' command.
    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -cp
    Cookie Policy configuration for [server1]
    ================================================================================
    +----------------------------------------------------------------------+-------+
    |                                 Name                                 | Value |
    +----------------------------------------------------------------------+-------+
    | write-value-on-header-policy.apply-url-encoding-rule                 |       |
    | write-value-on-header-policy.charset-encoding                        | UTF-8 |
    +----------------------------------------------------------------------+-------+
    ================================================================================
    [DAS]domain1.adminServer>remove-web-cookie-policy -server server1 -enc
    Successfully applied part of the changes.
    Restart the server to apply the remaining changes.
    For detailed cookie policy information, use the 'show-web-engine-configuration -cp' command.
    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -cp
    Cookie Policy configuration for [server1]
    ================================================================================
    +------------------------------------------------------------------------------+
    |                                    Result                                    |
    +------------------------------------------------------------------------------+
    | The Cookie Policy configuration does not exist.                              |
    +------------------------------------------------------------------------------+
    ================================================================================

Deletes a Character Set Encoding from the web engine. The changes only apply to the domain.xml file. In order to apply changes to the actual service, the server must be restarted.

  • Related Schema

    web-engine.xsd - web-engine/encoding

  • Aliases

    rmenc

  • Usage

    remove-web-encoding [-cluster <cluster-name> | -server <server-name>]
                        [-f,--forceLock]
                        [-url]
                        [-req]
                        [-res]
                        [-vh <virtual-host-name>]
  • Parameters

    ParameterDescription
    [-f, --forceLock]Forcibly applies the configuration changes.
    [-url]Deletes the character set encoding of a request URL.
    [-req]Deletes the character set encoding of a request.
    [-res]Deletes the character set encoding of a response.
    [-vh <virtual-host-name>]Virtual host.
  • Example

    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -enc
    Encoding configuration for [server1]
    ================================================================================
    +-----------------------------------------------------------------+------------+
    |                               Name                              |    Value   |
    +-----------------------------------------------------------------+------------+
    | encoding.request-url-encoding.forced                            | ISO-8859-1 |
    | encoding.request-encoding.forced                                | ISO-8859-1 |
    | encoding.response-encoding.forced                               | ISO-8859-1 |
    +-----------------------------------------------------------------+------------+
    ================================================================================
    
    [DAS]domain1.adminServer>remove-web-encoding -server server1 -url
    Successfully applied part of the changes.
    Restart the server to apply the remaining changes.
    For detailed encoding information, use the 'show-web-engine-configuration -enc' command.
    
    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -enc
    Encoding configuration for [server1]
    ================================================================================
    +-----------------------------------------------------------------+------------+
    |                               Name                              |    Value   |
    +-----------------------------------------------------------------+------------+
    | encoding.request-url-encoding                                   |            |
    | encoding.request-encoding.forced                                | ISO-8859-1 |
    | encoding.response-encoding.forced                               | ISO-8859-1 |
    +-----------------------------------------------------------------+------------+
    ================================================================================
    
    [DAS]domain1.adminServer>remove-web-encoding -server server1 -req -res
    Successfully applied part of the changes.
    Restart the server to apply the remaining changes.
    For detailed encoding information, use the 'show-web-engine-configuration -enc' command.
    
    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -enc
    Encoding configuration for [server1] 
    ================================================================================
    +------------------------------------------------------------------------------+
    |                                    Result                                    |
    +------------------------------------------------------------------------------+
    | The Encoding configuration does not exist.                                   |
    +------------------------------------------------------------------------------+
    ================================================================================

Deletes property configurations from the web engine. The deleted properties are case sensitive. The changes only apply to the domain.xml file. In order to apply changes to the actual service, the server must be restarted.

  • Related Schema

    web-engine.xsd - web-engine/properties

  • Aliases

    rmwebpr

  • Usage

    remove-web-properties [-cluster <cluster-name> | -server <server-name>]
                          [-f,--forceLock]
                          [-a,--all | -k,--keys <keys>]
                          [-vh <virtual-host-name>]
  • Parameters

    ParameterDescription
    [-f, --forceLock]Forcibly applies the configuration changes.
    [-a,--all | -k,--keys <keys>]
    • -k, --keys <keys> deletes a specified property from the web engine. The value is case sensitive. To specify multiple keys, separate each key with a comma (,).

    • -a, --all deletes all properties currently set.

    [-vh <virtual-host-name>]Virtual host.
  • Example

    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -pr
    Properties configuration for [server1]
    ================================================================================
    +----------------------------------------------------------------------+-------+
    |                                 Name                                 | Value |
    +----------------------------------------------------------------------+-------+
    | jeus.servlet.jsp.compile-java-source-concurrently                    | true  |
    | jeus.servlet.jsp.compile-java-source-concurrently1                   | false |
    | jeus.servlet.jsp.assure-utf8-file-encoding-detection                 | false |
    +----------------------------------------------------------------------+-------+
    ================================================================================
    
    [DAS]domain1.adminServer>remove-web-properties -server server1
    The following options are missing: [-a Remove all web engine properties., -k Remove the web engine properties. Separate them with the "," character.]
    [DAS]domain1.adminServer>remove-web-properties -server server1 -k -a
    The k option is missing an argument.
    [DAS]domain1.adminServer>remove-web-properties -server server1 -k jeus.servlet.jsp.compile-java-source-concurrently -a
    The option 'k' was specified but an option from this group has already been selected: 'a'
    [DAS]domain1.adminServer>remove-web-properties -server server1 -k jeus.servlet.jsp.compile-java-source-concurrently1
    Successfully applied part of the changes.
    Restart the server to apply the remaining changes.
    For detailed custom response header information, use the 'show-web-engine-configuration -pr' command.
    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -pr
    Properties configuration for [server1]
    ================================================================================
    +----------------------------------------------------------------------+-------+
    |                                 Name                                 | Value |
    +----------------------------------------------------------------------+-------+
    | jeus.servlet.jsp.compile-java-source-concurrently                    | true  |
    | jeus.servlet.jsp.assure-utf8-file-encoding-detection                 | false |
    +----------------------------------------------------------------------+-------+
    ================================================================================
    
    [DAS]domain1.adminServer>remove-web-properties -server server1 -a
    Successfully applied part of the changes.
    Restart the server to apply the remaining changes.
    For detailed custom response header information, use the 'show-web-engine-configuration -pr' command.
    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -pr
    Properties configuration for [server1]
    ================================================================================
    +------------------------------------------------------------------------------+
    |                                    Result                                    |
    +------------------------------------------------------------------------------+
    | The Properties configuration does not exist.                                 |
    +------------------------------------------------------------------------------+
    ================================================================================

Deletes an HTTP Response Custom Header configuration from the web engine. The deleted Response Headers are case insensitive. The changes only apply to the domain.xml file. In order to apply changes to the actual service, the server must be restarted.

  • Related Schema

    web-engine.xsd - web-engine/response-header

  • Aliases

    rmwebrh

  • Usage

    remove-response-header [-cluster <cluster-name> | -server <server-name>]
                           [-f,--forceLock]
                           [-a,--all | -n,--name <header-name>]
  • Parameters

    ParameterDescription
    [-f, --forceLock]Forcibly applies the configuration changes.
    [-a,--all | -n,--name <header-name>]
    • -n, --name <header-name> deletes an HTTP Response Header. The value is case insensitive. To specify multiple headers, separate each header with a comma (,).

    • -a, --all deletes all HTTP Response Headers that are currently set.

  • Example

    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -rh
    Response Custom Header configuration for [server1]
    =======================================================
    +----------------------------------------+------------+
    |                  Name                  |    Value   |
    +----------------------------------------+------------+
    | testheader                             | testvalue3 |
    | testheader2                            | testvalue2 |
    | testheader4                            | testvalue5 |
    | testheader5                            | testvalue5 |
    | testheader6                            | testvalue6 |
    | testheader7                            | testvalue7 |
    +----------------------------------------+------------+
    =======================================================
    
    [DAS]domain1.adminServer>remove-response-header -server -server1
    At least one option must be specified.
    [DAS]domain1.admiServer>remove-response-header -server -server1 -a -n testheader
    The option 'n' was specified but an option from this group has already been selected: 'a'
    [DAS]domain1.adminServer>remove-response-header -server server1 -n testheader
    Successfully applied part of the changes.
    Restart the server to apply the remaining changes.
    For detailed custom response header information, use the 'show-web-engine-configuration -rh' command.
    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -rh
    Response Custom Header configuration for [server1]
    =======================================================
    +----------------------------------------+------------+
    |                  Name                  |    Value   |
    +----------------------------------------+------------+
    | testheader2                            | testvalue2 |
    | testheader4                            | testvalue5 |
    | testheader5                            | testvalue5 |
    | testheader6                            | testvalue6 |
    | testheader7                            | testvalue7 |
    +----------------------------------------+------------+
    =======================================================
    [DAS]domain1.adminServer>remove-response-header -server server1 -n testheader2,testheader4
    Successfully applied part of the changes.
    Restart the server to apply the remaining changes.
    For detailed custom response header information, use the 'show-web-engine-configuration -rh' command.
    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -rh
    Response Custom Header configuration for [server1]
    =======================================================
    +----------------------------------------+------------+
    |                  Name                  |    Value   |
    +----------------------------------------+------------+
    | testheader5                            | testvalue5 |
    | testheader6                            | testvalue6 |
    | testheader7                            | testvalue7 |
    +----------------------------------------+------------+
    =======================================================
    
    [DAS]domain1.adminServer>remove-response-header -server server1 -a
    Successfully applied part of the changes.
    Restart the server to apply the remaining changes.
    For detailed custom response header information, use the 'show-web-engine-configuration -rh' command.
    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -rh
    Response Custom Header configuration for [server1]
    ================================================================================
    +------------------------------------------------------------------------------+
    |                                    Result                                    |
    +------------------------------------------------------------------------------+
    | The Response Custom Header configuration does not exist.                     |
    +------------------------------------------------------------------------------+
    ================================================================================

Deletes a Tmax connector. This command only applies to the domain.xml file. In order to apply changes to the actual service, the server must be restarted.

  • Related Schema

    web-engine.xsd - web-engine/web-connections/tmax-connector

  • Aliases

    rmtmaxcon

  • Usage

    remove-tmax-connector [-cluster <cluster-name> | -server <server-name>]
                          [-f,--forceLock]
                          <web-connection-name>
  • Parameters

    ParameterDescription
    [-f, --forceLock]Forcibly applies the configuration changes.
    <web-connection-name>Tmax connector name.
  • Example

    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -cn
    Tmax connector[tmax1] configuration for [server1]
    ================================================================================
    +-------------------------------------------+----------------------------------+
    |                    Name                   |               Value              |
    +-------------------------------------------+----------------------------------+
    | name                                      | tmax1                            |
    | port                                      |                             1024 |
    | server-group-name                         | group1                           |
    | server-name                               | server1                          |
    | dispatcher-config-class                   | service.DispatcherConfig         |
    | reconnect-interval                        |                             5000 |
    | reconnect-count-for-backup                |                               12 |
    | tmax-address                              | 5.0.1.2                          |
    | tmax-version                              |                                  |
    | server-type                               |                                  |
    | xaresource-class                          |                                  |
    | tmax-backup-address                       |                                  |
    | tmax-backup-port                          |                                  |
    | use-nio                                   | false                            |
    | selector-count                            |                                1 |
    | connection-type                           |                                  |
    | output-buffer-size                        |                             8192 |
    | postdata-read-timeout                     |                            30000 |
    | max-post-size                             | unlimited                        |
    | max-parameter-count                       | unlimited                        |
    | max-header-count                          | unlimited                        |
    | max-header-size                           | unlimited                        |
    | max-querystring-size                      |                             8192 |
    | threadpool.min                            |                               20 |
    | threadpool.max                            |                               20 |
    | threadpool.max-idle-time                  |                           300000 |
    | threadpool.max-queue                      | unlimited                        |
    | threadpool.thread-state-notify            |                                  |
    +-------------------------------------------+----------------------------------+
    ================================================================================
    
    [DAS]domain1.adminServer>remove-tmax-connector -server server1 tmax1
    Successfully changed only the XML.
    Restart the server to apply the changes.
    For detailed web connection information, use the 'show-web-engine-configuration -cn' command.

Deletes a virtual host. This command only applies to the domain.xml file. In order to apply changes to the actual service, the server must be restarted.

  • Related Schema

    web-engine.xsd - web-engine/virtual-host

  • Aliases

    rmvh

  • Usage

    remove-virtual-host [-cluster <cluster-name> | -server <server-name>]
                        [-f,--forceLock]
                        <virtual-host-name>
  • Parameters

    ParameterDescription
    [-f, --forceLock]Forcibly applies the configuration changes.
    <virtual-host-name>Virtual host name.
  • Example

    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -vh
    Virtual host[host2] configuration for [server1]
    ================================================================================
    +-------------------------------------+----------------------------------------+
    |                 Name                |                  Value                 |
    +-------------------------------------+----------------------------------------+
    | virtual-host-name                   | host2                                  |
    +-------------------------------------+----------------------------------------+
    | host-name                           | www.foo.com                            |
    |                                     | 192.168.1.2                            |
    +-------------------------------------+----------------------------------------+
    | access-log.enable                   | true                                   |
    +-------------------------------------+----------------------------------------+
    | access-log.format                   | default                                |
    +-------------------------------------+----------------------------------------+
    | access-log.exclude-ext              |                                        |
    +-------------------------------------+----------------------------------------+
    | access-log.use-parent-handlerst     | true                                   |
    +-------------------------------------+----------------------------------------+
    | access-log.formatter-class          | jeus.util.logging.SimpleFormatter      |
    +-------------------------------------+----------------------------------------+
    | properties                          |                                        |
    +-------------------------------------+----------------------------------------+
    ================================================================================
    
    [DAS]domain1.adminServer>remove-virtual-host -server server1 host2
    Successfully applied the configuration changes.
    For detailed virtual-host information, use the 'show-web-engine-configuration -vh' 
    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -vh
    Virtual Host configuration for [server1]
    ================================================================================
    +------------------------------------------------------------------------------+
    |                                    Result                                    |
    +------------------------------------------------------------------------------+
    | The Virtual Host configuration does not exist.                               |
    +------------------------------------------------------------------------------+
    ================================================================================

Deletes an HTTP, TCP, or AJP listener. This command only applies to the domain.xml file. In order to apply changes to the actual service, the server must be restarted. The ADMIN-HTTP listener is not deleted.

  • Related Schema

    web-engine.xsd - web-engine/web-connections/http-listener, ajp13-listener, tcp-listener

  • Aliases

    rmwebl

  • Usage

    remove-web-listener [-cluster <cluster-name> | -server <server-name>]
                        [-f,--forceLock]
                        <web-connection-name>
  • Parameters

    ParameterDescription
    [-f, --forceLock]Forcibly applies the configuration changes.
    <web-connection-name>Listener name.
  • Example

    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -cn
    Http Listener[ADMIN-HTTP] configuration for [server1]
    ================================================================================
    +-----------------------------------------------------------------+------------+
    |                               Name                              |    Value   |
    +-----------------------------------------------------------------+------------+
    | name                                                            | ADMIN-HTTP |
    | server-listener-ref                                             | base       |
    | max-keep-alive-request                                          |        100 |
    | server-access-control                                           | false      |
    | allowed-server                                                  |            |
    | connection-type                                                 |            |
    | output-buffer-size                                              |       8192 |
    | postdata-read-timeout                                           |      30000 |
    | max-post-size                                                   | unlimited  |
    | max-parameter-count                                             | unlimited  |
    | max-header-count                                                | unlimited  |
    | max-header-size                                                 | unlimited  |
    | max-querystring-size                                            |       8192 |
    | threadpool.min                                                  |          1 |
    | threadpool.max                                                  |         32 |
    | threadpool.max-idle-time                                        |     300000 |
    | threadpool.max-queue                                            | unlimited  |
    | threadpool.thread-state-notify                                  |            |
    +-----------------------------------------------------------------+------------+
    ================================================================================
    
    Ajp13 Listener[ajp1] configuration for [server1]
    =========================================================================
    +---------------------------------------------------------------+-------+
    |                              Name                             | Value |
    +---------------------------------------------------------------+-------+
    | name                                                          | ajp1  |
    | server-listener-ref                                           | ajp   |
    | read-timeout                                                  |     0 |
    | server-access-control                                         | false |
    | allowed-server                                                |       |
    | output-buffer-size                                            |  8192 |
    | postdata-read-timeout                                         | 30000 |
    | max-post-size                                                 |    -1 |
    | max-parameter-count                                           |    -1 |
    | max-header-count                                              |    -1 |
    | max-header-size                                               |    -1 |
    | max-querystring-size                                          |  8192 |
    | threadpool.min                                                |    20 |
    | threadpool.max                                                |    20 |
    | threadpool.max-idle-time                                      | 300000|
    | threadpool.max-queue                                          |    -1 |
    | threadpool.thread-state-notify                                |       |
    +---------------------------------------------------------------+-------+
    =========================================================================
    
    Http Listener[http1] configuration for [server1]
    =======================================================================
    +--------------------------------------------------------+------------+
    |                          Name                          |    Value   |
    +--------------------------------------------------------+------------+
    | name                                                   | http1      |
    | server-listener-ref                                    | http-server|
    | max-keep-alive-request                                 |        100 |
    | server-access-control                                  | false      |
    | allowed-server                                         |            |
    | connection-type                                        |            |
    | output-buffer-size                                     |       8192 |
    | postdata-read-timeout                                  |      30000 |
    | max-post-size                                          | unlimited  |
    | max-parameter-count                                    | unlimited  |
    | max-header-count                                       | unlimited  |
    | max-header-size                                        | unlimited  |
    | max-querystring-size                                   |       8192 |
    | threadpool.min                                         |         30 |
    | threadpool.max                                         |         30 |
    | threadpool.max-idle-time                               |     300000 |
    | threadpool.max-queue                                   | unlimited  |
    | threadpool.thread-state-notify                         |            |
    +--------------------------------------------------------+------------+
    =======================================================================
    
    TCP Listener[tcp1] configuration for [server1]
    ================================================================================
    +-------------------------------------------+----------------------------------+
    |                    Name                   |               Value              |
    +-------------------------------------------+----------------------------------+
    | name                                      | tcp1                             |
    | server-listener-ref                       | tcp                              |
    | dispatcher-config-class                   | tcp.DispatcherConfigImpl         |
    | server-access-control                     | false                            |
    | allowed-server                            |                                  |
    | connection-type                           |                                  |
    | output-buffer-size                        |                             8192 |
    | postdata-read-timeout                     |                            30000 |
    | max-post-size                             |                      unlimited   |
    | max-parameter-count                       |                      unlimited   |
    | max-header-count                          |                      unlimited   |
    | max-header-size                           |                      unlimited   |
    | max-querystring-size                      |                             8192 |
    | threadpool.min                            |                               10 |
    | threadpool.max                            |                               25 |
    | threadpool.max-idle-time                  |                           300000 |
    | threadpool.max-queue                      |                      unlimited   |
    | threadpool.thread-state-notify            |                                  |
    +-------------------------------------------+----------------------------------+
    ================================================================================
    
    [DAS]domain1.adminServer>remove-web-listener -server server1 http1
    Successfully changed only the XML.
    Restart the server to apply the changes.
    For detailed web connection information, use the 'show-web-engine-configuration -cn' command.
    
    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -cn
    Http Listener[ADMIN-HTTP] configuration for [server1]
    ================================================================================
    +-----------------------------------------------------------------+------------+
    |                               Name                              |    Value   |
    +-----------------------------------------------------------------+------------+
    | name                                                            | ADMIN-HTTP |
    | server-listener-ref                                             | base       |
    | max-keep-alive-request                                          |        100 |
    | server-access-control                                           | false      |
    | allowed-server                                                  |            |
    | connection-type                                                 |            |
    | output-buffer-size                                              |       8192 |
    | postdata-read-timeout                                           |      30000 |
    | max-post-size                                                   | unlimited  |
    | max-parameter-count                                             | unlimited  |
    | max-header-count                                                | unlimited  |
    | max-header-size                                                 | unlimited  |
    | max-querystring-size                                            |       8192 |
    | threadpool.min                                                  |          1 |
    | threadpool.max                                                  |         32 |
    | threadpool.max-idle-time                                        |     300000 |
    | threadpool.max-queue                                            | unlimited  |
    | threadpool.thread-state-notify                                  |            |
    +-----------------------------------------------------------------+------------+
    ================================================================================
    
    Ajp13 Listener[ajp1] configuration for [server1]
    =========================================================================
    +---------------------------------------------------------------+-------+
    |                              Name                             | Value |
    +---------------------------------------------------------------+-------+
    | name                                                          | ajp1  |
    | server-listener-ref                                           | ajp   |
    | read-timeout                                                  |     0 |
    | server-access-control                                         | false |
    | allowed-server                                                |       |
    | output-buffer-size                                            |  8192 |
    | postdata-read-timeout                                         | 30000 |
    | max-post-size                                                 |    -1 |
    | max-parameter-count                                           |    -1 |
    | max-header-count                                              |    -1 |
    | max-header-size                                               |    -1 |
    | max-querystring-size                                          |  8192 |
    | threadpool.min                                                |    20 |
    | threadpool.max                                                |    20 |
    | threadpool.max-idle-time                                      | 300000|
    | threadpool.max-queue                                          |    -1 |
    | threadpool.thread-state-notify                                |       |
    +---------------------------------------------------------------+-------+
    =========================================================================
    
    TCP Listener[tcp1] configuration for [server1]
    ================================================================================
    +-------------------------------------------+----------------------------------+
    |                    Name                   |               Value              |
    +-------------------------------------------+----------------------------------+
    | name                                      | tcp1                             |
    | server-listener-ref                       | tcp                              |
    | dispatcher-config-class                   | tcp.DispatcherConfigImpl         |
    | server-access-control                     | false                            |
    | allowed-server                            |                                  |
    | connection-type                           |                                  |
    | output-buffer-size                        |                             8192 |
    | postdata-read-timeout                     |                            30000 |
    | max-post-size                             |                      unlimited   |
    | max-parameter-count                       |                      unlimited   |
    | max-header-count                          |                      unlimited   |
    | max-header-size                           |                      unlimited   |
    | max-querystring-size                      |                             8192 |
    | threadpool.min                            |                               10 |
    | threadpool.max                            |                               25 |
    | threadpool.max-idle-time                  |                           300000 |
    | threadpool.max-queue                      |                      unlimited   |
    | threadpool.thread-state-notify            |                                  |
    +-------------------------------------------+----------------------------------+
    ================================================================================
    
    [DAS]domain1.adminServer>remove-web-listener -server server1  tcp1
    Successfully changed only the XML.
    Restart the server to apply the changes.
    For detailed web connection information, use the 'show-web-engine-configuration -cn' command.
    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -cn
    Http Listener[ADMIN-HTTP] configuration for [server1]
    ================================================================================
    +-----------------------------------------------------------------+------------+
    |                               Name                              |    Value   |
    +-----------------------------------------------------------------+------------+
    | name                                                            | ADMIN-HTTP |
    | server-listener-ref                                             | base       |
    | max-keep-alive-request                                          |        100 |
    | server-access-control                                           | false      |
    | allowed-server                                                  |            |
    | connection-type                                                 |            |
    | output-buffer-size                                              |       8192 |
    | postdata-read-timeout                                           |      30000 |
    | max-post-size                                                   | unlimited  |
    | max-parameter-count                                             | unlimited  |
    | max-header-count                                                | unlimited  |
    | max-header-size                                                 | unlimited  |
    | max-querystring-size                                            |       8192 |
    | threadpool.min                                                  |          1 |
    | threadpool.max                                                  |         32 |
    | threadpool.max-idle-time                                        |     300000 |
    | threadpool.max-queue                                            | unlimited  |
    | threadpool.thread-state-notify                                  |            |
    +-----------------------------------------------------------------+------------+
    ================================================================================
    
    Ajp13 Listener[ajp1] configuration for [server1]
    =========================================================================
    +---------------------------------------------------------------+-------+
    |                              Name                             | Value |
    +---------------------------------------------------------------+-------+
    | name                                                          | ajp1  |
    | server-listener-ref                                           | ajp   |
    | read-timeout                                                  |     0 |
    | server-access-control                                         | false |
    | allowed-server                                                |       |
    | output-buffer-size                                            |  8192 |
    | postdata-read-timeout                                         | 30000 |
    | max-post-size                                                 |    -1 |
    | max-parameter-count                                           |    -1 |
    | max-header-count                                              |    -1 |
    | max-header-size                                               |    -1 |
    | max-querystring-size                                          |  8192 |
    | threadpool.min                                                |    20 |
    | threadpool.max                                                |    20 |
    | threadpool.max-idle-time                                      | 300000|
    | threadpool.max-queue                                          |    -1 |
    | threadpool.thread-state-notify                                |       |
    +---------------------------------------------------------------+-------+
    =========================================================================
    
    [DAS]domain1.adminServer>remove-web-listener -server server1 ADMIN-HTTP
    [DAS]domain1.adminServer>remove-web-listener -server server1 ADMIN-HTTP
    ADMIN-HTTP cannot be removed.

Deletes a WebtoB connector. This command only applies to the domain.xml file. In order to apply changes to the actual service, the server must be restarted.

  • Related Schema

    web-engine.xsd - web-engine/web-connections/webtob-connector

  • Aliases

    rmwebtobcon

  • Usage

    remove-webtob-connector [-cluster <cluster-name> | -server <server-name>]
                            [-f,--forceLock]
                            <web-connection-name>
  • Parameters

    ParameterDescription
    [-f, --forceLock]Forcibly applies the configuration changes.
    <web-connection-name>WebtoB connector name.
  • Example

    [DAS]domain1.adminServer>webcfg -cn -server server1
    Http Listener[ADMIN-HTTP] configuration for [server1]
    ================================================================================
    +-----------------------------------------------------------------+------------+
    |                               Name                              |    Value   |
    +-----------------------------------------------------------------+------------+
    | name                                                            | ADMIN-HTTP |
    | server-listener-ref                                             | base       |
    | max-keep-alive-request                                          |        100 |
    | server-access-control                                           | false      |
    | allowed-server                                                  |            |
    | connection-type                                                 |            |
    | output-buffer-size                                              |       8192 |
    | postdata-read-timeout                                           |      30000 |
    | max-post-size                                                   | unlimited  |
    | max-parameter-count                                             | unlimited  |
    | max-header-count                                                | unlimited  |
    | max-header-size                                                 | unlimited  |
    | max-querystring-size                                            |       8192 |
    | threadpool.min                                                  |          1 |
    | threadpool.max                                                  |         32 |
    | threadpool.max-idle-time                                        |     300000 |
    | threadpool.max-queue                                            | unlimited  |
    | threadpool.thread-state-notify                                  |            |
    +-----------------------------------------------------------------+------------+
    ================================================================================
    
    
    WebtoB Connector[webtob1] configuration for [server1]
    ================================================================================
    +------------------------------------------------------------------+-----------+
    |                               Name                               |   Value   |
    +------------------------------------------------------------------+-----------+
    | name                                                             | webtob1   |
    | port                                                             |      9999 |
    | ip-address                                                       | localhost |
    | hth-count                                                        |         1 |
    | request-prefetch                                                 | false     |
    | registration-id                                                  | MyGroup   |
    | read-timeout                                                     |         0 |
    | reconnect-interval                                               |      5000 |
    | connection-type                                                  |           |
    | output-buffer-size                                               |      8192 |
    | postdata-read-timeout                                            |     30000 |
    | max-post-size                                                    | unlimited |
    | max-parameter-count                                              | unlimited |
    | max-header-count                                                 | unlimited |
    | max-header-size                                                  | unlimited |
    | max-querystring-size                                             |      8192 |
    | threadpool.number                                                |        30 |
    | threadpool.thread-state-notify                                   |           |
    | send-buffer-size                                                 |           |
    | receive-buffer-size                                              |           |
    +------------------------------------------------------------------+-----------+
    ================================================================================
    
    [DAS]domain1.adminServer>remove-webtob-connector -server server1 webtob1
    Successfully changed only the XML.
    Restart the server to apply the changes.
    For detailed web connection information, use the 'show-web-engine-configuration -cn' command.
    
    [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -cn
    Http Listener[ADMIN-HTTP] configuration for [server1]
    ================================================================================
    +-----------------------------------------------------------------+------------+
    |                               Name                              |    Value   |
    +-----------------------------------------------------------------+------------+
    | name                                                            | ADMIN-HTTP |
    | server-listener-ref                                             | base       |
    | max-keep-alive-request                                          |        100 |
    | server-access-control                                           | false      |
    | allowed-server                                                  |            |
    | connection-type                                                 |            |
    | output-buffer-size                                              |       8192 |
    | postdata-read-timeout                                           |      30000 |
    | max-post-size                                                   | unlimited  |
    | max-parameter-count                                             | unlimited  |
    | max-header-count                                                | unlimited  |
    | max-header-size                                                 | unlimited  |
    | max-querystring-size                                            |       8192 |
    | threadpool.min                                                  |          1 |
    | threadpool.max                                                  |         32 |
    | threadpool.max-idle-time                                        |     300000 |
    | threadpool.max-queue                                            | unlimited  |
    | threadpool.thread-state-notify                                  |            |
    +-----------------------------------------------------------------+------------+
    ================================================================================

Resumes a temporarily suspended web component (WebtoB connector, context, or servlet).

  • Related Schema

    web-engine.xsd - web-engine/web-connections

  • Aliases

    webresume

  • Usage

    resume-web-component [-cluster <cluster-name> | -server <server-name>]
                         [-ctx,--context <context>]
                         -svl,--servlet <servlet> ]
  • Parameters

    ParameterDescription
    [-ctx, --context <context>]

    Web context that contains the servlet to be started.

    This parameter must be used in conjunction with the -svl option.

    Set <context> to the module name from the result of executing the command that used the application-information -type option.

    [-svl,--servlet <servlet>]Servlet to be restarted. This parameter can be used only when the context option is set.
  • Example

    • [-svl,--servlet <servlet>] option is used

      [DAS]domain1.adminServer>appinfo -server server1 -id servlets -type war
      There are no EJBs in this module.
      General information about the web module [servlets-examples].
      ================================================================================
      +------------------------+---------------------------+-------------------------+
      |       Module Name      |     Unique Module Name    |       Context Path      |
      +------------------------+---------------------------+-------------------------+
      | servlets-examples      | servlets-examples         | /servlets-examples      |
      +------------------------+---------------------------+-------------------------+
      ================================================================================
      
      Servlets
      ================================================================================
      +---------------+---------------+------+-------+-----+---------+---------------+
      |      Name     |     Class     | State| Count | Attr| RegType |  URLPatterns  |
      |               |               |      |       |ibute|         |               |
      +---------------+---------------+------+-------+-----+---------+---------------+
      | CookieExample | CookieExample | SUSPE|    -1 | SYNC| WEB_XML | /servlet/Cooki|
      |               |               |NDED  |       |     |         |eExample       |
      +---------------+---------------+------+-------+-----+---------+---------------+
      | RequestInfoExa| RequestInfoExa| NOT_L|    -1 | SYNC| WEB_XML | /servlet/Reque|
      |mple           |mple           |OADED |       |     |         |stInfoExample/*|
      |               |               |      |       |     |         |               |
      +---------------+---------------+------+-------+-----+---------+---------------+
      | RequestParamEx| RequestParamEx| NOT_L|    -1 | SYNC| WEB_XML | /servlet/Reque|
      |ample          |ample          |OADED |       |     |         |stParamExample |
      +---------------+---------------+------+-------+-----+---------+---------------+
      | HelloWorldExam| HelloWorldExam| NOT_L|    -1 | SYNC| WEB_XML | /servlet/Hello|
      |ple            |ple            |OADED |       |     |         |WorldExample   |
      +---------------+---------------+------+-------+-----+---------+---------------+
      | RequestHeaderE| RequestHeaderE| NOT_L|    -1 | SYNC| WEB_XML | /servlet/Reque|
      |xample         |xample         |OADED |       |     |         |stHeaderExample|
      |               |               |      |       |     |         |               |
      +---------------+---------------+------+-------+-----+---------+---------------+
      | CompressionFil| compressionFil| NOT_L|    -1 | SYNC| WEB_XML | /CompressionTe|
      |terTestServlet |ters.Compressio|OADED |       |     |         |st             |
      |               |nFilterTestServ|      |       |     |         |               |
      |               |let            |      |       |     |         |               |
      +---------------+---------------+------+-------+-----+---------+---------------+
      | SessionExample| SessionExample| NOT_L|    -1 | SYNC| WEB_XML | /servlet/Sessi|
      |               |               |OADED |       |     |         |onExample      |
      +---------------+---------------+------+-------+-----+---------+---------------+
      ================================================================================
      
      Filters
      ================================================================================
      +---------------+---------------+-----------+---------+-------------+----------+
      |      Name     |     Class     | Attribute | RegType | URLPatterns | Servlets |
      +---------------+---------------+-----------+---------+-------------+----------+
      | Servlet Mapped| filters.Exampl| SYNC      | WEB_XML | N/A         | invoker  |
      |Filter         |eFilter        |           |         |             |          |
      +---------------+---------------+-----------+---------+-------------+----------+
      | Path Mapped   | filters.Exampl| SYNC      | WEB_XML | /servlet/*  | N/A      |
      |Filter         |eFilter        |           |         |             |          |
      +---------------+---------------+-----------+---------+-------------+----------+
      | Compression   | compressionFil| SYNC      | WEB_XML | N/A         | N/A      |
      |Filter         |ters.Compressio|           |         |             |          |
      |               |nFilter        |           |         |             |          |
      +---------------+---------------+-----------+---------+-------------+----------+
      | Set Character | filters.SetCha| SYNC      | WEB_XML | N/A         | N/A      |
      |Encoding       |racterEncodingF|           |         |             |          |
      |               |ilter          |           |         |             |          |
      +---------------+---------------+-----------+---------+-------------+----------+
      | Request Dumper| filters.Reques| SYNC      | WEB_XML | N/A         | N/A      |
      |Filter         |tDumperFilter  |           |         |             |          |
      +---------------+---------------+-----------+---------+-------------+----------+
      ================================================================================
      
      Listeners
      ================================================================================
      +-------------------------------------+------------------------------+---------+
      |                 Name                |             Type             | RegType |
      +-------------------------------------+------------------------------+---------+
      | listeners.ContextListener           | ServletContextListener       | WEB_XML |
      | listeners.SessionListener           | ServletContextListener       | WEB_XML |
      +-------------------------------------+------------------------------+---------+
      ================================================================================
      
      EJBs
      ================================================================================
      +-----------+------+-------------------------+---------------------------------+
      | Bean Name | Type |    Local Export Name    |        Remote Export Name       |
      +-----------+------+-------------------------+---------------------------------+
      (No data available)
      ================================================================================
      [DAS]domain1.adminServer>resume-web-component -server server1 -ctx servlets
      The following options are missing: [-cn The name of the WebtoB connection to resume, -svl The name of the servlet to resume]
      
      [DAS]domain1.adminServer>resume-web-component -server server1 -ctx servlets -svl InvalidExample
      The command resume-web-component was successfully executed.
      Failed server(s)
      ================================================================================
      +---------+----------+----------------+----------------------------------------+
      |  Server |  Context |     Servlet    |                 Action                 |
      +---------+----------+----------------+----------------------------------------+
      | server1 | servlets | InvalidExample | Servlet[InvalidExample] failed to      |
      |         |          |                |resume.                                 |
      +---------+----------+----------------+----------------------------------------+
      ================================================================================
      For detailed application information, use the 'application-info' command.
      
      [DAS]domain1.adminServer>resume-web-component -server server1 -ctx /servlets -svl CookieExample
      The command resume-web-component was successfully executed.
      Failed server(s)
      ================================================================================
      +---------+-----------+---------------+----------------------------------------+
      |  Server |  Context  |    Servlet    |                 Action                 |
      +---------+-----------+---------------+----------------------------------------+
      | server1 | /servlets | CookieExample | Servlet[CookieExample] does not exist. |
      +---------+-----------+---------------+----------------------------------------+
      ================================================================================
      For detailed application information, use the 'application-info' command.
      
      [DAS]domain1.adminServer>resume-web-component -server server1 -ctx servlets -svl CookieExample
      The command resume-web-component was successfully executed.
      Successful server(s)
      ================================================================================
      +---------+----------+--------------------+------------------------------------+
      |  Server |  Context |       Servlet      |               Action               |
      +---------+----------+--------------------+------------------------------------+
      | server1 | servlets | CookieExample      | Suspended -> Running               |
      +---------+----------+--------------------+------------------------------------+
      ================================================================================
      For detailed application information, use the 'application-info' command.

Displays session information.

  • Related Schema

    jeus-session-server.xsd, jeus-session-domain.xsd

  • Aliases

    getsc, ssc

  • Usage

    show-session-configuration [-server <server-name>]
                               [-cluster <cluster-name>]
                               [-hsc,--http-session-config]
                               [-sl,--server-list]
  • Parameters

    ParameterDescription
    [-hsc,--http-session-config]http-session-config specified in the domain.
    [-sl,--server-list]Current clustering configurations and a list of single servers.
  • Example

    • [-server <server-name>] option is used

      [DAS]domain1.adminServer>show-session-configuration -server server1
      Session-config configuration for server [server1]
      ================================================================================
      +----------------------------------------------------+------------+------------+
      |                        name                        |   default  |    value   |
      +----------------------------------------------------+------------+------------+
      | (to) timeout                                       | 30 min     | 40 min     |
      | (sh) shared                                        | false      | true       |
      | (rp) reload-persistent                             | false      | false      |
      | tracking-mode                                      |            |            |
      |    - (tmc) tracking-mode.cookie                    | true       | true       |
      |    - (tmu) tracking-mode.url                       | false      | false      |
      |    - (tms) tracking-mode.ssl                       | false      | false      |
      | session-cookie                                     |            |            |
      |    - (scn) session-cookie.cookie-name              | JSESSIONID | JSESSIONID |
      |    - (scv) session-cookie.version                  | 0 (0 or 1) |          0 |
      |    - (scd) session-cookie.domain                   |            |            |
      |    - (scp) session-cookie.path                     |            |            |
      |    - (scm) session-cookie.max-age                  |         -1 |         -1 |
      |    - (scs) session-cookie.secure                   | false      | true       |
      |    - (sch) session-cookie.http-only                | true       | true       |
      +----------------------------------------------------+------------+------------+
      
      (opt) is used for the modify-session-config command.
      ================================================================================
    • [-cluster <cluster-name>] option is used

      [DAS]domain1.adminServer>show-session-configuration -cluster distribute
      Session-route-config configuration for cluster [distribute]
      ================================================================================
      +----------------------------------------------------+------------+------------+
      |                        name                        |   default  |    value   |
      +----------------------------------------------------+------------+------------+
      | (tn) reserved-thread-num                           |          0 |          1 |
      | (ct) connection-timeout                            | 5000 msec  | 300 msec   |
      | (rt) read-timeout                                  | 20000 msec | 20000 msec |
      | (bl) backup-level                                  | set        | get        |
      | (fd) failover-delay                                | 600 sec    | 1000 sec   |
      | (rd) restart-delay                                 | 600 sec    | 2000 sec   |
      | file-db                                            |            |            |
      |    - (dpa) file-db.path                            |            |            |
      |    - (dmh) file-db.min-hole                        |        100 |        200 |
      |    - (dpt) file-db.passivation-timeout             | -1 msec    | -1 msec    |
      |    - (dpr) file-db.packing-rate                    |        0.5 |        0.5 |
      +----------------------------------------------------+------------+------------+
      
      The default file-db path(unset): $(SERVER_HOME)/.workspace/session/distributed/
      (opt) is used for the modify-session-config command.
      ================================================================================
    • [-sl,--server-list] option is used

      [DAS]domain1.admin-server>show-session-configuration --server-list
      Server-list info
      ================================================================================
      +------------------------------------------------------------------------------+
      |                                    RESULT                                    |
      +------------------------------------------------------------------------------+
      | clustered servers [distribute]                                               |
      |    - server1                                                                 |
      |    - server2                                                                 |
      |    - server3                                                                 |
      |    - server4                                                                 |
      | single servers                                                               |
      |    - adminServer                                                             |
      +------------------------------------------------------------------------------+
      ================================================================================

Displays web engine configurations. For more information about the items and fields displayed when executing this command, refer to the web engine structure reference in the domain.xml file.

An item not set in the domain.xml file is not displayed. In other words, if a value is displayed, the configuration is set or is assigned a default value.

  • Related Schema

    web-engine.xsd - web-gine

  • Aliases

    webcfg, webconf, showwebcfg, showwebconf

  • Usage

    show-web-engine-configuration [-cluster <cluster-name> | -server <server-name>] 
                                  [-vh,--virtual host]
                                  [-cn,--web-connections]
                                  [-al,--access-log]
                                  [-sc,--session-config]
                                  [-rh,--response-header]
                                  [-mo,--monitoring]
                                  [-enc,--encoding]
                                  [-cp,--cookie-policy]
                                  [-jsp,--jsp-engine]
                                  [-pr,--properties]
                                  [-erp,--error-page]
                                  [-att,--async-timeout_thread]
                                  [-ast,--attach-stacktrace]
  • Parameters

    ParameterDescription
    [-vh,--virtual host]Displays the virtual host configuration information.
    [-cn,--web-connections]Displays the web connection configuration information.
    [-al,--access-log]Displays the access log configuration information.
    [-sc,--session-config]Displays the web engine session configuration information.
    [-rh,--response-header]Displays the response header configuration information.
    [-mo,--monitoring]Displays the web engine monitoring configuration information.
    [-enc,--encoding]Displays the web engine encoding configuration information.
    [-cp,--cookie-policy]Displays the cookie policy configuration information.
    [-jsp,--jsp-engine]Displays the JSP engine configuration information.
    [-pr,--properties]Displays the web engine property configuration information.
    [-erp,--error-page]Displays the default error page configuration of the web engine.
    [-att,--async-timeout_thread]Displays the timeout thread configuration information of an asynchronous servlet.
    [-ast,--attach-stacktrace]Displays the configuration that determines whether to add the stack trace when an error occurs.
  • Example

    • Display all web engine configurations.

      [DAS]domain1.adminServer>show-web-engine-configuration -server server1 
      Encoding configuration for [server1]
      ================================================================================
      +-----------------------------------------------------------------+------------+
      |                               Name                              |    Value   |
      +-----------------------------------------------------------------+------------+
      | encoding.request-url-encoding.default                           | UTF-8      |
      | encoding.request-encoding.default                               | UTF-8      |
      | encoding.response-encoding.default                              | ISO-8859-1 |
      +-----------------------------------------------------------------+------------+
      ================================================================================
      [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -enc
      Encoding configuration for [server1]
      ================================================================================
      +-----------------------------------------------------------------+------------+
      |                               Name                              |    Value   |
      +-----------------------------------------------------------------+------------+
      | encoding.request-url-encoding.default                           | UTF-8      |
      | encoding.request-encoding.default                               | UTF-8      |
      | encoding.response-encoding.default                              | ISO-8859-1 |
      +-----------------------------------------------------------------+------------+
      ================================================================================
      [DAS]domain1.adminServer>show-web-engine-configuration -server server1
      Basic configuration for [server1]
      ================================================================================
      +----------------------------------------------------------------------+-------+
      |                                 Name                                 | Value |
      +----------------------------------------------------------------------+-------+
      | default-error-page                                                   |       |
      | attach-stacktrace-on-error                                           | false |
      | async-timeout-min-threads                                            |    10 |
      +----------------------------------------------------------------------+-------+
      ================================================================================
      
      Monitoring configuration for [server1]
      ==================================================================
      +-------------------------------------------------------+--------+
      |                          Name                         |  Value |
      +-------------------------------------------------------+--------+
      | check-thread-pool                                     | 300000 |
      | check-class-reload                                    | 300000 |
      | check-session                                         | 300000 |
      +-------------------------------------------------------+--------+
      ==================================================================
      
      Encoding configuration for [server1]
      ================================================================================
      +-----------------------------------------------------------------+------------+
      |                               Name                              |    Value   |
      +-----------------------------------------------------------------+------------+
      | encoding.request-url-encoding.default                           | UTF-8      |
      | encoding.request-encoding.default                               | UTF-8      |
      | encoding.response-encoding.default                              | ISO-8859-1 |
      +-----------------------------------------------------------------+------------+
      ================================================================================
      
      Cookie Policy configuration for [server1]
      ================================================================================
      +------------------------------------------------------------------------------+
      |                                    Result                                    |
      +------------------------------------------------------------------------------+
      | The Cookie Policy configuration does not exist.                              |
      +------------------------------------------------------------------------------+
      ================================================================================
      
      JSP engine configuration for [server1]
      ================================================================================
      +----------------------------------------------------------------------+-------+
      |                                 Name                                 | Value |
      +----------------------------------------------------------------------+-------+
      | jsp-work-dir                                                         |       |
      | java-compiler                                                        | javac |
      | compile-output-dir                                                   |       |
      | compile-option                                                       |       |
      | compile-encoding                                                     |       |
      | check-included-jspfile                                               | true  |
      | keep-generated                                                       | false |
      | graceful-jsp-reloading                                               | false |
      | graceful-jsp-reloading-period                                        | 45000 |
      | use-in-memory-compilation                                            | false |
      +----------------------------------------------------------------------+-------+
      ================================================================================
      
      Response Custom Header configuration for [server1]
      ================================================================================
      +------------------------------------------------------------------------------+
      |                                    Result                                    |
      +------------------------------------------------------------------------------+
      | The Response Custom Header configuration does not exist.                     |
      +------------------------------------------------------------------------------+
      ================================================================================
      
      Virtual host[host2] configuration for [server1]
      ================================================================================
      +-------------------------------------+----------------------------------------+
      |                 Name                |                  Value                 |
      +-------------------------------------+----------------------------------------+
      | virtual-host-name                   | host2                                  |
      +-------------------------------------+----------------------------------------+
      | host-name                           | www.foo.com                            |
      |                                     | 192.168.1.2                            |
      +-------------------------------------+----------------------------------------+
      | access-log.enable                   | true                                   |
      +-------------------------------------+----------------------------------------+
      | access-log.format                   | common %I                              |
      +-------------------------------------+----------------------------------------+
      | access-log.exclude-ext              |                                        |
      +-------------------------------------+----------------------------------------+
      | access-log.use-parent-handlerst     | true                                   |
      +-------------------------------------+----------------------------------------+
      | access-log.formatter-class          | jeus.util.logging.SimpleFormatter      |
      +-------------------------------------+----------------------------------------+
      | properties                          |                                        |
      +-------------------------------------+----------------------------------------+
      ================================================================================
      
      Virtual host[host1] configuration for [server1]
      ================================================================================
      +-------------------------------------+----------------------------------------+
      |                 Name                |                  Value                 |
      +-------------------------------------+----------------------------------------+
      | virtual-host-name                   | host1                                  |
      +-------------------------------------+----------------------------------------+
      | host-name                           | tmax.co.kr                             |
      |                                     | tmax.com                               |
      +-------------------------------------+----------------------------------------+
      | access-log.enable                   | true                                   |
      +-------------------------------------+----------------------------------------+
      | access-log.format                   | common %l                              |
      +-------------------------------------+----------------------------------------+
      | access-log.exclude-ext              |                                        |
      +-------------------------------------+----------------------------------------+
      | access-log.use-parent-handlerst     | true                                   |
      +-------------------------------------+----------------------------------------+
      | access-log.formatter-class          | jeus.util.logging.SimpleFormatter      |
      +-------------------------------------+----------------------------------------+
      | properties                          |                                        |
      +-------------------------------------+----------------------------------------+
      ================================================================================
      
      WebtoB connector[webtob1] configuration for [server1]
      ================================================================================
      +------------------------------------------------------------------+-----------+
      |                               Name                               |   Value   |
      +------------------------------------------------------------------+-----------+
      | name                                                             | webtob1   |
      | port                                                             |      9999 |
      | ip-address                                                       | localhost |
      | hth-count                                                        |         1 |
      | request-prefetch                                                 | false     |
      | registration-id                                                  | MyGroup   |
      | read-timeout                                                     |         0 |
      | reconnect-interval                                               |      5000 |
      | connection-type                                                  |           |
      | output-buffer-size                                               |      8192 |
      | postdata-read-timeout                                            |     30000 |
      | max-post-size                                                    | unlimited |
      | max-parameter-count                                              | unlimited |
      | max-header-count                                                 | unlimited |
      | max-header-size                                                  | unlimited |
      | max-querystring-size                                             |      8192 |
      | threadpool.number                                                |        10 |
      | threadpool.thread-state-notify                                   |           |
      +------------------------------------------------------------------+-----------+
      ================================================================================
      
      Ajp13 listener[ajp] configuration for [server1]
      ================================================================================
      +------------------------------------------------------------------+-----------+
      |                               Name                               |   Value   |
      +------------------------------------------------------------------+-----------+
      | name                                                             | ajp       |
      | server-listener-ref                                              | ajp       |
      | read-timeout                                                     |         0 |
      | server-access-control                                            | false     |
      | allowed-server                                                   |           |
      | output-buffer-size                                               |      8192 |
      | postdata-read-timeout                                            |     30000 |
      | max-post-size                                                    | unlimited |
      | max-parameter-count                                              | unlimited |
      | max-header-count                                                 | unlimited |
      | max-header-size                                                  | unlimited |
      | max-querystring-size                                             |      8192 |
      | threadpool.min                                                   |        10 |
      | threadpool.max                                                   |        20 |
      | threadpool.max-idle-time                                         |    300000 |
      | threadpool.max-queue                                             | unlimited |
      | threadpool.thread-state-notify                                   |           |
      +------------------------------------------------------------------+-----------+
      ================================================================================
      
      Http listener[ADMIN-HTTP] configuration for [server1]
      ================================================================================
      +-----------------------------------------------------------------+------------+
      |                               Name                              |    Value   |
      +-----------------------------------------------------------------+------------+
      | name                                                            | ADMIN-HTTP |
      | server-listener-ref                                             | base       |
      | max-keep-alive-request                                          |            |
      | server-access-control                                           | false      |
      | allowed-server                                                  |            |
      | connection-type                                                 |            |
      | output-buffer-size                                              |       8192 |
      | postdata-read-timeout                                           |      30000 |
      | max-post-size                                                   | unlimited  |
      | max-parameter-count                                             | unlimited  |
      | max-header-count                                                | unlimited  |
      | max-header-size                                                 | unlimited  |
      | max-querystring-size                                            |       8192 |
      | threadpool.min                                                  |          1 |
      | threadpool.max                                                  |         32 |
      | threadpool.max-idle-time                                        |     300000 |
      | threadpool.max-queue                                            | unlimited  |
      | threadpool.thread-state-notify                                  |            |
      +-----------------------------------------------------------------+------------+
      ================================================================================
      
      Access-log configuration for [server1]
      ================================================================================
      +----------------------+-------------------------------------------------------+
      |         Name         |                         Value                         |
      +----------------------+-------------------------------------------------------+
      | enable               | true                                                  |
      | format               | common %I                                             |
      | use-parent-handlerst | false                                                 |
      | formatter-class      | jeus.util.logging.SimpleFormatter                     |
      +----------------------+-------------------------------------------------------+
      ================================================================================
      
      Session-config configuration for [server1]
      ====================================================================
      +-----------------------------------------------------+------------+
      |                         Name                        |    Value   |
      +-----------------------------------------------------+------------+
      | timeout                                             |         40 |
      | shared                                              | true       |
      | reload-persistent                                   | false      |
      | tracking-mode.cookie                                | true       |
      | tracking-mode.url                                   | false      |
      | tracking-mode.ssl                                   | false      |
      | session-cookie.cookie-name                          | JSESSIONID |
      | session-cookie.version                              |          0 |
      | session-cookie.domain                               |            |
      | session-cookie.path                                 |            |
      | session-cookie.max-age                              |         -1 |
      | session-cookie.secure                               | true       |
      | session-cookie.http-only                            | true       |
      | session-cookie.comment                              |            |
      +-----------------------------------------------------+------------+
      ====================================================================
      
      Properties configuration for [server1]
      ================================================================================
      +--------------------------------+---------------------------------------------+
      |              Name              |                     Value                   |
      +--------------------------------+---------------------------------------------+
      | key1                           | value1                                      |
      | key2                           | value2                                      |
      | keyn                           | valuen                                      |
      +--------------------------------+---------------------------------------------+
      ================================================================================
    • Display web engine configurations by options.

      [DAS]domain1.adminServer>show-web-engine-configuration -erp -att -server server1 
      Basic configuration for [server1]
      ================================================================================
      +----------------------------------------------------------------------+-------+
      |                                 Name                                 | Value |
      +----------------------------------------------------------------------+-------+
      | default-error-page                                                   |       |
      | attach-stacktrace-on-error                                           | false |
      | async-timeout-min-threads                                            |    10 |
      +----------------------------------------------------------------------+-------+
      ================================================================================
      
      [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -sc
      Session-config configuration for [server1]
      ====================================================================
      +-----------------------------------------------------+------------+
      |                         Name                        |    Value   |
      +-----------------------------------------------------+------------+
      | timeout                                             |         40 |
      | shared                                              | true       |
      | reload-persistent                                   | false      |
      | tracking-mode.cookie                                | true       |
      | tracking-mode.url                                   | false      |
      | tracking-mode.ssl                                   | false      |
      | session-cookie.cookie-name                          | JSESSIONID |
      | session-cookie.version                              |          0 |
      | session-cookie.domain                               |            |
      | session-cookie.path                                 |            |
      | session-cookie.max-age                              |         -1 |
      | session-cookie.secure                               | true       |
      | session-cookie.http-only                            | true       |
      | session-cookie.comment                              |            |
      +-----------------------------------------------------+------------+
      ====================================================================
      
      [DAS]domain1.adminServer>show-web-engine-configuration -server server1 -cn
      Webtob Connector[webtob1] configuration for [server1]
      ================================================================================
      +--------------------------------------------------------------+---------------+
      |                             Name                             |      Value    |
      +--------------------------------------------------------------+---------------+
      | name                                                         | webtob1       |
      | webtob-home                                                  |               |
      | webtob-ipcbaseport                                           |          6666 |
      | hth-count                                                    |             1 |
      | request-prefetch                                             | false         |
      | registration-id                                              | MyGroup       |
      | read-timeout                                                 |             0 |
      | reconnect-interval                                           |          5000 |
      | reconnect-count                                              |            -1 |
      | connection-type                                              |               |
      | output-buffer-size                                           |          8192 |
      | postdata-read-timeout                                        |         30000 |
      | max-post-size                                                |   unlimited   |
      | max-parameter-count                                          |   unlimited   |
      | max-header-count                                             |             2 |
      | max-header-size                                              |            30 |
      | max-querystring-size                                         |          8192 |
      | threadpool.number                                            |            10 |
      | threadpool.thread-state-notify                               |               |
      | send-buffer-size                                             |               |
      | receive-buffer-size                                          |               |
      +--------------------------------------------------------------+---------------+
      ================================================================================
      
      Ajp13 Listener[apache-service] configuration for [server1]
      ================================================================================
      +----------------------------------------------------+-------------------------+
      |                        Name                        |           Value         |
      +----------------------------------------------------+-------------------------+
      | name                                               | apache-service          |
      | server-listener-ref                                | ajp                     |
      | read-timeout                                       |                       0 |
      | server-access-control                              | false                   |
      | allowed-server                                     |                         |
      | output-buffer-size                                 |                    8192 |
      | postdata-read-timeout                              |                   30000 |
      | max-post-size                                      |             unlimited   |
      | max-parameter-count                                |             unlimited   |
      | max-header-count                                   |             unlimited   |
      | max-header-size                                    |             unlimited   |
      | max-querystring-size                               |                    8192 |
      | threadpool.min                                     |                      30 |
      | threadpool.max                                     |                      30 |
      | threadpool.max-idle-time                           |                  300000 |
      | threadpool.max-queue                               |             unlimited   |
      | threadpool.thread-state-notify                     |                         |
      +----------------------------------------------------+-------------------------+
      ================================================================================
      
      Http Listener[http1] configuration for [server1]
      ================================================================================
      +--------------------------------------------------------+---------------------+
      |                          Name                          |         Value       |
      +--------------------------------------------------------+---------------------+
      | name                                                   | http1               |
      | server-listener-ref                                    | http-server         |
      | max-keep-alive-request                                 |                 100 |
      | server-access-control                                  | false               |
      | allowed-server                                         |                     |
      | connection-type                                        |                     |
      | output-buffer-size                                     |                8192 |
      | postdata-read-timeout                                  |               30000 |
      | max-post-size                                          |                2096 |
      | max-parameter-count                                    |         unlimited   |
      | max-header-count                                       |         unlimited   |
      | max-header-size                                        |         unlimited   |
      | max-querystring-size                                   |                8192 |
      | threadpool.min                                         |                  10 |
      | threadpool.max                                         |                  20 |
      | threadpool.max-idle-time                               |              300000 |
      | threadpool.max-queue                                   |         unlimited   |
      | threadpool.thread-state-notify                         |                     |
      +--------------------------------------------------------+---------------------+
      ================================================================================

Displays the JVM memory information of the web engine, the thread pool states of each listener/connector of the web engine, and the request count and the process time of the context.

  • Related Schema

    web-engine.xsd

  • Aliases

    webstats, stat, st

  • Usage

    show-web-statistics [-server <server-name>]
                        [-ctx,--context <context-name>]
                        [-t,--thread | -s,--session | -r,--request |-m,--memory]
  • Parameters

    ParameterDescription
    [-t,--thread]Displays the thread pool states of each web engine listener. The information displayed includes the number of allocated worker threads, the number of clients in the wait queue, and the maximum number of threads in the thread pool.
    [-s,--session]

    Displays the connection information of the session servers in the web engine.

    The information displayed includes the name of the currently connected session server, the total number of sessions, and the number of session servers and connections used in the pool.

    [-r,--request]Displays the accumulated number of processed requests and the average process time for each context.
    [-m,--memory]Displays the state of the memory used by the current JVM in the web engine.
  • Example

    [DAS]domain1.adminServer>show-web-statistics -server server1
    Distributed session information: (server1_servlet)
    ================================================================================
    +-------------+--------------+----------------------+------------+-------------+
    | Manager name|Active session|  Passivated session  |File-db size|Backup server|
    +-------------+--------------+----------------------+------------+-------------+
    | _sessionInfo|            0 |                    0 |          0 |             |
    |     - backup|            0 |                    0 |          0 | NULL        |
    +-------------+--------------+----------------------+------------+-------------+
    ================================================================================
    
    Thread information : (server1_servlet)
    ================================================================================
    +-------------+-------------------+-------------+-------------+----------------+
    | Thread pool |   Current thread  |  Min thread |  Max thread |  Current queue |
    |    name     |       count       |    count    |    count    |     count      |
    +-------------+-------------------+-------------+-------------+----------------+
    | webtob1-hth0| 250               | 250         | 250         | 0              |
    +-------------+-------------------+-------------+-------------+----------------+
    | ADMIN-HTTP  | 1                 | 1           | 32          | 0              |
    +-------------+-------------------+-------------+-------------+----------------+
    | http1       | 10                | 10          | 20          | 0              |
    +-------------+-------------------+-------------+-------------+----------------+
    ================================================================================
    
    Request information of contexts
    ================================================================================
    +--------+---------+------------+--------------------+---------------+---------+
    | Context|  Total  | Successful |     Successful     |    Average    |  Async  |
    |  name  |requests |  requests  |  processing time   |processing time|requests |
    +--------+---------+------------+--------------------+---------------+---------+
    | session| 0       | 0          | 0 ms               | 0.0 ms        | 0       |
    |Info    |         |            |                    |               |         |
    +--------+---------+------------+--------------------+---------------+---------+
    ================================================================================
    
    Memory information : (server1_servlet)
    ==========================================================
    +---------------------------------------+----------------+
    |            VM total memory            | VM free memory |
    +---------------------------------------+----------------+
    | 87752704 bytes                        | 40639544 bytes |
    +---------------------------------------+----------------+
    ==========================================================
    
    [DAS]domain1.adminServer>show-web-statistics -server server1 -r
    Request information of contexts
    ================================================================================
    +--------+---------+------------+--------------------+---------------+---------+
    | Context|  Total  | Successful |     Successful     |    Average    |  Async  |
    |  name  |requests |  requests  |  processing time   |processing time|requests |
    +--------+---------+------------+--------------------+---------------+---------+
    | session| 0       | 0          | 0 ms               | 0.0 ms        | 0       |
    |Info    |         |            |                    |               |         |
    +--------+---------+------------+--------------------+---------------+---------+
    ================================================================================
    
    [DAS]domain1.adminServer>show-web-statistics -server server1 -t
    Thread information : <server1_servlet>
    ================================================================================
    +-------------+-------------------+-------------+-------------+----------------+
    | Thread pool |   Current thread  |  Min thread |  Max thread |  Current queue |
    |    name     |       count       |    count    |    count    |     count      |
    +-------------+-------------------+-------------+-------------+----------------+
    | webtob1-hth0| 250               | 250         | 250         | 0              |
    +-------------+-------------------+-------------+-------------+----------------+
    | ADMIN-HTTP  | 1                 | 1           | 32          | 0              |
    +-------------+-------------------+-------------+-------------+----------------+
    | http1       | 10                | 10          | 20          | 0              |
    +-------------+-------------------+-------------+-------------+----------------+
    ================================================================================
    
    [DAS]domain1.adminServer>show-web-statistics -server server1 -m
    Memory information : <server1_servlet>
    ==========================================================
    +---------------------------------------+----------------+
    |            VM total memory            | VM free memory |
    +---------------------------------------+----------------+
    | 87359488 bytes                        | 39660200 bytes |
    +---------------------------------------+----------------+
    ==========================================================
    
    ## Execution result in the clustered situation
    [DAS]domain1.adminServer>show-web-statistics -server server1 -s
    Distributed session information : (server1_servlet)
    ================================================================================
    +--------------+--------------+-------------------+-------------+--------------+
    | Manager name |Active session| Passivate session | File-db size| Backup server|
    +--------------+--------------+-------------------+-------------+--------------+
    | _sessionInfo |            0 |                 0 |           0 |              |
    |      - backup|            0 |                 0 |           0 | NULL         |
    +--------------+--------------+-------------------+-------------+--------------+
    ================================================================================
    
    ## Execution result in the default configuration
    [DAS]domain1.adminServer>show-web-statistics -server server1 -s
    Standard session information : (server1_servlet)
    ==========================================================
    +--------------+-----------------------------------------+
    | Manager name |              Active session             |
    +--------------+-----------------------------------------+
    | _sessionInfo | 0                                       |
    +--------------+-----------------------------------------+
    ==========================================================

Suspends the specified context or servlet.

  • Related Schema

    web-engine.xsd - web-engine/web-connections

  • Aliases

    websuspend

  • Usage

    suspend-web-component [-cluster <cluster-name> | -server <server-name>]
                          [-ctx,--context <context>]
                          -svl,--servlet <servlet>] 
  • Parameters

    ParameterDescription
    [-ctx, --context <context>]

    Web context that contains the servlet to be suspended.

    This parameter must be used in conjunction with the -svl option.

    Set <context> to the module name from the result of executing the command that used the application-information -type option.

    [-svl,--servlet <servlet>]Servlet to be suspended. This parameter can be used only when the context option is set.
  • Example

    • [-svl,--servlet <servlet>] option is used

      [DAS]domain1.adminServer>appinfo -id servlets -type war
      The type and id options can be specified together only if option server is also specified.
      [DAS]domain1.adminServer>appinfo -id servlets -type war -server server1
      There are no EJBs in this module.
      General information about the web module [servlets-examples].
      ================================================================================
      +------------------------+---------------------------+-------------------------+
      |       Module Name      |     Unique Module Name    |       Context Path      |
      +------------------------+---------------------------+-------------------------+
      | servlets-examples      | servlets-examples         | /servlets-examples      |
      +------------------------+---------------------------+-------------------------+
      ================================================================================
      
      Servlets
      ================================================================================
      +---------------+---------------+------+-------+-----+---------+---------------+
      |      Name     |     Class     | State| Count | Attr| RegType |  URLPatterns  |
      |               |               |      |       |ibute|         |               |
      +---------------+---------------+------+-------+-----+---------+---------------+
      | CookieExample | CookieExample | NOT_L|    -1 | SYNC| WEB_XML | /servlet/Cooki|
      |               |               |OADED |       |     |         |eExample       |
      +---------------+---------------+------+-------+-----+---------+---------------+
      | RequestInfoExa| RequestInfoExa| NOT_L|    -1 | SYNC| WEB_XML | /servlet/Reque|
      |mple           |mple           |OADED |       |     |         |stInfoExample/*|
      |               |               |      |       |     |         |               |
      +---------------+---------------+------+-------+-----+---------+---------------+
      | RequestParamEx| RequestParamEx| NOT_L|    -1 | SYNC| WEB_XML | /servlet/Reque|
      |ample          |ample          |OADED |       |     |         |stParamExample |
      +---------------+---------------+------+-------+-----+---------+---------------+
      | HelloWorldExam| HelloWorldExam| NOT_L|    -1 | SYNC| WEB_XML | /servlet/Hello|
      |ple            |ple            |OADED |       |     |         |WorldExample   |
      +---------------+---------------+------+-------+-----+---------+---------------+
      | RequestHeaderE| RequestHeaderE| NOT_L|    -1 | SYNC| WEB_XML | /servlet/Reque|
      |xample         |xample         |OADED |       |     |         |stHeaderExample|
      |               |               |      |       |     |         |               |
      +---------------+---------------+------+-------+-----+---------+---------------+
      | CompressionFil| compressionFil| NOT_L|    -1 | SYNC| WEB_XML | /CompressionTe|
      |terTestServlet |ters.Compressio|OADED |       |     |         |st             |
      |               |nFilterTestServ|      |       |     |         |               |
      |               |let            |      |       |     |         |               |
      +---------------+---------------+------+-------+-----+---------+---------------+
      | SessionExample| SessionExample| NOT_L|    -1 | SYNC| WEB_XML | /servlet/Sessi|
      |               |               |OADED |       |     |         |onExample      |
      +---------------+---------------+------+-------+-----+---------+---------------+
      ================================================================================
      
      Filters
      ================================================================================
      +---------------+---------------+-----------+---------+-------------+----------+
      |      Name     |     Class     | Attribute | RegType | URLPatterns | Servlets |
      +---------------+---------------+-----------+---------+-------------+----------+
      | Servlet Mapped| filters.Exampl| SYNC      | WEB_XML | N/A         | invoker  |
      |Filter         |eFilter        |           |         |             |          |
      +---------------+---------------+-----------+---------+-------------+----------+
      | Path Mapped   | filters.Exampl| SYNC      | WEB_XML | /servlet/*  | N/A      |
      |Filter         |eFilter        |           |         |             |          |
      +---------------+---------------+-----------+---------+-------------+----------+
      | Compression   | compressionFil| SYNC      | WEB_XML | N/A         | N/A      |
      |Filter         |ters.Compressio|           |         |             |          |
      |               |nFilter        |           |         |             |          |
      +---------------+---------------+-----------+---------+-------------+----------+
      | Set Character | filters.SetCha| SYNC      | WEB_XML | N/A         | N/A      |
      |Encoding       |racterEncodingF|           |         |             |          |
      |               |ilter          |           |         |             |          |
      +---------------+---------------+-----------+---------+-------------+----------+
      | Request Dumper| filters.Reques| SYNC      | WEB_XML | N/A         | N/A      |
      |Filter         |tDumperFilter  |           |         |             |          |
      +---------------+---------------+-----------+---------+-------------+----------+
      ================================================================================
      
      Listeners
      ================================================================================
      +-------------------------------------+------------------------------+---------+
      |                 Name                |             Type             | RegType |
      +-------------------------------------+------------------------------+---------+
      | listeners.ContextListener           | ServletContextListener       | WEB_XML |
      | listeners.SessionListener           | ServletContextListener       | WEB_XML |
      +-------------------------------------+------------------------------+---------+
      ================================================================================
      
      EJBs
      ================================================================================
      +-----------+------+-------------------------+---------------------------------+
      | Bean Name | Type |    Local Export Name    |        Remote Export Name       |
      +-----------+------+-------------------------+---------------------------------+
      (No data available)
      ================================================================================
      [DAS]domain1.adminServer>suspend-web-component
      The following options are missing: [-cn The name of the WebtoB connection to suspend, -svl The name of the servlet to suspend]
      [DAS]domain1.adminServer>suspend-web-component -svl CookieExample
      Use the -server or -cluster option.
      [DAS]domain1.adminServer>suspend-web-component -svl CookieExample -server server1
      The context option must be set with the servlet option.
      [DAS]domain1.adminServer>suspend-web-component -svl CookieExample -server server1 -ctx servlets
      The command suspend-web-component was successfully executed.
      Successful servers
      ================================================================================
      +---------+----------+--------------------+------------------------------------+
      |  Server |  Context |       Servlet      |               Action               |
      +---------+----------+--------------------+------------------------------------+
      | server1 | servlets | CookieExample      | Running -> Suspended               |
      +---------+----------+--------------------+------------------------------------+
      ================================================================================
      For detailed application information, use the 'application-info' command.
      [DAS]domain1.adminServer>

The following is a list of JMS engine commands.

CommandDescription
list-jms-connection-factoriesDisplays a list of all connection factories registered with the JMS engine or the information of a specified connection factory.
add-jms-connection-factoryAdds a new connection factory.
remove-jms-connection-factoryDeletes a specified connection factory.
list-jms-destinationsDisplays a list of all destinations registered with the JMS engine or the information of a specified destination.
add-jms-destinationAdds a new destination to the JMS engine.
remove-jms-destinationDeletes a destination from the JMS engine.
control-jms-destinationControls the service status of a specified destination.
list-jms-clientsDisplays a list of all connected clients.
ban-jms-clientForcibly disconnects a connection with a JMS client.
list-jms-durable-subscriptionsDisplays a list of all durable subscribers registered with the JMS engine or the information of a specified durable subscriber.
list-jms-messagesDisplays destination message information.
view-jms-messageDisplays detailed information of a specified message.
move-jms-messagesMoves messages to a different destination.
delete-jms-messagesDeletes messages from a destination.
export-jms-messagesExports a message from a specified destination in the XML type.
import-jms-messagesImports an XML type message exported to a specified destination.
list-jms-pending-transactionsDisplays a list of pending transactions.
commit-jms-pending-transactionForcibly commits a pending transaction.

Displays a list of all connection factories registered with the JMS engine or the information of a specified connection factory.

  • Aliases

    jmscf, jmsconf

  • Usage

    list-jms-connection-factoryies -server <server-name>
                                   [-n, --name <factory-name>]
  • Parameters

    ParameterDescription
    -server <server-name>Server name to which the connection factory belongs.
    [-n, --name <factory-name>]Connection factory name. If not specified, brief descriptions of all connection factories are displayed.
  • Example

    [DAS]domain1.adminServer>list-jms-connection-factories -server adminServer
    Connection Factory Information
    ================================================================================
    +-------------------------------------+--------------------------------+-------+
    |             Factory Name            |           Export Name          |  Type |
    +-------------------------------------+--------------------------------+-------+
    | ConnectionFactory                   | ConnectionFactory              | nonxa |
    | XAConnectionFactory                 | XAConnectionFactory            | xa    |
    +-------------------------------------+--------------------------------+-------+
    ================================================================================
    [DAS]domain1.adminServer>list-jms-connection-factories -server adminServer -name ConnectionFactory
    ===================================================================
    ConnectionFactory
    
    +---------------------------------------------+-------------------+
    | Factory Name                                | ConnectionFactory |
    | Export Name                                 | ConnectionFactory |
    | Type                                        | nonxa             |
    | Client ID                                   | not-set           |
    | Max Client Session Threads                  |               100 |
    | Clustered                                   | false             |
    | Broker Selection Policy                     | round-robin       |
    +---------------------------------------------+-------------------+
    ===================================================================
    
    ================================================================================
    +------------------------------------------------------------------------------+
    |                                   Addresses                                  |
    +------------------------------------------------------------------------------+
    | 192.168.0.26:9741(JMSServiceChannel-internal)                                |
    +------------------------------------------------------------------------------+
    ================================================================================
    

Adds a new connection factory to the JMS engine. A queue or a topic connection factory can be created.

  • Aliases

    add-connection-factory, addconf, createconf

  • Usage

    add-jms-connection-factory -server <server-name>
                               -type <factory-type>
                               -name <factory-name>
                               [-export <export name>]                           
                               [-clientid <client-id>]
  • Parameters

    ParameterDescription
    -server <server-name>Server name to which the connection factory is added.
    -type <factory-type>

    Connection factory type

    Input options:

    • nonxa

    • xa

    • queue

    • topic

    • xaqueue

    • xatopic

    -name <factory-name>

    Connection factory name.

    The name must be unique within the JMS engine.

    [-export <export name>]

    JNDI name of the new connection factory.

    The name must be unique within the JNDI server.

    [-clientid <client-id>]Client ID. It is given to a connection created by the connection factory.
  • Example

    [DAS]domain1.adminServer>add-jms-connection-factory -server adminServer -type nonxa -name MyConnectionFactory
    Executed Successfully
    View the results using 'list-jms-connection-factories -server adminServer -name MyConnectionFactory'
    [DAS]domain1.adminServer>list-jms-connection-factories -server adminServer
    Connection Factory Information
    ================================================================================
    +-------------------------------------+--------------------------------+-------+
    |             Factory Name            |           Export Name          |  Type |
    +-------------------------------------+--------------------------------+-------+
    | ConnectionFactory                   | ConnectionFactory              | nonxa |
    | MyConnectionFactory                 | MyConnectionFactory            | nonxa |
    | XAConnectionFactory                 | XAConnectionFactory            | xa    |
    +-------------------------------------+--------------------------------+-------+
    ================================================================================

Deletes a specified connection factory from the JMS engine.

  • Aliases

    remove-connection-factory, deleteconf, removeconf

  • Usage

    remove-jms-connection-factory -server <server-name>
                                  -name <factory-name>
  • Parameters

    ParameterDescription
    -server <server-name>Server name to which the connection factory belongs.
    -name <factory-name>Connection factory to be deleted.
  • Example

    [DAS]domain1.adminServer>list-jms-connection-factories -server adminServer
    Connection Factory information
    ================================================================================
    +-------------------------------------+--------------------------------+-------+
    |             Factory Name            |           Export Name          |  Type |
    +-------------------------------------+--------------------------------+-------+
    | ConnectionFactory                   | ConnectionFactory              | nonxa |
    | MyConnectionFactory                 | MyConnectionFactory            | nonxa |
    | XAConnectionFactory                 | XAConnectionFactory            | xa    |
    +-------------------------------------+--------------------------------+-------+
    ================================================================================
    [DAS]domain1.adminServer>remove-jms-connection-factory -server adminServer -name MyConnectionFactory
    Executed Successfully
    View the results using 'list-jms-connection-factories -server adminServer'
    [DAS]domain1.adminServer>list-jms-connection-factories -server adminServer
    Connection Factory information
    ================================================================================
    +-------------------------------------+--------------------------------+-------+
    |             Factory Name            |           Export Name          |  Type |
    +-------------------------------------+--------------------------------+-------+
    | ConnectionFactory                   | ConnectionFactory              | nonxa |
    | XAConnectionFactory                 | XAConnectionFactory            | xa    |
    +-------------------------------------+--------------------------------+-------+
    ================================================================================

Displays a list of all destinations registered with the JMS engine or the information of a specified destination.

  • Aliases

    jmsdest, dest

  • Usage

    list-jms-destinations -cluster <cluster-name> | -server <server-name>
                          [-n, --name <destination-name>] 
  • Parameters

    ParameterDescription
    -cluster <cluster-name> | -server <server-name>Cluster or server name to which the destination belongs.
    [-n, --name <destination-name>]Destination name. If not specified, brief descriptions of all destinations are displayed.
  • Example

    [[DAS]domain1.adminServer>list-jms-destinations -server adminServer
    Destination information in Server adminServer
    ================================================================================
    +---------+---------+-------+------------+-------------+-----------+-----------+
    |   Name  |  Export |  Type |  Remaining | Dead Letter |  Produce  |  Consume  |
    |         |  Name   |       |  Messages  | Destination | Suspended | Suspended |
    +---------+---------+-------+------------+-------------+-----------+-----------+
    | Examples| Examples| Topic |          0 | JEUSMQ_DLQ  | false     | false     |
    |Topic    |Topic    |       |            |             |           |           |
    +---------+---------+-------+------------+-------------+-----------+-----------+
    | Examples| Examples| Queue |          0 | JEUSMQ_DLQ  | false     | false     |
    |Queue    |Queue    |       |            |             |           |           |
    +---------+---------+-------+------------+-------------+-----------+-----------+
    | JEUSMQ_D| JEUSMQ_D| Queue |          0 | JEUSMQ_DLQ  | false     | false     |
    |LQ       |LQ       |       |            |             |           |           |
    +---------+---------+-------+------------+-------------+-----------+-----------+
                  
    For detailed information, use  the -name option 
    ================================================================================
    [DAS]domain1.adminServer>list-jms-destinations -server adminServer -name ExamplesQueue
    Detailed destination information in Server adminServer
    ==================================================================
    ExamplesQueue
                  
    +------------------------------------------------+---------------+
    | Export Name                                    | ExamplesQueue |
    | Type                                           | Queue         |
    | Dead Letter Destination                        | JEUSMQ_DLQ    |
    | Consumer Count                                 |             0 |
    | Processed Messages                             |             0 |
    | Remaining Messages                             |             0 |
    | Pending Messages                               |             0 |
    | Dispatched Messages                            |             0 |
    | Delivered Messages                             |             0 |
    | Expired Messages                               |             0 |
    | Moved Messages                                 |             0 |
    | Memory Usage (current)                         | 0kb           |
    | Memory Usage (high mark)                       | 0kb           |
    | Produce Suspended                              | false         |
    | Consume Suspended                              | false         |
    +------------------------------------------------+---------------+
    ==================================================================

Adds a new destination to the JMS engine.

  • Aliases

    add-destination, adddest, createdest

  • Usage

    add-jms-destination -cluster <cluster-name | -server <server-name>
                        -type <destination-type>
                        -name <destination-name>
                        [-export <export-name>]
  • Parameters

    ParameterDescription
    -cluster <cluster-name | -server <server-name>Cluster or server name to which the destination is added.
    -type <destination-type>Destination type (queue or topic).
    -name <destination-name>

    Destination name to be created.

    The name must be unique within the JMS engine.

    [-export <export-name>]

    JNDI name of the new connection factory.

    The name must be unique within the JEUS JNDI server. If not specified, the value of destination-name is used.

  • Example

    [DAS]domain1.adminServer>add-jms-destination -server adminServer -type queue -name MyQueue
    Executed Successfully
    View the results using 'list-jms-destinations -server adminServer -name MyQueue'
    [DAS]domain1.adminServer>list-jms-destinations -server adminServer
    Destination information in Server adminServer
    ================================================================================
    +---------+---------+-------+------------+-------------+-----------+-----------+
    |   Name  |  Export |  Type |  Remaining | Dead Letter |  Produce  |  Consume  |
    |         |  Name   |       |  Messages  | Destination | Suspended | Suspended |
    +---------+---------+-------+------------+-------------+-----------+-----------+
    | MyQueue | MyQueue | Queue |          0 | JEUSMQ_DLQ  | false     | false     |
    +---------+---------+-------+------------+-------------+-----------+-----------+
    | Examples| Examples| Topic |          0 | JEUSMQ_DLQ  | false     | false     |
    |Topic    |Topic    |       |            |             |           |           |
    +---------+---------+-------+------------+-------------+-----------+-----------+
    | Examples| Examples| Queue |          0 | JEUSMQ_DLQ  | false     | false     |
    |Queue    |Queue    |       |            |             |           |           |
    +---------+---------+-------+------------+-------------+-----------+-----------+
    | JEUSMQ_D| JEUSMQ_D| Queue |          0 | JEUSMQ_DLQ  | false     | false     |
    |LQ       |LQ       |       |            |             |           |           |
    +---------+---------+-------+------------+-------------+-----------+-----------+
    
    For detailed information, use the -name option 
    ==============================================================================

Deletes a destination from the JMS engine.

  • Aliases

    remove-destination, deletedest, removedest

  • Usage

    remove-jms-destination -cluster <cluster-name | -server <server-name>
                           -name <destination-name>
  • Parameter

    ParameterDescription
    -cluster <cluster-name | -server <server-name>Cluster or server name to which the destination belongs.
    -name <destination-name>Destination name to be deleted.
  • Example

    [DAS]domain1.adminServer>list-jms-destinations -server adminServer
    Destination information in Server adminServer
    ================================================================================
    +---------+---------+-------+------------+-------------+-----------+-----------+
    |   Name  |  Export |  Type |  Remaining | Dead Letter |  Produce  |  Consume  |
    |         |  Name   |       |  Messages  | Destination | Suspended | Suspended |
    +---------+---------+-------+------------+-------------+-----------+-----------+
    | MyQueue | MyQueue | Queue |          0 | JEUSMQ_DLQ  | false     | false     |
    +---------+---------+-------+------------+-------------+-----------+-----------+
    | Examples| Examples| Topic |          0 | JEUSMQ_DLQ  | false     | false     |
    |Topic    |Topic    |       |            |             |           |           |
    +---------+---------+-------+------------+-------------+-----------+-----------+
    | Examples| Examples| Queue |          0 | JEUSMQ_DLQ  | false     | false     |
    |Queue    |Queue    |       |            |             |           |           |
    +---------+---------+-------+------------+-------------+-----------+-----------+
    | JEUSMQ_D| JEUSMQ_D| Queue |          0 | JEUSMQ_DLQ  | false     | false     |
    |LQ       |LQ       |       |            |             |           |           |
    +---------+---------+-------+------------+-------------+-----------+-----------+
    
    For detailed information, use the -name option 
    ==============================================================================
    [DAS]domain1.adminServer>
    remove-jms-destination -server adminServer -name MyQueue
    Executed Successfully
    View the results using 'list-jms-destinations -server adminServer'
     
    [DAS]domain1.adminServer>list-jms-destinations -server adminServer
    Destination information in Server adminServer
    ================================================================================
    +---------+---------+-------+------------+-------------+-----------+-----------+
    |   Name  |  Export |  Type |  Remaining | Dead Letter |  Produce  |  Consume  |
    |         |  Name   |       |  Messages  | Destination | Suspended | Suspended |
    +---------+---------+-------+------------+-------------+-----------+-----------+
    | Examples| Examples| Topic |          0 | JEUSMQ_DLQ  | false     | false     |
    |Topic    |Topic    |       |            |             |           |           |
    +---------+---------+-------+------------+-------------+-----------+-----------+
    | Examples| Examples| Queue |          0 | JEUSMQ_DLQ  | false     | false     |
    |Queue    |Queue    |       |            |             |           |           |
    +---------+---------+-------+------------+-------------+-----------+-----------+
    | JEUSMQ_D| JEUSMQ_D| Queue |          0 | JEUSMQ_DLQ  | false     | false     |
    |LQ       |LQ       |       |            |             |           |           |
    +---------+---------+-------+------------+-------------+-----------+-----------+
                
    For detailed information, use the -name option 
    ==============================================================================

Displays destination message information.

  • Aliases

    message, msg

  • Usage

    list-jms-messages -cluster <cluster-name> | -server <server-name>
                    -dest <destination-name> | -durable <<client-id>_<durable-name>>
                    [-s,--selector <message-selector>]
                    [-offset <offset>]
                    [-size <size>]
                    [-id <message-id-pattern>]
                    [-type <message-type>]
                    [-from <YYYY:MM:DD:HH:MM:SS>]
                    [-to <YYYY:MM:DD:HH:MM:SS>]
  • Parameter

    ParameterDescription
    -cluster <cluster-name> | -server <server-name>Cluster or server name to which the destination belongs.
    -dest <destination-name> | -durable <<client-id>_<durable-name>>Destination name or durable subscriber name of the message to be displayed.
    [-s, --selector <message-selector>]Only messages with the specified message selector can be displayed.
    [-offset <offset>]Offset from which messages are displayed when messages are divided before displayed.
    [-size <size>]Number of messages to be displayed when messages are divided before displayed.
    [-id <message-id-pattern>]Only messages with the specified message ID pattern can be displayed.
    [-type <message-type>]Only messages with the specified message type can be displayed.
    [-from <YYYY:MM:DD:HH:MM:SS>]Only messages received after the specified time can be displayed.
    [-to <YYYY:MM:DD:HH:MM:SS>]Only messages received before the specified time can be displayed.
  • Example

    [DAS]domain1.adminServer>list-jms-messages -server adminServer -dest ExamplesQueue
    Messages in Destination ExamplesQueue.
    
    ==============================================================================
    +-------------------------+-------------+------------------------------------+
    |        Message ID       | Message Type|            Created Time            |
    +-------------------------+-------------+------------------------------------+
    | ID:0:36386800005:2:2    | Text        | Mon May 07 20:10:01 KST 2012       |
    | ID:0:36386800006:2:2    | Text        | Mon May 07 20:10:03 KST 2012       |
    | ID:0:36386800007:2:2    | Text        | Mon May 07 20:10:04 KST 2012       |
    | ID:0:36386800008:2:2    | Text        | Mon May 07 20:10:06 KST 2012       |
    +-------------------------+-------------+------------------------------------+
    ==============================================================================

Displays detailed information of a specified message.

  • Aliases

    viewmsg

  • Usage

    view-jms-messages  -cluster <cluster-name> | -server <server-name>
                    -dest <destination-name> | -durable <<client-id>_<durable-name>>
                    -id <message-id> 
  • Parameters

    ParameterDescription
    -cluster <cluster-name> | -server <server-name>Cluster or server name to which the destination or the durable subscriber belongs.
    -dest <destination-name> | -durable <<client-id>_<durable-name>>Destination name or durable subscriber name of the message to be displayed.
    -id <message-id>Message ID of the message to be displayed.
  • Example

    [DAS]domain1.adminServer>list-jms-messages -server adminServer -dest ExamplesQueue
    Messages in Destination ExamplesQueue
    ================================================================================
    +------------------+--------------+--------------------------------------------+
    |    Message ID    | Message Type |                Created Time                |
    +------------------+--------------+--------------------------------------------+
    | ID:1:6927265:1:0 | Text         | Tue Mar 19 15:53:17 KST 2013               |
    | ID:1:6927265:1:1 | Text         | Tue Mar 19 15:53:17 KST 2013               |
    | ID:1:6927265:1:2 | Text         | Tue Mar 19 15:53:17 KST 2013               |
    | ID:1:6927265:1:3 | Text         | Tue Mar 19 15:53:17 KST 2013               |
    | ID:1:6927265:1:4 | Text         | Tue Mar 19 15:53:17 KST 2013               |
    +------------------+--------------+--------------------------------------------+
    ================================================================================
    
    [DAS]domain1.adminServer>view-jms-message -server adminServer -dest ExamplesQueue -id ID:1:6927265:1:0
    Message ID:1:6927265:1:0
    ================================================================================
    +------------------+-----------------------------------------------------------+
    |  Attribute name  |                           Value                           |
    +------------------+-----------------------------------------------------------+
    | Message ID       | ID:1:6927265:1:0                                          |
    | Destination Name | ExamplesQueue                                             |
    | Delivery Mode    |                                                         2 |
    | Message Type     | Text                                                      |
    | Correlation ID   |                                                           |
    | Created Time     | Tue Mar 19 15:53:17 KST 2013                              |
    | Expiration Time  | -                                                         |
    | Time-to-live     |                                                         0 |
    | Priority         |                                                         4 |
    | Redelivered      | false                                                     |
    | Delivery Time    | Tue Mar 19 15:53:17 KST 2013                              |
    | Redelivery Limit |                                                         4 |
    | Reply To         |                                                           |
    | Message Body     | Test Message                                              |
    +------------------+-----------------------------------------------------------+
    ================================================================================

Moves messages to a different destination.

  • Aliases

    mvmsg

  • Usage

    move-jms-message  -cluster <cluster-name> | -server <server-name>
                   -dest <destination-name> | -durable <<client-id>_<durable-name>>
                   -id <message-id> | -all
                   -target <destination-name>
  • Parameters

    ParameterDescription
    -cluster <cluster-name> | -server <server-name>Cluster or server name to which the destination or the durable subscriber belongs.
    -dest <destination-name> | -durable <<client-id>_<durable-name>>Destination name or durable subscriber name of the message to be displayed.
    -id <message-id> | -allID of the message to be moved. Individual message IDs or all messages can be selected.
    -target <destination-name>Target destination of the message.
  • Example

    [DAS]domain1.adminServer>list-jms-destinations -server adminServer
    Destination information in Server adminServer
    ================================================================================
    +---------+---------+-------+------------+-------------+-----------+-----------+
    |   Name  |  Export |  Type |  Remaining | Dead Letter |  Produce  |  Consume  |
    |         |  Name   |       |  Messages  | Destination | Suspended | Suspended |
    +---------+---------+-------+------------+-------------+-----------+-----------+
    | MyQueue | MyQueue | Queue |          0 | JEUSMQ_DLQ  | false     | false     |
    +---------+---------+-------+------------+-------------+-----------+-----------+
    | Examples| Examples| Topic |          0 | JEUSMQ_DLQ  | false     | false     |
    |Topic    |Topic    |       |            |             |           |           |
    +---------+---------+-------+------------+-------------+-----------+------- ----+
    | Examples| Examples| Queue |          5 | JEUSMQ_DLQ  | false     | false     |
    |Queue    |Queue    |       |            |             |           |           |
    +---------+---------+-------+------------+-------------+-----------+-----------+
    | JEUSMQ_D| JEUSMQ_D| Queue |          0 | JEUSMQ_DLQ  | false     | false     |
    |LQ       |LQ       |       |            |             |           |           |
    +---------+---------+-------+------------+-------------+-----------+-----------+
    
    For detailed information, use the -name option 
    ================================================================================
    [DAS]domain1.adminServer>move-jms-messages -server adminServer -dest ExamplesQueue -all -target MyQueue
    Successfully moved all messages from ExamplesQueue to MyQueue is successful
    [DAS]domain1.adminServer>list-jms-destinations -server adminServer
    Destination information in Server adminServer
    ================================================================================
    +---------+---------+-------+------------+-------------+-----------+-----------+
    |   Name  |  Export |  Type |  Remaining | Dead Letter |  Produce  |  Consume  |
    |         |  Name   |       |  Messages  | Destination | Suspended | Suspended |
    +---------+---------+-------+------------+-------------+-----------+-----------+
    | MyQueue | MyQueue | Queue |          5 | JEUSMQ_DLQ  | false     | false     |
    +---------+---------+-------+------------+-------------+-----------+-----------+
    | Examples| Examples| Topic |          0 | JEUSMQ_DLQ  | false     | false     |
    |Topic    |Topic    |       |            |             |           |           |
    +---------+---------+-------+------------+-------------+-----------+-----------+
    | Examples| Examples| Queue |          0 | JEUSMQ_DLQ  | false     | false     |
    |Queue    |Queue    |       |            |             |           |           |
    +---------+---------+-------+------------+-------------+-----------+-----------+
    | JEUSMQ_D| JEUSMQ_D| Queue |          0 | JEUSMQ_DLQ  | false     | false     |
    |LQ       |LQ       |       |            |             |           |           |
    +---------+---------+-------+------------+-------------+-----------+-----------+
    
    For detailed information, use the -name option 
    ================================================================================

Imports all messages from an XML file in a destination.

  • Aliases

    immsg

  • Usage

    import-jms-message  -cluster <cluster-name> | -server <server-name>
                       -dest <destination-name>
                       -path <file-path>
                       [-overwrite] 
  • Parameter

    ParameterDescription
    -cluster <cluster-name> | -server <server-name>Cluster or server name to which the destination or the durable subscriber belongs.
    -dest <destination-name>Destination name of the message to be imported.
    -path <file-path>Path to the file to which imported messages are saved.
    [-overwrite]A new JMSMessageID is not issued to an imported message. A message with the same ID is overwritten.
  • Example

    [DAS]domain1.adminServer>list-jms-messages -server adminServer -dest ExamplesQueue
    There are no messages in ExamplesQueue.
    [DAS]domain1.adminServer>import-jms-messages -server adminServer -dest ExamplesQueue -path exported.xml
    Successfully imported 5 of 5 messages.
    [DAS]domain1.adminServer>list-jms-messages -server adminServer -dest ExamplesQueue
    Messages in Destination ExamplesQueue 
    ================================================================================
    +------------------------+--------------+--------------------------------------+
    |       Message ID       | Message Type |             Created Time             |
    +------------------------+--------------+--------------------------------------+
    | ID:1:1239036099:1:5    | Text         | Tue Mar 19 19:52:54 KST 2013         |
    | ID:1:1239036099:1:6    | Text         | Tue Mar 19 19:52:54 KST 2013         |
    | ID:1:1239036099:1:7    | Text         | Tue Mar 19 19:52:54 KST 2013         |
    | ID:1:1239036099:1:8    | Text         | Tue Mar 19 19:52:54 KST 2013         |
    | ID:1:1239036099:1:9    | Text         | Tue Mar 19 19:52:54 KST 2013         |
    +------------------------+--------------+--------------------------------------+
    ================================================================================

The following is a list of data source commands that manage data sources and change data source configurations.

CommandsDescription
add-data-sourceDynamically adds a data source to the domain.
remove-data-sourceDeletes a data source from the domain.
modify-data-sourceChanges the configuration of a data source. Some configurations can be changed dynamically.
list-data-sourcesDisplays a list of all data sources in the domain. If a data source ID is specified, its configuration is displayed in detail.
test-data-sources-configChecks if a data source configuration is correct.
add-cluster-data-sourceDynamically adds a cluster data source to the domain.
remove-cluster-data-sourceDeletes a cluster data source from the domain.
modify-cluster-data-sourceChanges the configuration of a cluster data source. Most configurations can be changed dynamically.
list-cluster-data-sourcesDisplays a list of all cluster data sources in the domain. If a data source ID is specified, its configuration is displayed in detail.

Dynamically adds a data source to the domain.

  • Aliases

    addds

  • Usage

    add-data-source [-id,--dataSourceID <data-source-id>]
                 [-ac,--autoCommit <auto-commit-value>]
                 [-sqt,--stmtQueryTimeout <statement-query-timeout>]
                 [-aocl,--actionOnConnectionLeak <action-on-connection-leak>]
                 [-min,--min <minimum-size>]
                 [-max,--max <maximum-size>]
                 [-step,--step <resizing-step>]
                 [-period,--period <resizing-period>]
                 [-ew,--enableWait <enable-wait>]
                 [-wt,--waitTime <wait-time>]
                 [-dds,--delegationDataSource <delegation-data-source>]
                 [-muc,--maxUseCount <max-use-count>]
                 [-cq,--checkQuery <check-query>]
                 [-cqt,--checkQueryTimeout <check-query-timeout>]
                 [-nvi,--nonValidationInterval <non-validation-interval>]
                 [-cqp,--checkQueryPeriod <check-query-period>]
                 [-cqrc,--checkQueryRetrialCount <check-query-retrial-count>]
                 [-dpocq,--destroyPolicyOnCheckQuery <destroy-policy-on-check-query>]
                 [-scs,--stmtCachingSize <stmt-caching-size>]
                 [-sfs,--stmtFetchSize <stmt-fetch-size>]
                 [-ct,--connectionTrace <connection-trace>]
                 [-gct,--getConnectionTrace <get-connection-trace>]
                 [-act,--autoCommitTrace <auto-commit-trace>]
                 [-ust,--useSqlTrace <use-sql-trace>]
                 [-kcho,--keepConnectionHandleOpen <keep-connection-handle-open>]
                 [-en,--exportName <export-name>]
                 [-dscn,--dataSourceClassName <data-source-class-name>]
                 [-dst,--dataSourceType <data-source-type>]
                 [-vendor,--vendor <vendor>]
                 [-desc,--description <description>]
                 [-sn,--serverName <server-name>]
                 [-pn,--portNumber <port-number>]
                 [-dn,--databaseName <database-name>]
                 [-user,--user <user>]
                 [-pw,--password <password>]
                 [-lt,--loginTimeout <login-timeout>]
                 [-il,--isolationLevel <isolation-level>]
                 [-pdt,--poolDestroyTimeout <pool-destroy-timeout>]
                 [-prop,--property <property>]
                 [-sxe,--supportXaEmulation <support-xa-emulation>]
                 [-ddba,--delegationDba <delegation-dba>]
                 [-dbat,--dbaTimeout <dba-timeout>]
                 [-cqc,--checkQueryClass <check-query-class>]
                 [-is,--initSql <init-sql>]
                 [-f,--forceLock]
                 [-detail]
  • Parameters

    ParameterDescription
    [-id,--dataSourceID <data-source-id>]Data source ID. The data source ID must be unique within the domain.
    [-ac,--autoCommit <auto-commit-value>]

    Option to use the auto-commit configuration of the data source.

    Input options:

    • TRUE

    • FALSE

    • DRIVER: If DRIVER is selected, the auto-commit configuration of the JDBC driver is used. The configuration value can only be set when the transaction is not linked to the connection pool data sources that use the XA emulation function or linked to XA data sources.

    [-sqt,--stmtQueryTimeout <statement-query-timeout> ]

    Query timeout used for java.sql.Statement objects created through the data source connection.

    JEUS calls the query timeout configuration method (java.sql.Statement#setQueryTimeout) defined in the JDBC API and implemented by the JDBC driver vendor. The query timeout differs depending on the JDBC driver vendors. (Unit: ms)

    [-aocl,--actionOnConnectionLeak <action-on-connection-leak>]

    Determines the action JEUS takes when it detects JDBC connections used by applications (stateless component - servlet/JSP, stateless session bean, MDB), but not yet returned.

    Input options are listed below. If unspecified, the configuration of the server is used.

    • NO_ACTION: Take no actions.

    • WARNING: Log the information of the JDBC connections that are not returned.

    • AUTO_CLOSE: Log the information of the unreturned JDBC connections and collect them.

    [-min,--min <minimum-size>]Minimum number of connections in the connection pool.
    [-max,--max <maximum-size>]Maximum number of connections in the connection pool.
    [-step,--step <resizing-step>]Number of DB connections obtained if the number of connections is insufficient and the number of connections in the connection pool is less than the maximum value.
    [-period,--period <resizing-period>]Period in which to adjust the connection pool size based on the minimum value. If the connection pool size is greater than the minimum value, unused connections are closed. If the size is less than the minimum value, new DB connections are obtained. (Unit: ms)
    [-ew,--enableWait <enable-wait>]

    Determines how to handle connection requests when no connections are available in the pool and additional connections cannot be added.

    • true: Wait until a connection is available.

    • false: Create a new (disposable) connection that does not enter the pool and is discarded after use.

    [-wt,--waitTime <wait-time>]Period in which to wait for a connection if --enable-wait is true. If a connection cannot be obtained within the period, JEUS generates a timeout exception. (Unit: ms)
    [-dds,--delegationDataSource <delegation-data-source>]

    If a request does not involve a transaction, it is better to get a connection from the connection pool data source instead of from the XA data source.

    In this situation, a connection from the connection pool data source provides the same functionality as a connection from the XA data source, but with a smaller impact on system performance. Therefore, when using the XA data source, delegate connection requests unrelated to transactions to the connection pool data source.

    When Oracle and DB2 use XA connections for both cases, with or without transactions, unexplained errors can occur; using this configuration can help avoid such situation.

    [-muc,--maxUseCount <max-use-count>]

    Maximum number of times a connection can be used. If the number of times a connection is used exceeds the specified number, the connection is replaced with a new connection.

    The default value is 0: a connection is not replaced.

    [-cq,--checkQuery <check-query>]

    Query (query-check) that checks the connection status.

    Simple selection queries are recommended when validating the connection to the DB.

    [-cqt,--checkQueryTimeout <check-query-timeout>]

    When a check-query is executed to check the connection status, a driver can be in the wait state indefinitely if the DB does not respond. Apply a timeout to the check-query to avoid this situation.

    This can be set by using the java.sql.Statement#setQueryTimeout method defined in the JDBC API.

    If the value is less than 1000ms, the value is set to 0. (Unit: ms)

    [-nvi,--nonValidationInterval <non-validation-interval>]

    Option to skip connection checks if the interval between the last check and the recent check is within the specified interval. This option is useful for when overhead is created by frequent connection checks. (Unit: ms)

    For example, if the option is set to 5000 ms, and 5 seconds has not passed since the last connection check, connections are sent to the applications without being checked.

    [-cqp,--checkQueryPeriod <check-query-period>]

    Checks the connections in the connection pool at the specified interval to delete faulty connections. (Unit: ms)

    For data sources that belong to cluster data sources, this option must be set to be used for checking its own state.

    [-cqrc,--checkQueryRetrialCount <check-query-retrial-count>]

    If --destroyPolicyOnCheckQuery is set to FAILED_CONNECTION_ONLY, a connection check is performed only once.

    If --destroyPolicyOnCheckQuery is set to ALL_CONNECTIONS and a problem is detected during the first connection check, all other connections are also checked, resulting in the connection check being performed twice.

    The total connection check count is determined by adding this option value to the default connection check value.

    [-dpocq,--destroyPolicyOnCheckQuery <destroy-policy-on-check-query>]

    Policy for connections in the connection pool when invalid connections are found.

    • FAILED_CONNECTION_ONLY: Delete only invalid connections.

    • ALL_CONNECTIONS: Delete invalid connections and validate other connections in the connection pool. If another invalid connection is detected in the pool, delete all the connections from the connection pool.

    [-scs,--stmtCachingSize <stmt-caching-size>]

    JDBC driver parses SQL statements sent as parameters whenever applications request prepared statements. Parsing SQL statements can affect system performance, so JEUS offers a function that internally caches the prepared statements. This option sets the number of prepared statements that can be cached. If this option is used, connections are always open, so the clear job performed by the driver is not executed.

    For example, when the Oracle JDBC driver sets auto-commit to false and closes the connection without executing commit or rollback, commit is executed unconditionally.

    The use of the statement caching function is recommended if provided by the JDBC driver.

    [-sfs,--stmtFetchSize <stmt-fetch-size>]Fetch size of the JDBC driver statement.
    [-ct,--connectionTrace<connection-trace>]

    Option to offer additional information for connections.

    • false: --getConnectionTrace and --autoCommitTrace cannot be used.

    [-gct,--getConnectionTrace <get-connection-trace>]Displays the stack trace when the application calls java.sql.DataSource#getConnection.
    [-act,--autoCommitTrace <auto-commit-trace>]Records logs and the stack trace to server logs when java.sql.Connection#setAutoCommit is called. The log level of jeus.jdbc.connection-trace logger must be set to FINE.
    [-ust,--useSqlTrace <use-sql-trace>]

    Displays SQL queries used by connections.

    If the jeus.jdbc.sql logger level is set to FINE, the SQL query history can be checked in server logs. If this function is used, the statement implementation class of the JDBC driver is wrapped by a JEUS class. Therefore, applications that cast and use statement objects of the JDBC driver cannot use this function.

    [-kcho,--keepConnectionHandleOpen <keep-connection-handle-open>]

    If this option is set to true and an XA connection is used and returned to the pool, the handle (or the logical connection) is kept open.

    This function is required when using DB2 universal drivers. If this option is used, connections are always open, so the clear job performed by the driver is not executed.

    For example, when the Oracle JDBC driver sets auto-commit to false and closes the connection without executing commit or rollback, commit is executed unconditionally.

    The use of the statement caching function is recommended if provided by the JDBC driver.

    [-en,--exportName <export-name>]

    JNDI name of the data source.

    If two data sources are guaranteed to be bound to different JNDIs on different servers, they can have the same JNDI name. Different data sources with the same JNDI names are not allowed on the same server.

    If not specified, the data source ID is used as the JNDI name.

    [-dscn,--dataSourceClassName <data-source-class-name>]JDBC driver data source class name. Enter the full name, including the package name.
    [-dst,--dataSourceType <data-source-type>]

    Data source type.

    Input options:

    • DATA_SOURCE: Connection pooling service is not provided.

    • CONNECTION_POOL_DATA_SOURCE: Connection pooling service is provided.

    • XA_DATA_SOURCE: XA interface and the connection pooling service are provided.

    [-vendor,--vendor <vendor>]JDBC driver vendor name.
    [-desc,--description <description>]Displays data source descriptions.
    [-sn,--serverName <server-name>]Host name or IP at which the database runs.
    [-pn,--portNumber <port-number>]Listener port number of the database.
    [-dn,--databaseName <database-name>]

    Database name. Sets the database SID (for Oracle).

    [-user,--user <user>]Database user ID. The user must have the proper permissions to handle transactions.
    [-pw,--password <password>]Database user password. To encrypt the password before storing, use the '{algorithm}ciphertext' format.
    [-lt,--loginTimeout <login-timeout>]Maximum time to wait for the login screen to connect to the database. (Unit: seconds)
    [-il,--isolationLevel <isolation-level>]Transaction isolation level defined in java.sql.Connection.
    [-pdt,--poolDestroyTimeout <pool-destroy-timeout>]

    Amount of time in wait for the connection pool destroy command to complete. (Unit: ms)

    The connection pool is destroyed when applications that defined the data sources are undeployed or when the server goes down. During this process, if the connection is used for network communication with a DB, the destroy process can be blocked and left hanging indefinitely. This option is used to avoid this situation. If this option is set, connection pool destruction waits the specified time period and then performs undeployment or terminates the server.

    [-prop,--property <property>]

    This option provides a unified configuration method to accommodate all property configurations that can differ by JDBC driver.

    For a single property, use the 'name:type=value' format.

    To specify multiple properties, separate each property with a comma (,).

    [-sxe,--supportXaEmulation <support-xa-emulation>]

    This option only applies to the connection pool data source type. This option emulates the connection pool data source connection to participate in a global transaction (XA).

    For JEUS 6 and earlier versions, this option is an alternative to LocalXADataSource. It is used in the ConnectionPoolDataSource type connection pools.

    Note that only one connection pool data source can participate per transaction.

    [-ddba,--delegationDba <delegation-dba>]

    JNDI name of the data source (hereafter DBA delegation data source), which has permission to forcibly terminate database sessions (DBA permission). If there is a delay in handling a query through the connection received from the data source, a query that forcibly terminates the DB session is sent to the DB using the DBA delegation data source. After the application handles exceptions that occurred due to the disabled connection, it closes the connection. JEUS then deletes the connection and gets a new connection from the DB and assigns it to the connection pool.

    Currently, this function is supported for Tibero, Oracle, and Sybase. It was created to suspend queries that take too long to perform for JDBC driver version 2.0 and earlier. For JDBC driver version 3.0 and later, it is recommended to use java.sql.Statement#setQueryTimeout instead of forcibly terminating DB sessions.

    Especially for XA data sources, if DB sessions are terminated while XA operates normally, the XA operation can generate an error. Therefore, the use of the statement query timeout and the transaction timeout properties is recommended.

    [-dbat,--dbaTimeout <dba-timeout>]

    The delegation DBA data source waits the specified period for queries on a connection to finish. If timeout occurs, a query is sent to the DB that forcibly terminates the DB session.

    This option only applies when --delegationDba is set. (Unit: ms)

    [-cqc,--checkQueryClass <check-query-class>]

    Class name. It includes the package name, that implements the function for users or developers who want to customize the connection check function.

    The class must implement the jeus.jdbc.connectionpool.JEUSConnectionChecker interface.

    [-is,--initSql <init-sql>]SQL query that is initially handled after a connection has been created.
    [-f,--forceLock]Forcibly applies the configuration changes.
    [-detail]Displays the detailed results of the configuration changes.
  • Example

    [DAS]domain1.adminServer>addds -id ds1 -dst ConnectionPoolDataSource -dscn 
    oracle.jdbc.pool.OracleConnectionPoolDataSource -sn 61.77.153.4 -pn 1521 -
    dn orcl -user scott -password tiger -property driverType;java.lang.String;thin 
    Successfully performed the ADD operation for data source [ds1] to domain.
    Check the results using "add-data-source"

Changes the configuration of a data source. Some configurations can be changed dynamically.

  • Aliases

    modifyds

  • Usage

    modify-data-source -id,--dataSourceID <data-source-id>
                 [-ac,--autoCommit <auto-commit-value>]
                 [-sqt,--stmtQueryTimeout <statement-query-timeout>]
                 [-aocl,--actionOnConnectionLeak <action-on-connection-leak>]
                 [-min,--min <minimum-size>]
                 [-max,--max <maximum-size>]
                 [-step,--step <resizing-step>]
                 [-period,--period <resizing-period>]
                 [-ew,--enableWait <enable-wait>]
                 [-wt,--waitTime <wait-time>]
                 [-dds,--delegationDataSource <delegation-data-source>]
                 [-muc,--maxUseCount <max-use-count>]
                 [-cq,--checkQuery <check-query>]
                 [-cqt,--checkQueryTimeout <check-query-timeout>]
                 [-nvi,--nonValidationInterval <non-validation-interval>]
                 [-cqp,--checkQueryPeriod <check-query-period>]
                 [-cqrc,--checkQueryRetrialCount <check-query-retrial-count>]
                 [-dpocq,--destroyPolicyOnCheckQuery <destroy-policy-on-check-query>]
                 [-scs,--stmtCachingSize <stmt-caching-size>]
                 [-sfs,--stmtFetchSize <stmt-fetch-size>]
                 [-ct,--connectionTrace <connection-trace>]
                 [-gct,--getConnectionTrace <get-connection-trace>]
                 [-act,--autoCommitTrace <auto-commit-trace>]
                 [-ust,--useSqlTrace <use-sql-trace>]
                 [-kcho,--keepConnectionHandleOpen <keep-connection-handle-open>]
                 [-en,--exportName <export-name>]
                 [-dscn,--dataSourceClassName <data-source-class-name>]
                 [-dst,--dataSourceType <data-source-type>]
                 [-vendor,--vendor <vendor>]
                 [-desc,--description <description>]
                 [-sn,--serverName <server-name>]
                 [-pn,--portNumber <port-number>]
                 [-dn,--databaseName <database-name>]
                 [-user,--user <user>]
                 [-pw,--password <password>]
                 [-lt,--loginTimeout <login-timeout>]
                 [-il,--isolationLevel <isolation-level>]
                 [-pdt,--poolDestroyTimeout <pool-destroy-timeout>]
                 [-prop,--property <property>]
                 [-sxe,--supportXaEmulation <support-xa-emulation>]
                 [-ddba,--delegationDba <delegation-dba>]
                 [-dbat,--dbaTimeout <dba-timeout>]
                 [-cqc,--checkQueryClass <check-query-class>]
                 [-is,--initSql <init-sql>]
                 [-f,--forceLock]
                 [-detail]
  • Parameters

    ParameterDescription
    [-id,--dataSourceID <data-source-id>]Data source ID. The data source ID must be unique within the domain.
    [-ac,--autoCommit <auto-commit-value>]

    [Dynamic change] Option to use the auto-commit configuration of the data source.

    Input options:

    • TRUE

    • FALSE

    • DRIVER: If DRIVER is selected, the auto-commit configuration of the JDBC driver is used. The configuration value can only be set when the transaction is not linked to the connection pool data sources that use the XA emulation function or linked to XA data sources.

    [-sqt,--stmtQueryTimeout <statement-query-timeout>]

    [Dynamic change] Query timeout used for java.sql.Statement objects created through the data source connection.

    JEUS calls the query timeout configuration method (java.sql.Statement#setQueryTimeout) defined in the JDBC API and implemented by the JDBC driver vendor. The query timeout differs depending on the JDBC driver vendors. (Unit: ms)

    [-aocl,--actionOnConnectionLeak <action-on-connection-leak>]

    [Dynamic change] Determines the action JEUS takes when it detects JDBC connections used by applications (stateless component - servlet/JSP, stateless session bean, MDB), but not yet returned.

    Input options:

    • NO_ACTION: Take no actions.

    • WARNING: Log the information of the JDBC connections that are not returned.

    • AUTO_CLOSE: Log the information of the unreturned JDBC connections and collect them.

    If not specified, the configuration of the server is used. To undo this setting, enter "unset" as the option value.

    [-min,--min <minimum-size>][Dynamic change] Minimum number of connections in the connection pool.
    [-max,--max <maximum-size>][Dynamic change] Maximum number of connections in the connection pool.
    [-step,--step <resizing-step>][Dynamic change] Number of DB connections to be obtained if the number of connections is insufficient and the number of connections in the connection pool is less than the maximum value.
    [-period,--period <resizing-period>][Dynamic change] Period in which to adjust the connection pool size based on the minimum value. If the connection pool size is greater than the minimum value, unused connections are closed. If the size is less than the minimum value, new DB connections are obtained. (Unit: ms)
    [-ew,--enableWait <enable-wait>]

    [Dynamic change] Determines how to handle connection requests when no connections are available in the pool and additional connections cannot be added.

    • true: Wait until a connection is available.

    • false: Create a new (disposable) connection that does not enter the pool and is discarded after use.

    [-wt,--waitTime <wait-time>][Dynamic change] Period in which to wait for a connection if --enable-wait is true. If a connection cannot be obtained within the period, JEUS generates a timeout exception. (Unit: ms)
    [-dds,--delegationDataSource <delegation-data-source>]

    [Dynamic change] If a request does not involve a transaction, it is better to get a connection from the connection pool data source instead of from the XA data source.

    In this situation, a connection from the connection pool data source provides the same functionality as a connection from the XA data source, but with a smaller impact on system performance. Therefore, when using the XA data source, delegate connection requests unrelated to transactions to the connection pool data source.

    When Oracle and DB2 use XA connections for both cases, with or without transactions, unexplained errors can occur; using this configuration can help avoid such situation.

    To undo this setting, enter "unset" as the option value.

    [-muc,--maxUseCount <max-use-count>][Dynamic change] Maximum number of times a connection can be used. If the number of times a connection is used exceeds the specified number, the connection is replaced with a new connection. The default value is 0: a connection is not replaced.
    [-cq,--checkQuery <check-query>]

    [Dynamic change] Query (query-check) that checks the connection status. Simple selection queries are recommended when validating the connection to the DB.

    In order to undo this setting, enter "unset" as the option value.

    [-cqt,--checkQueryTimeout <check-query-timeout>]

    [Dynamic change] When a check-query is executed to check the connection status, a driver can be in the wait state indefinitely if the DB does not respond. Apply a timeout to the check-query to avoid this situation.

    This can be set by using the java.sql.Statement#setQueryTimeout method defined in the JDBC API.

    If the value is less than 1000ms, the value is set to 0. (Unit: ms)

    [-nvi,--nonValidationInterval <non-validation-interval>]

    [Dynamic change] Option to skip connection checks if the interval between the last check and the recent check is within the specified time period. This option is useful for when overhead is created by frequent connection checks. (Unit: ms)

    For example, if the option is set to 5000 ms, and 5 seconds has not passed since the last connection check, connections are sent to the applications without checking.

    [-cqp,--checkQueryPeriod <check-query-period>]

    [Dynamic change] Checks the connections in the connection pool at the specified interval to delete faulty connections. (Unit: ms)

    For data sources that belong to cluster data sources, this option must be set to be used for checking its own state.

    [-cqrc,--checkQueryRetrialCount <check-query-retrial-count>]

    [Dynamic change] If --destroyPolicyOnCheckQuery is set to FAILED_CONNECTION_ONLY, a connection check is performed only once.

    If --destroyPolicyOnCheckQuery is set to ALL_CONNECTIONS and a problem is detected during the first connection check, all other connections are also checked, resulting in the connection check being performed twice.

    The total connection check count is determined by adding this option value to the default connection check value.

    [-dpocq,--destroyPolicyOnCheckQuery <destroy-policy-on-check-query>]

    [Dynamic change] Policy for connections in the connection pool when invalid connections are found.

    • FAILED_CONNECTION_ONLY: Delete only invalid connections.

    • ALL_CONNECTIONS: Delete invalid connections and validate other connections in the connection pool. If another invalid connection is detected in the pool, delete all connections in the connection pool.

    [-scs,--stmtCachingSize <stmt-caching-size>]

    [Dynamic change] JDBC driver parses SQL statements sent as parameters whenever applications request prepared statements. Parsing SQL statements can affect system performance, so JEUS offers a function that internally caches the prepared statements. This option sets the number of prepared statements that can be cached. If this option is used, connections are always open, so the clear job performed by the driver is not executed.

    For example, when the Oracle JDBC driver sets auto-commit to false and closes the connection without executing commit or rollback, commit is executed unconditionally.

    The use of the statement caching function is recommended if provided by the JDBC driver.

    [-sfs,--stmtFetchSize <stmt-fetch-size>][Dynamic change] Fetch size of JDBC driver statement.
    [-ct,--connectionTrace <connection-trace>]

    [Dynamic change] Option to offer additional information for connections.

    • false: --getConnectionTrace and --autoCommitTrace cannot be used.

    [-gct,--getConnectionTrace <get-connection-trace>][Dynamic change] Displays the stack trace when the application calls java.sql.DataSource#getConnection.
    [-act,--autoCommitTrace <auto-commit-trace>][Dynamic change] Records logs and the stack trace to server logs when java.sql.Connection#setAutoCommit is called. The log level of jeus.jdbc.connection-trace logger must be set to FINE.
    [-ust,--useSqlTrace <use-sql-trace>]

    [Dynamic change] Displays SQL queries used by connections.

    If the jeus.jdbc.sql logger level is set to FINE, the SQL query history can be checked in server logs. If this function is used, the statement implementation class of the JDBC driver is wrapped by a JEUS class. Therefore, applications that cast and use statement objects of the JDBC driver cannot use this function.

    [-kcho,--keepConnectionHandleOpen <keep-connection-handle-open>]

    [Dynamic change] If this option is set to true and an XA connection is used and returned to the pool, the handle (or the logical connection) is kept open.

    This function is required when using DB2 universal drivers. If this option is used, connections are always open, so the clear job performed by the driver is not executed.

    For example, when the Oracle JDBC driver sets auto-commit to false and closes the connection without executing commit or rollback, commit is executed unconditionally.

    The use of the statement caching function is recommended if provided by the JDBC driver.

    [-en,--exportName <export-name>]

    JNDI name of the data source.

    If two data sources are guaranteed to be bound to different JNDIs on different servers, they can have the same JNDI name. Different data sources with the same JNDI names are not allowed on the same server.

    If not specified, the data source ID is used as the JNDI name. To undo this setting, enter "unset" as the option value.

    [-dscn,--dataSourceClassName <data-source-class-name>]JDBC driver data source class name. Enter the full name, including the package name.
    [-dst,--dataSourceType <data-source-type>]

    Data source type.

    • DATA_SOURCE: Connection pooling service is not provided.

    • CONNECTION_POOL_DATA_SOURCE: Connection pooling service is provided.

    • XA_DATA_SOURCE: XA interface and the connection pooling service are provided.

    [-vendor,--vendor <vendor>]

    JDBC driver vendor name.

    To undo this setting, enter "unset" as the option value.

    [-desc,--description <description>]

    Displays data source descriptions.

    To undo this setting, enter "unset" as the option value.

    [-sn,--serverName <server-name>]

    Host name or IP at which the database runs.

    To undo this setting, enter "unset" as the option value.

    [-pn,--portNumber <port-number>]

    Listener port number of the database.

    To undo this setting, enter "unset" as the option value.

    [-dn,--databaseName <database-name>]

    Database name. Sets the database SID (for Oracle).

    To undo this setting, enter "unset" as the option value.

    [-user,--user <user>]

    Database user ID. The user must have the proper permissions to handle transactions.

    To undo this setting, enter "unset" as the option value.

    [-pw,--password <password>]

    Database user password.

    To encrypt the password before storing, use the '{algorithm}ciphertext' format.

    To undo this setting, enter "unset" as the option value.

    [-lt,--loginTimeout <login-timeout>]Maximum time to wait for the login screen to connect to the database. (Unit: seconds)
    [-il,--isolationLevel <isolation-level>]

    Transaction isolation level defined in java.sql.Connection. If not specified, the default configuration of the JDBC driver is used.

    To undo this setting, enter "unset" as the option value.

    [-pdt,--poolDestroyTimeout <pool-destroy-timeout>]

    Period in which to wait for the connection pool destroy command to complete. (Unit: ms)

    The connection pool is destroyed when applications that defined the data sources are undeployed or when the server goes down. During this process, if the connection is used for network communication with the DB, the destroy process can be blocked and left hanging indefinitely. This option is used to avoid this situation. If this option is set, connection pool destruction waits the specified time period and then performs undeployment or server termination.

    [-prop,--property <property>]

    This option provides a unified configuration method to accommodate all property configurations that can differ by JDBC driver.

    For a single property, use the 'name:type=value' format.

    To specify multiple properties, separate each property with a comma (,).

    [-sxe,--supportXaEmulation <support-xa-emulation>]

    This option only applies to the connection pool data source type. This option emulates the connection pool data source connection to participate in a global transaction (XA).

    For JEUS 6 and earlier versions, this option is an alternative to LocalXADataSource. It is used in the ConnectionPoolDataSource type of connection pools.

    Note that only one connection pool data source can participate per transaction.

    [-ddba,--delegationDba <delegation-dba>]

    JNDI name of the data source (hereafter DBA delegation data source), which has permission to forcibly terminate database sessions (DBA permission). If there is a delay in handling a query through the connection received from the data source, a query that forcibly terminates the DB session is sent to the DB using the DBA delegation data source. After the application handles exceptions that occurred due to the disabled connection, it closes the connection. JEUS then deletes the connection and gets a new connection from the DB and assigns it to the connection pool.

    Currently, this function is supported for Tibero, Oracle, and Sybase. This function was created to suspend queries that take too long to perform for JDBC driver version 2.0 and earlier. For JDBC driver version 3.0 and later, it is recommended to use java.sql.Statement#setQueryTimeout instead of forcibly terminating DB sessions.

    Especially for XA data sources, if DB sessions are terminated while XA operates normally, the XA operation can generate an error. Therefore, use the statement query timeout and the transaction timeout properties.

    In order to undo this setting, enter "unset" as the option value.

    [-dbat,--dbaTimeout <dba-timeout>]

    The delegation DBA data source waits the specified time period for queries on a connection to finish. If timeout occurs, a query is sent to the DB that forcibly terminates the DB session.

    This option only applies when --delegationDba is set. (Unit: ms)

    [-cqc,--checkQueryClass <check-query-class>]

    Class name, which includes the package name, that implements the function for users or developers who want to customize the connection check function.

    The class must implement the jeus.jdbc.connectionpool.JEUSConnectionChecker interface.

    In order to undo this setting, enter "unset" as the option value.

    [-is,--initSql <init-sql>]

    SQL query that is initially handled after a connection has been created.

    In order to undo this setting, enter "unset" as the option value.

    [-f,--forceLock]Forcibly applies the configuration changes.
    [-detail]Displays the detailed results of the configuration changes.
  • Example

    [DAS]domain1.adminServer>modifyds -id ds1 -min 10 -max 50
    Successfully performed the MODIFY operation for configuration of the data source [ds1].
    Check the results using "modify-data-source -id ds1"

Displays a list of all data sources in the domain. If a data source ID is specified, its configuration is displayed in detail.

  • Aliases

    listds, lsds

  • Usage

    list-data-sources [-id,--dataSourceID <data-source-id>]
  • Parameters

    ParameterDescription
    [-id,--dataSourceID <data-source-id>]Data source ID.
  • Example

    [DAS]domain1.adminServer>lsds
    The list of data sources
    ================================================================================
    +----------------+----------------------+--------------------------------------+
    | Data source ID |   JNDI export name   |           Data source type           |
    +----------------+----------------------+--------------------------------------+
    | ds1            | ds1                  | ConnectionPoolDataSource             |
    | ds2            | ds2                  | ConnectionPoolDataSource             |
    | ds3            | ds3                  | ConnectionPoolDataSource             |
    +----------------+----------------------+--------------------------------------+
    ================================================================================
    
    [DAS]domain1.adminServer>lsds -id ds1
    The configuration of the data source [ds1]
    ================================================================================
    +----------------------------+-------------------------------------------------+
    |     Configuration name     |               Configuration value               |
    +----------------------------+-------------------------------------------------+
    | id                         | ds1                                             |
    | export-name                | ds1                                             |
    | data-source-class-name     | oracle.jdbc.pool.OracleConnectionPoolDataSource |
    | data-source-type           | ConnectionPoolDataSource                        |
    | vendor                     | oracle                                          |
    | server-name                | 61.77.153.4                                     |
    | port-number                |                                            1521 |
    | database-name              | orcl                                            |
    | user                       | scott                                           |
    | password                   | tiger                                           |
    | login-timeout              |                                               0 |
    | auto-commit                | DRIVER                                          |
    | stmt-query-timeout         |                                               0 |
    | pool-destroy-timeout       |                                           10000 |
    | property                   | [driverType;java.lang.String;thin]              |
    | action-on-connection-leak  | Warning                                         |
    | support-xa-emulation       | false                                           |
    | min                        |                                              10 |
    | max                        |                                              50 |
    | step                       |                                               1 |
    | period                     |                                         3600000 |
    | enable-wait                | false                                           |
    | wait-time                  |                                           10000 |
    | max-use-count              |                                               0 |
    | dbaTimeout                 |                                              -1 |
    | stmt-caching-size          |                                              -1 |
    | stmt-fetch-size            |                                              -1 |
    | connection-trace           | false                                           |
    | get-connection-trace       | true                                            |
    | auto-commit-trace          | false                                           |
    | use-sql-trace              | false                                           |
    | keep-connection-handle-open| false                                           |
    +----------------------------+-------------------------------------------------+
    ================================================================================

Dynamically adds a cluster data source to the domain.

  • Aliases

    addcds

  • Usage

    add-cluster-data-source [-id,--dataSourceID <data-source-id>]
                            [-en,--exportName <export-name>]
                            [-dss,--dataSourceSelector <data-source-selector>]
                            [-lb,--loadBalance <load-balance>]
                            [-ipc,--isPreConn <is-pre-conn>]
                            [-ufb,--useFailback <use-failback>]
                            [-cds,--componentDataSources <component-data-sources>]
                            [-f,--forceLock]
                            [-detail]
  • Parameters

    ParameterDescription
    [-id,--dataSourceID <data-source-id>]Data source ID. The data source ID must be unique within the domain.
    [-en,--exportName <export-name>]

    JNDI name of the cluster data source.

    If two data sources are guaranteed to be bound to different JNDIs on different servers, they can have the same JNDI name. Different data sources with the same JNDI names are not allowed on the same server.

    If not specified, the cluster data source ID is used as the JNDI name.

    [-dss,--dataSourceSelector <data-source-selector>]

    When obtaining connections from cluster data sources, users or developers can customize policies for a specific component data source selection by inheriting and implementing the jeus.jdbc.helper.DataSourceSelector abstract class. Next, the class name to include the implementation class package name must be set. After it is set, the Load Balance configuration is ignored, and failover and failback are performed unconditionally.

    • Failover is performed for one round, starting from the next index of the component data source that was initially selected.

    • Failback is performed in the same fashion as when Use Failback is set. The implementor must consider synchronization when defining the policy.

    [-lb,--loadBalance <load-balance>]

    Option to use load balancing.

    • true: The configurations --isPreConn and --useFailback are ignored.

    [-ipc,--isPreConn <is-pre-conn>]Option to create connection pools of component data sources that belong to the cluster data source, in advance. Although creating connection pools in advance can improve performance, it is not a good use of resources.
    [-ufb,--useFailback <use-failback>]

    Option to perform failback using the main data source after performing failover using the assistant data source. By default, failback is performed.

    This option provides compatibility with earlier versions of JEUS that only support failover.

    To perform failback, --checkQuery and --checkQueryPeriod must be set for the main data source.

    [-cds,--componentDataSources <component-data-sources>]Data source ID of the component data sources that belong to the cluster data source.
    [-f,--forceLock]Forcibly applies the configuration changes.
    [-detail]Displays detailed results of the configuration changes.
  • Example

    [DAS]domain1.adminServer>addcds -id cds1 -cds ds1,ds2
    Successfully performed the ADD operation for cluster data source [cds1] to domain.
    Check the results using "add-cluster-data-source"

Changes the configuration of a cluster data source. Most configurations can be changed dynamically.

  • Aliases

    modifycds

  • Usage

    modify-cluster-data-source -id,--dataSourceID <data-source-id>
                               [-en,--exportName <export-name>]
                               [-dss,--dataSourceSelector <data-source-selector>]
                               [-lb,--loadBalance <load-balance>]
                               [-ipc,--isPreConn <is-pre-conn>]
                               [-ufb,--useFailback <use-failback>]
                               [-cds,--componentDataSources <component-data-sources>]
                               [-f,--forceLock]
                               [-detail]
  • Parameters

    ParameterDescription
    -id,--dataSourceID <data-source-id>]

    Cluster data source ID.

    The cluster data source ID must be unique within a domain.

    [-en,--exportName <export-name>]

    JNDI name of the cluster data source.

    If two data sources are guaranteed to be bound to different JNDIs on different servers, they can have the same JNDI name. Different data sources with the same JNDI names are not allowed on the same server.

    If not specified, the cluster data source ID is used as the JNDI name. In order to undo this setting, enter "unset" as the option value.

    [-dss,--dataSourceSelector <data-source-selector>]

    [Dynamic change] When obtaining connections from cluster data sources, users or developers can customize policies for a specific component data source selection by inheriting and implementing the jeus.jdbc.helper.DataSourceSelector abstract class. Next, the class name to include the implementation class package name must be set. After it is set, the Load Balance configuration is ignored, and failover and failback are performed unconditionally.

    • Failover is performed for one round, starting from the next index of the component data source that was initially selected.

    • Failback is performed in the same fashion as when Use Failback is set. The implementor must consider synchronization when defining the policy.

    In order to undo this setting, enter "unset" as the option value.

    [-lb,--loadBalance <load-balance>]

    [Dynamic change] Option to use load balancing.

    • true: the configurations --isPreConn and --useFailback are ignored.

    [-ipc,--isPreConn <is-pre-conn>][Dynamic change] Option to create connection pools of component data sources that belong to the cluster data source, in advance. Although creating connection pools in advance can improve performance, it is not a good use of resources.
    [-ufb,--useFailback <use-failback>]

    [Dynamic change] Option to perform failback using the main data source after performing failover using the assistant data source. By default, failback is performed.

    This option provides compatibility with earlier versions of JEUS that only support failover.

    To perform failback, --checkQuery and --checkQueryPeriod must be set for the main data source.

    [-cds,--componentDataSources <component-data-sources>][Dynamic change] Data source ID of the component data sources that belong to the cluster data source.
    [-f,--forceLock]Forcibly applies the configuration changes.
    [-detail]Displays detailed results of the configuration changes.
  • Example

    [DAS]domain1.adminServer>modifycds -id cds1 -cds ds1 
    Successfully performed the MODIFY operation for configuration of the cluster data source [cds1].
    Check the results using "modify-cluster-data-source -id cds1"

Displays a list of all cluster data sources in the domain. If a data source ID is specified, its configuration is displayed in detail.

  • Aliases

    listcds, lscds

  • Usage

    list-cluster-data-sources [-id,--dataSourceID <data-source-id>]
  • Parameters

    ParameterDescription
    [-id,--dataSourceID <data-source-id>]Cluster data source ID.
  • Example

    [DAS]domain1.adminServer>lscds
    The list of cluster data sources
    ================================================================================
    +--------------------+-----------------------+---------------------------------+
    |   Data source ID   |    JNDI export name   |      Component data sources     |
    +--------------------+-----------------------+---------------------------------+
    | cds1               | cds1                  | [ds1, ds2]                      |
    | cds2               | cds2                  | [ds3, ds4]                      |
    +--------------------+-----------------------+---------------------------------+
    ================================================================================
    
    [DAS]domain1.adminServer>lscds -id cds1
    The configuration of cluster data source [cds1]
    ================================================================================
    +------------------------------------------+-----------------------------------+
    |            Configuration name            |        Configuration value        |
    +------------------------------------------+-----------------------------------+
    | id                                       | cds1                              |
    | export-name                              | cds1                              |
    | load-balance                             | false                             |
    | is-pre-conn                              | false                             |
    | use-failback                             | true                              |
    | component-data-sources                   | [ds1, ds2]                        |
    +------------------------------------------+-----------------------------------+
    ================================================================================

The following is a list of commands that monitor and control JDBC/JCA Connection pools.

CommandDescription
create-connection-poolCreates a JDBC connection pool. This does not apply to JCA connection pools.
enable-connection-poolActivates a JDBC connection pool. This does not apply to JCA connection pools.
disable-connection-poolDeactivates a JDBC connection pool. This does not apply to JCA connection pools.
refresh-connection-poolReplaces connections in the JDBC connection pool with new connections. This does not apply to JCA connection pools.
shrink-connection-poolReduces the number of connections in the JDBC connection pool to the minimum number. This does not apply to JCA connection pools.
control-connection-poolControls JDBC/JCA connection pools. This command can create, activate, deactivate, refresh, or shrink connection pools.
connection-pool-infoMonitors JDBC/JCA connection pools. If a connection pool ID is specified, its information is displayed in detail.
control-cluster-data-sourceControls cluster data sources. Displays a list of component data sources of cluster data sources or performs failback.

Controls JDBC/JCA connection pools. This command can create, activate, deactivate, refresh, or shrink connection pools.

  • Aliases

    controlcp, ctrlcp

  • Usage

    control-connection-pool -id <connection-pool-id> 
                            [-server <server-name>]
                            -enable | -shrink | -disable | -refresh | -create
  • Parameters

    ParameterDescription
    -id <connection-pool-id>Connection pool ID.
    [-server <server-name>]Server name.
    -enableActivates a connection pool.
    -shrinkReduces the number connections of connection pool to the minimum number of connections.
    -disableDeactivates a connection pool.
    -refreshReplaces connections in the connection pool with new connections.
    -createCreates a connection pool.
  • Example

    [DAS]domain1.adminServer>ctrlcp -id ds1 -server server1 -enable
    Servers that successfully enabled a connection pool : server1
    Servers that failed to enable a connection pool : none.
    
    [DAS]domain1.adminServer>ctrlcp -id ds1 -server server1 -shrink
    Servers that successfully shrank a connection pool : server1
    Servers that failed to shrink a connection pool : none.
    
    [DAS]domain1.adminServer>ctrlcp -id ds1 -server server1 -disable
    Servers that successfully disabled a connection pool : server1
    Servers that failed to disable a connection pool : none.
    
    [DAS]domain1.adminServer>ctrlcp -id ds1 -server server1 -refresh
    Servers that successfully refreshed a connection pool : server1
    Servers that failed to refresh a connection pool : none.
    
    [DAS]domain1.adminServer>ctrlcp -id ds1 -server server1 -create
    Servers that successfully created a connection pool : server1
    Servers that failed to create a connection pool : none.

Monitors JDBC/JCA connection pools. If a connection pool ID is specified, its information is displayed in detail.

  • Aliases

    cpinfo

  • Usage

    connection-pool-info -server <server-name>
                         [-id <connection-pool-id>]
                         [-jca | -jdbc]
                         [-jndi]
                         [-active]
                         [-t]
                         [-stmt]
  • Parameters

    ParameterDescription
    -server <server-name>Server name
    [-id <connection-pool-id>]Connection pool ID.
    [-jca]Displays only JCA connection pool information.
    [-jdbc]Displays only JDBC connection pool information.
    [-jndi]Displays the JNDI name of the connection pool.
    [-active]Displays the created connection pools on the server.
    [-t]

    Displays the name of the thread that most recently used the connection.

    This parameter requires the -id parameter to be used.

    [-stmt]Statement cache information by each connection.
  • Example

    [DAS]domain1.adminServer>cpinfo -server server1 -jndi -jdbc
    The connection pool information on the server [server1].
    ================================================================================
    +------------+------------+-----+-----+-----+------+--------+-----+-----+------+
    | Connection | JNDI export| Min | Max | Acti| Idle | Disposa|Total| Wait| Enabl|
    |  Pool ID   |    name    |     |     | ve  |      |  ble   |     |     |  ed  |
    +------------+------------+-----+-----+-----+------+--------+-----+-----+------+
    | ds1        | ds1        |   2 |  30 |   0 |    2 |      0 |   2 |false| true |
    +------------+------------+-----+-----+-----+------+--------+-----+-----+------+
    | ds2 *      | ds2        |   2 |  30 |   0 |    0 |      0 |   0 |false| false|
    +------------+------------+-----+-----+-----+------+--------+-----+-----+------+
    
    * : has not been created, total = active + idle + disposable
    ================================================================================
    
    [DAS]domain1.adminServer>cpinfo -server server1 -id ds1 -t -jdbc 
    Information about connections in the server [server1]'s connection pool [ds1].
    ================================================================================
    +---------------+-------+-------------------+-----------+--------+-------------+
    | Connection ID | State |  State time(sec.) | Use count |  Type  | Thread name |
    +---------------+-------+-------------------+-----------+--------+-------------+
    | ds1-1         | active|          1105.954 |         1 | pooled | http-w1     |
    | ds1-2         | idle  |          1105.923 |         0 | pooled |             |
    +---------------+-------+-------------------+-----------+--------+-------------+
    ================================================================================
    
    [DAS]domain1.adminServer>cpinfo -server server1 -id ds1 -stmt -jdbc
    Information about statement caches in the server [server1]'s connection pool [ds1].
    ================================================================================
    +--------------+-----------+--------+---------+--------+-----------+-----------+
    | Connection ID|   Access  |   Hit  |   Miss  |   Add  |   Remove  |  Current  |
    |              |   Count   | Count  |  Count  | Count  |   Count   |   Size    |
    +--------------+-----------+--------+---------+--------+-----------+-----------+
    | ds1-1        |         5 |      0 |       5 |      5 |         0 |         5 |
    +--------------+-----------+--------+---------+--------+-----------+-----------+
    | ds1-2        |         5 |      2 |       3 |      3 |         0 |         3 |
    +--------------+-----------+--------+---------+--------+-----------+-----------+
    ================================================================================

The following is a list of transaction commands.

CommandDescription
modify-transaction-managerChanges the configuration of the transaction manager of a server.
recover-transactionsRecovers the resource manager of a server. Resources to be recovered can be selected.
show-transaction-managerChecks the configuration of the transaction manager of a server.
transaction-infoChecks the transaction by its status on a server.

Changes the configuration of the transaction manager of a server.

  • Aliases

    modify-tm, modifytm, tmconfig, tmconf

  • Usage

    modify-transaction-manager <server-name>
                        [-at,--activeTimeout <active timeout>]
                        [-pt,--prepareTimeout <prepare timeout>]
                        [-pdt,--preparedTimeout <prepared timeout>]
                        [-ct,--commitTimeout <commit timeout>]
                        [-rt,--recoveryTimeout <recovery timeout>]
                        [-ut,--uncompletedTimeout <uncompleted timeout>]
                        [-d,--txLogDir <transaction log directory>]
                        [-a,--automaticRecovery <automatic recovery enable/disable>]
                        [-f,--forceLock]
                        [-detail]
  • Parameters

    ParameterDescription
    <server-name>Name of the server for which the transaction configuration is changed.
    [-at,--activeTimeout <active timeout>]Period in which to commit when starting a transaction. If timeout occurs, the transaction is forcibly rolled back.
    [-pt,--prepareTimeout <prepare timeout>]Period in which the root coordinator receives a response from a sub-coordinator after sending the prepare command.
    [-pdt,--preparedTimeout <prepared timeout>]Period in which the sub-coordinator waits for global decisions from the root coordinator after sending the prepare response.
    [-ct,--commitTimeout <commit timeout>]Period in which the root coordinator receives a response after sending the commit command to a sub-coordinator.
    [-rt,--recoveryTimeout <recovery timeout>]Period in which to receive the recovery information. If timeout occurs, the recovery is delegated to the user.
    [-ut,--uncompletedTimeout <uncompleted timeout>]Period in which incomplete transactions recover. If timeout occurs, incomplete transactions are deleted.
    [-d,--txLogDir <transaction log directory>]Directory that stores transactions for recovery. For more information, refer toJEUS Server Guide. "7.5.2. Recovery Related Log File".
    [-a,--automaticRecovery <automatic recovery enable/disable>][Dynamic changes] Option to let another server recover incomplete transactions when an error occurs in the server. For more information, refer to JEUS Server Guide. "7.5. Transaction Recovery".
    [-f,--forceLock]Forcibly applies the configuration changes.
    [-detail]Displays detailed results of the configuration changes.
  • Example

    • Check the current configuration.

      [DAS]domain1.adminServer>modify-transaction-manager server1
      Shows the current configuration.
      transaction of server (server1)
      ================================================================================
      +---------------------+--------------------------------------------------------+
      | Active Timeout      | 600000                                                 |
      | Prepare Timeout     | 120000                                                 |
      | Prepared Timeout    | 60000                                                  |
      | Commit Timeout      | 240000                                                 |
      | Recovery Timeout    | 120000                                                 |
      | Uncompleted Timeout | 86400000                                               |
      | Tx Log Dir          | ${SERVER_HOME}/.workspace/tmlog                        | 
      | Automatic Recovery  | false                                                  |
      +---------------------+--------------------------------------------------------+
      ================================================================================
    • Dynamically turn on the transaction auto-recovery function.

      [DAS]domain1.adminServer>modify-transaction-manager server1 -automaticRecovery true 
      Successfully performed the MODIFY operation for transaction of server (server1).
      Check the results using "show-transaction-manager server1 or modify-transaction-manager server1"
    • Change the timeout configuration that applies when the server reboots.

      [DAS]domain1.adminServer>modify-transaction-manager server1 -activeTimeout 20000
      Successfully performed the MODIFY operation for transaction of server (server1), but all changes were non-dynamic. They will be applied after restarting.
      Check the results using "show-transaction-manager server1 or modify-transaction-manager server1"
    • Change the configuration that allows dynamic changes and the configuration that applies when the server reboots.

      [DAS]domain1.adminServer>modify-transaction-manager server1 -automaticRecovery true -activeTimeout 20000
      Successfully performed the MODIFY operation for transaction of server (server1), but some changes were non-dynamic. They will be applied after restarting.
      Check the results using "show-transaction-manager server1 or modify-transaction-manager server1" 

Checks the transaction by its status on a server.

  • Aliases

    transactioninfo, txinfo

  • Usage

    transaction-info -server <server-name>
                     [-i,--inflight]
                     [-d,--indoubt]
                     [-r,--retrying]
  • Parameters

    ParameterDescription
    -server <server-name>Server name.
    [-i,--inflight]Checks the running transactions, transactions in the memory that have not reached the commit or rollback step.
    [-d,--indoubt]Checks the incomplete transactions, transactions that require recovery or that have undetermined status.
    [-r,--retrying]Checks the transactions to be retried within JEUS because one-phase-commit or two-phase-commit was not successfully performed due to problems with the resource manager.
  • Example

    [DAS]domain1.adminServer>transaction-info -server server1
    <transactions of server1>
    
    In-Flight Transaction Information
    ================================================================================
    +------------------+---------+-------+--------+---------+---------+------------+
    |        XID       | Coordina| Extern| Status | Timeout |  Elapse | XAResources|
    |                  |   tor   |al XID |        |         |         |            |
    +------------------+---------+-------+--------+---------+---------+------------+
    | 049FE5.00C0A80011| 192.168.|       | STATUS | 5000(ms)| 7418(ms)| jdbc/derby/|
    |2608221CC3D6B40000|0.17:9736|       |_MARKED_|         |         |XADataSource|
    |000000000011.00   |         |       |ROLLBACK|         |         |            |
    +------------------+---------+-------+--------+---------+---------+------------+
    ================================================================================
    
    In-doubt Transaction Information
    ==========================================================================
    +----+----------------+--------------------+-------+------------+--------+
    | XID|   Coordinator  |    External XID    | Status|  Decision  | Sub-XID|
    +----+----------------+--------------------+-------+------------+--------+
    (No data available)
    ==========================================================================
    
    Retrying Transaction Information
    =============================================================
    +----+-----+------------------------------+-------+---------+
    | XID| Name|        Failure Count         | Status| Decision|
    +----+-----+------------------------------+-------+---------+
    (No data available)
    =============================================================

The following is a list of security commands for user, group, and policy.

  • User management commands

    User management commands are used to add, change, and delete users.

    CommandDescription
    add-userAdds a new user to the security system.
    remove-userDeletes a user from the current domain.
    list-user-namesDisplays a list of all users (user names) that logged onto the current domain and the lock state of each user.
    show-userDisplays detailed user information.
    set-passwordSets the user password.
    lock-userLocks a user.
    unlock-userReleases a lock on a user.
  • Group management commands

    Group management commands are used to add, update, or delete groups.

    CommandDescription
    add-goupAdds a new group to the security system.
    add-user-to-groupAdds a new member to a group registered with the security system.
    remove-user-from-groupDeletes a user from a group in the current domain.
    remove-groupDeletes a group.
    list-group-namesDisplays a list of groups of the security system.
    show-groupDisplays detailed group information.
    check-group-memberChecks if the user is registered with a group.
  • Policy management commands

    Policy commands are used to manage security system policies, add or delete principal-role mappings or role-resource mappings, and manage the overall policy associated with authorization checks of the security system.

    CommandDescription
    show-policyDisplays policies that include a context ID.
    assign-roleAssigns a role to a principal.
    unassign-roleDeletes a role from a principal.
    assign-resourceAssigns a resource and action to a role.
    unassign-resourceDeletes a resource from a role.

Caution

Due to the sensitive nature of the information processed by these commands, the user must have proper permissions.

Releases a lock on a user set by the lock-user command.

  • Aliases

    unlockuser

  • Usage

    unlock-user <user-name>  
               [-domain <domain-name>]
  • Parameter

    ParameterDescription
    <user-name>User name.
  • Example

    [DAS]domain1.adminServer> unlock-user user2
    The user [user2] has been successfully unlocked.

Adds a new group to the security system. The group name must be unique within the current domain. Domain names can be checked using the list-group-names command. The group name is used to refer to a specific group during the calling process, it corresponds to the ID of the group.

  • Aliases

    addgroup

  • Usage

    add-group <group-name>
             [-domain <domain-name>]
             [-f,--force]
  • Parameters

    ParameterDescription
    <group-name>Group name.
    [-f,--force]Forcibly applies the configuration changes.
  • Example

    [DAS]domain1.adminServer> add-group group1
    The group [group1] has been successfully added.

Assigns a resource and action to a role.

  • Aliases

    assignresource, assignres

  • Usage

    assign-resource <role-name> 
                    <resource-name>
                    [-actions <actions>]
                    [-contextid <context-id>]
                    [-classname <classname>]
                    [-domain <domain-name>]
                    [-f,--force]
  • Parameters

    ParameterDescription
    <role-name>Role name.
    <resource-name>Resource name. Resource names are Java class names that represent the resource. E.g., jeus.server.
    -actions <actions>

    Actions assigned to the role.

    A list of actions for a resource. Each action is separated by a blank space. For example, the jeus.server resource has "boot" and "down" as its actions.

    If -actions is set, actions are the second parameter of the constructor of the class configured with -classname. The default class name is jeus.security.resource.ResourcePermission, and its constructor parameters are "resource" and "actions".

    [-contextid <context-id>]Context name that distinguishes policies. The contextID is used to specify a context other than the default context.
    [-classname <classname>]

    Permission class name.

    A class configured with -classname must be a Java class that extends the class java.security.Permission abstract. The class must have at least one constructor that receives a string type "role" as an argument.

    For more information about resource permissions, refer to the jeus.security.resource.ResourcePermission class.

    For more information about which resource permissions are checked in JEUS, refer to JEUS Security Guide. fer.

    [-f,--force]Forcibly applies the configuration changes.
  • Example

    [DAS]domain1.adminServer> assign-resource deployRole jeus.* -actions deploy-applications
    The resource [jeus.*] is assigned to the role [deployRole].

This section describes node management commands. A node is a JEUS installation on a machine. The commands are used to manage a remote server from the DAS (Domain Administrator Server) so they can only be accessed through the DAS. For more information, refer to "JEUS Node Manager Guide".

The following is a list of node management commands.

CommandDescription
add-java-nodeAdds a new Java node.
add-ssh-nodeAdds a new SSH node.
apply-patchApplies a patch to a specified node.
check-jeus-installedChecks if JEUS is installed on a node.
check-ssh-nodeChecks if the SSH node is configured properly.
install-jeusInstalls JEUS, including the current domain configuration, on a node.
list-nodesDisplays a list of nodes
modify-java-nodeChanges the configuration of a Java node.
modify-nodeChanges the configuration of a node.
modify-ssh-nodeChanges the configuration of a SSH node.
patch-infoDisplays the information of the patches applied on the node.
remove-nodeDeletes a node.
remove-patchDeletes a patch applied to the specified node.
show-nodeDisplays node information and a list of servers mapped to the node.
uninstall-jeusUninstalls JEUS from a node.

Adds a new SSH node. Input proper values for each options to access SSH. The check-ssh-node command is used to check the access to SSH. The SSH node can be changed using the modify-ssh-node command.

  • Aliases

    addsshnode

  • Usage

    add-ssh-node <node-name> 
                 -host <host-name>  
                 [-dir <install-dir> ]
                 [-port <port-number> ] 
                 [-user <user-name> ] 
                 [-privatekey <file-path> ]
  • Parameters

    ParameterDescription
    <node-name>Node name to be added. The name must be unique because it is used as ID.
    -host <host-name>Host address of the remote node.
    [-dir <install-dir>]JEUS installation directory of the remote node.
    [-port <port-number>]SSH access port (Default value: Port 22)
    [-user <user-name>]SSH access user name.
    [-privatekey <file-path>]Path to the private key file used for SSH access.
  • Example

    [DAS]domain1.adminServer> add-ssh-node node1 -host 192.168.34.55 -dir /home/sshU
    ser/jeus -user sshUser
    The node [node1] was successfully added.

Displays node information and a list of servers mapped to the node.

The default SSH node information can be changed using the modify-ssh-node command. The information about servers mapped to the node can be changed using the modify-server command.

  • Aliases

    shownode, nodeinfo

  • Usage

    show-node <node-name>
  • Parameters

    ParameterDescription
    <node-name>Node name.
  • Example

    [DAS]domain1.adminServer> show-node node1
    ================================================================================
    +------------------+-----------------------------------------------------------+
    |     Property     |                           Value                           |
    +------------------+-----------------------------------------------------------+
    | Node Name        | node1                                                     |
    | Host             | 192.168.34.55                                             |
    | Mapped Servers   | adminServer server1                                       |
    | Node Type        | JAVA                                                      |
    | NodeManager Port |                                                      7730 |
    | Use SSL          | false                                                     |
    +------------------+-----------------------------------------------------------+
    ================================================================================
    

This section describes the commands available when accessing the node manager. A node is a JEUS installation on a machine. The status of a server can be checked by accessing the Java type node manager. For more information about the Java type node manager, refer to JEUS Node Manager Guide. "JEUS Node Manager Guide".

The following is a list of node management commands.

CommandDescription
connect-nodemanagerAccesses the node manager.
disconnect-nodemanagerDisconnects from the node manager. This command can only be used when connected to the node manager.
nm-start-serverStarts a server through the node manager. This command can only be used when connected to the node manager.
nm-state-serverChecks and displays the state of a server started through the node manager. This command can only be used when connected to the node manager.
nm-stop-serverTerminates a server started through the node manager. This command can only be used when connected to the node manager.
stop-nodemanagerTerminates the node manager. This command can only be used when connected to the node manager.

Starts a server through the node manager.

  • Aliases

    nmstart, nmstartserver

  • Usage

    nm-start-server [-domain <domain-name>]
                    -server <server-name>
                    -u,--user <user-name>
                    -p,--password <password>
                    [-dasurl <dasurl>]
                    [-f,--force]
                    [-s,--standby]
                    [-host <nm-host>]
                    [-port <nm-port>]
                    [-t,--type <connect-type>]
                    [-ts,--truststoreFile <truststore-file>]
                    [-tsp,--truststorePass <truststore-password>]
  • Parameter

    ParameterDescription
    [-domain <domain-name>]Domain name to which the server to be started belongs.
    -server <server-name>Server name to be started.
    -u,--user <user-name>Account information required to start the server.
    -p,--password <password>Password of the account required to start the server.
    [-dasurl <dasurl>]URL information of DAS, which is required to start MS.
    [-f, --force]Sets MS to the RUNNING state, even if application deployment failed when starting MS.
    [-s, --standby]Sets MS to the STANDBY state.
    [-host <nm-host>]If the node manager is not connected, the host information of the node manager can be given as an option to access the node manager to start the server.
    [-port <nm-port>]If the node manager is not connected, the port information of the node manager can be given as an option to access the node manager to start the server.
    [-t --type <connect-type>]

    Option to use SSL when accessing a node manager.

    Input options:

    • ssl

    • plain (Default value)

    [-ts,--truststoreFile <truststore-file>]Path to the truststore file when SSL is used.
    [-tsp,--truststorePass <truststore-password>]Password of the truststore file when SSL is used.
  • Example

    [NodeManager]domain1>nm-start-server -server server1 -u jeus -p jeus
    succeed to start server[server1].
      RUNNING
  • Note

    This command can be used without being connected to the server.

Starting from JEUS v7.0 Fix#1, commands can be executed using JSON.

If a JSON message, which requests command execution, is sent as a HTTP POST request to a server, the server handles the request and then sends a JSON message, which contains the result, as the HTTP response.

The following is a command used as an example in this section.

serverinfo -server server1 -state

The following is the process of executing a command using JSON.

  1. Create a JSON message that executes a command.

    The following is a JSON message that executes the example command.

    {
        "jeusadmin": {
            "command": "server-info",
            "options":[
                "-server server1",
                "-state"
                ],
            "argument": null
        }
    }
    ClassificationDescription
    commandName of the command to be executed.
    optionsOptions and parameters of the command.
    argumentArguments of the command.
  2. Send the JSON message to the server to request command execution. Set HTTP as the protocol and POST as the method.

    The following is a URL that receives requests for executing JSON messages in JEUS.

    http://${SERVER_HOST}:${SERVER_BASE_PORT}/jsonCommand/command.json

    Note

    To execute a command on a JEUS server, user authentication is required. Use HTTP Basic Authentication for user authentication.

  3. The server interprets and executes the JSON message. The JSON result message is then sent as a HTTP response. The execution result differs depending on the individual command.

    The following is an example of a result that can be received as a server response. The result may change according to the JEUS domain configuration.

    {
        "jeusadmin-result": {
            "message":"",
            "data":[
                {
                    "title":"Information of Domain (domain1)",
                    "header":null,
                    "column-names":[
                        "Server","Status","Node Name","PID","Cluster",
                        "Latest StartTime/ShutdownTime","Need to Restart",
                        "Listen Ports"
                    ],
                    "rows":[
                        {
                            "row-key":"0",
                            "values":[
                                "server1(*)","RUNNING (284sec)","N/A","2151","N/A", 
                                ... (생략)
                            ]
                        }
                    ],
                    "footer":null
                }
            [,
            "post-message":""
        }
    }     

    The following comprise a JSON result message.

    • message

      Message displayed at the top. If there are multiple messages, a list of messages is displayed. Depending on the command, a message may not exist.

    • data

      Object that contains the execution result. Depending on the command, an object may not exist. A table is a regular data structure and comprised of the following.

      ClassificationDescription
      titleTable title.
      headerTable header.
      column-namesTable column names.
      rows

      Table rows.

      A row is comprised of two elements.

      • row-key: Row name.

      • values: Row value.

      footerTable footer.
    • post-message

      Message displayed at the bottom. If there are multiple post-messages, a list is displayed. Depending on the command, a message may not exist.

This section describes how to install and distribute an application using JSON. Unlike other commands, to install or distribute an application, the application must be sent along with the JSON message.

The following describes the process of installing or distributing an application using JSON.

  1. Create a JSON message that requests command execution. The following is the command used to distribute the Hello.war application to 'server1'.

    {
        "jeusadmin": {
            "command": "deploy-application",
            "options":[
                "-servers server1",
                "-path Hello.war"
                ],
            "argument": null
        }
    }
  2. Send the written JSON message and files as a multi-part type to the server to request command execution. Multi-part consists of a command part, which contains the JSON command written in the step 1, and a file part, which sets the application archive to be distributed.

    The following is a URL that receives application deployment requests using a JSON message in the JEUS server.

    http://${SERVER_HOST}:${SERVER_BASE_PORT}/jsonCommand/install.json

    Important

    To execute a command on a JEUS server, user authentication is required. Use HTTP Basic Authentication for user authentication.

  3. The server interprets and executes the JSON message. The JSON result message is then sent as a HTTP response. This part is same as executing regular commands. For more information, refer to "4.2.16.1. Executing Regular Commands".

This section describes the application compiler that compiles EJB interface impl, skeleton, stub classes, and the servlet classes and web service endpoint classes created by compiling JSP.

This tool may be selectively used to compile EJB 2.1 interface impl, RMI stub, skeleton classes, and the JSP of a web module to create servlet classes in advance. EJB that only consists of EJB 3 interfaces, JAX-WS clients, and server applications do not need to use this tool.

This tool is useful in the following cases:

  1. When there are many beans that conform to EJB 2.x standards, and the initial deployment period is long.

  2. When JSP must be precompiled because JSP compilation time is a large portion of the service time.

For EJB 2.x modules, the fast-deploy configuration must be set or the [-fast] option must be added to the deploy command of the jeusadmin console tool when deploying applications. If the fast-deploy option is set to true, the appcompiler can be prevented from automatically executing when deploying modules at runtime. If the fast-deploy option is set, impl, skeleton, and stub classes are not compiled and pre-created classes are used to decrease the deployment time.

The appcompiler tool consists of the 'Each' mode and the 'Batch' mode. The 'Each' mode creates a file and then compiles it separately, while the 'Batch' mode creates all files first and then compiles them all at once. In the 'Batch' mode, the processing speed is faster than in the 'Each' mode; however, in 'Batch' mode, if an error occurs during compilation, the debugging is much more difficult.

'Each' is the default mode. To use the 'Batch' mode, use the [-batch] option or set jeus.app.compiler.mode=batch. However, the 'Batch' mode only applies to EJB 2.x modules.

Warning

When executing appcompiler for WAR files on Windows, the temporary directory may not be deleted because java.net.URLClassLoader cannot explicitly close the WEB-INF/lib/*.jar files included in a WAR file. Starting from Java 7, a close method for java.net.URLClassLoader is provided, so later versions do not generate this error. Currently, the temporary directories must be deleted manually.

The following describes tool parameters and how to use them. Examples are given.

  • Usage

    appcompiler [-h] 
                [-verbose] 
                [-clp <class-path>]
                [-keep] 
                [-jspmap] 
                [-batch] 
                [-q]
                [-client <clientview_filename>]
                [-noaddfile] 
                [-deloldgen]
                [-ejbjar <ejb-jar.xml_path>]
                [-jeusejbdd <jeus-ejb-dd.xml_path>]
                [-D <property=value>]
                [-property <file-name>]
                [-target <application-path>]
                [-j concurrency-level]
                [-ejbonly]
                [-webonly]
    
  • Parameters

    ParameterDescription
    [-h]Displays appcompiler help information.
    [-verbose]Sets the verbose mode, which displays detailed process information (Sets the log level to FINEST).
    [-clp]Registers libraries required for compilation as class paths. A file or directory can be specified. To specify multiple items, separate each item with a semicolon (;) in Windows or a colon (:) in UNIX.
    [-keep]Option to keep the source code created during compilation.
    [-jspmap]Option to create a servlet-mapping table (jeus_jspmap.xml). If this option is used, the name of the directory that contains JSP files cannot include Java reserved words. E.g., enum, class, etc.
    [-batch]

    Sets the batch mode, which creates all files and then compiles them all at once.

    If this option is not set, the 'each' mode is used, which creates a file and then compiles it. This option only applies to EJB 2.x modules.

    [-q]

    When compiling an EAR application that contains multiple modules, if a web module fails to compile, the compilation process stops immediately and error messages are displayed. If this option is not set and a web module fails to compile, error messages are displayed but the compilation process proceeds with the remaining modules.

    [-client <clientview_filename>]

    Name of the clientview file that contains new stub and interface classes.

    • <clientview_filename> supports only JAR files, an EJB archived file type. The clientview file is created in the same directory as the archived or exploded applications, which are to be compiled. This option applies to standalone EJB modules and EAR applications that contain EJB modules.

    • If <clientview_filename> is the same as <application_file_or_directory_name>, it is not supported.

    • If a file with the same name as <clientview_filename> exists, include the clientview interface classes and stub classes in the file. The clientview file is provided to the client to develop applications that use EJB installed on the server.

    [-noaddfile]

    This option is only valid when used with the [-client] option. -noaddfile creates a clientview file, however, the target files are not compiled and the original files are maintained.

    For example, when appcompiler is used for calc.jar, the -client option is used to create the clientview file. The clientview file contains stubs and remote and home interface classes. Before creating the clientview file, compile the calc.jar file. The compiled file includes class files, such as impl, skeleton, and stub files created during the compilation. To create a clientview file without compiling calc.jar, the [-noaddfile] option can be used.

    [-deloldgen]

    When compiling an EJB module, the compilation is executed after the impl, skel, and stub files created by the previous version of JEUS are deleted.

    [Note]

    Setting the name of impl, skel, and stub classes in JEUS 4 and JEUS 5 is different from that in JEUS 7. If an EJB module, created in JEUS 4 or JEUS 5, is compiled using the JEUS 7 appcompiler, the impl, skel, and stub files created in JEUS 4 or JEUS 5 can cause EJB to run abnormally. This parameter is used to prevent this problem.

    [-ejbjar <ejb-jar.xml_path>]ejb-jar.xml file to be used for compilation.
    [-jeusejbdd <jeus-ejb-dd.xml_path> ]jeus-ejb-dd.xml file to be used for compilation.
    [-D <property=value>]Specifies a system property. This option can be used more than once.
    [-property <file-name>]File name that contains system properties to be set.
    [-target <application-path>]

    File (archived ear, jar, war) or directory (exploded EAR, JAR, WAR) of the target application to be compiled.

    EAR, standalone JAR, and WAR are regarded as applications. impl, skel, and stub class files created during compilation are added to the target application files.

    [-j concurrency-level]This option is used when compiling JSP files. If there is a large number of JSP files, set this option to perform compilation using multiple threads concurrently. (Default value: 1)
    [-ejbonly]Compile only EJB modules in EAR.
    [-webonly]Compile only Web modules in EAR.
  • Example

    appcompiler is a regular script file located in the JEUS_HOME/bin/ directory.

    • The following command creates a home and remote interface, impl, skel, and stub classes of the "ejb.jar" module. The command also includes the files in the ejb.jar file.

      $ appcompiler ejb.jar
    • The following command creates servlet classes from all JSP files of the web.war module and includes them in the war file.

      $ appcompiler web.war
    • The following command compiles modules in batch mode.

      $ appcompiler -batch app.jar
    • The following command creates a home and remote interface, impl, skel, and stub classes of the "ejb.jar" module. The command also includes the files in the ejb.jar file, and creates the clientview.jar file, which contains the home and remote interfaces and the created stub classes.

      $ appcompiler -client clientview.jar ejb.jar

This section explains how to automatically create the JEUS EJB DD file (jeus-ejb-dd.xml), using the information in the ejb-jar.xml file and previously created property files.

The properties required to deploy EJB can be set as default values, so the JEUS EJB DD file is not required. Although the JEUS EJB DD file is not necessary to create a new EJB, it can be used to create an application or to easily create templates to migrate applications to JEUS.

Note

Currently, only ejbddinit is provided to create JEUS EJB DD. However, tools for creating JEUS WEB DD are scheduled for release. The annotation-based method in Java EE 6 is not supported since it can be configured within the source files.

The following describes how to use the tool and parameters. Examples are provided.

  • Usage

    ejbddinit [-property property_file_path]
              [-level log_level]
              [-source application_file_or_directory_name]
  • Parameters

    ParameterDescription
    [-property property_file_path]

    Path to the property files. This option is required to the create the jeus-ejb-dd.xml file correctly. Values can be set by mapping properties to JEUS EJB DD tags. For more information about the list of configurable properties, refer toSection 4.4, “List of properties”.

    • Ex) export-port=40001

      Creates the jeus-ejb-dd.xml file and sets export-port to 40001 for all EJBs.

    • Ex) SampleBean.export-port=40004

      Creates the jeus-ejb-dd.xml file and sets export-port to 40004 for the EJB with a name of SampleBean in the ejb.jar file. By placing a dot(.) separator before each property name, the property of a specific EJB can be set. If the same property exists in a EJB, the property that names a specified EJB has higher property.

    [-level log_level]Log level displayed on the screen when executing ejbddinit.
    [-source application_file_or_directory_name]

    Path to the EJB modules. The EJB module can be a directory or a compressed file with the .jar extension.

    If a JEUS EJB DD file is successfully created and the EJB module is a directory, the jeuc-ejb-dd.xml file is created under the META-INF folder. If the EJB module is a compressed file, a new compressed file with the ".new" extension, added to the original file name, is created. The jeus-ejb-dd.xml file is also created under the META-INF folder within the compressed file.

List of properties

The following is a list of properties supported by ejbddinit. Refer to the descriptions of the corresponding jeus-ejb-dd.xml tags for property details.

[Table 4.1] ejbddinit property

PropertyTypeNote
sourceStringPath to EJB modules. This is not related to the jeus-ejb-dd.xml tags.
logging-levelStringLog level displayed when ejbddinit is executed. This is not related to jeus-ejb-dd.xml tags.
export-nameStringCorresponds to the <export-name> tag of jeus-ejb-dd.xml. This property is recommended only for specific EJBs. For more information, refer to Supported patterns for export-name property.
local-export-nameStringCorresponds to the <local-export-name> tag of jeus-ejb-dd.xml. This property is recommended only for specific EJBs.
export-portint (not negative)Corresponds to the <export-port> tag of jeus-ejb-dd.xml.
export-iiopbooleanCorresponds to the <export-iiop> tag of jeus-ejb-dd.xml.
thread-maxint (not negative)Corresponds to the <thread-max> tag of jeus-ejb-dd.xml.
bean-pool-minint (not negative)Corresponds to the <bean-pool>/<pool-min> tag of jeus-ejb-dd.xml.
bean-pool-maxint (not negative)Corresponds to the <bean-pool>/<pool-max> tag of jeus-ejb-dd.xml.
connect-pool-minint (not negative)Corresponds to the <connect-pool>/<pool-min> tag of jeus-ejb-dd.xml.
connect-pool-maxint (not negative)Corresponds to the <connect-pool>/<pool-max> tag of jeus-ejb-dd.xml.
capacityint (not negative)Corresponds to the <capacity> tag of jeus-ejb-dd.xml.
passivation-timeoutlong (not negative or -1 for disable)Corresponds to the <passivation-timeout> tag of jeus-ejb-dd.xml.
disconnect-timeoutlong (not negative or -1 for disable)Corresponds to the <disconnect-timeout> tag of jeus-ejb-dd.xml.
engine-typeString (defined)

Corresponds to the <engine-type> tag of jeus-ejb-dd.xml.

Input options:

  • EXCLUSIVE_ACCESS

  • SINGLE_OBJECT

  • MULTIPLE_OBJECT

subengine-typeString (defined)

Corresponds to the <subengine-type> tag of jeus-ejb-dd.xml.

Input options:

  • ReadLocking

  • WriteLocking

  • WriteLockingFind

fetch-sizeint (not negative)Corresponds to the <fetch-size> tag of jeus-ejb-dd.xml.
init-cachingbooleanCorresponds to the <init-caching> tag of jeus-ejb-dd.xml.
table-nameStringCorresponds to the <table-name> tag of jeus-ejb-dd.xml.
creating-tableString (defined)

Corresponds to the <creating-table> tag of jeus-ejb-dd.xml.

Input options:

  • none

  • use-existing

  • force-create

deleting-tablebooleanCorresponds to the <deleting-table> tag of jeus-ejb-dd.xml.
db-vendorStringCorresponds to the <db-vendor> tag of jeus-ejb-dd.xml.
datasource-nameStringCorresponds to the <data-source-name> tag of jeus-ejb-dd.xml.
enable-instant-qlbooleanCorresponds to the <enable-instant-ql> tag of jeus-ejb-dd.xml.

Supported patterns for the export-name property

In general, export-name is set to the EJB module name or set by using the values of the <ejb-name> and <ejb-class> tags of the EJB component defined in ejb-jar.xml. Patterns are provided for easier use of these values.


The following describes how to use patterns. The example assumes that an EJB class named 'sample-ejb' exists and the fully qualified EJB component class name is 'sample.SampleBean'. It is packaged within an EJB module named 'myejb'.

  • Set export-name to 'myejb_sample-ejb'.

    export-name=%{module-name}_%{ejb-name}
  • Set export-name to 'PREFIX_sample.SampleBean'.

    export-name=PREFIX_%{ejb-fqn}
  • Set export-name to 'SampleBean_POSTFIX'.

    export-name=%{ejb-class}_POSTFIX

As shown in the previous example, when setting export-name, a combination of patterns can be used or the required (such as PREFIX or POSTFIX) character strings can be appended to a pattern. The pattern name is case insensitive.

Property File Example

The following is an example of creating the ejbddinit property file. It is recommended to modify the following example to suit each EJB in which JEUS EJB DD is created.

# PROPERTY FILE SAMPLE
# JEUS EJB DD Generation Option

# target file or directory path
source=/home/workspace/ejb.jar

# log-level for EJB DD init
logging-level=DEBUG

# JEUS EJB DD configuration tag and value pairs for all EJBs
db-vendor=mysql
datasource-name=jdbc/__default
creating-table=use-existing
deleting-table=false
engine-type=EXCLUSIVE_ACCESS
subengine-type=ReadLocking
fetch-size=1111
enable-instant-ql=true    
export-port=9999
export-iiop=false
thread-max=100
bean-pool-min=10
bean-pool-max=100
capacity=10000
passivation-timeout=300000
disconnect-timeout=-1
connect-pool-min=10
connect-pool-max=100
init-caching=false

# JEUS EJB DD configuration tag and value pairs for BookBean EJB
BookBean.export-name=BookBeanFromProperty
BookBean.local-export-name=LocalBookBeanFromProperty
BookBean.export-port=55555
BookBean.thread-max=100

webddgen creates and updates jeus-web-dd.xml in the WEB-INF directory of a web application according to the user input values. This tool also creates the jeus-ejb-dd.xml file in the WEB-INF directory of a web module. If the file is compressed, jeus-web-dd.xml is included in the file.

The following describes how to use the tool and parameters. Examples are provided.

  • Usage

    webddgen -file <war-file-path>
             [-ctx <context-path>]
             [-prop <context-level-property>]
             [-verbose]
             [-websocket]
  • Parameters

    ParameterDescription
    -file <war-file-path>

    Path to the web module.

    The web module can be a directory or a compressed file with the .jar extension.

    [-ctx <context-path>]context-path to be set in jeus-web-dd.xml.
    [-prop <context-level-property>]

    Web module-specific property.

    For example, to use the JSP written in JEUS 4 without modifying the file, set the jeus.servlet.jsp.modern property of the web module that contains the JSP to false. The property format is name=value.

    (E.g., jeus.servlet.jsp.modern=false)

    [-verbose]Option that ensures the directory used internally in webddgen is not deleted unless webddgen is re-executed. This option is useful when debugging a problem that occurred during operation.
    [-websocket]Set this option when WebSocket Container is used. If this option is set, add the <websocket/> tag to jeus-web-dd.xml.
  • Example

    • Display usage.

      $ webddgen -help
    • Create jeus-web-dd.xml in the web.war file.

      $ webddgen -file web.war
    • Add context-path when creating jeus-web-dd.xml.

      $ webddgen -file web.war -ctx /web1
    • Set the jeus.servlet.jsp.modern property to false in the web module that contains the JSP written in JEUS 4.

      $ webddgen -file oldjsps.war -prop jeus.servlet.jsp.modern=false

The encryption tool is used to encrypt and decrypt strings. It also encodes strings in base64 format and provides the hash result.

For algorithms that require a secret key, such as AES, DES, DESEDE, BLOWFISH, and SEED, a security.key file must be created in advance. The security.key file is located in the JEUS_HOME/domains/<domain name>/config/security directory, and the path can be changed using the system property jeus.security.keypath property.

Note

In JEUS v6.0 Fix#3 and later, a master password can be used to encrypt the secret.key file.

The encryption algorithm was updated in JEUS 6.0 Fix#4. The option to convert the previous ciphertext format to a new format was added to the encryption tool in JEUS 6.0 Fix#5.

The encryption tool is invoked using the encryption script located in the following directory.

JEUS_HOME/bin/

Example

In the example it is assumed that the JEUS_HOME system environment variable is set and the JEUS_HOME/bin directory is set as the system path.

  • When invoked, the tool simply shows encoded or decoded strings.

    If no parameters are specified or if the call syntax is incorrect, a help screen is displayed.

    $ ./encryption base64 mypassword
    [BASE64] : [mypassword] --> [encode:bXlwYXNzd29yZA==]
    [BASE64] : [bXlwYXNzd29yZA==] --> [decode:mypassword]

    The string, "bXlwYXNzd29yZA==", is the result of encoding "mypassword" in base64 format.

    $ ./encryption DESede mypassword 
    [DESEDE] : [mypassword] --> [encode:8JLoskMPHkwwLKi+TJeOgQZBDO15PBQ=]
    [DESEDE] : [8JLoskMPHkwwLKi+TJeOgQZBDO15PBQ=] --> [decode:mypassword]

    The string, "8JLoskMPHkwwLKi+TJeOgQZBDO15PBQ=", is the result of encrypting "mypassword" using the DESede cipher algorithm. The secret key, created for the encryption, is stored in the secret.key file under the JEUS_HOME/domains/<domain name>/config/security directory. (If an encryption was previously performed, the key stored in the secret.key file is used.)

  • Use the -protectkey option to encrypt the secret.key file with a master password.

    $ ./encryption -protectkey AES mypassword 
    Input the master password For key encryption>
    Confirm the master password For key encryption>
    [AES] : [mypassword] --> [encode:qsHQdjqh8aAr3fWPYWbU0/VkFbs9yllZeRJaK5xSiuo=]
    [AES] : [qsHQdjqh8aAr3fWPYWbU0/VkFbs9yllZeRJaK5xSiuo=] --> [decode:mypassword]

    This example is similar to the previous examples. However, in this example, a master password is required.

    The password is used to encrypt the secret key with the DESede algorithm. To use the secret.key file, which was created using a master password, the master password must be entered. The following shows how to encrypt using the encrypted secret.key file.

    $ ./encryption -protectkey AES mypassword 
    The encryption key file is encrypted. Enter the master password.
    Password>
    [AES] : [mypassword] --> [encode:qsHQdjqh8aAr3fWPYWbU0/VkFbs9yllZeRJaK5xSiuo=]
    [AES] : [qsHQdjqh8aAr3fWPYWbU0/VkFbs9yllZeRJaK5xSiuo=] --> [decode:mypassword]
  • In JEUS 6.0 Fix#4, the encryption algorithm was enhanced for greater security. In JEUS 6.0 Fix#4, encryption syntax created in earlier versions cannot be used because the ciphertext format was updated. Fix#5 and later versions provide a function that converts the ciphertext in the encryption tool. The function can be used with the -convert option.

    $ ./encryption -convert AES i06wYRz3u60/Gqun2sKtXH1u=
    Decryption was successful.
    [before:i06wYRz3u60/Gqun2sKtXH1u=] --> [after:ET7c/P21Qx1Io8UI6Ss2NvZ0G=]
  • When the security.key file is encrypted, decrypt the file.

    $ ./encryption -convert -protectkey AES i06wYRz3u60/Gqun2sKtXH1u=
    The encryption key file is encrypted. Enter the master password.
    Password>
    
    Decryption succeed.
    [before:i06wYRz3u60/Gqun2sKtXH1u=] --> [after:ET7c/P21Qx1Io8UI6Ss2NvZ0G=]

The wsgen tool is for the JAX-WS web service. It creates a WSDL file and JAX-RPC mapping files from Java classes. wsgen can also create web service policy configuration files.

wsgen creates the following from the service endpoint interface classes and classes implemented in Java.

  • Portable Artifacts

  • WSDL file of web services (option)

  • The web service policy wsit-<endpoint classname>.xml file (option)

The following describes how to use the tool and parameters. Examples are provided.

  • Usage

    Usage: wsgen [options] <SEI>
    
    where [options] include:
      -classpath <path>        specify where to find input class files
      -cp <path>               same as -classpath <path>
      -d <directory>           specify where to place generated output files
      -extension               allow vendor extensions - functionality not specified
                               by the specification.  Use of extensions may
                               result in applications that are not portable or
                               may not interoperate with other implementations
      -help                    display help
      -keep                    keep generated files
      -r <directory>           resource destination directory, specify where to
                               place resouce files such as WSDLs
      -s <directory>           specify where to place generated source files
      -verbose                 output messages about what the compiler is doing
      -version                 print version information
      -wsdl[:protocol]         generate a WSDL file.  The protocol is optional.
                               Valid protocols are soap1.1 and Xsoap1.2, the default
                               is soap1.1.  Xsoap1.2 is not standard and can only be
                               used in conjunction with the -extension option
      -servicename <name>      specify the Service name to use in the generated WSDL
                               Used in conjunction with the -wsdl option.
      -portname <name>         specify the Port name to use in the generated WSDL
                               Used in conjunction with the -wsdl option.
    
    Examples:
      wsgen -cp . example.Stock
      wsgen -cp . example.Stock -wsdl -servicename {http://mynamespace}MyService 
  • Parameters

    ParameterDescription
    -classpath <path>Path to Java class files.
    -cp <path>Alias for -classpath <path>.
    -d <directory>Result files directory.
    -extensionAllows vendor extensions. This option may cause compatibility and portability issues.
    -helpDisplays help.
    -keepKeeps created files.
    -r <directory>WSDL file directory. Used with the genwsdl property.
    -s <directory>Source files directory.
    -verboseDisplays verbose messages.
    -versionDisplays version information.
    -wsdl[:protocol]

    Normally, the wsgen tool does not create a WSDL file. This option allows developers to view the WSDL file before it is deployed.

    '[:protocol]' is optional, and the default value is soap1.1. To use Xsoap1.2, the -extension option must be specified.

    -servicename <name>Name of a specific wsdl:service element of the created WSDL file. Used with the -wsdl property.
    -portname <name>Name of a specific wsdl:portname element of the created WSDL file. Used with the -wsdl property.
  • Example

    wsgen is a general script file located in JEUS_HOME/bin/.

    The following is an example of executing wsgen.

    ~$ wsgen -classpath build/classes -d build/classes -wsdl 
    fromjava.server.AddNumbersImpl

    The previous command organizes the JAX-WS web service from fromjava.server.AddNumbersImpl, the service endpoint implementation class. The class path to fromjava.server.AddNumbersImpl is "build/classes", and Java Bean files are created in the "build/classes" directory with the WSDL file.

The wsimport tool is for the JAX-WS web service. It creates client-side Java stub source files and server-side web service interface Java source files from the WSDL file. wsimport also creates web service policy configuration files.

wsimport creates the following from the WSDL file.

  • SEI, service classes, and other JAXB related Java classes

  • wsit-client.xml file and the WSDL file that includes the web service policy settings

The following describes how to use the tool and parameters. Examples are provided.

  • Usage

    Usage: wsimport [options] <WSDL_URI>
    
    where [options] include:
      -b <path>                 specify jaxws/jaxb binding files or additional schemas
                                (Each <path> must have its own -b)
      -B <jaxbOption>            Pass this option to JAXB schema compiler
      -catalog <file>           specify catalog file to resolve external entity 
                                references supports TR9401, XCatalog, 
                                and OASIS XML Catalog format
      -d <directory>            specify where to place generated output files
      -extension                allow vendor extensions - functionality not specified
                                by the specification.  Use of extensions may
                                result in applications that are not portable or
                                may not interoperate with other implementations
      -help                     display help
      -httpproxy:<host>:<port>  specify a HTTP proxy server (port defaults to 8080)
      -keep                     keep generated files
      -p <pkg>                  specifies the target package
      -quiet                    suppress wsimport output
      -s <directory>            specify where to place generated source files
      -target <version>         generate code as per the given JAXWS spec version 
                                Defaults to 2.2, Accepted values are 2.0, 2.1 and 2.2
                                e.g. 2.0 will generate compliant code for JAXWS 2.0
                                spec
      -verbose                  output messages about what the compiler is doing
      -version                  print version information
      -wsdllocation <location>  @WebServiceClient.wsdlLocation value
    
    Extensions:
      -XadditionalHeaders         map headers not bound to request or response message 
                                  to Java method parameters
      -Xauthfile                  file to carry authorization information in the format
                                  http://username:password@example.org/stock?wsdl
      -Xdebug                     print debug information
      -Xno-addressing-databinding enable binding of W3C EndpointReferenceType to Java
      -Xnocompile                 do not compile generated Java files
    
    Examples:
      wsimport stock.wsdl -b stock.xml -b stock.xjb
      wsimport -d generated http://example.org/stock?wsdl
  • Parameters

    ParameterDescription
    -b <path>External JAX-WS or JAXB binding files.
    -B <jaxbOption>Specifies to pass this option to the JAXB schema compiler.
    -catalog <file>Sets the external entity reference values such as the TR9401, XCatalog, and OASIS XML Catalog types. The ant xmlcatalog type can also be used.
    -d <directory>Result files directory.
    -extensionAllows vendor extensions. This option may cause compatibility and portability issues.
    -helpDisplays help.
    -httpproxy:<host>:<port> HTTP proxy server. (Default value: 8080)
    -keepKeeps created files.
    -p <pkg>Java package names for all Namespace URIs defined in WSDL.
    quietPrevents output messages from being displayed.
    -s <directory> Source files directory. If this property is set, the keep property is automatically set.
    -target <version>Creates code according to the specified version of JAX-WS specifications.
    -verboseDisplays verbose messages. (Default value: false)
    -versionDisplays version information.
    -wsdllocation <location>If WSDL URI is set in this property, it applies to service end-point interfaces and @WebServiceClient.wsdlLocation and @WebService.wsdlLocation annotations of the service interfaces.
  • Example

    wsimport is a general script file located in JEUS_HOME/bin/.

    The following is an example of executing wsimport.

    ~$ wsimport -d build/classes -keep -p fromwsdl.server src/conf/AddNumbers.wsdl

    The previous command created a portable artifact with a package name of fromwsdl.server from AddNumbers.wsdl. Java class source files created by the [-keep] option are not deleted.

The java2wsdl tool is for the JAX-RPC web service. It creates WSDL files and JAX-RPC mapping files from Java classes. java2wsdl creates resources, such as web service WSDL files and JAX-RPC mappings files, from the service endpoint interface Java classes or implementation classes.

The following describes how to use the tool and parameters. Examples are provided.

  • Usage

    Usage: java2wsdl <options> <input file>
    
    where <input file> include:
      configuration file          service configuration xml file (by default)
    
    where <options> include:
      -classpath <path>           specify where to find input class files
      -cp <path>                  same as -classpath <path>
      -d <directory>              specify where to place generated output files
      -level <log-level>          specify a log level
      -verbose                    [optional] turn verbose mode on
  • Parameters

    ParameterDescription
    -classpath <path>Path to Java class files.
    -cp <path>Alias for -classpath <path>.
    -d <directory>Result files directory.
    -levelLog level.
    -verboseDisplays verbose messages.
  • Example

    java2wsdl is a general script file located in JEUS_HOME/bin/.

    The following is an example of executing java2wsdl.

    ~$ java2wsdl -classpath build/classes -d build/web/WEB-INF service-config.xml

    The previous command created WSDL files and JAX-RPC mapping files in the "build/web/WEB-INF" directory using the service-config.xml configuration file and classes in the "build/classes" directory.

The wsdl2java tool is for the JAX-RPC web service. The following are the codes created by wsdl2java from a WSDL file.

  • Web service Java source code stubs for clients

  • Web service interface Java source code for servers

The following describes how to use the tool and parameters. Examples are provided.

  • Usage

    Usage: wsdl2java mode [options] wsdlURI
    
    where mode include:
    -gen:client              generate all client artifacts
    -gen:server              generate all server artifacts
    -gen                     same as -gen:client
    -import:client           generate client JSR-109 portable artifacts only
    -import:server           generate server JSR-109 portable artifacts only
    -import                  same as -import:client
    
    where [options] include:
    * destination directory
    -d <directory>           specify where to put output files
    -cd <directory>          specify where to put compiled class files
                             If not specifed, the compile class files will be
                             put in where '-d' specifies
    
    * WSDL and Java mapping
    -inputmapping <filename> specify the input JSR-109 JAX-RPC mapping file
                             (used for generating Java artifacts)
    -package <package_name>  specify the java package name to which
                             all namespaceURI in the WSDL map
    -ns2pkg NS=PKG           specify the namespaceURI and java package name mapping
                             (NS : namespaceURI, PKG : java package name)
                             This option can be used serveral times
    
    * output file
    -outputmapping <filename>  specify the output JSR-109 JAX-RPc mapping file
                             for the input WSDL
                             This option can not be used with '-inputmapping'
    -compile                 compile generated Java source files
                             ('tools.jar' must be in the classpath)
    -nokeepsrc               delete generated java source files
    
    * artifact generation options
    -nowrapped               disable wrapped mode detection for the WSDL
    -datahandleronly         force javax.activation.DataHandler for MIME types
    -nodatabinding           force javax.xml.soap.SOAPElement for all WSDL parts
    -soapver <VER>           specify SOAP version used in stub/tie class.
                             VER : '11' for SOAP 1.1, '12' for SOAP 1.2
    -resolvedir directory    specify directory where to be put local copies
                             of include/import schemas and import WSDL
    
    * other options
    -username                username to access the WSDL-URI
    -password                password to access the WSDL-URI
    
    * verbose options
    -level <LEVEL>           specify log level.
                             LEVEL : SEVERE, WARNING, INFO, FINE, FINER, FINEST
    -verbose                 same as -level FINE

  • Parameters

    ParameterDescription
    -gen:clientCreates Java classes for clients.
    -gen:serverCreates Java classes for servers.
    -genSame as -gen:client.
    -import:clientCreates Portable Artifact for clients.
    -import:serverCreates a Portable Artifact for servers
    -importSame as -import:client.
    -d <directory>Output directory.
    -cd <directory>Compiled class files directory.
    -inputmapping <filename>Input JAX-RPC mapping files used to create Java classes.
    -package <package_name>Java package name for all namespace URIs in WSDL.
    -ns2pkg NS=PKG

    Java package name for the namespace URI.

    • NS: Namespace URI

    • PKG: Java package name

    -outputmapping <filename>Output JAX-RPC mapping files for the WSDL input.
    -compileCompiles created Java files.
    -nokeepsrcDeletes created Java source files.
    -nowrappedDisables the wrapped mode detection function for WSDL.
    -datahandleronlyApplies javax.activation.DataHandler to the MIME type.
    -nodatabindingApplies javax.xml.soap.SOAPElement to all WSDL message parts.
    -soapver <VER>

    SOAP version used in stub/tie classes.

    • 11: SOAP 1.1

    • 12: SOAP 1.2

    -resolvedir <directory>Stores remote WSDL files, including schema files, in an accessible repository.
    -usernameUsername to access WSDL-URI
    -passwordPassword to access WSDL-URI
    -level <LEVEL>Log level.
    -verboseDisplays verbose messages.

WSDL complements the UDDI standards by providing a binding protocol between abstract interfaces and network services. wsdl2uddi is provided by JEUS UDDI WSDL Publishing.

The wsdl2uddi tool can publish web services to UDDI from the WSDL file.

Usage

The following describes how to use the tool and parameters. Examples are provided.

  • Usage

    Usage: wsdl2uddi UDDIVersion WSDLURI [wsdl-options] 
                      -uddiInquiry <UDDIInquiryURI> -uddiPublish <UDDIPublish> 
                      -uddiUsername <UDDIUsername> -uddiPassword <UDDIPassword> [options]
    
    * wsdl-options
        -wsdlUsername          username to access the WSDL-URI
        -wsdlPassword          password to access the WSDL-URI
    
    * options
        -level <LEVEL>         specify log level.
                               LEVEL : SEVERE, WARNING, INFO, FINE, FINER, FINEST
        -verbose               same as -level FINE
  • Parameters

    ParameterDescription
    UDDIVersionUDDI version. Input options: v2 and v3.
    WSDLURIURI value of the location of the actual WSDL.
    -uddiInquiry <UDDIInquiryURI>Inquiry URI value of the actual UDDI.
    -uddiPublish <UDDIPublish>Publish URI value of the actual UDDI.
    -uddiUsername <UDDIUsername>Username required to access UDDI.
    -uddiPassword <UDDIPassword>Password required to access UDDI.
    -wsdlUsernameUsername required to access WSDL URL.
    -wsdlPasswordPassword required to access WSDL URL.
    -level <LEVEL>Log level.
    -verboseDisplays verbose messages (same as the 'FINE' log level).
  • Example

    wsdl2uddi is a general script file located in JEUS_HOME/bin/.

    The following is an example of executing wsdl2uddi.

    ~$ wsdl2uddi v3 http://localhost:8088/AddNumbers/addnumbers?wsdl
    -uddiInquiry http://localhost:8088/uddi/inquiry
    -uddiPublish http://localhost:8088/uddi/publish
    -uddiUsername jeus
    -uddiPassword jeus
    -verbose

    The previous command publishes web services to UDDI using the remote "http://localhost:8088/AddNumbers/addnumbers?wsdl" WSDL file. The UDDI Inquiry, the Publish URI, username, and password can be specified.

The 'xjc' tool converts XML schema files to JAXB content classes in the Java programming language.

The following describes how to use the tool and parameters. Examples are provided.

  • Usage

    Usage: xjc [-options ...] <schema file/URL/dir/jar> ... [-b <bindinfo>] ...
    If dir is specified, all schema files in it will be compiled.
    If jar is specified, /META-INF/sun-jaxb.episode binding file will be compiled.
    Options:
      -nv                :  do not perform strict validation of the input schema(s)
      -extension         :  allow vendor extensions - do not strictly follow the
                            Compatibility Rules and App E.2 from the JAXB Spec
      -b <file/dir>      :  specify external bindings files 
                            (each <file> must have its own -b)
                            If a directory is given, **/*.xjb is searched
      -d <dir>           :  generated files will go into this directory
      -p <pkg>           :  specifies the target package
      -httpproxy <proxy> :  set HTTP/HTTPS proxy. Format is 
                            [user[:password]@]proxyHost:proxyPort
      -httpproxyfile <f> :  Works like -httpproxy but takes the argument in a file 
                            to protect password
      -classpath <arg>   :  specify where to find user class files
      -catalog <file>    :  specify catalog files to resolve external entity 
                            references support TR9401, XCatalog, 
                            and OASIS XML Catalog format.
      -readOnly          :  generated files will be in read-only mode
      -npa               :  suppress generation of package level annotations 
                            (**/package-info.java)
      -no-header         :  suppress generation of a file header with timestamp
      -target 2.0        :  behave like XJC 2.0 and generate code that doesnt use any 
                            2.1 features.
      -xmlschema         :  treat input as W3C XML Schema (default)
      -relaxng           :  treat input as RELAX NG (experimental,unsupported)
      -relaxng-compact   :  treat input as RELAX NG compact syntax 
                            (experimental,unsupported)
      -dtd               :  treat input as XML DTD (experimental,unsupported)
      -wsdl              :  treat input as WSDL and compile schemas inside it 
                            (experimental,unsupported)
      -verbose           :  be extra verbose
      -quiet             :  suppress compiler output
      -help              :  display this help message
      -version           :  display version information
    
    Extensions:
      -Xlocator          :  enable source location support for generated code
      -Xsync-methods     :  generate accessor methods with the 'synchronized' keyword
      -mark-generated    :  mark the generated code as @javax.annotation.Generated
      -episode <FILE>    :  generate the episode file for separate compilation 
  • Parameters

    ParameterDescription
    -nv

    Option to check schema validation.

    Enter true or false.

    -extension

    Option to execute the XJC binding compiler in extension mode.

    Enter true or false. (Default value: false)

    -b <file/dir>Sets at least one external binding file.
    -d <dir>By default, the XJC binding compiler creates Java content classes in the current directory. This option specifies a different directory.
    -p <pkg>Specified target package name that overwrites any other customization.
    -httpproxy <proxy>HTTP/HTTPS proxy.
    -httpproxyfile <f>Similar to the -httpproxy parameter but uses arguments in the file to protect the password.
    -classpath <arg>Path to client application classes registered with the <jxb:javaType> and <xjc:superClass> customizations.
    -catalog <file>External catalog files for TR9401, XCatalog, and OASIS XML catalog formats.
    -readOnlySets Java source files to 'read only' mode. (Default value: false)
    -npaSummarizes the package level annotations in package-info.java.
    -no-headerCreates file headers without timestamps.
    -target (2.0|2.1)Behaves like XJC 2.0 or 2.1, and creates code that is fully 2.0 or 2.1 compatible (2.2 functions are not used).
    -xmlschema

    Treats input as a W3C XML schema.

    Input options:

    • relaxng

    • relaxng-compact

    • dtd

    • wsdl

    • xmlschema (Default)

    -relaxngTreats input as RELAX NG.
    -relaxng-compactTreats input as simple RELAX NG.
    -dtdXML DTD file is used as the input schema of the compiler.
    -wsdlSpecifies a WSDL file and compiles the schema files in the WSDL file.
    -verboseDisplays verbose messages.
    -quietPrevents compiler output messages from being displayed, such as progression information or warning messages.
    -helpDisplays help.
    -versionDisplays the compiler version.
  • Example

    xjc is a general script file located in JEUS_HOME/bin/.

    The following is an example of executing xjc.

    ~$ xjc -d build/classes -p com.tmaxsoft src/conf/ts.xsd

    The previous command creates compiled Java class files with a package name of "com.tmaxsoft" in the "build/classes" folder, from the ts.xsd schema file.

The schemagen tool creates a schema file for each namespace in a Java class.

The following describes how to use the tool and parameters. Examples are provided.

  • Usage

    Usage: schemagen [-options ...] <java files> 
    Options: 
        -d <path>             : specify where to place processor and javac generated
                                class files
        -cp <path>            : specify where to find user specified files
        -classpath <path>     : specify where to find user specified files
        -encoding <encoding>  : specify encoding to be used for apt/javac invocation 
        -episode <file>       : generate episode file for separate compilation
        -version              : display version information
        -fullversion          : display full version information
        -help                 : display this usage message
  • Parameters

    ParameterDescription
    -d <path>Path to the processors and class files.
    -cp <path>Alias for -classpath <path>.
    -classpath <path>Path to user-specified files.
    -encoding <encoding>Encoding used to call apt/javac.
    -episode <file>Creates episode files to be separately compiled.
    -versionDisplays version information.
    -fullversionDisplays full version information.
    -helpDisplays help.

This section describes the tcpmon tool.

The following should be assumed when using the listener mode.

  • Server (A) receives a SOAP request from port 8000.

  • The web service client of client (B) is trying to monitor SOAP messages.


In this scenario, the client web service program can use tcpmon to monitor SOAP messages.

Execute tcpmon in client (B), and execute the following.

Changing the End-Point Address of a Web Service

To use the tcpmon in the listener mode, the client or client program settings must be modified to change the end-point address of the web service.

  • For the J2SE JAX-WS web service client

    Modify the code to change the end-point address of the web service.

    (javax.xml.ws.BindingProvider)port).getRequestContext().put(
        javax.xml.ws.BindingProvider.ENDPOINT_ADDRESS_PROPERTY,
        "http://localhost:9000/ws/AddNumbersService");
    • port

      JAX-WS BindingProvider object for service end-point interfaces.

    • javax.xml.ws.BindingProvider.ENDPOINT_ADDRESS_PROPERTY

      Standard properties defined in the JAX-WS specification for setting the end point address.

  • For the J2SE JAX-RPC web service client

    Modify the code to change the end-point address of the web service.

    ((javax.xml.rpc.Stub)port)._setProperty(
          javax.xml.rpc.Stub.ENDPOINT_ADDRESS_PROPERTY,
          “http://localhost:9000/ws/AddressBookService”);
    • port

      JAX-RPC Stub object for service end-point interfaces.

    • javax.xml.rpc.Stub.ENDPOINT_ADDRESS_PROPERTY

      Standard properties defined in the JAX-RPC specification for setting the end-point address.

  • For the J2EE web service client

    The previous properties can be applied to the JEUS configuration file (jeus-web-dd.xml or jeus-ejb-dd.xml) by adding the <stub-property> block inside the <service-client> block, without modifying the code.

    <service-client>
        <port-info>
            <stub-property>
                <name>javax.xml.rpc.service.endpoint.address</name>
                <value>
                    http://localhost:9000/ws/AddressBookService
                </value>
            </stub-property>
        </port-info>
    </service-client>