Return-Path: Delivered-To: apmail-geronimo-scm-archive@www.apache.org Received: (qmail 90336 invoked from network); 18 Dec 2005 06:07:07 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (209.237.227.199) by minotaur.apache.org with SMTP; 18 Dec 2005 06:07:07 -0000 Received: (qmail 80682 invoked by uid 500); 18 Dec 2005 06:07:04 -0000 Delivered-To: apmail-geronimo-scm-archive@geronimo.apache.org Received: (qmail 80197 invoked by uid 500); 18 Dec 2005 06:06:59 -0000 Mailing-List: contact scm-help@geronimo.apache.org; run by ezmlm Precedence: bulk list-help: list-unsubscribe: List-Post: Reply-To: dev@geronimo.apache.org List-Id: Delivered-To: mailing list scm@geronimo.apache.org Received: (qmail 79821 invoked by uid 99); 18 Dec 2005 06:06:57 -0000 Received: from asf.osuosl.org (HELO asf.osuosl.org) (140.211.166.49) by apache.org (qpsmtpd/0.29) with ESMTP; Sat, 17 Dec 2005 22:06:57 -0800 X-ASF-Spam-Status: No, hits=-9.4 required=10.0 tests=ALL_TRUSTED,NO_REAL_NAME X-Spam-Check-By: apache.org Received: from [209.237.227.194] (HELO minotaur.apache.org) (209.237.227.194) by apache.org (qpsmtpd/0.29) with SMTP; Sat, 17 Dec 2005 22:06:44 -0800 Received: (qmail 89749 invoked by uid 65534); 18 Dec 2005 06:06:23 -0000 Message-ID: <20051218060623.89748.qmail@minotaur.apache.org> Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r357449 [3/11] - in /geronimo/branches/1.0/modules/scripts/src/resources/docs: ./ Administrative tasks_attachments/ Architecture_attachments/ Configuring LDAP_attachments/ Geronimo Administration Console_attachments/ JBoss to Geronimo - EJB... Date: Sun, 18 Dec 2005 06:06:14 -0000 To: scm@geronimo.apache.org From: hogstrom@apache.org X-Mailer: svnmailer-1.0.5 X-Virus-Checked: Checked by ClamAV on apache.org X-Spam-Rating: minotaur.apache.org 1.6.2 0/1000/N Added: geronimo/branches/1.0/modules/scripts/src/resources/docs/Deploying secure applications.html URL: http://svn.apache.org/viewcvs/geronimo/branches/1.0/modules/scripts/src/resources/docs/Deploying%20secure%20applications.html?rev=357449&view=auto ============================================================================== --- geronimo/branches/1.0/modules/scripts/src/resources/docs/Deploying secure applications.html (added) +++ geronimo/branches/1.0/modules/scripts/src/resources/docs/Deploying secure applications.html Sat Dec 17 22:04:20 2005 @@ -0,0 +1,216 @@ + + + Documentation : Deploying secure applications + + + + + + + + + +
+ +
+ This page last changed on Dec 14, 2005 by hcunico@gmail.com. +
+ +


+Article donated by: Simon Godik, Hernan Cunico

+ + +

The purpose of this section is to provide some general guidelines on the application deployment process from a Security perspective. This is not intended to be the absolute guide for deployment. Throughout the articles in the Apache Geronimo V1 - Documentation, you will find several deployment examples organized by topics such as JDBC, Web services, JCA, Secutiry, etc.

+ +

This section is organized in the following topics:

+ + + + +

Deployment options for Web applications

+

Web applications can be deployed in a number of ways, standalone war file or part of an ear file. Web applications deployment can be targeted to a specific servlet container (such as jetty or tomcat) or use container-neutral schema. Note that container-neutral schema also has a way to define container-specific parameters.

+ +

If deployed as part of an ear file, there are 2 ways to include the Web application deployment plan: include it in the geronimo-application.xml as it's own module element or include a reference to the Web application deployment plan by using <alt-dd> element. The syntax of the Web application element is the same in both cases, so keep this in mind when you look at the examples.

+ +

Back to Top

+ +

Deploying Web application with the container-neutral schema

+

The namespace for the container neutral Web application deployment plan is http://geronimo.apache.org/xml/ns/j2ee/web-1.0. The name of the schema file is
+geronimo-web-1.0.xsd. It is best if you become familiar with the schema.

+ +

When configuring security in the deployment plan you need to specify two elements, security-realm-name and security:security element.

+ +

security-realm-name element defines the name of the Security Realm for the application. security:security element defines J2EE role mappings to Principals.

+ +

Here is an example of the Web application deployment plan:

+ +
+
<web-app xmlns="http://geronimo.apache.org/xml/ns/j2ee/web-1.0">
+   ...
+   <security-realm-name>geronimo-properties-realm</security-realm-name>
+   <security:security xmlns:security=":http://geronimo.apache.org/xml/ns/security-1.1">...</security:security>
+   ...
+</web-app>
+
+ +

Back to Top

+ +

Defining Security Realm Name

+

Security realm name is specified by the <security-realm-name> element. Its value is passed as an input parameter to the JAAS LoginContext constructor. In JAAS terms, this is application configuration name.

+ +

Do not be misled by the name of the security-realm-name element. This name implies that you are naming the Security Realm, but in fact you may not. The value of this element is application configuration name and as such, it selects a GBean implementing ConfigurationEntryFactory interface that has this name. The most likely choice is the GenericSecurityRealm of the same name. But other GBean types are possible, such as ServerRealmConfigurationEntry or (less likely) DirectConfigurationEntry. Make sure you know what GBean you are refererring to.

+ +

You can reuse Security Realm definitions in other configurations or include your own. For example, org/apache/geronimo/Security configuration contains geronimo-properties-realm GenericSecurityRealm. If you decide to define your own GenericSecurityRealm GBean, use GBean elements that are allowed by your deployment plan schema.

+ +

Note that Geronimo JAAS configuration GBean will complain if the name of your own GenericSecurityRealm GBean is a duplicate of some other configuration entry name that is already deployed. To avoid this kind of problems, use unique Security Realm names. Refer to Component Configuration, Configuring Security Realm section for the details how to configure your own GenericSecurityRealm.

+ +

Back to Top

+ +

Example of the Web application deployment with web-container neutral schema

+

To better understand this example make sure you read the Component Configuration, Configuring Security Realm section before.

+ +

Note that realm-principal and domain-principal wrap an instance of the class that implements Principal interface.

+ +
+
<web-app xmlns="http://geronimo.apache.org/xml/ns/j2ee/web-1.0">
+   ...
+   <security-realm-name>geronimo-properties-realm</security-realm-name>
+   <security:security 
+      xmlns:security="http://geronimo.apache.org/xml/ns/security-1.1">
+
+      <default-principal>
+         <principal class="org.apache.geronimo.security.realm.providers.GeronimoUserPrincipal" name="system"
+                designated-run-as="true"/>
+      </default-principal>
+
+      <role-mappings>
+         <role role-name="admin">
+            <login-domain-principal domain-name="geronimo-properties-realm"
+                name="admin" class="org.apache.geronimo.security.realm.providers.GeronimoGroupPrincipal"/>
+         </role>
+      </role-mappings>
+   </security:security>
+   ...
+</web-app>
+
+ +

This example defines principal as the default principal for the application and mapped J2EE admin role to the login-domain-principal named admin that wraps the org.apache.geronimo.securityrealm.providers.GeronimoGroupPrincipal class. In other words we maped J2EE admin role to the admin group from the
+geronimo-login-domain Login Domain.

+ +

In the example above, the Security Realm is presumed to be deployed elsewhere. For example org/apache/geronimo/Security configuration deploys geronimo-properties-realm: geronimo.server:J2EEApplication=null,J2EEModule=org/apache/geronimo/Security,J2EEServer=geronimo,j2eeType=SecurityRealm,name=geronimo-properties-realm

+ +

Back to Top

+ +

Deploying Web application on Jetty container

+

Jetty container deployment plan namespace is http://geronimo.apache.org/xml/ns/j2ee/web/jetty-1.0
+As far as security configuration is concerned it allows the same structure as the container-neutral schema:

+ +
+
<xs:schema targetNamespace="http://geronimo.apache.org/xml/ns/j2ee/web/jetty-1.0"  
+	xmlns:security="http://geronimo.apache.org/xml/ns/security-1.1">
+	<xs:complexType name="web-appType">
+	....
+		<xs:sequence minOccurs="0">
+    			<xs:element name="security-realm-name" type="xs:string"/>
+    			<xs:element ref="security:security" minOccurs="0"/>
+		</xs:sequence>
+	...
+	</xs:complexType>
+</xs:schema>
+
+ +

And security definition will be the same as in the container-neutral schema.

+ +
+
<web-app xmlns="http://geronimo.apache.org/xml/ns/j2ee/web/jetty-1.0">
+   ...
+   <security-realm-name>geronimo-properties-realm</security-realm-name>
+   <security:security 
+      xmlns:security="http://geronimo.apache.org/xml/ns/security-1.1">
+
+      <default-principal>
+         <principal class="org.apache.geronimo.security.realm.providers.GeronimoUserPrincipal" name="system"
+                designated-run-as="true"/>
+      </default-principal>
+
+      <role-mappings>
+         <role role-name="admin">
+            <login-domain-principal domain-name="geronimo-properties-realm"
+                name="admin" class="org.apache.geronimo.security.realm.providers.GeronimoGroupPrincipal"/>
+         </role>
+      </role-mappings>
+   </security:security>
+   ...
+</web-app>
+
+ +

Back to Top

+ +

Deploying Web application on Tomcat container

+

Tomcat container deployment plan namespace is http://geronimo.apache.org/xml/ns/j2ee/web/tomcat-1.0.
+As far as security configuration is concerned it allows the same structure as container-neutral schema:

+ +
+
<xs:schema targetNamespace="http://geronimo.apache.org/xml/ns/j2ee/web/tomcat-1.0"
+	xmlns:security="http://geronimo.apache.org/xml/ns/security-1.1">
+	<xs:complexType name="web-appType">
+	....
+		<xs:sequence minOccurs="0">
+    			<xs:element name="security-realm-name" type="xs:string"/>
+    			<xs:element ref="security:security" minOccurs="0"/>
+		</xs:sequence>
+	...
+	</xs:complexType>
+</xs:schema>
+
+ +

And security definition will be the same as in the container-neutral schema.

+ +
+
<web-app xmlns="http://geronimo.apache.org/xml/ns/j2ee/web/tomcat-1.0">
+   ...
+   <security-realm-name>geronimo-properties-realm</security-realm-name>
+   <security:security 
+      xmlns:security="http://geronimo.apache.org/xml/ns/security-1.1">
+
+      <default-principal>
+         <principal class="org.apache.geronimo.security.realm.providers.GeronimoUserPrincipal" name="system"
+                designated-run-as="true"/>
+      </default-principal>
+
+      <role-mappings>
+         <role role-name="admin">
+            <login-domain-principal domain-name="geronimo-properties-realm"
+                name="admin" class="org.apache.geronimo.security.realm.providers.GeronimoGroupPrincipal"/>
+         </role>
+      </role-mappings>
+   </security:security>
+   ...
+</web-app>
+
+ +

Back to Top

+ + +
+ + + + + + + +
Document generated by Confluence on Dec 15, 2005 19:14
+ + \ No newline at end of file Added: geronimo/branches/1.0/modules/scripts/src/resources/docs/Deployment plans.html URL: http://svn.apache.org/viewcvs/geronimo/branches/1.0/modules/scripts/src/resources/docs/Deployment%20plans.html?rev=357449&view=auto ============================================================================== --- geronimo/branches/1.0/modules/scripts/src/resources/docs/Deployment plans.html (added) +++ geronimo/branches/1.0/modules/scripts/src/resources/docs/Deployment plans.html Sat Dec 17 22:04:20 2005 @@ -0,0 +1,247 @@ + + + Documentation : Deployment plans + + + + + + + + + +
+ +
+ This page last changed on Dec 14, 2005 by hcunico@gmail.com. +
+ +


+Article donated by: Hernan Cunico

+ +

Deployment plans are the Geronimo version of the J2EE deployment descriptors. They are still XML files based on XML schemas and containing the configuration details for a specific application module. Via the deployment plans you can not only deploy application modules but also other configurations such as a security realm, see the Deploying secure applications and Deploy the LDAP realm sections for further details and examples.

+ +

The following table illustrates the deployment descriptors name and file location for both standard J2EE and Apache Geronimo specific.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FileStandard Deployment Descriptors in the J2EE specificationApache Geronimo specific Deployment plan
Web Application Archive (WAR)web.xml under the WEB-INF directorygeronimo-web.xml
Enterprise Web application archive (EAR)application.xmlgeronimo-application.xml
J2EE Connector resources archive (RAR)ra.xmlgeronimo-ra.xml
J2EE client application archive (JAR)client.xmlgeronimo-application-client.xml
JAR containing EJBsejb-jar.xml under the META-INF directoryopenejb-jar.xml
+ +

Here are some Geronimo specific deployment plan examples:

+ +

geronimo-web.xml

+
+
<web-app xmlns="http://geronimo.apache.org/xml/ns/web"
+         xmlns:naming="http://geronimo.apache.org/xml/ns/naming"
+         configId="MDBDemoWebApp"
+         parentId="MDBDemo">
+         
+     <context-root>messaging-ejb</context-root>    
+     
+    <ejb-ref>
+        <ref-name>ejb/CustomerHome</ref-name>
+        <target-name>geronimo.server:EJBModule=MDBDemo,J2EEApplication=null,J2EEServer=geronimo,j2eeType=EntityBean,name=CustomerEJB</target-name>
+    </ejb-ref>
+
+	<resource-ref>
+        <ref-name>jms/broker</ref-name>
+        <resource-link>DefaultActiveMQConnectionFactory</resource-link>
+    </resource-ref>
+    
+    <resource-env-ref>
+        <ref-name>jms/queue/DefQueue</ref-name>
+        <message-destination-link>SendReceiveQueue</message-destination-link>
+    </resource-env-ref>
+    
+</web-app>
+
+ +

Back to Top

+ +

geronimo-application.xml

+
+
<application xmlns="http://geronimo.apache.org/xml/ns/j2ee/application"
+	configId="com/ibm/j2g/security"
+	parentId="org/apache/geronimo/Server">
+
+    <security xmlns="http://geronimo.apache.org/xml/ns/security">
+        <default-principal realm-name="j2g">
+            <principal class="org.apache.geronimo.security.realm.providers.GeronimoUserPrincipal" name="system"/>
+        </default-principal>
+        <role-mappings>
+            <role role-name="authenticated">
+                <realm realm-name="j2g">
+                    <principal class="org.apache.geronimo.security.realm.providers.GeronimoGroupPrincipal" name="authenticated"/>
+                </realm>
+            </role>
+            <role role-name="uploader">
+                <realm realm-name="j2g">
+                    <principal class="org.apache.geronimo.security.realm.providers.GeronimoGroupPrincipal" name="uploader"/>
+               </realm>
+            </role>
+        </role-mappings>
+    </security>
+
+   	<gb:gbean name="j2g-realm" class="org.apache.geronimo.security.realm.GenericSecurityRealm"
+   		xmlns:gb="http://geronimo.apache.org/xml/ns/deployment-1.0">
+        <gb:reference name="ServerInfo">
+        	<gb:application>*</gb:application>
+        	<gb:module>org/apache/geronimo/System</gb:module>
+        	<gb:name>ServerInfo</gb:name>
+        </gb:reference>
+        <gb:reference name="LoginService">
+        	<gb:application>*</gb:application>
+        	<gb:module>org/apache/geronimo/Security</gb:module>
+        	<gb:name>JaasLoginService</gb:name>
+        </gb:reference>
+    	<gb:attribute name="realmName">j2g</gb:attribute>
+    	<gb:xml-reference name="LoginModuleConfiguration">
+    		<l:login-config xmlns:l="http://geronimo.apache.org/xml/ns/loginconfig">
+    			<l:login-module control-flag="REQUIRED" server-side="true">
+    				<l:login-domain-name>j2g</l:login-domain-name>
+    				<l:login-module-class>
+    					org.apache.geronimo.security.realm.providers.PropertiesFileLoginModule
+    				</l:login-module-class>
+     				<l:option name="usersURI">
+				    	var/security/j2g_users.properties
+			        </l:option>
+        			<l:option name="groupsURI">
+          				var/security/j2g_groups.properties
+        			</l:option>
+    			</l:login-module>
+    		</l:login-config>
+    	</gb:xml-reference>
+    </gb:gbean>
+</application>
+
+ +

