The Buttso Blathers

ServerSent-Events on WebLogic Server

2012-09-24T10:54:00.004+09:30

In addition to the WebSocket support we've added into the next major release of WebLogic Server (version 12.1.2 with all usual caveats with respect to release timeframes, no guarantee, etc.) we've also added support for the HTML5 ServerSent-Event model through collaborating with the GlassFish team and integrating the GlassFish ServerSent-Event feature.

The HTML5 ServerSent-Event model provides a mechanism to allow browser clients to establish a uni-directional communication path to a server, where the server is then able to push messages to the browser at any point in time.

A common JavaScript API (EventSource) is provided in modern browsers that allows the client to establish connections to the server and register callback functions to handle events as they come in over the connection, which can then be used to make any necessary page updates.

Some good sources of information on ServerSent-Events/EventSources are:

This new feature in WebLogic Server and GlassFish provides a small Java API and a couple of annotations that developers use to create and publish ServerSent-Event handlers, from which applications on the server can use to send messages to connected browser clients at any time, essentially enabling applications to push messages to clients over standard HTTP(S).

The runtime component of the feature uses CDI to instantiate and manage the handlers and support the injection of them into other application components as well as setting up and managing the asynchronous connection for each client.

Jitu from the GlassFish team provided some information on the feature earlier in the year:

http://weblogs.java.net/blog/jitu/archive/2012/04/20/server-sent-events-sse-glassfish

Bhakti also from the GlassFish team has a posting with an example of a SSE application that fetches data from a twitter feed and republishes to clients:

http://weblogs.java.net/blog/bhaktimehta/archive/2012/04/21/server-sent-events-sample-glassfish

Here it is running on a development build of WebLogic Server 12.1.2.

Besides being an interesting new feature with lots of possibilities, this also serves to demonstrate how the WebLogic and GlassFish teams are cooperating and producing innovative outcomes.

WebSockets on WebLogic Server

2012-09-18T10:10:00.001+09:30

We've been busy working on putting in support for the WebSocket Protocol into WebLogic Server with the intent to include it in the next major release (usual caveats apply with respect to dates, times, features, etc.). Running the Autobahn WS Testsuite, which seems to be the industry defacto WebSocket compatibility verifier, we are seeing reports with very high levels of compatibility.

As there's no standard WebSocket Java API at this point, we've chosen to model the API on the Grizzly WebSocket API with some minor changes where necessary. Once the results of JSR-356 (Java API for WebSocket) becomes public, we'll look to implement and support that.

In the background we have also done some integration work with the earlier WebSocket-SDK that was being used as a vehicle for WebSocket API investigations in order to try it out and look at the SPI requirements -- but we won't expose it in WLS 12.1.2 and will wait for the formal Java API for WebSocket to be finalized.

Back to WLS 12.1.2 and it's WebSocket API, as an exercise, I just ported the Apache Tomcat WebSocket demo called snake to run on WLS.

The original Tomcat demo source is here:

http://svn.apache.org/viewvc/tomcat/trunk/webapps/examples/WEB-INF/classes/websocket/snake/

Here it is running on a development build of WebLogic Server 12.1.2.

There are some differences in terms of handling of connections and the registration approach but it was a pretty straight forward exercise and took about 30 minutes. The demo didn't require too many major changes as the APIs are semantically similar in terms of accepting connections, handling messages and sending/broadcasting messages to clients. Thankfully I didn't have to do anything on the client JavaScript side ... :-)

We also have the Grizzy/GlassFish Chat demo running on WLS as well.

More info to come as we progress the documentation, etc. Should be some demos of this running at OOW this year too I'd guess.

JSF Managed Beans, @PostConstruct and CDI

2012-07-02T13:29:00.000+09:30

In a similar vein to my last post, with this blog I'd like to try and raise the visibility of another bug that is being seen in a few different places, and for which there is already a patch available for it.

The basic issue here is that when an application is using JSF Managed Beans that in turn make use of the @PostContruct lifecycle annotation to execute some post-construction tasks, if the WEB-INF/beans.xml file is included and thus enables the CDI circuitry, the @PostConstruct method on the JSF ManagedBean is no longer invoked.

The good news is that if this scenario is part of your application design, then you can pick up and apply a patch for WLS 12c that will resolve the issue.

The relevant base bug # is 13703600 and the Smart Update patch ID is UXPH.

From what I've read in the bug logs, we're also looking to include this fix in one of the patch-set-updates (PSUs) we are providing, so anyone that applies the relevant PSU should automatically get this fix.

Multipart File Upload with WLS 12c

2012-06-25T14:53:00.004+09:30

Multipart File Upload with WLS 12c

Just a word for anyone out there looking to use the Servlet 3.0 file upload feature with WLS 12c.

If you use the annotation approach on the Servlet class, it works perfectly well

However if you use the web.xml file to specify or override specific values using the multipart-config settings, then we have a small issue when we parse and apply those settings to the underling configuration bean. This results in the maxFileSize value always being set to a value of 0.

Ultimately this manifests itself as a problem when uploading any file since the file size will always exceed the maximum allowed size of 0.

The good news is there's a fix already available for it -- if you run into it, look for the patch for bug#14915431 or SmartUpdate patch 8EC8.

WebLogic and EJB 3.1 @Singleton @Startup with @PostConstruct

2012-04-04T12:41:00.000+09:30

That's quite the mouthful of annotations ..

A question was posed recently on the WLS EJB OTN forum asking about why WLS doesn't correctly support this combination of annotations, where the method with the @PostConstruct annotation was not being called as expected.

I thought I'd check it out with a simple test, which I'm sharing here.

1. Using NetBeans, I created a new "Web Application" project and assigned it to use my local WebLogic Server 12c installation.

2.Within the project, I created an EJB 3.1 Singleton using the NetBeans wizard. Not that creating EJBs in Java EE 6 requires this sort of assistance any more, having done away with most of the gunk from earlier versions of the specification. With EJB 3.1, an EJB can now be just a class with annotations and the logic. That's it. Simple.

3. On the EJB 3.1 Singleton, I then added the @Startup annotation to indicate that the bean must be instantiated when the container starts. I also added a method which I annotated with @PostContruct to indicate it should be called after the class has been instantiated via its constructor. The method prints a message to standard out when it is called.

I also added an instance variable with a default value, that is subsequently changed in the init method. Accessing this from a servlet will also show whether the init method was invoked.

/*
 * To change this template, choose Tools | Templates
 * and open the template in the editor.
 */
package sab.demo;

import java.util.Date;
import javax.annotation.PostConstruct;
import javax.ejb.Singleton;
import javax.ejb.LocalBean;
import javax.ejb.Startup;

/**
 *
 * @author sbutton
 */
@Singleton
@Startup
public class TestSingletonBean {
    
    private String TESTVAL = "IF YOU SEE THIS @POSTCONSTRUCT HAS NOT BEEN CALLED";
    
    @PostConstruct
    void init() {
        TESTVAL = "@PostConstruct method was called on " + new Date();
        System.out.printf("\n\nIn init: %s\n", TESTVAL);
    }
    
    public String getTestVal() {
        return TESTVAL; 
    }    
}

5. Since this test app is making use of the new Java EE 6 ease-of-use features that support the deployment of EJBs in Web applications, I could simply deploy this web application to see if the EJB Singleton was started on deployment and whether the @PostConstruct method was called.

Looking on the console where WebLogic Server was started in NetBeans, the message from the init method is seen right after the application deployment completes.

This demonstrates that WebLogic Server is correctly handling EJB 3.1 with @Singleton, @Startup and @PostConstruct.

6. Taking it one minor step further.

