OAuth Sample

Key phrases associated with this sample: "OAuth", "authorization"

Procedure

Build the OAuth Sample Application

1. Identifying the directory structure of the OAuth Sample

   You do not need to build the OAuth Sample before using it. The following directions describe the steps to rebuild the OAuth Sample, with additional information for modifications.

   The OAuth Sample is located in the following zip file directories:

   Table 1. OAuth Sample Zip File Directory Structure

   Directory	Description
   OAuth/src/	Contains the sample source code for the sample.
   OAuth/installableApps/	Contains the was.oauth.samples.ear file for sample. This directory is not modified if this sample is rebuilt.
   OAuth Sample/lib/	Contains the Web archive (WAR) files, and the final was.oauth.samples.ear file for the Samples. This directory is created when this sample is rebuilt.

2. Running the Samples build script

   To rebuild the OAuth Samples EAR file, perform the following steps:

   1. Set the WAS_HOME environment variable to point to your WebSphere Application Server install directory.
      • Locate the WebSphere Application server directory.
      • On UNIX platforms, issue the command

        export WAS_HOME=directory

      • On Windows run

        set WAS_HOME=directory

      In each of these, replace 'directory' with the location of your WebSphere installation. For example,

      export WAS_HOME=/opt/IBM/WebSphere/AppServer

   2. Change to the OAuth Sample directory where you unzipped the sample. This directory contains build.xml which is used to build the sample.
   3. Run the Samples build script.
      • On UNIX platforms, run

        scripts/buildsamples.sh

      • On Windows run

        scripts\buildsamples.bat

   The Sample is now built.

   The buildsamples scripts are located in the OAuth/scripts directory. The scripts set the appropriate class path information and run the Ant build utility. The Ant utility reads the build.xml files, which describe how to build the Samples. Refer to the Apache Ant Web site for additional documentation on the Ant utility.

Procedure

Installing the OAuth Sample.ear file

1. Install the sample using the WebSphere console
2. Click on the sample in the console, then select "Security role to user/group mapping".
3. Click on the sample in the console, then select "Security role to user/group mapping".
4. Place a check next to "oauth2_admin" and click on "Map Special Subjects>All Authenticated in Application's Realm"
5. Click OK, and then Save.
6. Start the application.

Running the Sample

Before you begin, you must verify that the application server is running before running the clients. This sample is a standard J2EE application, and you can install on WebSphere Application Server. Prior to running this sample, you need to configure and enable OAuth feature (see the WebSphere Application Server Information Center for more information).

The sample code shows how to write a provider side application to register an OAuth client, how to remove client authorization, how to customize OAuth service provider, and how to write an OAuth client to work with OAuth service provider.

To run the OAuth sample from a WebSphere Application Server, perform the following steps:

1. Start the server.
2. Point your browser to the client interface. For example, http://localhost:9080/oauth2samples/
3. To run other samples, you can click on links or type the following URL from browser directly

   http://localhost:9080/oauth2samples/<sample.jsp>

where "sample.jsp" is the sample you want to test. You can run the following samples:

clienttable.jsp

You need to log in as a user with WebSphere Application Server administrator role.

dbclienttable.jsp

You need to log in as a user with WebSphere Application Server administrator role

Once you log in as an administrator user, you can use the interactive screen to add or remove an OAuth client.

The following illustration shows the correctly running OAuth sample: