Cloud: Java Cloud Service SDK

#

## Sample Introduction

This sample demonstrates an alternate mode of authentication to web pages. It shows how to explicitly enable FORM authentication. The default mode of authentication is Single Sign-On. This sample shows how to overwrite the default mode with FORM-based authentication. It also demonstrate how to enable role-based authorization. Once you log in, the sample first authenticates you, and than checks if you have access to a web page. Access to the page is granted through special role assignment.

After you run the sample, a sample welcome page will be displayed, asking for your authentication with the FORM style, then checks if the input user name and password are legal. Once successfully logged in, you can immediately visit the second page.

For details about the sample code, see the files that are listed in the table.

## Main Files Used in the Sample

Directory Location:

SDK_HOME/samples/security/greeting-form-auth

(where SDK_HOME is the directory containing your Oracle Java Cloud Service installation)

File Click source files to view code. | Description
--- | ---
build.xml | Ant build file that contains targets for building, deploying, and running the sample.
index.html | Sample welcome page that contains a FORM authentication element.
secured.jsp | JavaServer page that is secured and accessed only by an authenticated user.
error.html | HyperText Markup Language page that is displayed when the authentication fails.
web.xml | Web application deployment descriptor that defines the authentication method, security constraint, and role.
weblogic.xml | Oracle WebLogic Server-specific web application deployment descriptor that declares the application context root and security role assignment.

## Prepare the Sample

### Prerequisites for Deploying the Sample Locally

1. Install Oracle WebLogic Server and configure it. This is required only if you want to deploy applications locally.
2. In the `SDK_HOME/samples/myenv.*` script, set the MW_HOME environment variable to the directory where WebLogic Server is installed.
3. Run the script:
   - On Linux, run: `. ./myenv.sh`
   - On Windows, run: `myenv.cmd`
4. Set the following environment variables in the `SDK_HOME/samples/build.common.properties` properties file:
   - set local to true, the default value is false.
   - set identity-domain to the identity domain name where you will deploy the application.
   - set service-instance to the service instance name where you will deploy the application.
   - set local-admin-url to the URL of the local WebLogic admin server.
   - set local-admin-user to the admin user who has permission to deploy the application.
   - set local-app-users-group to the app-users-group by which the application is secured.

You can also refer to Preparing Applications for Java Cloud Service Deployment in Using Oracle Java Cloud Service and the sample main page for more details.

### Prerequisites for Deploying the Sample on Java Cloud Service

If you are going to install your application only on a remote Java Cloud Service instance, you will not need to have WebLogic Server installed locally. Just make sure that "ant" and "javac" are available in the path.

Set the following environment variables in the `SDK_HOME/samples/build.common.properties` properties file:

- set identity-domain to the identity domain name where you will deploy the application.
- set service-instance to the service instance name where you will deploy the application.
- set cloud-admin-url to the admin URL that is used to deploy the application on Oracle Cloud.
- set cloud-admin-user to the admin user who has permission to deploy the application on Oracle Cloud.
- set cloud-app-users-group to the app-users-group by which the application is secured. You must also use the My Service Security page to create a new role that is of the form `<service-instance>.JavaUsers`, and then assign that role to the user who will log onto the sample after it is deployed on Oracle Cloud.

## Build and Deploy the Sample

To build the sample, follow these steps:

1. Change to the `SDK_HOME/samples/security/greeting-form-auth` directory, where SDK_HOME refers to the main Java Cloud service SDK installation directory, such as `/home/user/oracle-javacloud-sdk`.
2. Execute the following command in the shell. (If you deploy the sample to local environment, choose the shell where you run the `myenv.*` script.)
   `ant clean`
   This command cleans the build directory
   `ant build`
   This command compiles and stages the sample.
3. Execute the following command in the shell. (If you deploy the sample to local environment, choose the shell where you run the `myenv.*` script.)
   `ant install`
   This command installs the sample on the local WebLogic Server or a remote Java Cloud Service.

The Ant command uses the `build.xml` file in the `SDK_HOME/samples/security/greeting-form-auth` directory to build the sample.

## Run the Sample

1. Complete the steps in the "Prepare the Sample" section.
2. Execute the following command in the shell. (If you deploy the sample to local environment, choose the shell where you run the `myenv.*` script.)
   `ant run`
   This command tries to automatically launch the web browser with the URL pattern `http://server:port/greeting-form-auth`, where the server would include the identity domain and service instance name. For example, `https://java1-wnctrial.java.dc1.c9labga.us.oracle.com/greeting-form-auth`, where `java1` is the service instance name and `wnctrial` is the identity domain. The rest of the host name `java.dc1.c9labga.us.oracle.com` is based on the environment. The actual URL should be printed when you run the sample.
   If the above does not work, you can open a browser, then copy and paste the above URL.
   For non-Windows and non-Mac machines, make sure that you have specified valid browser for the `default.browser` property in `SDK_HOME/samples/build.common.properties.`