To independently observe the value of TESTVAL to ensure it has been modified via the init method, in the same project (it's very handy this web and ejb cohabitation ...) I added a servlet using the @WebServlet annotation.

In the servlet, I used the @EJB annotation to obtain a reference to the @Singleton and displayed the result of calling its getTestVal method on the page.

/*
 * To change this template, choose Tools | Templates
 * and open the template in the editor.
 */
package sab.demo;

import java.io.IOException;
import java.io.PrintWriter;
import javax.ejb.EJB;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 *
 * @author sbutton
 */
@WebServlet(name = "TestServlet", urlPatterns = {"/TestServlet", "/test"})
public class TestServlet extends HttpServlet {

    @EJB
    TestSingletonBean singleton;

    protected void doGet(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        response.setContentType("text/html;charset=UTF-8");
        PrintWriter out = response.getWriter();
        try {
            out.println("");
            out.println("");
            out.println("<title>Servlet TestServlet</title>");
            out.println("");
            out.println("");
            out.println("<h1>Servlet TestServlet at " + request.getContextPath() + "</h1>");
            out.printf("<p>Singleton TESTVAL: %s</p>", singleton.getTestVal());
            out.println("");
            out.println("");
        } finally {
            out.close();
        }
    }
}

7. Calling this from a browser shows the value of TESTVAL to be that set in the init method.

So in summary, this simple example shows WebLogic Server 12c supporting the EJB @Singleton and @Startup semantics correctly.

WebLogic Server Singleton Services

2012-03-05T15:05:00.002+10:30

WebLogic Server has supported the notion of a Singleton Service for a number of releases, in which WebLogic Server will maintain a single instance of a configured singleton service on one managed server within a cluster. The singleton can be migrated to another server in the cluster, either automatically if it's current hosting server becomes available, or manually at an operators request. The singleton can be optionally be configured with a preferred server to run on, as well as a set of named servers to which it can be migrated. A singleton can be deployed as a standalone service or as part of an application deployment.

The documentation for the singleton server is here:

http://docs.oracle.com/cd/E24329_01/web.1211/e24425/service_migration.htm#i1051668

With this capability, a question arises from time-to-time whether the Singleton Service feature in WebLogic Server can be used to provide a cluster wide singleton service for applications to use

The answer to this is yes, but it requires you to do a few things to expose the singleton instance to applications running in the cluster so that it can be looked up and used.

Since a singleton service is basically a POJO that implements the weblogic.cluster.singleton.SingletonService interface, which gets instantiated and managed by WebLogic Server, it doesn't have a surface area that allows it to be seen by applications running in the cluster.

To allow the singleton service to be used by applications, in addition to implementing the basic logic that is required, it also needs to perform the following tasks:

Provide an RMI Remote interface that the singleton service additionally implements, which then allows it to be accessed and invoked from any server in the cluster
When the singleton service is activated, it binds itself into the cluster-wide JNDI tree
When the singleton service is deactivated, unbinds itself from the cluster-wide JNDI tree

DemoSingletonImpl

package sab.demo.wlssingletoninstance;

import java.rmi.Remote;
import java.rmi.RemoteException;

/**
 *
 * @author sbutton
 */
public interface DemoSingleton extends Remote {
    
    public final String JNDI_NAME="DemoSingleton";
    
    public String singletonLocation();
    
    public String getWebLogicServerName();
    public String getHostName();
    
    public int increment();
    public int value();
    
}

DemoSingletonImpl

package sab.demo.wlssingletoninstance;

import java.net.InetAddress;
import java.net.UnknownHostException;
import java.rmi.RemoteException;
import java.util.logging.Logger;
import javax.naming.Context;
import javax.naming.NamingException;
import javax.rmi.PortableRemoteObject;
import weblogic.cluster.singleton.SingletonService;
import weblogic.jndi.Environment;

/**
 * Example of a WebLogic Server Singleton Service that can be accessed from
 * other deployed components.
 *
 * @author sbutton
 */
public class DemoSingletonImpl implements DemoSingleton, SingletonService {

    private Integer counter = 0;
    final private Logger logger = new Logger().getLogger("DemoSingletonImpl");

    public DemoSingletonImpl() {
        super();
        logger.info("Constructor");
    }

    // ================================================================ //
    // ===================== Singleton Service Methods ================ //
    // ================================================================ //
    
    @Override
    public void activate() {
        logger.info("Activate on " + singletonLocation());
        counter = 0;
        try {
            Environment env = new Environment();
            Context ctx = env.getInitialContext();
            ctx.rebind(JNDI_NAME, this);
            logger.info("Executed bind for: " + JNDI_NAME);
            logger.info(String.format("Looking up JNDI_NAME returns: %s", ctx.lookup(JNDI_NAME).getClass().getName()));
            //quickTest();

        } catch (NamingException e) {
            logger.warning("Unable to bind: " + this.getClass().getName() + " into JNDI as:" + this.getClass().getName() + ", Error: " + e.getMessage());
        }
    }

    @Override
    public void deactivate() {
        logger.info("Deactivate on " + singletonLocation());
        try {
            Environment env = new Environment();
            Context ctx = env.getInitialContext();
            ctx.unbind(JNDI_NAME);
            logger.info("Executed unbind for: " + JNDI_NAME);
        } catch (NamingException e) {
            System.out.println("\tUnable to unbind from JNDI as: " + JNDI_NAME + ", Error: " + e.getMessage());
        }
    }

    // ================================================================ //
    // ========================= Remotable Methods ==================== //
    // ================================================================ //
    
    @Override
    public String singletonLocation()  {
        return String.format("%s %s",
                getHostName(),
                getWebLogicServerName());
    }

    @Override
    public String getWebLogicServerName() {
        return Utilities.getWebLogicServerName();
    }

    @Override
    public String getHostName() {
        return Utilities.getHostName();
    }

    @Override
    public synchronized int increment() {
        counter++;
        return counter.intValue();
    }

    @Override
    public int value() {
        return counter.intValue();
    }

    // ================================================================ //
    // ========================== Private Methods ===================== //
    // ================================================================ //    
    
    /**
     * Called on activate to verify binding is available
     */
    private void quickTest() {
        try {
            Environment env = new Environment();
            Context ctx = env.getContext();
            DemoSingleton singleton =
                    (DemoSingleton) PortableRemoteObject.narrow(ctx.lookup(DemoSingleton.JNDI_NAME), DemoSingleton.class);
            logger.info("quickTest: " + singleton.singletonLocation());
        } catch (Exception ne) {
            logger.log(Logger.SEVERE, ne);
            logger.severe("Error: %s" + ne.getMessage());
        }
    }
}

Deploying and Configuring the Singleton
To deploy the singleton in standalone mode, compile and package the classes into a JAR file and put the JAR file into the WebLogic Server classpath. Note this needs to be done on each physical machine where the managed servers in the cluster run.

You configure a singleton service instance for cluster using the WebLogic Server console.

This ultimately writes an entry in the domain's config.xml as such:

<singleton-service>
  <name>DemoSingleton</name>
  <user-preferred-server>Mike</user-preferred-server>
  <class-name>sab.demo.wlssingletoninstance.DemoSingletonImpl</class-name>
  <cluster>Tingles</cluster>
</singleton-service>

When the preferred managed server starts, the singleton service will be instantiated.

<Mar 2, 2012 3:25:32 PM CST> <Notice> <Cluster> <BEA-000102> <Joining cluster Tingles on 239.192.0.0:7001> 
<Mar 2, 2012 3:25:33 PM CST> <Notice> <WebLogicServer> <BEA-000365> <Server state changed to RUNNING.> 
<Mar 2, 2012 3:25:33 PM CST> <Notice> <WebLogicServer> <BEA-000360> <The server started in RUNNING mode.> 
[] INFO Activate on Steve-Button-MacBook-Pro.local Mike
[] INFO Executed bind for: DemoSingleton
[] INFO Looking up JNDI_NAME returns: sab.demo.wlssingletoninstance.DemoSingletonImpl
[] INFO quickTest: Steve-Button-MacBook-Pro.local Mike

Performing a manual migration using the console, the singleton gets deactivated on the current server and activated on another.

[] INFO Deactivate on Steve-Button-MacBook-Pro.local Mike
[] INFO Executed unbind for: DemoSingleton

<Mar 2, 2012 3:25:34 PM CST> <Notice> <WebLogicServer> <BEA-000360> <The server started in RUNNING mode.> 
[] INFO Activate on Steve-Button-MacBook-Pro.local James
[] INFO Executed bind for: DemoSingleton
[] INFO Looking up JNDI_NAME returns: sab.demo.wlssingletoninstance.DemoSingletonImpl
[] INFO quickTest: Steve-Button-MacBook-Pro.local James

Using the Singleton
Applications wishing to use the singleton service then need to look it up from the cluster-wide JNDI tree, narrow it to singleton service type and invoke it's methods as needed.

  private DemoSingleton getSingleton() throws ClassCastException, NamingException {
    Context ctx = getInitialContext()
    DemoSingleton singleton = (DemoSingleton) PortableRemoteObject.narrow(ctx.lookup(DemoSingleton.JNDI_NAME), DemoSingleton.class);
    return singleton;
}

Using this in a servlet for example, you can see how the servlet running on the managed server Mike is able to access the singleton service running on managed server James.

When the singleton service is migrated, the servlet then seamlessly accesses it on the other managed server, where it is now co-located in this specific example below.

Summary
This is obviously a fairly simple example but it should highlight the basic requirements and method to create an cluster wide singleton that can be used by applications.

WebLogic Server 11g (10.3.6) Documentation

2012-03-01T16:30:00.000+10:30

The OTN documentation pages don't appear yet to have a link to the WLS 10.3.6 documentation set.

If you are looking for it in the interim you can find it here:

http://docs.oracle.com/cd/E23943_01/wls.htm

While this is predominantly a patchset, there are a number of new features listed in the What's New in WebLogic Server document.

Some worthy examples are:

Java SE 7 support
Storing transaction logs (TLOG) in a database
GlassFish web deployment descriptor support
Enable RESTful Web Services with JAX-RS and Jersey 1.9
DataSource changes to support setting credentials on a connection and using proxy connections
Application scoped JDBC drivers, where a JDBC driver can be deployed within an EAR file

Web application filtering classloader documentation update

2012-03-01T16:13:00.000+10:30

Following a posting on here last year that described using the filtering classloader within a web application, several folks commented that it wasn't described in the documentation.

The WebLogic Server 12c (12.1.1.0) documentation shows the prefer-application-packages and prefer-application-resources elements as being available in the weblogic.xml file.

http://docs.oracle.com/cd/E24329_01/web.1211/e21049/weblogic_xml.htm#autoId24

The WebLogic Server 11g (10.3.6.0) documentation should also include this when it gets pushed out to OTN.

<wls:weblogic-web-app>
     <wls:weblogic-version>12.1.1</wls:weblogic-version>
     <wls:context-root>FilterWeb</wls:context-root>
     <wls:container-descriptor>
         <wls:prefer-application-packages>
             <wls:package-name>com.oracle.foo</wls:package-name>
         </wls:prefer-application-packages>
     </wls:container-descriptor>
</wls:weblogic-web-app>

WebLogic Server 12c - Identifying versions of modules, libraries, frameworks

2011-12-12T14:42:00.000+10:30

Now that WebLogic Server 12c has been released, it's interesting to look at the various libraries, modules and open-source frameworks it uses.

One approach to doing this is to use the wls-cat utility to search for a known class from the framework, module or open-source framework you are interested in looking at, and observing where the class is loaded from and the corresponding library version.

JavaServer Faces

One important item to note here is that as of the WebLogic Server 12c release, the JSF implementation has been added directly to the WebLogic Server classpath. This is a change from the WebLogic Server 11g release where the JSF implementation was provided as an optional shared-library, which needed to be deployed in order for applications to use JSF. With WebLogic Server 12c, JSF is now an integral part of the server and can be used without the necessity of deploying and referencing the shared-library.

javax.faces.webapp.FacesServlet:

com.sun.faces.facelets.Facelet:

Using:

JSF 2.1
Mojarra 2.1.5

Java Persistence API / EclipseLink

javax.persistence.Entity:

org.eclipse.persistence.jpa.JpaEntityManager:

Using:

JPA 2.0
EclipseLink 2.3

Context and Dependency Injection/Weld

javax.enterprise.inject.Model:

org.jboss.weld.Container:

Using:

CDI 1.0
Weld 1.1.3-SP1

SLF4J

org.slf4j.Logger:

Using:

SLF4J 1.6.1

WebLogic Server 12c - Maven Usage Notes

2011-12-12T10:42:00.001+10:30

Note: apologies for the formatting, this posting was a cut and paste from a .docx document and thus has all the styles inlined. In the interests of time, I thought it was better to just post it as-is and make it available, rather than try and reformat it. Which I know I'd keep pushing off until eternity.

This document provides a short overview of installing, configuring and using the new wls-maven-plugin provided in WebLogic Server 12c.

Convention Over Configuration

With the wls-maven-plugin:12.1.1.0 we have followed the theme of Maven and used a convention-over-configuration approach. This means that for a set of the commonly used configuration elements, we have adopted a sensible, consistent set of default values that can be used across all of the goals. This reduces the amount of configuration necessary to use the plugin and helps achieve uniform goal executions, even in different environments.

The common configuration elements are:

middlewareHome: ${project.basedir}/Oracle/Software

weblogicHome: “wlserver” or “wlserver_12.1”, depending on the install type

domainHome: ${project.basedir}/Oracle/Domains

source: ${project.build.directory}/${project.build.finalName}.${project.packaging}

adminurl: t3://localhost:7001

While these configuration parameters have default values, they can all be overridden in a pom.xml file or on the command line as need be.

However by having them be sensible defaults, they can be left out of a configuration section and used consistently across all of the goals.

As an example, it’s possible to issue the following commands that all use the same WLS installation and domain without specifying any repetitive values:

$ wls:install -
DartifactLocation=/Users/sbutton/Downloads/wls/wls_1211/wls1211_dev.zip

$ wls:create-domain –Duser=weblogic –Dpassword=welcome1

$ wls:start-server

Installing the Plugin

For WLS 12c, the wls-maven-plugin is provided as a pre-built jar file and the

accompanying pom.xml file is also provided as an easily accessible file in the same directory.

$MW_HOME/wlserver/server/lib/wls-maven-plugin.jar

$MW_HOME/wlserver/server/lib/pom.xml

The wls-maven-plugin is installed using the following commands:

$ cd $MW_HOME/wlserver/server/lib

$ mvn install

$ mvn install:install-file –Dfile=wls-maven-plugin.jar –DpomFile=pom.xml

The default pom.xml file now has the required setting to enable the use of the “wls” goal prefix enabled by default.

To use the “wls” goalPrefix, you will need to edit the Maven settings.xml file and add the following entry:

<pluginGroups>

<pluginGroup>com.oracle.weblogic</pluginGroup>

</pluginGroups>

Once you have installed the plugin, you can very simply validate it using the wls:help goal.

$ mvn wls:help

This goal does not require a project or pom.xml and will display the list of goals available in the wls-maven-plugin if the plugin has been successfully installed.

Basic Configuration of Plugin

Below is an example of a basic Java EE 6 Web Application pom.xml file that enables the use of the wls-maven-plugin.

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

<artifactId>maven-demo</artifactId>

<version>1.0-SNAPSHOT</version>

<name>maven-demo</name>

<endorsed.dir>${project.build.directory}/endorsed</endorsed.dir>

<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

</properties>

<groupId>javax</groupId>

<artifactId>javaee-web-api</artifactId>

<scope>provided</scope>

</dependency>

</dependencies>

<build>

...

<plugin>

<groupId>com.oracle.weblogic</groupId>

<artifactId>wls-maven-plugin</artifactId>

<version>12.1.1.0</version>

</plugin>

</plugins>

</build>

</project>

Install

This goal installs WLS into a local directory to enable it to be used execute the other goals, as well as a installation to create a WLS domain that can be used to deploy and test the application represented as the Maven project.

To install, you need a distribution to install. This is specified using the <artifactLocation> configuration element in the wls-maven-plugin section of the pom.xml, or specify it using the –DartifactLocation property when Maven is invoked.

The target directory for the installation is specified using the optional weblogicHome configuration element. This is set to ${basedir}/Oracle/Software by default. Specifying a <middlewareHome> value will direct the install to be performed in the specified location.

I will focus on the zip distribution since it reflects a development usage model.

The location of the zip distribution can be specified as one of the following:

a) local file reference

