Introduction
Reference table
The Orion Administration tool
The Orion LoadBalancer tool
The Orion Main Server
|
Tools Overview Orion comes with a number of tools. This article describe which these are and how they are used
Introduction
Reference table The Orion Administration tool The Orion LoadBalancer tool The Orion Main Server 1 Introduction This article describes the tools distributed with the Orion Application Server. 2 Reference table The tools distributed with the Orion Application Server can be found in the table below:
3 The Orion Administration tool The Orion Administration tool can be used to perform the following tasks:
Shutting down an Orion Application Server
Restarting an Orion Application Server Deploying/Redeploying Applications to an Orion Application Server Undeploying Applications from an Orion Application Server Binding a Web-module to a web-site Getting information about an Application's DataSources Restarting an Application Adding a User to an Application Adding a DataSource to an Application 3.1 Shutting down an Orion Application Server The Orion Administration tool can be used to shutdown an Orion Application Server. The syntax for this operation is given below.
The specified host and port values should be the host and port of the Orion Application Server that is to be shut down. The specified username and password should represent a valid active User at the target Server. The -shutdown command tells the Orion Administration tool that it should handle the shutting down of the Server process. If force is specified, the Administration tool will try to shutdown the Server emidiately instead of gracefully allowing the Server to try and close all used resources before shutting down as when using the defualt ("ordinary") If a "reason" is specified in conjunction with "force" (see above), this description will be used as the shutdown-reason in any notification and/or log entries for this shutdown. 3.2 Restarting an Orion Application Server The Orion Administration tool can be used to restart an Orion Application Server. The syntax for this operation is given below.
The specified host and port values should be the host and port of the Orion Application Server that is to be shut down. The specified username and password should represent a valid active User at the target Server. The -restart command tells the Orion Administration tool that it should handle the restart of the target Server process. If a "reason" is specified this description will be used as the restart-reason in any notification and/or log entries for this shutdown. 3.3 Deploying/Redeploying Applications to an Orion Application Server The Orion Administration tool can be used to deploy an Application to an Orion Application Server. The syntax for this operation is given below.
The specified host and port values should be the host and port of the Orion Application Server that is the target of this deployment. The specified username and password should represent a valid active User at the Server that will be contacted. The -deploy command tells the Orion Administration tool that it should handle the deployment of an Application. The -file argument should be the name of the .ear file to deploy. The -deploymentName specified should be the unique name to use when referencing to this deployment of the Application. If the specified deployment exists on the target Server, the operation will be treated as a redeployment. If -targetPath is specified, this will be used to determine where the Application's .ear-file will be stored on the target Server. The default value is the "applications"-directory in the Orion installation directory. If -parent is specified, this will be used as the name of an existing Application deployment that will be configured to be the parent of this deployment. If -deploymentDirectory is specified this will be used as the name of the root directory for the deployment configurations. By giving it a value of "[NONE]", the deployment configurations will be written into the .ear-file. The default behaviour is to write the configuration files into a directory named after the depoymen-name (see above) under the default deployment directory (a directory named "application-deployments" directly under the Orion installation directory). If the -cluster switch is specified, the Server that is the target of the deployment will in its turn ask all known active cluster nodes to reproduce the same deployment. If the -ingorePrevousDeployment switch is specified, the Server will remove any Application deployed using the specified deployment name prior to deploying this Application. If the -bindWebApps switch is specified, any Web-moudles that are part of the deployed Application will be bound to the default web-site using the value of the Web-modules name-tag as context-root. 3.4 Undeploying Applications from an Orion Application Server The Orion Administration tool can be used to undeploy an Application from an Orion Application Server. The syntax for this operation is given below.
The specified host and port values should be the host and port of the target Orion Application Server. The specified username and password should represent a valid active User at the Server that will be contacted. The -undeploy command tells the Orion Administration tool that it should handle the undeployment of an Application at the target Server. The deploymentName should be the unique deployment name for the deployed Application to undeploy. The next argument that can be true or false specifies if all deployment files should be removed when then Application is undeployed. The defaul it true. 3.5 Binding a Web-module to a web-site The Orion Administration tool can be used to bind the Web-module of an Application to a web-site at a given target Server. The syntax for this operation is given below.
The specified host and port values should be the host and port of the Orion Application Server that is the target of this deployment. The specified username and password should represent a valid active User at the Server that will be contacted. The -bindWebApp command tells the Orion Administration tool that it should handle the binding of a Web-module at the target Server. The deploymentName argument should be the unique deployment name for the deployed Application that holds the Web-module to bind. The webModuleName argument should be the name of the Web-module to bind. The webSiteName argument should be the name of the web site to bind the Web-module to. The contextroot argument should be the context root that the Web-mdoule should be bound to on the specified web site. 3.6 Getting information about an Application's DataSources The Orion Administration tool can be used to gain information about a previously deployed Application's current DataSources. The syntax for this operation is given below.
The specified host and port values should be the host and port of the target Orion Application Server. The specified username and password should represent a valid active User at the target Server. The -application command tells the Orion Administration tool that it should handle an operation tareting a previusly deployed Application. The deploymentName argument should be the unique deployment name for the deployed Application that should be restarted The -dataSourceInfo subcommand tells the Orion Administration tool that it should handle the restart of the target Application. Executing this operation will return a list of all DataSource's availalbe to the specified Application. For each DataSource, the total number of connections is listed together with the number of those connections that are either cached or used. 3.7 Restarting an Application The Orion Administration tool can be used to restart a previously deployed J2EE Application on an Orion Application Server. The syntax for this operation is given below. If the Application has been modified, the Application deployment will be updated.
The specified host and port values should be the host and port of the target Orion Application Server. The specified username and password should represent a valid active User at the target Server. The -application command tells the Orion Administration tool that it should handle an operation targeting a previusly deployed Application. The deploymentName argument should be the unique deployment name for the deployed Application that should be restarted The -restart subcommand tells the Orion Administration tool that it should handle the restart of the target Application. 3.8 Adding a User to an Application The Orion Administration tool can be used to add a new user to a previously deployed J2EE Application on an Orion Application Server. The syntax for this operation is given below..
The specified host and port values should be the host and port of the target Orion Application Server. The specified username and password should represent a valid active User at the target Server. The -application command tells the Orion Administration tool that it should handle an operation targeting a previusly deployed Application. The deploymentName argument should be the unique deployment name for the deployed Application that should be restarted The -addUser subcommand tells the Orion Administration tool that it should handle the adding of a new User to the target Application. The specified aUsername and aPassword should represent the username and password for the new User that should be added. Upon executing this operation, the target Server will use the UserManager defined for the previously deployed Application to add the specified User. 3.9 Adding a DataSource to an Application The Orion Administration tool can be used to add a new DataSource to a previously deployed J2EE Application on an Orion Application Server. The syntax for this operation is given below.
The specified host and port values should be the host and port of the target Orion Application Server. The specified username and password should represent a valid active User at the target Server. The -application command tells the Orion Administration tool that it should handle an operation targeting a previusly deployed Application. The deploymentName argument should be the unique deployment name for the deployed Application that should be restarted The -installDataSource subcommand tells the Orion Administration tool that it should handle the adding of a new DataSource to the target Application. The -jar argument should be the path to a jar file containing the driver to add to the Servers library. The -url argument should be used to specify the JDBC Database URL. The -location argument should be used to specify the namespace location of the raw source, for instance jdbc/DefaultRawDS The -pooledLocation argument should be used to specify the namespace location of the pooled source, for instance jdbc/DefaultPooledDS The -xaLocation argument should be used to specify the namespace location of the XA source, for instance jdbc/DefaultXADS The -cmtLocation argument should be used to specify the namespace location of the CMT source, for instance jdbc/DefaultDS. This is the source that is usually used by the Application. The -username and -password arguments should be used to specify the username and password that should be used when interacting with the Database. The -connectionDriver argument should be used to specify the JDBC Database driver classname, for instance "com.mydb.Driver". The -className argument should be used to specify the JDBC DataSource classname, for instance "com.evermind.sql.DriverManagerDataSource". 4 The Orion LoadBalancer tool The Orion LoadBalancer can be used as a frontend to distribute HTTP(S) request over a number of backend Servers. The syntax for using the LoadBalancer is given below.
The specified -config argument specifies a path to the load-balancer.xml config file, the default is config/load- balancer.xml The specified -host and -port arguments specifies the host/port to listen to for HTTP connections The -dontUseSessionID switch tells the balancer not to scan for Servlet session IDs as a mean of identifying clients (useful when for instance balancing SSL sites) The -dontUseIP switch tells the balancer not to route connections based on IP if no session exists/is scanned for. The -dontUseKeepAlives switch tells the balancer not to maintain keep-alives. This is useful if number of open sockets/used threads is a problem on the balancer but it will increase network traffic and CPU usage (and slow down client requests). The specified -minimumIsland argument specifies the minimum island to add to alive servers list, useful when using several balancer instances. By default, the LoadBalancer will manage all nodes on all cluster islands. The specified -maximumIsland argument specifies the maximum island to add to alive servers list, useful when using several balancer instances. By default, the LoadBalancer will manage all nodes on all cluster islands. The specified -selectiontype argument specifies how to select servers, the default is random, options are: 'random', 'first'. For more information about clustering and loadbalancing, see the clustering and load-balancing articles. 5 The Orion Main Server The Orion Main Server is used to start the Orion Application Server in one of the following ways:
Installing the Orion Application Server
Running the Orion Application Server Getting the Orion Application Server version Getting the Orion Application Server syntax 5.1 Installing the Orion Application Server The Orion Application Server can be started with a switch (-install) that tells the Server to active the admin account and rewrite text files to match the OS linefeeds, as exemplified below.
Specifying the -install switch installs the server, activates the admin account and rewrites text files to match the OS linefeed, whereafter the Server exit. 5.2 Running the Orion Application Server The Orion Application Server can be started with a number of switches and arguments as shown in the listing below.
Specifying the -install switch installs the server, activates the admin account and rewrites text files to match the OS linefeed, whereafter the Server exit. Specifying the -quiet switch surpress standard output. Specifying the -userThreads switch enables context lookup support from user-created threads. The -config argument specifies a location to a server.xml configuration file to use instead of the default config/server.xml. The -console switch launches the admin console in-process with the Orion Application Server. The -validateXML switch valides (strictly) the XML files when reading them. The -out argument is used to specify a file to route standard output to. The -err argument is used to specify a file to route error output to. The -version switch makes the Orion Application Server print the version number and then exit. The -? switch makes the Orion Application Server print the help message and then exit. 5.3 Getting the Orion Application Server version The Orion Application Server can be started with a switch (-version) that tells the Server to output its version number and then exit.
The -version switch makes the Orion Application Server print the version number and then exit. 5.4 Getting the Orion Application Server syntax The Orion Application Server can be started with a switch (-help or -?) that tells the Server to output available switches and arguments and then exit.
The -help (or -?) switch makes the Orion Application Server print the help message and then exit. Copyright © 2005 IronFlare AB |