Back to Top

+ +

geronimo-ra.xml

+
+
<?xml version="1.0" encoding="UTF-8"?>
+<connector xmlns="http://geronimo.apache.org/xml/ns/j2ee/connector" version="1.5"
+        configId="com/ibm/j2g/jca.rar" 
+        parentId="org/apache/geronimo/Server">
+
+    <resourceadapter>
+        <outbound-resourceadapter>
+            <connection-definition>
+                <connectionfactory-interface>com.ibm.j2g.jca.connector.FileRetrieverConnectionFactory</connectionfactory-interface>
+                <connectiondefinition-instance>
+                    <name>FileRetriever</name>
+                    <!-- The following path refers to the Geronimo home directory -->
+                    <config-property-setting name="RepositoryPath">..</config-property-setting>
+                    <connectionmanager>
+                        <no-transaction/>
+                        <no-pool/>
+                    </connectionmanager>
+                </connectiondefinition-instance>
+            </connection-definition>
+        </outbound-resourceadapter>
+    </resourceadapter>
+</connector>
+
+ +

Back to Top

+ +

geronimo-application-client.xml

+ +

ANY DONATIONS WOULD BE APPRECIATED HERE

+ +
+

+
+ +

Back to Top

+ +

openejb-jar.xml

+
+
<openejb-jar
+    xmlns="http://www.openejb.org/xml/ns/openejb-jar"
+    xmlns:naming="http://geronimo.apache.org/xml/ns/naming"
+    xmlns:security="http://geronimo.apache.org/xml/ns/security"
+    xmlns:sys="http://geronimo.apache.org/xml/ns/deployment"
+    configId="SessionBeanDemo" parentId="org/apache/geronimo/Server">
+ <enterprise-beans>
+ 	
+    <entity>
+        <ejb-name>CustomerEJB</ejb-name>
+        <jndi-name>CustomerHomeRemote</jndi-name>
+        <local-jndi-name></local-jndi-name>
+        <resource-ref>
+            <ref-name>jdbc/ibm-demo</ref-name>
+            <resource-link>SystemDatasource</resource-link>
+        </resource-ref>
+    </entity>
+    
+    <session>
+        <ejb-name>LoanManagerEJB</ejb-name>
+        <jndi-name>LoanManagerHomeRemote</jndi-name>
+        <ejb-ref>
+            <ref-name>ejb/CustomerHomeRemote</ref-name>
+            <ejb-link>CustomerEJB</ejb-link>
+        </ejb-ref>        
+   </session>
+ 	
+ 	<session>
+        <ejb-name>StatefulLoanManagerEJB</ejb-name>
+        <jndi-name>StatefulLoanManagerHomeRemote</jndi-name>
+        <ejb-ref>
+            <ref-name>ejb/CustomerHomeRemote</ref-name>
+            <ejb-link>CustomerEJB</ejb-link>
+        </ejb-ref>        
+   </session>
+   
+ </enterprise-beans>
+    
+</openejb-jar>
+
+ +

Back to Top

+ + +
+ + + + + + + +
Document generated by Confluence on Dec 15, 2005 19:14
+ + \ No newline at end of file Added: geronimo/branches/1.0/modules/scripts/src/resources/docs/Deployment.html URL: http://svn.apache.org/viewcvs/geronimo/branches/1.0/modules/scripts/src/resources/docs/Deployment.html?rev=357449&view=auto ============================================================================== --- geronimo/branches/1.0/modules/scripts/src/resources/docs/Deployment.html (added) +++ geronimo/branches/1.0/modules/scripts/src/resources/docs/Deployment.html Sat Dec 17 22:04:20 2005 @@ -0,0 +1,49 @@ + + + Documentation : Deployment + + + + + + + + + +
+ +
+ This page last changed on Dec 14, 2005 by hcunico@gmail.com. +
+ +


+Article donated by: Hernan Cunico

+ +

This section is an attempt to consolidate all the information and concepts related to deployment of applications and configurations. This list should expand as more content is shed to this Apache Geronimo V1 - Documentation.

+ + + + +

Back to top

+ + +
+ + + + + + + +
Document generated by Confluence on Dec 15, 2005 19:14
+ + \ No newline at end of file Added: geronimo/branches/1.0/modules/scripts/src/resources/docs/Development.html URL: http://svn.apache.org/viewcvs/geronimo/branches/1.0/modules/scripts/src/resources/docs/Development.html?rev=357449&view=auto ============================================================================== --- geronimo/branches/1.0/modules/scripts/src/resources/docs/Development.html (added) +++ geronimo/branches/1.0/modules/scripts/src/resources/docs/Development.html Sat Dec 17 22:04:20 2005 @@ -0,0 +1,46 @@ + + + Documentation : Development + + + + + + + + + +
+ +
+ This page last changed on Dec 14, 2005 by hcunico@gmail.com. +
+ +


+Article donated by:

+ +

Eclipse tools

+

Simple servlet and JSP applications

+

Web applications

+

EJB applications

+

Security applications

+

Web services applications

+

Client applications

+

...

+ + +
+ + + + + + + +
Document generated by Confluence on Dec 15, 2005 19:14
+ + \ No newline at end of file Added: geronimo/branches/1.0/modules/scripts/src/resources/docs/Geronimo Administration Console.html URL: http://svn.apache.org/viewcvs/geronimo/branches/1.0/modules/scripts/src/resources/docs/Geronimo%20Administration%20Console.html?rev=357449&view=auto ============================================================================== --- geronimo/branches/1.0/modules/scripts/src/resources/docs/Geronimo Administration Console.html (added) +++ geronimo/branches/1.0/modules/scripts/src/resources/docs/Geronimo Administration Console.html Sat Dec 17 22:04:20 2005 @@ -0,0 +1,436 @@ + + + Documentation : Geronimo Administration Console + + + + + + + + + +
+ +
+ This page last changed on Dec 14, 2005 by hcunico@gmail.com. +
+ +


+Article donated by: Hernan Cunico

+ +

The Geronimo Administration Console is a Web based interface that provides a convenient, user friendly way to administer many aspects of the Geronimo Server. Once you have the Apache Geronimo server started (see Tools and commands) you can access the Administration Console by pointing your browser to the following URL:

+ +

http://localhost:8080/console

+ +

The Administration Console log in page is depicted in the following figure.

+ +

+ +

Log in by specifying system as the username and manager as the password. Once you are logged in you will be redirected to the console's welcome page. The console has two main areas, a navigation panel on the left and a main content area on the right.

+ +

The navigation panel on the left provides easy access to the individual tasks, it is always present and allows easy transition from task to task. The main content area on the right is where the real work happens, this area will change as you select the different tasks in the navigation panel on the left. Each view contains one or more portlets that typically include a link for help in the header, see the following figure as an example.

+ +

+ +

Back to Top

+ +

Console Navigation (left panel)

+ +

As briefly explained in the previous section, the navigation panel provides access to the different tasks for administering the resources in Geronimo. This navigation panel is organized in the following main groups:

+ +

Welcome
+ Server
+ Services
+ Applications
+ Security
+ Misc

+ +

Welcome

+ +

This is the welcome page you see when you log in. It provides a gerenal description of what the Geronimo Administration Console is as well as some shortcut links to common tasks such as:

+ +

Common Console Actions

+ +
    +
  • Database Pools
  • +
  • Security Realms
  • +
  • JMS Resources
  • +
  • Deploy Applications
  • +
  • Web Server Ports
  • +
  • Memory & Uptime
  • +
+ + +

This page also provide links to:

+ +

Geronimo Online

+ + + + +

Geronimo Documentation

+ + + + +

Back to Top

+ +

Server

+ +

Organized under the Server group you will find statistical information as well as links for configuring and administering the different servers. This group is organized as follows:

+ +

Information
+ JVM
+ Server Logs
+ Shutdown
+ Web Server
+ JMS Server

+ +

Back to Top

+ +

Information

+ +

This portlet displays the server's uptime and the resources being used by the JVM.

+ +

JVM

+ +

This portlet displays the values of the system properties available to the server process.

+ +

Server Logs

+ +

This option provides four portlets, Log Manager, Server Log Viewer, Derby Log Viewer and Web Access Log Viewer.

+
    +
  • Log Manager
    +This portlet allows the user to select a configuration file for logging and/or change the log level and Refresh period. The default "Config file" is a standard log4j file and defines the location where the Geronimo Server will log Geronimo output. The configuration file also defines the log level, the maximum log file size, and other attributes associated with logging.
  • +
+ + +
    +
  • Server Log Viewer
    +This portlet displays the Geronimo server log and is helpful for debugging problems with the Geronimo Console and with deployed applications.
  • +
+ + +
    +
  • Derby Log Viewer
    +This portlet displays the log file for Geronimo's internal database, Derby.
  • +
+ + +
    +
  • Web Access Log Viewer
    +This portlet displays and filters the Web container log file. This log file contains HTTP accesses and messages from JSP and servlet applications that are running on Geronimo. By default this portlet displays the contents of the log file for the current date. You can apply different filtering criteria to view only data of your interest.
  • +
+ + +

Back to Top

+ +

Shutdown

+ +

This portlet allows a warm reboot of the server or a shutdown of it. A warm reboot will shutdown all applications and services and reboot the Geronimo kernel within the same process. The Administration Console session will be disconnected. Reconnect after the server is back up.

+ +

A shutdown will shutdown the server and cause the JVM to exit. To continue using the Geronimo Console after a shutdown, Geronimo must be restarted.

+ +

Back to Top

+ +

Web Server

+ +

