Before implementing RESTful Web Service by using basic authentication, download and install product components, configure WebLogic domain, start the Remote Server, and get the access to Oracle Enterprise Manager Fusion Middleware Control and Oracle WebLogic Server Remote Console.

1. Download and install the following product components:

   • Oracle Fusion Middleware—includes OWSM

     For more information, see "Preparing for Oracle Fusion Middleware Installation" in Planning an Installation of Oracle Fusion Middleware.

   • Oracle JDeveloper Studio Edition

     This is required only for a subset of use cases in this document.

     For more information about locating and downloading Oracle Fusion Middleware products, see the Oracle Fusion Middleware Download, Installation, and Configuration Readme Files on OTN.

2. Configure a WebLogic domain.

   For the complete procedure, see "Creating a WebLogic Domain" in Creating WebLogic Domains Using the Configuration Wizard.

3. Start the Remote Server in the domain.

   For the complete procedure, see "Starting and Stopping Servers" in Administering Server Startup and Shutdown for Oracle WebLogic Server.

4. Ensure that you can access the following administration tools:

   • Oracle Enterprise Manager Fusion Middleware Control:

     http://localhost:7001/em
     

   • Oracle WebLogic Server Remote Console

     http://localhost:7001/console
     

Before you deploy RESTful resources, first define a global policy to secure all RESTful resources by default.

1. Ensure that the WebLogic Server is running.
2. Start WLST and connect to the running instance of WebLogic Server, as described in "Accessing the Web Services Custom WLST Commands" in Administering Web Services.

   wls:/offline> connect('weblogic', 'password', 't3://localhost:7001')
   Connecting to t3://localhost:7001 with userid weblogic ...
   Successfully connected to Admin Server "AdminServer" that belongs to domain "base_domain".
    
   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.
   

3. Start a session.

   wls:/base_domain/serverConfig> beginWSMSession()
   Location changed to domainRuntime tree. This is a read-only tree with DomainMBean as the root.
   For more help, use help('domainRuntime')
    
   Session started for modification.
   

4. Define an OWSM global policy set for all RESTful resources.

   wls:/base_domain/serverConfig> createWSMPolicySet('rest-policy-set','rest-resource', 'Service("*")')
    
   Description defaulted to "Global policy attachments for RESTful Resource resources."
   The policy set was created successfully in the session.
   

5. Attach the oracle/wss_http_token_service_policy policy to the policy set to require basic authentication for all RESTful resources.

   wls:/base_domain/serverConfig> attachPolicySetPolicy('oracle/wss_http_token_service_policy')
    
   Policy reference "oracle/wss_http_token_service_policy" added.
   

6. Commit the session.

   wls:/base_domain/serverConfig> commitWSMSession()
    
   The policy set rest-policy-set is valid.
   Creating policy set rest-policy-set in repository.
    
   Session committed successfully.
   

You can create a simple HelloWorld RESTful web service by using JDeveloper.

1. Start JDeveloper.

   For the complete procedure, see "Next Steps After Installing Oracle JDeveloper Studio" in Installing Oracle JDeveloper.

2. Create an application and project using the Create Custom Application wizard.

   Invoke the Create Custom Application wizard by selecting File > New > Application and then General > Applications > Custom Application.

   • Application Name: RESTfulApplication

   • Project Name: RESTfulService

   • Project Features: Java

   • Default Package: samples.helloworld

   For all other values, accept the defaults.

   For the complete procedure, see "Creating Applications and Projects" in Developing Applications with Oracle JDeveloper.

3. Create a new Java class using the Create Java Class wizard.

   Invoke the Create Java Class wizard by right-clicking the RESTfulService project and selecting New > Java Class.

   Define the following characteristics:

   • Name: HelloWorldResource

   • Constructors from Superclass: Deselect

   • Implement Abstract Methods: Deselect

   For all other values, accept the defaults.

   For the complete procedure, see "How to Create a New Java Class or Interface" in Developing Applications with Oracle JDeveloper.

