1. Understanding Oracle WebLogic Server
  2. Sample Applications and Code Examples

14 Sample Applications and Code Examples

WebLogic Server provides a rich set of code examples and sample applications that show several approaches to learning about and working with WebLogic Server. These examples and sample applications are available through a separate WLS examples installer.

This chapter includes the following topics:

  • Installing and Running the Examples
    You can create a complete WebLogic domain that is configured with the full set of deployed code examples and sample applications by using the WLS examples installation program.
  • Conventions
    The instructions for building, deploying, and running the WebLogic Server code examples include a number of typographical conventions for indicating the path names for entities such as the WebLogic Server installation directory, the samples domain home directory, Apache Derby, and so on, in a platform-neutral way.
  • Jakarta EE 8 Examples
    Oracle WebLogic Server fully supports the Jakarta Platform, Enterprise Edition (Jakarta EE) 8 specification. The Jakarta EE 8 examples that are included demonstrate how to implement Jakarta EE 8 APIs and Oracle WebLogic Server-specific features.
  • Java EE 7 Examples
    Oracle WebLogic Server fully supports the Java Platform, Enterprise Edition (Java EE) 7 specification. The Java EE 7 examples that are included demonstrate how to implement Java EE 7 APIs and Oracle WebLogic Server-specific features.
  • Additional API Examples
    Oracle WebLogic Server also includes a set of examples that demonstrate how to implement additional Jakarta EE APIs and Oracle WebLogic Server-specific features.
  • Avitek Medical Records
    Avitek Medical Records (also known as MedRec) is a comprehensive educational sample application that demonstrates WebLogic Server and Jakarta EE features, as well as best practices. Avitek Medical Records is optionally installed with the WebLogic Server installation.
  • Derby Open-Source Database
    Derby is an open source relational database management system based on Java, JDBC, and SQL standards. Derby is bundled with WebLogic Server for use by the sample applications and code examples as a demonstration database.

Installing and Running the Examples

You can create a complete WebLogic domain that is configured with the full set of deployed code examples and sample applications by using the WLS examples installation program.

This section contains the following topics:

Parent topic: Sample Applications and Code Examples

Installing the WebLogic Server Code Examples

You obtain the WebLogic Server and Coherence examples in a separate, examples JAR file, fmw_14.1.2.0.0_wls_examples_generic.jar, which you install in the same ORACLE_HOME as your WebLogic Server installation. For more information about obtaining and installing WebLogic Server, see Installing the Oracle WebLogic Server and Coherence Software.

To set up the WebLogic Server samples domains, you run the Configuration Wizard in Quick Start mode. Select to Automatically Launch the Quickstart Configuration Wizard on the last WLS Examples Installation screen. The Quick Start Wizard creates the three sample domains: wl_server, medrec, and medrec-spring, under ORACLE_HOME\user_projects\domains.

If you run the Quick Start Configuration Wizard manually, as described in the following steps, then you must create the sample domains one at a time. This process requires you to run the Quick Start Wizard three times to create all three domains. For more information, see Running the Quick Start Configuration Wizard in Creating WebLogic Domains Using the Configuration Wizard.

Note:

During the manual domain configuration, you provide the name for each sample domain, so it might be something other than medrec, medrec-spring, and wl_server.
  • First, set the CONFIG_JVM_ARGS environment variable to specify the full path and JAR file name for each template that you want to use. For example, to create the MedRec domain:
    • On Windows: 
      set "CONFIG_JVM_ARGS=-DuserTemplates=C:\Oracle\Middleware\wlserver\common\
templates\wls\wls.jar,C:\Oracle\Middleware\wlserver\common\templates\
wls\medrec.jar"
    • On UNIX:
      export CONFIG_JVM_ARGS="-DuserTemplates=/Oracle/Middleware/wlserver/common/
templates/wls/wls.jar,/Oracle/Middleware/wlserver/common/templates/
wls/medrec.jar"
  • Then, run the Configuration Wizard in Quick Start mode with the following command:
    • On Windows:
      cd ORACLE_HOME\oracle_common\common\bin