This option provides two portlets, Web Server Manager and Network Listeners.

+
    +
  • Web Server Manager
    +When this portlet is enabled, it will collect server performance statistics. The values being meassured are:
  • +
+ + +
    +
  • +
      +
    • Requests
    • +
    • Connections
    • +
    • Errors
    • +
    • Active Resquests
    • +
    • Request Duration
    • +
    • Connections Open
    • +
    • Connection Requests
    • +
    • Connection Duration +
      +

      For the last five values, Count, Average and Maximum will be also displayed.

    • +
    +
  • +
  • Network Listeners
    +This portlet displays all the connector listeners (HTTP, HTTPS and AJP) and status for both Jetty and Tomcat Web containers. From this portlet you can add new listeners and change the status (stop, start, delete) of the existing connectors.
  • +
+ + +

Back to Top

+ +

JMS Server

+ +

This option provides two portlets, JMS Server Manager and JMS Network Listeners.

+
    +
  • JMS Server Manager
    +This portlet displays the available JMS Brokers and their status. From this portlet you can also start, stop, edit, add and delete JMS Brokers.
  • +
+ + +
    +
  • JMS Network Listeners
    +This portlet displays all the network connectors configured for the currently available JMS Brokers. From this portlet you can also start, stop, edit, add and delete JMS network connectors.
  • +
+ + +

Back to Top

+ +

Services

+ +

Organized under this group you will find links for configuring the following services:

+ +

Common Libraries
+ Database Pools
+ JMS

+ +

Common Libraries

+ +

This portlet displays the artifacts installed in the server's repository. The layout of the repository is the same as that used by Apache Maven making it possible to easily copy files over. From this portlet you can also install new artifacts.

+ +

Back to Top

+ +

Database Pools

+ +

This portlet displays all the available database pools and their status. Only server-wide database pools can be edited in this portlet, database pools deployed as part of a single application cannot, you will have to change the deployment plan in the application instead.

+ +

From this portlet you can edit the available, system-wide, database pools. There is also a usage link with examples of how to use the pool from your application.

+ +

This portlet includes a database pool creation wizard for new pools and also lets you import database pools from JBoss 4 and WebLogic 8.1.

+ +

Back to Top

+ +

JMS

+ +

This option provides two portlets, JMS Connection Factories and JMS Destination Manager.

+
    +
  • JMS Connection Factories
    +This portlet displays the JMS connectors that are configured on the server. From this portlet you can see the connectors status, display details, test the connection and new JMS Conneciton Factories.
  • +
+ + +
    +
  • JMS Destination Manager
    +This portlet is used to create and remove queues/topics.
  • +
+ + +

Back to Top

+ +

Applications

+ +

Organized under this group you will find links for installing and administering applications.

+ +

Deploy New
+ Application EARs
+ Web App WARs
+ EJB JARs
+ J2EE Connectors
+ App Clients
+ System Modules

+ +

Deploy New

+ +

This portlet allows you to deploy new applications on the Geronimo server. Web applications require deployment plans, which are either packaged with the war file or kept in a separate file which is typically called geronimo-web.xml.

+ +

Back to Top

+ +

Application EARs

+ +

This portlet displays the installed Application EARs and their status. From this portlet you can also stop, start and uninstall the available Application EARs.

+ +

Back to Top

+ +

Web App WARs

+ +

This portlet displays the installed Web Applications and their status. From this portlet you can also stop, start and uninstall the available Web Applications.

+ +

Back to Top

+ +

EJB JARs

+ +

This portlet displays the installed EJB JARs and their status. From this portlet you can also stop, start and uninstall the available EJB JARs.

+ +

Back to Top

+ +

J2EE Connectors

+ +

This portlet displays the installed J2EE Connectors and their status. From this portlet you can also stop, start and uninstall the available J2EE Connectors.

+ +

Back to Top

+ +

App Clients

+ +

This portlet displays the installed Application Clients and their status. From this portlet you can also stop, start and uninstall the available Application Clients.

+ +

Back to Top

+ +

System Modules

+ +

This portlet displays the installed System Modules and their status. From this portlet you can also stop, start and uninstall the available System Modules.

+ +

Back to Top

+ +

Security

+ +

Console Realm
+ Security Realm
+ Keystore

+ +

Console Realm

+ +

This option provides two portlets, Console Realm Users and Console Realm Groups.

+
    +
  • Console Realm Users
    +This portlet displays all the Console Realm Users and allows you to add, change password and delete them.
  • +
+ + +
    +
  • Console Realm Groups
    +This portlet displays all the Console Realm Groups and allows you to add, modify and delete them.
  • +
+ + +

Back to Top

+ +

Security Realm

+ +

This portlet displays all available security realms and their status. Only server-wide security realms can be edited in this portlet, security realms deployed as part of a single application cannot, you will have to change the deployment plan in the application instead.

+ +

From this portlet you can edit the available, system-wide, security realms. There is also a usage link with examples of how to use the realm from your application.

+ +

This portlet also includes a security realm creation wizard for creating new realms.

+ +

Back to Top

+ +

Keystore

+ +

This portlet displays the certificates installed, lets you import trusted certificates and generate a key pair.

+ +

Back to Top

+ +

Misc

+ +

At this point this group has only one entry and is for administering the embedded database. The breakdown of this group is as follows.

+ +

Embedded DB

+ + + + +

DB Info

