This documentation is in progress and includes all updates released after Identity Server 5.4.1. For documentation specific to a version, see About This Release.
Page Comparison - Setting Up the Sample Webapp (v.2 vs v.3) - WSO2 Identity Server 5.x.x - WSO2 Documentation

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Excerpt

To obtain and configure the Playground sample, follow the steps below.

  1. You can check out the repository of the OAuth 2.0 sample from GitHub. Follow the instructions here to checkout the folder. We refer <SAMPLE_HOME> as the modules/samples folder inside the folder where the product-is repository is checked out.

  2. Open a terminal window and add the following entry to the /etc/hosts file of your machine to configure the hostname.

    Info
    titleWhy is this step needed?

    Some browsers do not allow you to create cookies for a naked hostname, such as localhost. Cookies are required when working with SSO. Therefore, to ensure that the SSO capabilities work as expected in this tutorial, you need to configure the etc/host file as explained in this step.

    The etc/host file is a read-only file. Therefore, you won't be able to edit it by opening the file via a text editor. To avoid this, edit the file using the terminal commands.
    For example, use the following command if you are working on a Mac/Linux environment.

    Code Block
    sudo nano /etc/hosts
    Code Block
    languagebash
    127.0.0.1		wso2is.local
    Note

    Are you getting the error that is given below?

    Code Block
    titleError
    javax.net.ssl.SSLHandshakeException: sun.security.validator.ValidatorException: PKIX path building failed: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target

    The sample applications do not have a keystore in them. Therefore, after changing the tomcat hostname you might get this error because the public key of the WSO2 Identity Server does not exist in the Java certificate store. For more information on the steps you need to follow to overcome the error, see FAQ.

  3. In your command line, navigate Navigate to <SAMPLE_HOME>/oauth2/playground2 in the folder you checked out and directory via the terminal and build the sample using the following command. You must have Apache Maven installed to do this (see Installation Prerequisites for the appropriate version to use).

    Code Block
    mvn clean install
  4. After successfully building the sample, a .war file named playground2 can be found inside the <SAMPLE_HOME>/oauth2/playground2/target targetfolder. Deploy this sample web app on a web container. To do this, use the , such as Apache Tomcat server.

    Note

    Since this sample is written based on Servlet 3.0 it needs to be deployed on Tomcat 7.x.

    Use the following steps to deploy the web app in the web container:

    1. Stop the Apache Tomcat server if it is already running.
    2. Copy the playground2.war file to the <TOMCAT_HOME>/webapps folder.
    3. Start the Apache Tomcat server.
  5. Make sure to update param-value the following parameter in the WEB-INF/web.xml file with the server URL of the Identity Server if required. Service URL should have
    Make sure to enter the port the application is started up withrunning on, in the URL. If you have started the Identity Serve with an offseta port offset, then the matching port should be respective port needs to be configured here.

    Code Block
    <init-param>
         <description>serverUrl</description>
         <param-name>serverUrl</param-name>
         <param-value>https://localhost:9443/services/</param-value>
    </init-param>
    Info

    Note that localhost is the server that hosts WSO2 Identity Server and 9443 is the default SSL port of it.Inorderto access the admin services you should have the values in step 5 and 6. Since playground application is accessing the admin service OAuth2TokenValidationService, you should have the correct serverUrl,usernameand password asdescripbedin step 5 and 6.

  6. Update Update param-value of the parameters below  parameter with credentials of an admin user if required.

    Code Block
    <init-param>
         <description>userName</description>
         <param-name>userName</param-name>
         <param-value>admin</param-value>
    </init-param>
    <init-param>
         <description>password</description>
         <param-name>password</param-name>
         <param-value>admin</param-value>
    </init-param>
    Update the hostname in etc/hosts to wso2is.local or something similarly appropriate.
  7. Restart Apache Tomcat and access http://wso2is.local:8080/playground2/ (assuming Tomcat is running on HTTP port 8080).
    By default Tomcat runs on port 8080. If you have configured it to run on a different port make sure to update the URL and access the playground application.
    You are directed to the landing page of the sample application. Click on Import Photos and the following page appears.

    Image Modified
Note

Are you getting the error that is given below?

Code Block
titleError
javax.net.ssl.SSLHandshakeException: sun.security.validator.ValidatorException: PKIX path building failed: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target

The sample applications do not have a keystore in them. Therefore, after changing the tomcat hostname you might get this error because the public key of the WSO2 Identity Server does not exist in the Java certificate store. For more information on the steps you need to follow to overcome the error, see FAQ.

This application is used to request access tokens using the four OAuth2 grant types:

...