For a local file reference, you specify the path on the local file system

<groupId>com.oracle.weblogic</groupId>

<artifactId>wls-maven-plugin</artifactId>

<artifactLocation>

/Users/sbutton/Downloads/wls/wls_1211/wls1211_dev.zip

</artifactLocation>

</configuration>

</plugin>

The execution of the wls:install goal is shown below.

sbutton:~/Projects/Java/wls-maven-doc/maven-demo $ mvn wls:install

[INFO] Scanning for projects...

[INFO]

[INFO] ------------------------------------------------------------------------

[INFO] Building maven-demo 1.0-SNAPSHOT

[INFO] ------------------------------------------------------------------------

[INFO]

[INFO] --- wls-maven-plugin:12.1.1.0:install (default-cli) @ maven-demo ---

[INFO] ++====================================================================++

[INFO] ++ wls-maven-plugin: install ++

[INFO] ++====================================================================++

[INFO] Installing /Users/sbutton/Downloads/wls/wls_1211/wls1211_dev.zip into /Users/sbutton/Projects/Java/wls-maven-doc/maven-demo/Oracle/Software

[INFO] Installing the product, this may take some time.

[INFO] Executing: [cmd:[/bin/bash, -c, chmod +x ./configure.sh; ./configure.sh]]

[INFO] Process being executed, waiting for completion.

[INFO] [exec] **************************************************

[INFO] [exec] WebLogic Server 12c (12.1.1.0) Zip Configuration

[INFO] [exec]

[INFO] [exec] MW_HOME: /Users/sbutton/Projects/Java/wls-maven-doc/maven-demo/Oracle/Software

[INFO] [exec] JAVA_HOME: /System/Library/Java/JavaVirtualMachines/1.6.0.jdk/Contents/Home

[INFO] [exec] **************************************************

...

[INFO] [exec] BUILD SUCCESSFUL

[INFO] [exec] Total time: 0 seconds

[INFO] [configure script] exit code: 0

[INFO] ------------------------------------------------------------------------

[INFO] BUILD SUCCESS

[INFO] ------------------------------------------------------------------------

[INFO] Total time: 1:53.210s

[INFO] Finished at: Wed Nov 23 15:46:53 CST 2011

[INFO] Final Memory: 3M/81M

[INFO] ------------------------------------------------------------------------

b) URL reference

<groupId>com.oracle.weblogic</groupId>

<artifactId>wls-maven-plugin</artifactId>

<artifactLocation>

http://test.us.oracle.com:7001/downloads/wls1211_dev.zip

</artifactLocation>

</configuration>

</plugin>

The execution of the wls:install goal is shown below.

sbutton:~/Projects/Java/wls-maven-doc/maven-demo $ mvn wls:install

[INFO] Scanning for projects...

[INFO]

[INFO] ------------------------------------------------------------------------

[INFO] Building maven-demo 1.0-SNAPSHOT

[INFO] ------------------------------------------------------------------------

[INFO]

[INFO] --- wls-maven-plugin:12.1.1.0:install (default-cli) @ maven-demo ---

[INFO] ++====================================================================++

[INFO] ++ wls-maven-plugin: install ++

[INFO] ++====================================================================++

[INFO] Installing http://test.us.oracle.com:7001/downloads/wls1211_dev.zip into /Users/sbutton/Projects/Java/wls-maven-doc/maven-demo/Oracle/Software

[INFO] Attempt to download artifact from maven repo failed - Artifact not found

[INFO] Attempt to download the weblogic server instance directly from url.

[INFO] Downloading the file ...

...

[INFO] [exec] BUILD SUCCESSFUL

[INFO] [exec] Total time: 0 seconds

[INFO] [configure script] exit code: 0

[INFO] ------------------------------------------------------------------------

[INFO] BUILD SUCCESS

[INFO] ------------------------------------------------------------------------

[INFO] Total time: 4:23.710s

[INFO] Finished at: Wed Nov 23 15:53:21 CST 2011

[INFO] Final Memory: 3M/81M

[INFO] ------------------------------------------------------------------------

c) Maven Artifact

Here the distribution is retrieved from the local Maven repository itself. This means it needs to have been installed into the repository or pulled over from a remote repository at some point.

To install wls1211-dev.zip into Maven repository the following type of command can be used:

sbutton:~ $ mvn install:install-file -Dfile=wls1211_dev.zip
-DgroupId=com.oracle.weblogic -DartifactId=wls-dev
-Dpackaging=zip -Dversion=12.1.1.0

[INFO] Scanning for projects...

[INFO]

[INFO] ------------------------------------------------------------------------

[INFO] Building Maven Stub Project (No POM) 1

[INFO] ------------------------------------------------------------------------

[INFO]

[INFO] --- maven-install-plugin:2.3.1:install-file (default-cli) @ standalone-pom ---

[INFO] Installing /Users/sbutton/Downloads/wls/wls_1211/wls1211_dev.zip to /Users/sbutton/.m2/repository/com/oracle/weblogic/wls-dev/12.1.1.0/wls-dev-12.1.1.0.zip

[INFO] Installing /var/folders/cL/cLTyZKXjGgmQhEpoV+U-DE+++TI/-Tmp-/mvninstall7575420374983698784.pom to /Users/sbutton/.m2/repository/com/oracle/weblogic/wls-dev/12.1.1.0/wls-dev-12.1.1.0.pom

[INFO] ------------------------------------------------------------------------

[INFO] BUILD SUCCESS

[INFO] ------------------------------------------------------------------------

[INFO] Total time: 11.089s

[INFO] Finished at: Wed Nov 23 15:30:17 CST 2011

[INFO] Final Memory: 3M/81M

[INFO] ------------------------------------------------------------------------

This installs wls1211-dev.zip as a Maven artifact with the following coordinate:

com.oracle.weblogic:wls-dev:zip:12.1.1.0

To use this Maven artifact as the distribution to install, the plugin looks like the below.

<groupId>com.oracle.weblogic</groupId>

<artifactId>wls-maven-plugin</artifactId>

<artifactLocation>

com.oracle.weblogic:wls-dev:zip:12.1.1.0

</artifactLocation>

</configuration>

</plugin>

The execution of the wls:install goal is shown below.

sbutton:~/Projects/Java/wls-maven-doc/maven-demo $ mvn wls:install

[INFO] Scanning for projects...

[INFO]

[INFO] ------------------------------------------------------------------------

[INFO] Building maven-demo 1.0-SNAPSHOT

[INFO] ------------------------------------------------------------------------

[INFO]

[INFO] --- wls-maven-plugin:12.1.1.0:install (default-cli) @ maven-demo ---

[INFO] ++====================================================================++

[INFO] ++ wls-maven-plugin: install ++

[INFO] ++====================================================================++

[INFO] Installing com.oracle.weblogic:wls-dev:zip:12.1.1.0 into /Users/sbutton/Projects/Java/wls-maven-doc/maven-demo/Oracle/Software

[INFO] Installing the product, this may take some time.

[INFO] Executing: [cmd:[/bin/bash, -c, chmod +x ./configure.sh; ./configure.sh]]

[INFO] Process being executed, waiting for completion.

[INFO] [exec] **************************************************

[INFO] [exec] WebLogic Server 12c (12.1.1.0) Zip Configuration

[INFO] [exec]

[INFO] [exec] MW_HOME: /Users/sbutton/Projects/Java/wls-maven-doc/maven-demo/Oracle/Software

[INFO] [exec] JAVA_HOME: /System/Library/Java/JavaVirtualMachines/1.6.0.jdk/Contents/Home

[INFO] [exec] **************************************************

[INFO] [exec]

...

[INFO] [exec]

[INFO] [exec] Your environment has been set.

[INFO] [exec]

[INFO] [exec] BUILD SUCCESSFUL

[INFO] [exec] Total time: 0 seconds

[INFO] [configure script] exit code: 0

[INFO] ------------------------------------------------------------------------

[INFO] BUILD SUCCESS

[INFO] ------------------------------------------------------------------------

[INFO] Total time: 1:57.549s

[INFO] Finished at: Wed Nov 23 15:35:32 CST 2011

[INFO] Final Memory: 4M/81M

[INFO] ------------------------------------------------------------------------

Unless the <middlewareHome> configuration paramter is specified, the installation is performed in the ${basedir}/Oracle/Software directory.

sbutton:~/Projects/Java/wls-maven-doc/maven-demo $ ls -l

total 8

drwxr-xr-x 3 sbutton staff 102 23 Nov 15:44 Oracle

-rw-r--r-- 1 sbutton staff 3597 23 Nov 15:43 pom.xml

drwxr-xr-x 3 sbutton staff 102 23 Nov 15:03 src

sbutton:~/Projects/Java/wls-maven-doc/maven-demo $ ls -l Oracle/Software/

total 64

-rw-r--r-- 1 sbutton staff 5808 23 Nov 15:45 README.txt

-rw-r--r-- 1 sbutton staff 3064 23 Nov 15:45 configure.cmd

-rwxr-xr-x 1 sbutton staff 2857 23 Nov 15:45 configure.sh

-rw-r--r-- 1 sbutton staff 3189 23 Nov 15:45 configure.xml

-rw-r--r-- 1 sbutton staff 133 23 Nov 15:45 domain-registry.xml

drwxr-xr-x 508 sbutton staff 17272 23 Nov 15:46 modules

-rw-r--r-- 1 sbutton staff 1138 23 Nov 15:45 registry.template

-rw-r--r-- 1 sbutton staff 1320 23 Nov 15:46 registry.xml

drwxr-xr-x 3 sbutton staff 102 23 Nov 15:45 utils

drwxr-xr-x 7 sbutton staff 238 23 Nov 15:46 wlserver

Create-Domain

This goal creates a standard WLS domain from the specific WLS installation.

The location of the domain is specified using the optional <domainHome> configuration element. By default <domainHome> is set to ${basedir}/Oracle/Domains so it will be created in an Oracle/Domains subdirectory of the root directory of the Maven project.

The WLS installation to be used is specified using the optional <middlewareHome> configuration element. This is set to ${basedir}/Oracle/Software by default, so if the default location has been used to execute the install goal, it can be left out of this goal.

To create a domain, a user and password are required. These can be specified as configuration parameters using the <user> and <password> properties or they can be specified on the command line.

<groupId>com.oracle.weblogic</groupId>

<artifactId>wls-maven-plugin</artifactId>