+ +

This portlet displays information about the internal database, such as:

+
    +
  • Database Product name and version.
  • +
  • Driver and version.
  • +
  • Connection URL.
  • +
  • Supported functions and the supported SQL commands.
  • +
+ + +

Back to Top

+ +

DB Manager

+ +

This option provides two portlets, DB VIewer and Run SQL.

+
    +
  • DB Viewer
    +This portlet displays all the available databases and their tables and displays the contents of the tables. To view the tables in a particular database, click on the database link. This will show all the tables in the database. To view the contents of the tables, click on the View Contents link. At the bottom of the DB Viewer portlet there are links to take you back to View Databases or View Tables.
  • +
+ + +
    +
  • Run SQL
    +This portlet lets you run SQL commands to manipulate the data in the tables, create a new database or delete a database. You can enter the SQL commands in the SQL Command(s) text box, select the database that will be used and then click on Run SQL to excecute the command.
  • +
+ + +

Back to Top

+ +
+ + +
+ + console_1.jpg (image/pjpeg) +
+ + console_2.jpg (image/pjpeg) +
+ + ico_beanjar_16x16.gif (image/gif) +
+ + ico_connect_16x16.gif (image/gif) +
+ + ico_db_16x16.gif (image/gif) +
+ + ico_doc_16x16.gif (image/gif) +
+ + ico_folder_16x16.gif (image/gif) +
+ + ico_geronimo_16x16.gif (image/gif) +
+ + ico_list_16x16.gif (image/gif) +
+ + ico_lock_16x16.gif (image/gif) +
+ + ico_look_16x16.gif (image/gif) +
+ + ico_mail_16x16.gif (image/gif) +
+ + ico_servcomp_16x16.gif (image/gif) +
+ + ico_x_16x16.gif (image/gif) +
+
+ +
+ + + + + + + +
Document generated by Confluence on Dec 15, 2005 19:14
+ + \ No newline at end of file Added: geronimo/branches/1.0/modules/scripts/src/resources/docs/Geronimo Administration Console_attachments/console_1.jpg URL: http://svn.apache.org/viewcvs/geronimo/branches/1.0/modules/scripts/src/resources/docs/Geronimo%20Administration%20Console_attachments/console_1.jpg?rev=357449&view=auto ============================================================================== Binary file - no diff available. Propchange: geronimo/branches/1.0/modules/scripts/src/resources/docs/Geronimo Administration Console_attachments/console_1.jpg ------------------------------------------------------------------------------ svn:mime-type = application/octet-stream Added: geronimo/branches/1.0/modules/scripts/src/resources/docs/Geronimo Administration Console_attachments/console_2.jpg URL: http://svn.apache.org/viewcvs/geronimo/branches/1.0/modules/scripts/src/resources/docs/Geronimo%20Administration%20Console_attachments/console_2.jpg?rev=357449&view=auto ============================================================================== Binary file - no diff available. Propchange: geronimo/branches/1.0/modules/scripts/src/resources/docs/Geronimo Administration Console_attachments/console_2.jpg ------------------------------------------------------------------------------ svn:mime-type = application/octet-stream Added: geronimo/branches/1.0/modules/scripts/src/resources/docs/Geronimo Administration Console_attachments/ico_beanjar_16x16.gif URL: http://svn.apache.org/viewcvs/geronimo/branches/1.0/modules/scripts/src/resources/docs/Geronimo%20Administration%20Console_attachments/ico_beanjar_16x16.gif?rev=357449&view=auto ============================================================================== Binary file - no diff available. Propchange: geronimo/branches/1.0/modules/scripts/src/resources/docs/Geronimo Administration Console_attachments/ico_beanjar_16x16.gif ------------------------------------------------------------------------------ svn:mime-type = application/octet-stream Added: geronimo/branches/1.0/modules/scripts/src/resources/docs/Geronimo Administration Console_attachments/ico_connect_16x16.gif URL: http://svn.apache.org/viewcvs/geronimo/branches/1.0/modules/scripts/src/resources/docs/Geronimo%20Administration%20Console_attachments/ico_connect_16x16.gif?rev=357449&view=auto ============================================================================== Binary file - no diff available. Propchange: geronimo/branches/1.0/modules/scripts/src/resources/docs/Geronimo Administration Console_attachments/ico_connect_16x16.gif ------------------------------------------------------------------------------ svn:mime-type = application/octet-stream Added: geronimo/branches/1.0/modules/scripts/src/resources/docs/Geronimo Administration Console_attachments/ico_db_16x16.gif URL: http://svn.apache.org/viewcvs/geronimo/branches/1.0/modules/scripts/src/resources/docs/Geronimo%20Administration%20Console_attachments/ico_db_16x16.gif?rev=357449&view=auto ============================================================================== Binary file - no diff available. Propchange: geronimo/branches/1.0/modules/scripts/src/resources/docs/Geronimo Administration Console_attachments/ico_db_16x16.gif ------------------------------------------------------------------------------ svn:mime-type = application/octet-stream Added: geronimo/branches/1.0/modules/scripts/src/resources/docs/Geronimo Administration Console_attachments/ico_doc_16x16.gif URL: http://svn.apache.org/viewcvs/geronimo/branches/1.0/modules/scripts/src/resources/docs/Geronimo%20Administration%20Console_attachments/ico_doc_16x16.gif?rev=357449&view=auto ============================================================================== Binary file - no diff available. Propchange: geronimo/branches/1.0/modules/scripts/src/resources/docs/Geronimo Administration Console_attachments/ico_doc_16x16.gif ------------------------------------------------------------------------------ svn:mime-type = application/octet-stream Added: geronimo/branches/1.0/modules/scripts/src/resources/docs/Geronimo Administration Console_attachments/ico_folder_16x16.gif URL: http://svn.apache.org/viewcvs/geronimo/branches/1.0/modules/scripts/src/resources/docs/Geronimo%20Administration%20Console_attachments/ico_folder_16x16.gif?rev=357449&view=auto ============================================================================== Binary file - no diff available. Propchange: geronimo/branches/1.0/modules/scripts/src/resources/docs/Geronimo Administration Console_attachments/ico_folder_16x16.gif ------------------------------------------------------------------------------ svn:mime-type = application/octet-stream Added: geronimo/branches/1.0/modules/scripts/src/resources/docs/Geronimo Administration Console_attachments/ico_geronimo_16x16.gif URL: http://svn.apache.org/viewcvs/geronimo/branches/1.0/modules/scripts/src/resources/docs/Geronimo%20Administration%20Console_attachments/ico_geronimo_16x16.gif?rev=357449&view=auto ============================================================================== Binary file - no diff available. Propchange: geronimo/branches/1.0/modules/scripts/src/resources/docs/Geronimo Administration Console_attachments/ico_geronimo_16x16.gif ------------------------------------------------------------------------------ svn:mime-type = application/octet-stream Added: geronimo/branches/1.0/modules/scripts/src/resources/docs/Geronimo Administration Console_attachments/ico_list_16x16.gif URL: http://svn.apache.org/viewcvs/geronimo/branches/1.0/modules/scripts/src/resources/docs/Geronimo%20Administration%20Console_attachments/ico_list_16x16.gif?rev=357449&view=auto ============================================================================== Binary file - no diff available. Propchange: geronimo/branches/1.0/modules/scripts/src/resources/docs/Geronimo Administration Console_attachments/ico_list_16x16.gif ------------------------------------------------------------------------------ svn:mime-type = application/octet-stream Added: geronimo/branches/1.0/modules/scripts/src/resources/docs/Geronimo Administration Console_attachments/ico_lock_16x16.gif URL: http://svn.apache.org/viewcvs/geronimo/branches/1.0/modules/scripts/src/resources/docs/Geronimo%20Administration%20Console_attachments/ico_lock_16x16.gif?rev=357449&view=auto ============================================================================== Binary file - no diff available. Propchange: geronimo/branches/1.0/modules/scripts/src/resources/docs/Geronimo Administration Console_attachments/ico_lock_16x16.gif ------------------------------------------------------------------------------ svn:mime-type = application/octet-stream Added: geronimo/branches/1.0/modules/scripts/src/resources/docs/Geronimo Administration Console_attachments/ico_look_16x16.gif URL: http://svn.apache.org/viewcvs/geronimo/branches/1.0/modules/scripts/src/resources/docs/Geronimo%20Administration%20Console_attachments/ico_look_16x16.gif?rev=357449&view=auto ============================================================================== Binary file - no diff available. Propchange: geronimo/branches/1.0/modules/scripts/src/resources/docs/Geronimo Administration Console_attachments/ico_look_16x16.gif ------------------------------------------------------------------------------ svn:mime-type = application/octet-stream Added: geronimo/branches/1.0/modules/scripts/src/resources/docs/Geronimo Administration Console_attachments/ico_mail_16x16.gif URL: http://svn.apache.org/viewcvs/geronimo/branches/1.0/modules/scripts/src/resources/docs/Geronimo%20Administration%20Console_attachments/ico_mail_16x16.gif?rev=357449&view=auto ============================================================================== Binary file - no diff available. Propchange: geronimo/branches/1.0/modules/scripts/src/resources/docs/Geronimo Administration Console_attachments/ico_mail_16x16.gif ------------------------------------------------------------------------------ svn:mime-type = application/octet-stream Added: geronimo/branches/1.0/modules/scripts/src/resources/docs/Geronimo Administration Console_attachments/ico_servcomp_16x16.gif URL: http://svn.apache.org/viewcvs/geronimo/branches/1.0/modules/scripts/src/resources/docs/Geronimo%20Administration%20Console_attachments/ico_servcomp_16x16.gif?rev=357449&view=auto ============================================================================== Binary file - no diff available. Propchange: geronimo/branches/1.0/modules/scripts/src/resources/docs/Geronimo Administration Console_attachments/ico_servcomp_16x16.gif ------------------------------------------------------------------------------ svn:mime-type = application/octet-stream Added: geronimo/branches/1.0/modules/scripts/src/resources/docs/Geronimo Administration Console_attachments/ico_x_16x16.gif URL: http://svn.apache.org/viewcvs/geronimo/branches/1.0/modules/scripts/src/resources/docs/Geronimo%20Administration%20Console_attachments/ico_x_16x16.gif?rev=357449&view=auto ============================================================================== Binary file - no diff available. Propchange: geronimo/branches/1.0/modules/scripts/src/resources/docs/Geronimo Administration Console_attachments/ico_x_16x16.gif ------------------------------------------------------------------------------ svn:mime-type = application/octet-stream