4. Add the hello() method to the Java class, as shown in bold below.

   package samples.helloworld;
   public class HelloWorldResource {
       public String hello() {
           return "Hello!";
       }
   }
   

5. Create a RESTful service from the Java class using the Create RESTful Service from Java Class wizard.

   Invoke the Create RESTful Service from Java Class wizard by right-clicking HelloWorldResource.java and selecting Create RESTful Service.

   Define the following characteristics:

   • Root Path: helloworld

   • Configure HTTP Methods: hello

     - Type: Get
     - Produces: text/plain

   For all other values, accept the defaults.

   The code is updated as follows:

   package samples.helloworld;
    
   import javax.ws.rs.GET;
   import javax.ws.rs.Path;
   import javax.ws.rs.Produces;
    
   @Path("helloworld")
   public class HelloWorldResource {
    
       @GET
       @Produces("text/plain")
       public String hello() {
           return "Hello!";
       }
   }
   

You can authenticate a user by using javax.ws.rs.core.SecurityContext.

1. Access the SecurityContext by injecting an instance into a class field, setter method, or method parameter using the javax.ws.rs.core.Context annotation.

   Update the hello() method, created in the previous step, to print the authenticated user name obtained using the SecurityContext, as follows:

   package samples.helloworld;
    
   import javax.ws.rs.GET;
   import javax.ws.rs.Path;
   import javax.ws.rs.Produces;
   import javax.ws.rs.core.SecurityContext;
   import javax.ws.rs.core.Context;
   import java.security.Principal;
    
   @Path("helloworld")
   public class HelloWorldResource {
    
       @GET
       @Produces("text/plain")
       public String hello(@Context SecurityContext sc) {
           String user = "";
           if (sc != null) {
               Principal p = sc.getUserPrincipal();
               if (p != null) {
                   user = p.getName();
               }
           }
           return "Hello " + user + "!";
       }
   }
   

You can create a class that extends javax.ws.rs.core.Application to define the components of a RESTful web service application deployment and provides additional metadata.

1. Create a new Java class using the Create Java Class wizard.

   Invoke the Create Java Class wizard by right-clicking the samples.helloworld package and selecting New > Java Class. For assistance at anytime, press F1 or click Help.

   Define the following characteristics:

   • Name: MyApplication

   • Package: samples.helloworld

   • Extends: javax.ws.rs.core.Application

   • Constructors from Superclass: Deselect

   • Implement Abstract Methods: Deselect

   For all other values, accept the defaults.

   For the complete procedure, see "How to Create a New Java Class or Interface" in Developing Applications with Oracle JDeveloper.

2. Override the getClasses() method to return the list of RESTful web service resources (in this case, HelloWorldResource), by adding the code show in bold below.

   package samples.helloworld;
    
   import javax.ws.rs.core.Application;
   import java.util.HashSet;
   import java.util.Set;
    
   public class MyApplication extends Application {
       public Set<java.lang.Class<?>> getClasses() { 
              Set<java.lang.Class<?>> s = new HashSet<Class<?>>();
              s.add(HelloWorldResource.class);
              return s;
       }
   }
   

3. Add the javax.ws.rs.ApplicationPath annotation to define the base URI pattern that gets mapped to the servlet. For more information about how this information is used in the base URI of the resource, see "What Happens at Runtime: How the Base URI is Constructed" in Developing and Securing RESTful Web Services for Oracle WebLogic Server.

   package samples.helloworld;
    
   import javax.ws.rs.core.Application;
   import java.util.HashSet;
   import java.util.Set;
    
   import javax.ws.rs.ApplicationPath;
    
   @ApplicationPath("resources")
   public class MyApplication extends Application {
       public Set<java.lang.Class<?>> getClasses() { 
              Set<java.lang.Class<?>> s = new HashSet<Class<?>>();
              s.add(HelloWorldResource.class);
              return s;
       }
   }

Deploy the RESTful web service application as a WAR file to WebLogic Server.