com.oracle.weblogic:wls-dev:zip:12.1.1.0

</artifactLocation>

<user>weblogic</user>

<password>welcome1</user>

</configuration>

</plugin>

The execution of the wls:install goal is shown below.

sbutton:~/Projects/Java/wls-maven-doc/maven-demo $ mvn wls:create-domain

[INFO] Scanning for projects...

[INFO]

[INFO] ------------------------------------------------------------------------

[INFO] Building maven-demo 1.0-SNAPSHOT

[INFO] ------------------------------------------------------------------------

[INFO]

[INFO] --- wls-maven-plugin:12.1.1.0:create-domain (default-cli) @ maven-demo ---

[INFO] ++====================================================================++

[INFO] ++ wls-maven-plugin: create-domain ++

[INFO] ++====================================================================++

[INFO] Domain creation script:

readTemplate('/Users/sbutton/Projects/Java/wls-maven-doc/maven-demo/Oracle/Software/wlserver/common/templates/domains/wls.jar')

cd('/Security/base_domain/User/weblogic')

set('Name', 'weblogic')

set('Password', '***')

writeDomain('/Users/sbutton/Projects/Java/wls-maven-doc/maven-demo/Oracle/Domains/mydomain')

[INFO] ------------------------------------------------------------------------

[INFO] BUILD SUCCESS

[INFO] ------------------------------------------------------------------------

[INFO] Total time: 39.345s

[INFO] Finished at: Wed Nov 23 16:01:13 CST 2011

[INFO] Final Memory: 24M/81M

[INFO] ------------------------------------------------------------------------

Unless the <domainHome> configuration property is specified, the domain will be created in the ${basedir}/Oracle/Domains directory of the project.

sbutton:~/Projects/Java/wls-maven-doc/maven-demo $ ls -l Oracle/Domains/mydomain

total 16

drwxr-xr-x 3 sbutton staff 102 23 Nov 16:01 autodeploy

drwxr-xr-x 10 sbutton staff 340 23 Nov 16:01 bin

drwxr-xr-x 10 sbutton staff 340 23 Nov 16:01 config

drwxr-xr-x 3 sbutton staff 102 23 Nov 16:01 console-ext

-rw-r--r-- 1 sbutton staff 462 23 Nov 16:01 fileRealm.properties

drwxr-xr-x 7 sbutton staff 238 23 Nov 16:01 init-info

drwxr-xr-x 3 sbutton staff 102 23 Nov 16:01 lib

drwxr-xr-x 6 sbutton staff 204 23 Nov 16:01 security

drwxr-xr-x 3 sbutton staff 102 23 Nov 16:01 servers

-rwxr-x--- 1 sbutton staff 293 23 Nov 16:01 startWebLogic.sh

Start-Server

This goal executes a startWebLogic command on a given domain, starting the WebLogic Server instance for use.

This goal also uses the <middlewareHome> and <domainHome> configuration elements to specify the location of the WLS installation and domain to use.

If you have followed the convention-over-configuration approach and adopted the default values, these configuration elements do not need to be specified.

If you have installed WLS or created a domain in a different location, you must specify the location using the <middlewareHome> and <domainHome> configuration elements in the pom.xml or specify them as parameters on the command line.

Using the convention-over-configuration approach, the default domain ${basedir}/Oracle/Domains/mydomain using the WLS installation in ${basedir}/Oracle/Software can be started as shown below.

sbutton:~/Projects/Java/wls-maven-doc/maven-demo $ mvn wls:start-server

[INFO] Scanning for projects...

[INFO]

[INFO] ------------------------------------------------------------------------

[INFO] Building maven-demo 1.0-SNAPSHOT

[INFO] ------------------------------------------------------------------------

[INFO]

[INFO] --- wls-maven-plugin:12.1.1.0:start-server (default-cli) @ maven-demo ---

[INFO] ++====================================================================++

[INFO] ++ wls-maven-plugin: start-server ++

[INFO] ++====================================================================++

.[INFO] Starting server in domain /Users/sbutton/Projects/Java/wls-maven-doc/maven-demo/Oracle/Domains/mydomain

[INFO] Check stdout file for details: /Users/sbutton/Projects/Java/wls-maven-doc/maven-demo/Oracle/Domains/mydomain/server-2388282492279558044.out

[INFO] Process being executed, waiting for completion.

.........

[INFO] Server started successful

[INFO] ------------------------------------------------------------------------

[INFO] BUILD SUCCESS

[INFO] ------------------------------------------------------------------------

[INFO] Total time: 9.137s

[INFO] Finished at: Wed Nov 23 16:23:07 CST 2011

[INFO] Final Memory: 4M/81M

[INFO] ------------------------------------------------------------------------

Deploy

The deploy goal deploys an application.

The convention-over-configuration approach uses the defaults available for middlewareHome, adminurl, and the source file to deploy allowing the goal to be executed without any additional configuration.

sbutton:~/Projects/Java/wls-maven-doc/maven-demo $ mvn wls:deploy

[INFO] Scanning for projects...

[INFO]

[INFO] ------------------------------------------------------------------------

[INFO] Building maven-demo 1.0

[INFO] ------------------------------------------------------------------------

[INFO]

[INFO] --- wls-maven-plugin:12.1.1.0:deploy (default-cli) @ maven-demo ---

[INFO] ++====================================================================++

[INFO] ++ wls-maven-plugin: deploy ++

[INFO] ++====================================================================++

weblogic.Deployer invoked with options: -noexit -user weblogic -deploy -source /Users/sbutton/Projects/Java/wls-maven-doc/maven-demo/target/maven-demo.war

Task 0 initiated: [Deployer:149026]deploy application maven-demo on AdminServer.

Task 0 completed: [Deployer:149026]deploy application maven-demo on AdminServer.

Target state: deploy completed on Server AdminServer

[INFO] ------------------------------------------------------------------------

[INFO] BUILD SUCCESS

[INFO] ------------------------------------------------------------------------

[INFO] Total time: 5.803s

[INFO] Finished at: Wed Nov 23 16:36:52 CST 2011

[INFO] Final Memory: 6M/81M

[INFO] ------------------------------------------------------------------------

Stop-Server

The stop-server goal stops an executing server using the stopWebLogic script on the specified domain.

sbutton:~/Projects/Java/wls-maven-doc/maven-demo $ mvn wls:stop-server

[INFO] Scanning for projects...

[INFO]

[INFO] ------------------------------------------------------------------------

[INFO] Building maven-demo 1.0

[INFO] ------------------------------------------------------------------------

[INFO]

[INFO] --- wls-maven-plugin:12.1.1.0:stop-server (default-cli) @ maven-demo ---

[INFO] ++====================================================================++

[INFO] ++ wls-maven-plugin: stop-server ++

[INFO] ++====================================================================++

[INFO] Stop server in domain: /Users/sbutton/Projects/Java/wls-maven-doc/maven-demo/Oracle/Domains/mydomain

[INFO] Process being executed, waiting for completion.

[INFO] [exec] Stopping Weblogic Server...

[INFO] [exec]

[INFO] [exec] Initializing WebLogic Scripting Tool (WLST) ...

[INFO] [exec]

[INFO] [exec] Welcome to WebLogic Server Administration Scripting Shell

[INFO] [exec]

[INFO] [exec] Type help() for help on available commands

[INFO] [exec]

[INFO] [exec] Connecting to t3://localhost:7001 with userid weblogic ...

[INFO] [exec] Successfully connected to Admin Server 'AdminServer' that belongs to domain 'mydomain'.

[INFO] [exec]

[INFO] [exec] Warning: An insecure protocol was used to connect to the

[INFO] [exec] server. To ensure on-the-wire security, the SSL port or

[INFO] [exec] Admin port should be used instead.

[INFO] [exec]

[INFO] [exec] Shutting down the server AdminServer with force=false while connected to AdminServer ...

[INFO] [exec] WLST lost connection to the WebLogic Server that you were

[INFO] [exec] connected to, this may happen if the server was shutdown or

[INFO] [exec] partitioned. You will have to re-connect to the server once the

[INFO] [exec] server is available.

[INFO] [exec] Disconnected from weblogic server: AdminServer

[INFO] [exec] Disconnected from weblogic server:

[INFO] [exec]

[INFO] [exec] Exiting WebLogic Scripting Tool.

[INFO] [exec]

[INFO] [exec] Done

[INFO] [exec] Stopping Derby Server...

[INFO] ------------------------------------------------------------------------

[INFO] BUILD SUCCESS

[INFO] ------------------------------------------------------------------------

[INFO] Total time: 8.921s

[INFO] Finished at: Wed Nov 23 16:41:14 CST 2011

[INFO] Final Memory: 4M/81M

[INFO] ------------------------------------------------------------------------

APPC

The appc goal executes the WebLogic Server application compiler tool to prepare the application for deployment.

This benefits from the convention-over-configuration model, allowing it to be executed using the defaults of the project.

An example of the goal being executed is shown below. Note this example uses the –verbose flag to highlight the activities the appc utility is performing. This is not normally necessary.

sbutton:~/Projects/Java/wls-maven-doc/maven-demo $ mvn wls:appc -Dverbose

[INFO] Scanning for projects...

[INFO]

[INFO] ------------------------------------------------------------------------

[INFO] Building maven-demo 1.0

[INFO] ------------------------------------------------------------------------

[INFO]

[INFO] --- wls-maven-plugin:12.1.1.0:appc (default-cli) @ maven-demo ---

[INFO] ++====================================================================++

[INFO] ++ wls-maven-plugin: appc ++

[INFO] ++====================================================================++

[JspcInvoker]Checking web app for compliance.

[jspc] -webapp specified, searching . for JSPs

[jspc] Compiling /index.jsp

[INFO] ------------------------------------------------------------------------

[INFO] BUILD SUCCESS

[INFO] ------------------------------------------------------------------------

[INFO] Total time: 5.281s

[INFO] Finished at: Wed Nov 23 16:43:12 CST 2011

[INFO] Final Memory: 16M/81M

[INFO] ------------------------------------------------------------------------

WLST

The WLST goal enables the WebLogic Scripting Tool (WLST) to be used to execute scripts that configure resources or perform other operational actions on a WebLogic Server domain. The WLST used by the wlst Maven goal is the standard environment WebLogic Server WLST environment so all existing scripts should be able to be used.

Benefitting again from the convention-over-configuration, the middlewareHome and domainHome locations do not need to be specified if the defaults are used.

The WLST goal can execute an external script specified using the <fileName> configuration element or a sequence of WLST calls can be specified within the pom.xml using the <script> configuration element.

<groupId>com.oracle.weblogic</groupId>

<artifactId>wls-maven-plugin</artifactId>

com.oracle.weblogic:wls-dev:zip:12.1.1.0

</artifactLocation>

<user>weblogic</user>

<password>welcome1</user>

<filename>create-datasource.py</fileName>

</configuration>

</plugin>

An execution of the wlst goal is shown below.

sbutton:~/Projects/Java/wls-maven-doc/maven-demo $ mvn wls:wlst -DfileName=create-datasource.py

[INFO] Scanning for projects...

[INFO]

[INFO] ------------------------------------------------------------------------

[INFO] Building maven-demo 1.0

[INFO] ------------------------------------------------------------------------

[INFO]

[INFO] --- wls-maven-plugin:12.1.1.0:wlst (default-cli) @ maven-demo ---

[INFO] ++====================================================================++

[INFO] ++ wls-maven-plugin: wlst ++

[INFO] ++====================================================================++

*** Creating DataSource ***

Connecting to t3://localhost:7001 with userid weblogic ...

Successfully connected to Admin Server 'AdminServer' that belongs to domain 'mydomain'.

Warning: An insecure protocol was used to connect to the

server. To ensure on-the-wire security, the SSL port or

Admin port should be used instead.

Location changed to edit tree. This is a writable tree with

DomainMBean as the root. To make changes you will need to start

an edit session via startEdit().

For more help, use help(edit)

Starting an edit session ...

Started edit session, please be sure to save and activate your

changes once you are done.

Activating all your changes, this may take a while ...

The edit lock associated with this edit session is released

once the activation is completed.

Activation completed

Location changed to serverRuntime tree. This is a read-only tree with ServerRuntimeMBean as the root.

For more help, use help(serverRuntime)

**** DataSource Details ****

Name: cp

Driver Name: Oracle JDBC driver

DataSource: oracle.jdbc.xa.client.OracleXADataSource

Properties: {user=demo}

State: Running

[INFO] ------------------------------------------------------------------------

[INFO] BUILD SUCCESS

[INFO] ------------------------------------------------------------------------

[INFO] Total time: 10.686s

[INFO] Finished at: Wed Nov 23 16:55:25 CST 2011

[INFO] Final Memory: 13M/81M

[INFO] ------------------------------------------------------------------------

weblogic.xml and prefer-application-packages

2011-08-11T16:05:00.000+09:30

Short and sweet this one, purely for my own future simple reference.

To use prefer-application-packages in weblogic.xml, it looks like this:

<weblogic-web-app xmlns="http://xmlns.oracle.com/weblogic/weblogic-web-app" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd http://xmlns.oracle.com/weblogic/weblogic-web-app http://xmlns.oracle.com/weblogic/weblogic-web-app/1.2/weblogic-web-app.xsd">

  <jsp-descriptor>
    <keepgenerated>true</keepgenerated>
    <debug>true</debug>
  </jsp-descriptor>

  <context-root>/quicktest</context-root>
  
  <container-descriptor>
    <prefer-application-packages>
        <package-name>org.codehaus.jackson.*</package-name>
        <package-name>org.codehaus.jettison.*</package-name>
        <package-name>org.objectweb.asm.*</package-name>
    </prefer-application-packages>
  </container-descriptor>

</weblogic-web-app>

Unofficial Java SE 7 Builds for Mac OS X

2011-07-13T10:00:00.000+09:30

Not sure how I overlooked this, but according to this page here:

http://wikis.sun.com/display/OpenJDK/Mac+OS+X+Port

There are prebuilt (unofficial) binaries for Java SE 7 on Mac OS X here:

http://code.google.com/p/openjdk-osx-build/downloads/list?q=label:Featured

Good stuff.

Plugging in a later version of EclipseLink to WebLogic Server

2011-07-04T18:00:00.000+09:30

Talking with Doug Clarke of EclipseLink fame and fortune last week, it sounds like there is some real interest from developers in wanting to update WebLogic Server to use later versions of the EclipseLink in order to access it's evolving feature set.

Which should offer no surprises really, EclipseLink rocks.

Investigation

Turning to the situation at hand, the main points to be addressed are:

1. The later versions of EclipseLink are JPA 2.0 based, so we'll assume that the predominant use case is centered around using JPA 2.0.

WebLogic Server supports JPA 2.0 through the application of a Smart Update patch or via manual adjustments to the PRE_CLASSPATH to incorporate two additional JAR files that enable the use of JPA 2.0.

We'll consider this one easy to handle using documented features.

2. WebLogic Server provides a version of EclipseLink that is loaded as one it's standard feature bearing modules and thus is present by default in the classpath of WebLogic Server for deployed applications. For WLS 10.3.5, this version is org.eclipse.persistence_1.1.0.0_2-1.jar.

WebLogic Server has a feature called the Filtering Classloader, which enables applications to selectively override the libraries from WebLogic Server that an application sees. This should allow an application to be configured to not use the default version of EclipseLink that WebLogic Server provides. This requires each application to specifically provide a weblogic-application.xml file that lists the <prefer-application-packages> configuration set to explicitly filter our the org.eclipselink.persistence package.

3. Any change to the EclipseLink version should be isolated to just an application, and not applied to an entire WebLogic Server installation or domain.

To make the later version of EclipseLink available, there are a few simple options available that could be explored: a) the EclipseLink jar file could be added to the CLASSPATH of WebLogic Server; b) the EclipseLink jar file could be dropped into the $domain/lib directory; c) the newer version of EclipseLink could be used to replace the existing EclipseLink jar file shipped with WebLogic Server, retaining the same name; d) the WebLogic Server shared-library mechanism could be used to deploy the EclipseLink libraries which applications can then selectively reference.

For the sake of expediency, I won't bother going through the pros/cons with each of those options and will just pick a winner from my perspective: the use of a shared-library to provide a selectively consumable version of EclipseLink.

Let's just examine this for a moment -- a WebLogic Server shared-library is an artifact that can be deployed to a WebLogic Server target, which can then be referenced by an application being deployed, whereupon WebLogic Server will merge the contents of the shared-library with the application. This enables common libraries to be deployed and used by multiple applications. Furthermore, shared-libraries can take the format of a standard Java EE archives, where descriptors can be provided which are then also merged with the final application deployment.

Given those capabilities:

a) it's possible to construct and deploy an EAR file based shared-library that contains a later version of EclipseLink and a weblogic-application.xml file which provides a preset prefer-application-packages setting that filters the org.eclipselink.persistence.* package.

b) to use a later version of EclipseLink, an application simply needs to include it's own weblogic-application.xml that imports the EclipseLink shared-library it need to use.

Thus, we have a supported deployment format (can be targeted at single nodes, clusters, whatever ...) to provide later versions of EclipseLink, which can be shared and selectively used by applications as desired.

Implementation

To test this out in an end-to-end manner, I performed the following steps:

1. Downloaded eclipselink-2.2.0.v20110202-r8913.zip from the EclipseLink web site.

2. Created a small ant project to produce an eclipselink-shared-lib.ear file. The layout of the shared-library is just a standard Java EE EAR file and contains the following items:

META-INF/weblogic-application.xml
META-INF/application.xml
lib/eclipselink.jar

The weblogic-application.xml file contains the following configuration elements:

<weblogic-application>
<prefer-application-packages>
 <package-name>org.eclipse.persistence.*</package-name>
</prefer-application-packages>
</weblogic-application>

The application.xml was a necessary element to support the runtime library merging. As you can see from the below, it's basically a NOOP configuration file.

<application>
<display-name>eclipselink-shared-lin</display-name>
<module>
 <java></java>
</module>
</application>

The ant build script produces an EAR file from these elements with one important addition that marks the EAR file as a shared-library for WebLogic Server by adding a number of attributes to the META-INF/MANIFEST.MF file:

<target name="package" depends="prepare">
 <jar destfile="dist/${ant.project.name}.ear">
 <metainf dir="etc" includes="*.xml"/>
 <manifest>
 <attribute name="Extension-Name" value="eclipselink"/>
 <attribute name="Specification-Version" value="2.0"/>
 <attribute name="Implementation-Version" value="2.2.0"/>
 </manifest>
 <fileset dir="build" includes="**/*"/>
 </jar>
</target>

At deployment time, WebLogic Server will use the attributes as meta-data for the deployed shared-library.

The final EAR file looks like this:

sbutton:~/Projects/Java/eclipselink-shared-lib/dist $ jar tf eclipselink-shared-lib.ear
META-INF/
META-INF/MANIFEST.MF
META-INF/application.xml
META-INF/weblogic-application.xml
lib/
lib/eclipselink.jar

For reference, the simple ant project to build the eclipselink-shared-lib.ear file is here: eclipselink-shared-lib.zip.

3. Deployed eclipselink-shared-lib.ear to WebLogic Server. This results in a new library being available on the server, eclipselink#2.0@2.2.0.

4. Created a test application that imports eclipselink#2.0@2.2.0 and outputs the version of it that it is seeing.

The application uses a weblogic.xml to reference the eclipselink#2.0@2.2.0 shared-library that was deployed, which picks up both the new version of eclipselink.jar as well as the filtering-classloader description the library contains:

weblogic-application.xml:

<weblogic-application>
 <library-ref>
 <library-name>eclipselink</library-name>
 <specification-version>2.0</specification-version>
 <implementation-version>2.2.0</implementation-version>
 </library-ref>
</weblogic-application>

Within the application, used a simple servlet that outputs the version of EclipseLink it is seeing:

out.printf("EclipseLink Version: %s", org.eclipse.persistence.Version.getVersionString());

5. Packaged the application into an EAR file and deployed it to WebLogic Server as an application.

When the application is accessed it reports the new version of EclipseLink supplied via the shared-library:

EclipseLink Version: 2.2.0.v20110202-r8913

6. Performed a negative test by undeploying the application, removed the weblogic-application.xml file from it and redeployed it.

When the application is accessed it reports the default version of EclipseLink that WebLogic Server supplies:

EclipseLink Version: 2.1.3.v20110304-r9073

7. With the basic premise validated, add a JPA module to validate the code-weaving EclipseLink performs works as expected. To verify the version EclipseLink is using the EclipseLink log level was set to fine and the console output reviewed, which showed up as Eclipse Persistence Services - 2.2.0.v20110202-r8913

Summary

The use of WebLogic Server shared-libraries appears to be a very suitable model for providing later versions of EclipseLink that automatically filter out the WebLogic Server supplied versions, which applications can selectively choose to import when they need the later versions.

This was just a simple test of the concept of using WebLogic Server shared-libraries to do this. The EclipseLink/TopLink team are in the throes of formally certifying this approach, so keep an eye out for it on the EclipseLink site if it does pass full muster!

Building and Running OpenJDK 7 on Mac OS X - A Breeze

2011-06-17T14:52:00.000+09:30

Preparing a little for the Adelaide JUG meeting yesterday, where Java SE 7 was going to be the topic of discussion, I finally thought it was time to grab the OpenJDK 7 source, get it built and working on my Mac.

http://wikis.sun.com/display/OpenJDK/Mac+OS+X+Port

After checking off the pre-reqs, the process was as simple as following the small set of very clear instructions on the Wiki page.

The only small side excursion I had was that my bash environment had a JAVA_HOME env var set, which aborted the build at one point. Unsetting that and restarting the build, it then ran flawlessly for about 30mins before out popped a shiny new Open JDK 7 build.

Having never manually installed a JDK on my Mac (Apple updates have served me well) the instructions for how and where to install it was very helpful. And so simple! Particularly with how it results in the new JDK being visible to the /usr/libexec/java_home utility:



sbutton:~ $ /usr/libexec/java_home  -V 

Matching Java Virtual Machines (4):

1.6.0_24-b07-334, x86_64: "Java SE 6" /System/Library/Java/JavaVirtualMachines/1.6.0.jdk/Contents/Home

1.6.0_24-b07-334, i386: "Java SE 6" /System/Library/Java/JavaVirtualMachines/1.6.0.jdk/Contents/Home

1.7.0, x86_64: "OpenJDK 7" /Users/sbutton/Library/Java/JavaVirtualMachines/1.7.0.jdk/Contents/Home

1.7.0, i386: "OpenJDK 7" /Users/sbutton/Library/Java/JavaVirtualMachines/1.7.0.jdk/Contents/Home

Voila!

sbutton:~ $ export JAVA_HOME=`/usr/libexec/java_home  -v 1.7`

sbutton:~ $ java -version