config.cmd -target=config-oneclick
    • On UNIX:
      cd ORACLE_HOME/oracle_common/common/bin
config.sh -target=config-oneclick

For detailed information, see Using Quick Start to Create the WebLogic Sample Domains in Creating WebLogic Domains Using the Configuration Wizard.

MedRec-Spring

Before starting the MedRec-Spring domain, you have to copy the required Spring Framework 5.3.26 JAR files, which first must be downloaded from the https://repo1.maven.org/maven2/org/springframework repository. If needed, set your proxy settings for downloading the Spring Framework JAR files from the repository.

On Windows:

cd ORACLE_HOME\wlserver\samples\server
setExamplesEnv.cmd
cd medrec-spring  
Edit project.properties to change the attribute “medrec-spring.domain.dir=ORACLE_HOME\wlserver\samples\server\medrec-spring” 
cd modules
ant -f module-build-commons.xml download.spring.pkgs // Download the Spring JAR files
copy "ORACLE_HOME\wlserver\samples\server\medrec-spring\lib\runtime\*.jar" "ORACLE_HOME\wlserver\samples\server\medrec-spring\modules\medrec\web\target\exploded\medrec\WEB-INF\lib\"  All
copy "ORACLE_HOME\wlserver\samples\server\medrec-spring\lib\runtime\*.jar" "ORACLE_HOME\wlserver\samples\server\medrec-spring\modules\physician\web\target\exploded\physician\WEB-INF\lib\"  All
cd ORACLE_HOME\user_projects\domains\medrec-spring
startWebLogic.cmd

On Linux/UNIX:

cd ORACLE_HOME/wlserver/samples/server/
sh setExamplesEnv.sh
cd  medrec-spring/modules/  
ant -f module-build-commons.xml download.spring.pkgs // Download the Spring JAR files
cp -rf ORACLE_HOME/wlserver/samples/server/medrec-spring/lib/runtime/*.jar ORACLE_HOME/wlserver/samples/server/medrec-spring/modules/physician/web/target/exploded/physician/WEB-INF/lib/
cp -rf ORACLE_HOME/wlserver/samples/server/medrec-spring/lib/runtime/*.jar ORACLE_HOME/wlserver/samples//server/medrec-spring/modules/medrec/web/target/exploded/medrec/WEB-INF/lib
cd ORACLE_HOME/user_projects/domains/medrec-spring
sh startWebLogic.sh

Parent topic: Installing and Running the Examples

Starting the WebLogic Server Samples Domain

Start the examples server using one of the following procedures. In these procedures, DOMAIN_HOME represents the location where the samples domain is configured on your machine; for example, C:\ORACLE_HOME\user_projects\domains.

On Windows: Use a command shell and navigate to the DOMAIN_HOME\<samples_domain> directory. Enter the following command:

startWebLogic.cmd

On UNIX Bourne Shell: Navigate to the DOMAIN_HOME/<samples_domain> directory. Enter the following command:

sh ./startWebLogic.sh

Note:

By default, the examples server uses port 7001 to listen for incoming connections. The MedRec server also uses the same listen port by default, which means that you cannot run both domains at the same time without changing one of the listen ports. If you want to run both domains at the same time, use the WebLogic Server Remote Console to change the listen port of the examples server to something other than 7001, and then restart it. You can then run the MedRec server using its default listen port at the same that you run the examples server.

Parent topic: Installing and Running the Examples

Running the WebLogic Server Code Examples

Review the instructions provided with the code examples for information about building, deploying and running the code examples. When you start the WebLogic Server examples domain, a browser is automatically launched that displays a web page from which you can browse the code examples and obtain instructions for building, deploying, and running them.

Parent topic: Installing and Running the Examples

Conventions

The instructions for building, deploying, and running the WebLogic Server code examples include a number of typographical conventions for indicating the path names for entities such as the WebLogic Server installation directory, the samples domain home directory, Apache Derby, and so on, in a platform-neutral way.

The following conventions are used:

  • The instructions generally are for Windows command shells. If you are using a UNIX or Linux-based shell, substitute \ for / in path names.

  • ORACLE_HOME represents the directory you specified as the Oracle Home when you installed WebLogic Server; for example, C:\Oracle\Middleware\Oracle_Home.

  • WL_HOME represents the top-level installation directory for Oracle WebLogic Server. The default path is ORACLE_HOME\wlserver. (However, you are not required to install WebLogic Server in the Oracle Home directory.)

  • EXAMPLES_HOME represents the directory in which the WebLogic Server code examples are configured. The default path is ORACLE_HOME\wlserver\samples\server.

  • DOMAIN_HOME represents the directory in which the WebLogic Server sample domains are configured. The default path is ORACLE_HOME\user_projects\domains.

Source files for the code examples are separated from the domain configuration files, just as they should be in a real-world scenario. They are installed in the EXAMPLES_HOME directory.

The DOMAIN_HOME\<samples_domain> directory contains a WebLogic Server samples domain; it contains your applications and the XML configuration files that define how your applications and Oracle WebLogic Server will behave, as well as startup and environment scripts.

The EXAMPLES_HOME\examples\build directory contains client and server classes required by the examples and Derby database.

The WL_HOME\common\derby directory contains Derby, a demonstration database that the examples are configured to use. It also contains scripts that start and stop the database. For more information about Derby, see http://db.apache.org/derby.

Parent topic: Sample Applications and Code Examples

Jakarta EE 8 Examples

Oracle WebLogic Server fully supports the Jakarta Platform, Enterprise Edition (Jakarta EE) 8 specification. The Jakarta EE 8 examples that are included demonstrate how to implement Jakarta EE 8 APIs and Oracle WebLogic Server-specific features.

The Jakarta EE 8 examples are grouped into the following categories:

  • Jakarta JSON Binding—Use Jakarta JSON Binding with JAX-RS.

  • Jakarta Security—Configure a DatabaseIdentityStore to point to a backend database and then use it as an IdentityStore.

  • Jakarta JSON Processing—Use JSON Patch, JSON Merge Patch, and JSON Pointer to update a JSON document.

  • Servlet 4.0—Use the Servlet Mapping API, HTTP/2 Server Push, and the HTTP Trailer headers API.

  • JAX-RS 2.1—Use the new Server-Sent Events (SSE) and the new REST Reactive Client API.

  • JSF 2.3—Use the new features of JSF 2.3 such as direct support for WebSockets, class-level bean validation, CDI-compatible @ManagedProperty annotation feature, and Java date and time.

  • JPA 2.2—Use injection in @AttributeConverter annotation, new Jakarta EE 8 Date and Time, and also use support for retrieving the results of Query and TypedQuery as streams.

  • CDI 2.0—Use asynchronous events, observer ordering, and also use interception factory.

Parent topic: Sample Applications and Code Examples

Java EE 7 Examples

Oracle WebLogic Server fully supports the Java Platform, Enterprise Edition (Java EE) 7 specification. The Java EE 7 examples that are included demonstrate how to implement Java EE 7 APIs and Oracle WebLogic Server-specific features.

The Java EE 7 examples are grouped into the following categories:

  • Batch Application Processing 1.0—Submit batch jobs and obtain information about submitted jobs using the JobOperator interface, and use the batch parallelization model to run partitioned job steps.

  • Bean Validation 1.1—Use the bean validation group constraint and method level validation APIs.

  • Context and Dependency Injection (CDI) 1.1—Use CDI events and the @TransactionScoped and @Transactional  annotations.

  • Concurrency Utilities 1.0—Create dynamic proxy objects using the ContextService interface, submit tasks using the ManagedExecutorService interface, submit delayed or periodic tasks using the ManagedScheduledExecutorService interface, and obtain a managed thread from the Java EE container using the ManagedThreadFactory interface.

  • Enterprise JavaBeans 3.2—Use the new session bean life cycle callback interceptor methods API and also use a message-driven bean to implement a listener interface with no methods.

  • Expression Language 3.0—Use new EL features, including support for a standalone environment, static field or method references, new operators, Lambda expressions, and collection constructions and operations.

  • Java API for RESTful Web Services (JAX-RS) 2.0—Use asynchronous processing, filters and interceptors, and server-sent events (SSE) Jersey support.

  • Java EE Connector Architecture 1.7—Develop a resource adapter and deploy connector resources with annotations defined in the Java EE Connector Architecture 1.7 specification.

  • Java Message Service API 2.0—Use the JMS API in EJBs and servlets.

  • Java Persistence 2.1—Use JPA criteria update and criteria delete APIs, and the stored procedures API.

  • JSF 2.2—Use Java Server Faces (JSF) resource library contracts, file upload, faces flows, and HTML5 features.

  • JSON Processing 1.0—Use the Java API for JSON processing with JAX-RS.

  • Servlet 3.1—Use the HTTP protocol upgrade API, use non-blocking I/O for asynchronous reads and writes, change a session ID, and handle uncovered HTTP methods.

  • WebSocket—Process JSON-format data, using CDI and EJBs in WebSocket endpoints, enable a server to echo text sent by a client, and enable fallback to HTTP long polling as an alternative for WebSocket messaging.

Parent topic: Sample Applications and Code Examples

Additional API Examples

Oracle WebLogic Server also includes a set of examples that demonstrate how to implement additional Jakarta EE APIs and Oracle WebLogic Server-specific features. These examples are grouped in the following categories:

  • Database Connectivity—Use Data Sources, Multi Data Sources, and Rowsets.

  • EJB—Create stateless, stateful, entity, and message-driven EJBs, and more.

  • Internationalization—Internationalize an application using simple message catalogs.

  • Messaging—Use JMS topics, queues, and message-driven beans.

  • Resource Adapter—Use an entity EJB to interact with a Jakarta Connector Architecture resource adapter.

  • Security—Use the Java Authentication and Authorization Service, SAML, and outbound and two-way SSL.

  • Transactions—Use JTA to perform distributed transactions using the two phase commit protocol across two XA resources.

  • Web Application—Create simple servlets and JSPs, use the HTTP Publish-Subscribe server, and more.

  • Web Services—Create a variety of web services using JWS annotations.

  • XML—Use the STAX API and XMLBeans

  • Cluster—Cluster an EJB and use HTTP session state replication.

  • Coherence—Use the Coherence container to host Coherence applications

  • WebLogic Scripting Tool—Use the WebLogic Scripting Tool (WLST) to configure and manage a running Administration Server instance.

  • Split Development—Use the WebLogic split development directory structure to build, package, and deploy Enterprise Applications.

  • Service Component Architecture—Use WebLogic SCA, a lightweight Spring 2.5 (or higher) container, in a shopping cart application that demonstrates many of its key features.

  • Spring—Use Spring-simplified configuration in a Spring-based web application.

Parent topic: Sample Applications and Code Examples

Avitek Medical Records

Avitek Medical Records (also known as MedRec) is a comprehensive educational sample application that demonstrates WebLogic Server and Jakarta EE features, as well as best practices. Avitek Medical Records is optionally installed with the WebLogic Server installation.

You can start MedRec from the ORACLE_HOME/user_projects/domains/medrec directory, where ORACLE_HOME is the directory you specified as the Oracle Home when you installed Oracle WebLogic Server.

The sample application, MedRec (Spring) demonstrates Spring Framework application development practices.

Parent topic: Sample Applications and Code Examples

Derby Open-Source Database

Derby is an open source relational database management system based on Java, JDBC, and SQL standards. Derby is bundled with WebLogic Server for use by the sample applications and code examples as a demonstration database.

For more information about Derby, see http://db.apache.org/derby.

Parent topic: Sample Applications and Code Examples