openjdk version "1.7.0-internal"

OpenJDK Runtime Environment (build 1.7.0-internal-sbutton_2011_06_16_11_39-b00)

OpenJDK 64-Bit Server VM (build 21.0-b15, mixed mode)

Now looking forward to trying out some of the new language features with NetBeans 7.0.

All in all, a total breeze! Kudos to the OpenJDK Mac porters group.

WebLogic Server: Listing Groups of an Authenticated User

2011-06-14T16:40:00.001+09:30

Another question from a colleague today: "for a given authenticated user, how can I see what groups the user belongs to?"

Yep, good question Pas. Not sure, but worth some time to find out.

Hunting through the WebLogic Security Documentation, I found a good description and diagram of how a Subject is related to a Principal.

A principal is an identity assigned to a user or group as a result of authentication. Both users and groups can be used as principals by application servers such as WebLogic Server. The Java Authentication and Authorization Service (JAAS) requires that subjects be used as containers for authentication information, including principals.

As part of a successful authentication, principals are signed and stored in a subject for future use.

Any principal that is going to represent a WebLogic Server user or group needs to implement the WLSUser and WLSGroup interfaces, which are available in the weblogic.security.spi package.

Thus presumably, if you can get hold of the Subject, then you should be able to see the Principals associated with the User, of which some should reflect the Group(s) the User belongs to.

But how do you get the Subject?

I kept reading through documentation, but I couldn't see any really obvious description of where/how the Subject could be obtained.

Then, after almost giving up and resorting to looking through the Javadoc, I found this small reference:

http://download.oracle.com/docs/cd/E17904_01/web.1111/e13711/thin_client.htm#i1030501

In Example 3-3, notice that the JSP is calling an API (request.getRemoteUser()) to get the name of the user that logged in.

A different API, weblogic.security.Security.getCurrentSubject(), could be used instead. To use this API to get the name of the user, use it with the SubjectUtils API as follows:
String username = weblogic.security.SubjectUtils.getUsername(
weblogic.security.Security.getCurrentSubject());

Note: In the actual doc, there's a missing opening parenthesis in the supplied code snippet. I've added it in orange in the above.

Looking at the Javadoc, the weblogic.security.Security class has a static method that returns a javax.security.auth.Security object.

I also found a post from Edward Biemond here: http://blog.whitehorses.nl/2010/01/29/weblogic-web-application-container-security-part-1/ that discusses this area, from a slightly different more practical perspective perhaps.

With the Subject accessible and the description of the WLUser and WLGroup interfaces above, the group(s) an authenticated user belongs to can be readily discovered.

    import weblogic.security.Security;
    import weblogic.security.spi.WLSUser;
    import weblogic.security.spi.WLSGroup;
    ...
    private void doSubjectStuff(PrintWriter out,
      HttpServletRequest request,
      HttpServletResponse response) {



        Subject subject = Security.getCurrentSubject();

        

        StringBuffer groups = new StringBuffer();

        String user = null;

        boolean first = true;



        for(Principal p: subject.getPrincipals()) {

            if(p instanceof WLSGroup) {

                if(first) {

                    first=false;

                } else {

                    groups.append(", ");

                }

                groups.append(p.getName());

            } else if (p instanceof WLSUser) {

                user = p.getName();

            }

        }

        

        out.printf("<p>RemoteUser: %s, User: %s, belongs to: %s</p>", 

                request.getUserPrincipal().getName(),

                user, 

                groups);

    }

Calling this from a servlet, deployed within a simple web application that uses BASIC authentication mapped to a couple of WebLogic Server groups, the following output is displayed when the user "steve" logs in:

RemoteUser: steve, User: steve, belongs to: AppTesters, Deployers

Note, as Edmond also points out, the groups that are provided in the Subject are the WebLogic Server groups the user belongs to, and not the logical role-name defined in the web.xml file.

web.xml:
<security-role> <role-name>ADMINS</role-name> </security-role>

weblogic.xml:
<security-role-assignment> <role-name>ADMINS</role-name> <principal-name>AppTesters</principal-name> <principal-name>Administrators</principal-name> </security-role-assignment>

The primary new takeaway point I got from this was the use of the weblogic.security.Security class to obtain an instance of the current Subject.

Using SLF4J with WebLogic Server Logging

2011-06-07T16:10:00.002+09:30

Just recently, I needed to take a look at the SLF4J (Simple Logging Facade 4 Java) API, and more specifically, to how it could be employed on WebLogic Server.

Simple Logging Facade for Java

http://www.slf4j.org/

SLF4J follows the Commons-Logging model in that it provides a "Simple Logging Facade" with an API that can be used to insert log messages into application code, without specifying the specific Logging framework that is to be used. The actual work of capturing and emitting the log message is handled by "pluggable" SLF4J binding, which are added at deployment/runtime time (or server start) and handle the actual logging implementation work. There are pre-built bindings for the common logging frameworks such as JDK logging, Log4J, LogBack, as well as a simple Logging implementation that appears to simply print log messages to stdout.

Basic Problem

Having a look at a project that was using SLF4J with WebLogic Server, the question that came up was how could we direct the SLF4J logs into the standard WebLogic Server log facilities.

In it's basic form, with the slf4j-simple-1.6.0.jar binding being used, the SLF4J logs were not consistent with the rest of the WebLogic Server logs.

<Jun 7, 2011 3:22:04 PM CST> <Notice> <WebLogicServer> <BEA-000395> <Following extensions directory contents added to the end of the classpath:

/Users/sbutton/Projects/Domains/wls1035/lib/slf4j-api-1.6.0.jar:/Users/sbutton/Projects/Domains/wls1035/lib/slf4j-simple-1.6.0.jar> 

<Jun 7, 2011 3:22:05 PM CST> <Info> <WebLogicServer> <BEA-000377> <Starting WebLogic Server with Java HotSpot(TM) 64-Bit Server VM Version 19.1-b02-334 from Apple Inc.> 

<Jun 7, 2011 3:22:05 PM CST> <Info> <Management> <BEA-141107> <Version: WebLogic Server 10.3.5.0  Fri Apr 1 20:20:06 PDT 2011 1398638 > 

. . .

. . .

<Jun 7, 2011 3:22:13 PM CST> <Notice> <WebLogicServer> <BEA-000331> <Started WebLogic Admin Server "myserver" for domain "mydomain" running in Development Mode> 

<Jun 7, 2011 3:22:13 PM CST> <Notice> <WebLogicServer> <BEA-000365> <Server state changed to RUNNING> 

<Jun 7, 2011 3:22:13 PM CST> <Notice> <WebLogicServer> <BEA-000360> <Server started in RUNNING mode> 

14 [[ACTIVE] ExecuteThread: '0' for queue: 'weblogic.kernel.Default (self-tuning)'] INFO com.oracle.demo.wlsslf4j.TestServlet - *** This is an info: class com.oracle.demo.wlsslf4j.TestServlet

14 [[ACTIVE] ExecuteThread: '0' for queue: 'weblogic.kernel.Default (self-tuning)'] WARN com.oracle.demo.wlsslf4j.TestServlet - *** This is a warning: class com.oracle.demo.wlsslf4j.TestServlet

14 [[ACTIVE] ExecuteThread: '0' for queue: 'weblogic.kernel.Default (self-tuning)'] ERROR com.oracle.demo.wlsslf4j.TestServlet - *** This is an error: class com.oracle.demo.wlsslf4j.TestServlet

The question was: without writing a specific WLS binding, is there a way to enable the SLF4J logs to be directed into the WebLogic Server logs so they are consistently formatted and able to be viewed in the WebLogic Server console with the rest of the logs?

One Solution

The solution was quite straightforward in the end, simply by combining two pieces of existing functionality:

1. The SLF4J distribution ships with a binding for JDK logging called slf4j-jdk14-1.6.0.jar. This results in the SLf4J logs being directed into the JDK logging framework.

2. WebLogic Server ships with a JDK logging handler which will pick up log messages emitted from JDK logging framework and direct them into the WebLogic Server logging system.

The weblogic.logging.ServerLoggingHandler is documented here: http://download.oracle.com/docs/cd/E14571_01/web.1111/e13739/logging_services.htm#CHDBBEIJ

To get it all working, all it required was making the relevant libraries available to WebLogic Server and wiring them together using a logging.properties file.

Copy Libraries into WebLogic Server

SLF4J basically comes as two components. There's the API which is used by applications, and then there's the bridgings that handle the actual production of log messages into the desired form.

To make SLF4J available to WebLogic Server, I employed the simplest way I know - copy them into the domain/lib directory. This has a certain set of limitations in terms of updating versions without a server restart, etc. but it's a really simple way to get things working in the first instance.

sbutton:~/Projects/Domains/wls1035 $ ls -l lib/

total 88

-rw-r--r--  1 sbutton  staff    702  6 Jun 13:15 readme.txt

-rw-r--r--  1 sbutton  staff  25496  7 Jun 15:19 slf4j-api-1.6.0.jar

-rw-r--r--  1 sbutton  staff   8887  7 Jun 15:34 slf4j-jdk14-1.6.0.jar

Create a logging.properties file

The logging.properties file is a standard way to control JDK logging. Since we have directed SLf4J logs into JDK logging framework by making the slf4j-jdk14-1.6.0 binding available, we can configure JDK logging to use the ServerLoggingHandler provided by WebLogic Server, so as to direct its logs into the WebLogic Server logging system.

The JDK logging framework and its configuration options are all well documented, starting from Nov 2001 here: http://download.oracle.com/javase/1.4.2/docs/guide/util/logging/overview.html

Here is the logging.properties file that was used:

####

# Specify the handlers to create in the root logger

handlers = weblogic.logging.ServerLoggingHandler



# Register handlers for the com.oracle.demo package and its child loggers

com.oracle.demo.handlers = weblogic.logging.ServerLoggingHandler



# Do not send the org.hibernate.validator log messages to the root handler

com.oracle.demo.useParentHandlers = false



# Set the default logging level for the root logger

.level = ALL

com.oracle.demo.level = ALL



# Set the default logging level for new ServerLoggingHandler instances

weblogic.logging.ServerLoggingHandler.level = ALL

To direct the JDK logging framework to use the logging.properties file, the standard System property java.util.logging.config.file is used. With WebLogic Server, this can be easily accomplished by setting the JAVA_OPTIONS System property with the corresponding value.



$ export JAVA_OPTIONS="-Djava.util.logging.config.file=/Users/sbutton/Projects/Domains/wls1035/logging.properties"

Start WebLogic Server and Observe

With the libraries copied into the domain/lib directory, the logging.properties file created and specified as $JAVA_OPTIONS, starting WebLogic Server should now allow the logs created via SLF4J to be directed into the WebLogic Server logging framework. This should let them be seen on stdout in a consistent form with the standard WebLogic Server log messages, as well as via the WebLogic Server console through it's log viewer.

SL4J logs in stdout

<Jun 7, 2011 3:52:01 PM CST> <Notice> <WebLogicServer> <BEA-000365> <Server state changed to RUNNING> 

<Jun 7, 2011 3:52:01 PM CST> <Notice> <WebLogicServer> <BEA-000360> <Server started in RUNNING mode> 

<Jun 7, 2011 3:52:07 PM CST> <Warning> 

<com.oracle.demo.wlsslf4j.TestServlet> <BEA-000000> <*** This is a warning: class com.oracle.demo.wlsslf4j.TestServlet> 

<Jun 7, 2011 3:52:07 PM CST> <Error> <com.oracle.demo.wlsslf4j.TestServlet> <BEA-000000> <*** This is an error: class com.oracle.demo.wlsslf4j.TestServlet>

SL4J logs in WebLogic Server console

VI customizations for syntax coloring, auto-indenting and more

2011-05-30T16:48:00.001+09:30

A colleague recently sent me a VIM resource file to configure how VIM displays code.

A small set of simple changes, but the effect is very nice and makes the casual viewing of code, scripts, etc. much nicer with line numbering, auto-indenting, syntax color coding, etc.

$ cat ~/.vimrc

set shiftwidth=2 
set tabstop=2 
set number 
set ruler 
set expandtab 
set smartindent 
set autoindent 
set showmatch 
:syntax enable 
highlight Statement ctermfg=white
highlight PreProc ctermfg=3
set pastetoggle=<F10>

This is what it looks with a Java file:

Thanks Mark.

Applying WLS CAT to WLS 10.3.3

2011-05-26T15:14:00.000+09:30

To help answer an OTN question today regarding the use of the domain/lib directory on WLS 10.3.3, I went to use the CAT utility (as I've become accustomed) and then realized we'd only added it from the WLS 10.3.4 onwards.

As far as I'm aware, we don't make use of any newer APIs in WLS 10.3.4 within CAT, so I simply copied out the wls-cat.war file from a WLS 10.3.4 installation and deployed it to the WLS 10.3.3 domain I was using for the test.

The WLS CAT application deployed successfully and then seemed to work normally, letting me locate exactly where class I was using was being loaded from on WLS 10.3.3.

Of course this is totally unsupported, but if you're in need of WLS CAT on an earlier 10.3.x release and of the adventurous spirit, give it a shot. You can always undeploy it if it doesn't work for you.

Deploying a Random JSF 2.0 Example on WebLogic Server using Maven and NetBeans and Maven

2011-05-19T12:58:00.000+09:30

I had a bit of a hunt around yesterday looking for some JSF 2.0 example applications to deploy. I quickly came across a comprehensive JSF 2.0 tutorial @ http://www.coreservlets.com/JSF-Tutorial/jsf2/ published by Marty Hall.

For each of the tutorial sections on this site, the example code and pages that are used to demonstrate the concepts and discussion are published as accessible source code.

So I thought I'd try a few of them out with WebLogic Server 10.3.5.

The examples I looked at didn't contain a build script, so I very simply converted them into Maven projects, which I then was able to open immediately in NetBeans (this feature rocks!). I then built, packaged and ran the application on a WebLogic Server 10.3.5 domain, all from NetBeans.

All up, I'd say it tool ~2 mins to get the example loaded and building in NetBeans and deployed to WebLogic Server.

It takes a lot more to describe it below than it does to actually do it.

Here's what I did to get the data-tables example to build, package and deploy to WebLogic Server.

1. Download the zip file from http://www.coreservlets.com/JSF-Tutorial/jsf2/code/data-tables.zip.

2. Extract the zip file to a local directory, which produces:

/data-tables/WebContent
/data-tables/src
/data-tables/build

3. Generate a Java EE Web Application using the Maven Archetype mechanism. What a great feature this is in Maven.

$ mvn archetype:generate
...
[INFO] Generating project in Interactive mode
[INFO] No archetype defined. Using maven-archetype-quickstart (org.apache.maven.archetypes:maven-archetype-quickstart:1.0)
Choose archetype:
...
263: remote -> webapp-j2ee13 (-)
264: remote -> webapp-j2ee14 (-)
265: remote -> webapp-javaee6 (-)
266: remote -> webapp-jee5 (-)
...
Choose a number: 107: 266
Choose version:
1: 1.0
2: 1.0.1
3: 1.1
4: 1.2
Choose a number: 4:
Define value for property 'groupId': : coreservlets
Define value for property 'artifactId': : data-tables
Define value for property 'version': 1.0-SNAPSHOT: :
Define value for property 'package': coreservlets: :
Confirm properties configuration:
groupId: coreservlets
artifactId: data-tables
version: 1.0-SNAPSHOT
package: coreservlets
Y: : y

4. Copy the WebContent and src directories from the data-tables example into the new Maven project structure.

$ cp -rp ~/Projects/Java/data-tables/WebContent/* src/main/webapp/
$ cp -rp ~/Projects/Java//data-tables/src/ src/main/java/

5. Start NetBeans and simply open the data-tables/pom.xml file to load the project into the IDE.

Click around and explore the project to get a sense of what it contains.

6. Add the jsf-api dependency to the POM so the ManagedBean classes can be compiled.

You can either manually add this direct to the pom.xml as:

 <dependency>
 <groupId>javax.faces</groupId>
 <artifactId>jsf-api</artifactId>
 <version>2.0</version>
 <scope>provided</scope>
 </dependency>

Or use the "Add Dependency" option on the project to search for it and enter it via a dialog:

7. Add a weblogic.xml deployment descriptor to reference the JSF 2.0 shared-library deployed on the WLS domain.

I simply coped in an existing version of the file I had used before. You can also use the "New --> WebLogic --> WebLogic Descriptor" option in NetBeans to add it.

Add a library-ref to the jsf-2.0.war shared-library deployed on the WLS 10.3.4 domain.

<?xml version="1.0" encoding="UTF-8"?>
<weblogic-web-app>
<context-root>/data-tables-1.0-SNAPSHOT</context-root>
<library-ref>
 <library-name>jsf</library-name>
 <specification-version>2.0</specification-version>
 <implementation-version>1.0.0.0_2-0-2</implementation-version>
</library-ref>
</weblogic-web-app>

8. Run the project, select the WLS 10.3.5 Server type and watch it get built and packaged via Maven and deployed by NetBeans. This will start the WLS 10.3.5 server if necessary.

9. View the example application in a browser

Summary: there it is, a random JSF 2.0 example application, converted to a Maven project, opened in NetBeans and deployed to WebLogic Server 10.3.5, all in ~ 2mins.

First Adelaide Java User Group Session @ Oracle

2011-05-19T10:21:00.001+09:30

Tonight sees the first time that the Adelaide Java User Group meeting is being hosted @ the local Oracle office.

The session should be interesting with Derek Webber presenting on his area of expertise in Meta-programming with Groovy.

Meta-programming with Groovy

Meta-programming is a term to describe modifying code at runtime and is a very old idea in Computer Science. Groovy (now at 1.8) is a language that builds features directly on top of Java and aims to help developers be more productive. It’s meta-programming features provide a great number of opportunities to developers that are either really difficult to access or are all but impossible in plain Java. I will provide an overview of the Groovy Meta Object Protocol, along examples of what you can do with it. In particular it helps with:

easier reflection and adding behaviour dynamically
monkeypatching and extending existing 3rd party code
builders and domain-specific languages (DSLs)

For any local Adelaide folks interested in attending, the registration link is here:
http://www.jugevents.org/jugevents/event/registration.form?event.id=38181

Observing Bean Validation at JPA Level

2011-05-17T14:07:00.000+09:30

A quick followup to yesterdays posting regarding the use of JSF 2.0, JPA 2.0 and Bean Validation.

To verify the validation of the constraints at the JPA level, and not at the JSF front end, I decided to add a simple Servlet which calls the WidgetFacadeLocal directly to create a new Widget entity.

This led to a small, interesting side excursion.

Since the NetBeans project was defined as a Java EE 6 Web Application, when the new Servlet was added, the default option was to not generate a web.xml descriptor to describe the Servlet configuration and mapping, and instead to define the Servlet using the @WebServlet annotation on the Servlet class itself.

@WebServlet(name = "TestValidationServlet", urlPatterns = {"/TestValidationServlet"})
public class TestValidationServlet extends HttpServlet {
 ....
}

Now this won't deploy in this form to WebLogic Server 10.3.4 since it doesn't yet implement the Servlet 3.0 specification and support @WebServlet. But ... WebLogic Server has provided it's own specific annotation for Servlets since the 10.3 timeframe.

http://download.oracle.com/docs/cd/E17904_01/web.1111/e13712/annotateservlet.htm#i161636

Therefore to have this Servlet deploy and run on WebLogic Server, without introducing a web.xml file, the @WLServlet annotation can simply be added to the Servlet class, looking like this:

@WebServlet(name = "TestValidationServlet", urlPatterns = {"/TestValidationServlet"})
@weblogic.servlet.annotation.WLServlet(name = "TestValidationServlet", mapping = "/TestValidationServlet")
public class TestValidationServlet extends HttpServlet {
 ....
}

At compile time, add a reference to $WL_HOME/modules/com.bea.core.weblogic.web.api_1.4.0.0.jar to make the annotation available and it'll build and package successfully.

With that small excursion done, and the Servlet able to be deployed to WebLogic Server with the addition of the single @WLServlet annotation, the JPA validation can be tested.

This can be simply done again by injecting the stateless session bean WidgetFacadeLocal using an @EJB annotation, then creating a Widget with a known invalid property, and attempting to persist it through the session bean. Any validation constraints that are violated will be detected and returned in an EJBException that can be checked, and displayed.

...
@EJB WidgetFacadeLocal widgetFacade;
...
protected void processRequest(HttpServletRequest request, HttpServletResponse response)
 throws ServletException, IOException {
 ....
 try {
 Widget widget = new Widget();
 widget.setName("My Widget");
 widget.setEmail("bogus.email.com");
 widgetFacade.create(widget);

 } catch (EJBException ejbex) {
 out.printf("EJBException, caused by: %s", ejbex.getCause().getClass().getName());
 if (ejbex.getCausedByException() instanceof ConstraintViolationException) {
 ConstraintViolationException cve = (ConstraintViolationException) ejbex.getCausedByException();
 out.printf("Constraint Validations:");

 out.println("<ul>");
 for(ConstraintViolation cv: cve.getConstraintViolations()) {
 out.printf("<li>%s, %S, %s, %s</li>",
 cv.getRootBeanClass().getSimpleName(),
 cv.getPropertyPath(),
 cv.getMessage(),
 cv.getInvalidValue());
 }
 out.println("<ul>");
 }
 }
}

Here the Widget has an email address which is not valid, as well as missing the mandatory pricePerUnit property.

Deploying this to the WebLogic Server 10.3.4 domain used previously with JPA 2.0 enabled, and Bean Validation library added to the server classpath, the simple test shows that the Bean Validations are checked. An exception is returned that contains the set of constraint violations that occurred, which can be displayed to a user.

This demonstrates the use of implicit Bean Validation through using JPA 2.0 running on WebLogic Server 10.3.4.

Again, the key is to firstly ensure that the Server ClassPath is set to include the following libraries to expose and enable JPA 2.0 and have the Bean Validation implementation be visible to the JPA 2.0 provider:

$WLS_HOME/modules/com.oracle.jpa2support_1.0.0.0_2-0.jar
$WLS_HOME/modules/javax.persistence_1.0.0.0_2-0-0.jar
$GF_HOME/glassfish3/glassfish/modules/bean-validator.jar

And secondly, ensure that either the default JPA provider on the domain is set to TopLink, or the provider is specifically set to be org.eclipse.persistence.jpa.PersistenceProvider in persistence.xml within the application.

JSF 2.0, JPA 2.0 and Bean Validation on WebLogic Server

2011-05-16T16:13:00.002+09:30

For some time now, I’ve been meaning to build a simple application to demonstrate the use of JSF 2.0, JPA 2.0 and Bean Validation with WebLogic Server 10.3.4. But I hadn’t gotten around to it until I had a couple of hours free late last week.

Seeing as I didn’t have all that much time, I thought I’d try and repurpose the Java EE 6 CRUD (create-remove-update-delete) application that NetBeans generates for GlassFish 3.x, and see if I could get it to run on WebLogic Server.

The short answer to that was a resounding yes, with only a few minor changes or tricks.

In this blog, I’m going to step through what I did and highlight the changes that I played around with in order to make it work. I'm not going to make this a tutorial (at this point) since most of the steps that are required are simply using the NetBeans IDE and its wizards to generate the requisite components and pages.

Developing the Application

The starting point for this app was a single table, Widgets, created in a local Derby database.
Using NetBeans 7.0, a new Java EE Enterprise Application was created, using Java EE 6 and targetted at the GlassFish 3.1 server installed with NetBeans. This produces two child projects: a Web project and an EJB project.
In the EJB project, use the "Entity Classes from Database" to generate a JPA 2.0 Entity from the Widget table.

Worth pointing out here is the use of the Bean Validation specification to declare constraints on the various fields of the Widget entity.

I particularly appreciated the smarts NetBeans uses to provide a suggested @Pattern regular expression for an email field

@Pattern(regexp="[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?", message="Invalid email")//if the field contains email address consider using this annotation to enforce field validation
@Size(max = 100)
@Column(name = "EMAIL")
private String email;
Next, invoke the "Sessions Bean For Entity Classes ..." to generate a session facade with CRUD methods for the Widget entity.

Worth noting here are two points: First, the use of a Generics based Abstract class for the base CRUD operations, which is then subclassed by the WidgetFacade session bean to work specifically with the Widget entity. Second, the use of the JPA 2.0 Criteria API to build a number of queries in the base class.

public List<T> findRange(int[] range) {
 javax.persistence.criteria.CriteriaQuery cq getEntityManager().getCriteriaBuilder().createQuery();
 cq.select(cq.from(entityClass));
 javax.persistence.Query q = getEntityManager().createQuery(cq);
 q.setMaxResults(range[1] - range[0]);
 q.setFirstResult(range[0]);
 return q.getResultList();
}

This session bean is created with a local interface since the EJB 3.0 implementation in WebLogic Server requires the use of a business interface.
In the persistence.xml file, a trick worth keeping in mind here which may save you some pain later is to explicitly specify the JPA provider to use. This helps later on when you deploy the completed application to WebLogic Server, where the default JPA provider is Kodo/OpenJPA. This can be overridden at the WLS domain level, but setting it in persistence.xml within the application itself is an easy way to do it now.

<provider>org.eclipse.persistence.jpa.PersistenceProvider</provider>

For more details on changing the default JPA provider for a WLS domain, see here:

http://buttso.blogspot.com/2010/05/changing-default-jpa-provider-in.html
With the EJB project now complete, the JSF pages can be generated for the application. In the Web project, this is done using the "JSF Pages from Entity Classes ..." wizard.

What this wizard generates is a set of JSF pages to represent each of the CRUD operations, a Controller ManagedBean to handle the various tasks required by each of the JSF view pages and the data interactions (with paging) and a EJB 3.1 @Stateless session bean to act as a session facade on the Widget entity.

The new EJB in WAR packaging option available with Java EE 6 is not yet available on WebLogic Server, so the first trick here is to change the Web project to use the session facade that has already been generated in the EJB project. This is possible because the NetBeans wizards generate the same underlying code for the session facade whether it is for an EJB specific project or as part of the JSF Pages for Entity Classes wizard.

Delete the session bean bean in the Web project, then adjust the JSF controller to use the local interface for the session bean in the EJB project:

//@EJB
//private sab.demo.widget.service.WidgetFacade ejbFacade;
@EJB
private sab.demo.widget.service.WidgetFacadeLocal ejbFacade;

Note that EJB 3.1 supports a No-Interface view of an EJB, which WebLogic Server doesn't yet support. So here we have changed the injection point to use the Local interface from our EJB project.

There is also a getFacade method which needs this simple type change as well:

//private WidgetFacade getFacade() {
private WidgetFacadeLocal getFacade() {
return ejbFacade;
}
Delete the persistence.xml file generated within the Web project, since this will now be supplied with the EJB project.
Modify the web.xml file and change the "version" attribute to be "2.5" to specify a valid version for WebLogic Server:

<web-app version="2.5" ... >
Using the "New ..." wizard, add a WebLogic Deployment descriptor to the Web project, and specify a shared library reference to the JSF 2.0 shared library that WebLogic Server supplies.

<?xml version="1.0" encoding="UTF-8"?>
<weblogic-web-app>
 <context-root>Widget</context-root>
 <library-ref>
 <library-name>jsf</library-name>
 <specification-version>2.0</specification-version>
 <implementation-version>1.0.0.0_2-0-2</implementation-version>
 </library-ref>
</weblogic-web-app>

See the links for more details about JSF 2.0 and WebLogic Server, including instructions for how to deploy and reference the shared-library:

http://buttso.blogspot.com/2010/05/jsf-20-support-in-weblogic-server-1033.html
http://buttso.blogspot.com/2011/03/jsf-with-managed-beans-and-dependency.html
Build the final application into an EAR file that is ready for deployment.

Deploying the Application to WebLogic Server

To deploy a JSF 2.0 application to WebLogic Server, the JSF 2.0 shared-library must be deployed. See links referenced above for details on how to do this.

http://buttso.blogspot.com/2010/05/jsf-20-support-in-weblogic-server-1033.html
http://buttso.blogspot.com/2011/03/jsf-with-managed-beans-and-dependency.html
To use JPA 2.0 with WebLogic Server, two optional libraries within the WebLogic Server installation must be placed into the classpath. This can be automated through the use of a SmartUpdate patch, or it can be performed manually by setting a PRE_CLASSPATH environment variable and specifying the required libraries before starting the WebLogic Server domain.

$ export PRE_CLASSPATH=/Users/sbutton/Java/wls-1035-dev/modules/com.oracle.jpa2support_1.0.0.0_2-0.jar:/Users/sbutton/Java/wls-1035-dev/modules/javax.persistence_1.0.0.0_2-0-0.jar
See the documentation for more details as needed:

http://download.oracle.com/docs/cd/E17904_01/web.1111/e13720/using_toplink.htm#CIHDJHHI
The application is also using the Bean Validation specification which is not supplied with WebLogic Server 10.3.4. To ensure that the JSF 2.0 and JPA 2.0 implementation in TopLink can see the Bean Validation implementation and automatically enlist it's services, I added it as an additional library to the PRE_CLASSPATH environment variable:

$ export PRE_CLASSPATH=${PRE_CLASSPATH):/Users/sbutton/Java/glassfish-31/glassfish3/glassfish/modules/bean-validator.jar

Note here I am just referencing the library from a local GlassFish installation I have. I could copy this library out into a separate location or even download it independently and reference it. Call me lazy if you will ... :-)
Start a WebLogic Server domain
Using the WebLogic Console, configure the required datasource (jdbc/sample) to point at the Derby database and test to ensure it is working.
Using the console, deploy the application.

Test the application

With the application deployed, it can be tested to observe the JSF 2.0, JPA 2.0 and Bean Validation uses working on WebLogic Server.

For instance, create a new Widget and specify an incorrect email address. You'll see that JSF will automatically detect the invalid value based on the @Pattern constraint set on the Widget entity, and display the accompanying message as an error message on the page.

Correcting the email address value, the entry can be successfully be saved.

Looking at the stdout on the console where the WLS domain was started, the use of JPA 2.0 via EclipseLink and the automatic enlistment of the Bean Validation implementation can be seen in the lines below:

<May 16, 2011 3:58:26 PM CST> <Notice> <WebLogicServer> <BEA-000360> <Server started in RUNNING mode>
May 16, 2011 3:58:40 PM org.hibernate.validator.util.Version <clinit>
INFO: Hibernate Validator 4.1.0.Final
May 16, 2011 3:58:40 PM org.hibernate.validator.engine.resolver.DefaultTraversableResolver detectJPA
INFO: Instantiated an instance of org.hibernate.validator.engine.resolver.JPATraversableResolver.
<May 16, 2011 3:58:40 PM CST> <Notice> <EclipseLink> <BEA-2005000> <2011-05-16 15:58:40.781--ServerSession(1625943009)--EclipseLink, version: Eclipse Persistence Services - 2.1.3.v20110304-r9073>
<May 16, 2011 3:58:40 PM CST> <Notice> <EclipseLink> <BEA-2005000> <2011-05-16 15:58:40.782--ServerSession(1625943009)--Server: 10.3.5.0>
<May 16, 2011 3:58:41 PM CST> <Notice> <EclipseLink> <BEA-2005000> <2011-05-16 15:58:41.266--ServerSession(1625943009)--file:/Users/sbutton/Projects/Domains/wls1035/servers/AdminServer/tmp/_WL_user/Widget/qb0nwv/Widget-EJB.jar_Widget-EJBPU login successful>

If you forget to specify the JPA provider using the <provider> element in config.xml and deploy the application to a default WLS domain, then you may see the following error message when you try and access the application:

This exception indicates that an application is using the JPA 2.0 API, but WebLogic Server can't find a JPA 2.0 provider. This is the default condition of a WLS domain where the Kodo/Open JPA 1.0 provider is supplied at runtime.

This can be easily modified as described above by specifying an explicit <provider> value for EclipseLink (or Hibernate if you are using that) or by altering the default JPA provider at the domain level using the WebLogic Console:

Summary

It proved to be quite straight forward to take the Java EE 6 CRUD application generated by NetBeans and alter it slightly to deploy and run successfully on WebLogic Server 10.3.4, using it's JSF 2.0 and JPA 2.0 support.

Markus Quick Tests RichFaces 4.0 on WLS 10.3.4

2011-05-11T11:21:00.000+09:30

Nice to see this blog from Markus Eisele (belatedly on my part) in which he describes how to do a quick test of the RichFaces 4.0 showcase deployed on WLS 10.3.4 using it's optional support for JSF 2.0:

http://blog.eisele.net/2011/04/running-richfaces-400final-showcase-on.html

Thanks Markus, will try it out.

WebLogic Server 10.3.5 Available

2011-05-09T17:19:00.000+09:30

Oracle WebLogic Server 10.3.5 was released for download on OTN over the weekend.

See the Quick View/Download page @
http://www.oracle.com/technetwork/middleware/fusion-middleware/downloads/index.html

Tutorial: JSF 2.0 and JPA 2.0 with WebLogic Server using NetBeans

2011-03-16T14:24:00.001+10:30

The NetBeans team have produced a new tutorial demonstrating using JSF 2.0, JPA 2.0 with WebLogic Server 10.3.4 and NetBeans 7.0. The application uses the JPA entity and JSF page generation wizards to quickly produce a working application based on a sample schema.

Developing an Enterprise Application for Oracle WebLogic Server

From the WebLogic Server perspective, this tutorial demonstrates some of the nice integration points NetBeans now has with WebLogic Server.

For instance, the tutorial shows how NetBeans discovers and presents the set of WebLogic Server supplied JSF shared-libraries to the developer to select from.

It shows the resulting automatic configuration of the weblogic deployment descriptor to reference the chosen shared library, and finally it shows the automatic deployment that of the selected JSF shared library that NetBeans performs if necessary.

This all goes to make the use of JSF with WebLogic Server very straight forward.

The tutorial also highlights the simple approach NetBeans exposes for developers to Enable JPA 2.0 on the target WebLogic Server domain that is being used for the application.

All together this is a tutorial well worth taking a look at and stepping through to look at the generated code and pages.