Web Extension

Web Extension - for web application development

10. JSP pages - web application in action

Submitted by Mirjana on Tue, 02/14/2012 - 04:47

Web Extension

Login page:

You can log in with any valid SI user/password.

jsp1.jsp

JSP1 page has 2 text boxes.

Parameters that you will enter here, will not be used in background processing, just they will be used for demonstrating how they are taken into Process Data as well as Primary Document

If you enter XXX, and YYY values for these 2 fields, what you will get in Process Data and Primary Document (in SOMU_webapp_selectUser.bp), run in jsp2.jsp, is as follows:

Process Data:

<?xml version="1.0" encoding="UTF-8"?>

<system-account-user-id>admin</system-account-user-id>

<secondParam>YYY</secondParam>

<firstParam>XXX</firstParam>

<username>admin</username>

</ProcessData>

Primary Document:

<firstParam>XXX</firstParam>

<secondParam>YYY</secondParam>

</inputDocument>

In jsp2.jsp, you can find java code that is used to create strNvp and inputDocumentString, that are used for attribute values in runBP tag:

<sec:runBP user="<%=strUser%>" nvp="<%=strNvp%>" pridoc="<%=inputDocumentString%>" bpname="<%=strBP%>">

String strBPResults = XMLUtil.documentToString(bpResults, false);

org.dom4j.Document d = new org.dom4j.io.DOMReader().read(bpResults);

pageContext.setAttribute("org.apache.taglibs.xtags.taglib.Context", d);

</sec:runBP>

jsp2.jsp

jsp2.jsp will run SOMU_webapp_selectUsers business process that returns the list of all the users in SI system.

If you click on any user, you will get audit details, that means all admin activities for that user.

jsp3.jsp

9. Http Server Adapter setting

Submitted by Mirjana on Tue, 02/14/2012 - 04:43

Web Extension

You have to configure Http Server Adapter in order to run web application on SI

Go to Dasboard -> Deployment -> Services -> Configuration
Search for Http Server Adapter
In the option URI, click on 'add' and create a new URI with the name e.g. /SOMU_webApp
For ‘Launch BP Or WAR’, choose War File
For ‘WAR Config’, enter the full path to .war file (SOMU_webApp.war)

Once when all is done, you can run the web application by writing in the browser:

http://SI_IP:httpServerAdapter_port/SOMU_webApp

8. BPs used in the web application

Submitted by Mirjana on Tue, 02/14/2012 - 04:40

Web Extension

SOMU_webapp_selectUser.bp – run in jsp2.jsp

<assign to="pool">mysqlPool</assign>

<assign to="query_type">SELECT</assign>

<assign to="result_name">RESULT</assign>

<assign to="sql">select yfs_user.USERNAME, yfs_user.BILLINGADDRESS_KEY, yfs_user.SESSION_TIMEOUT, yfs_person_info.FIRST_NAME, yfs_person_info.LAST_NAME, yfs_person_info.EMAILID, yfs_person_info.PERSON_INFO_KEY from yfs_user, yfs_person_info where yfs_user.BILLINGADDRESS_KEY = yfs_person_info.PERSON_INFO_KEY</assign>

</output>

</input>

</operation>

</output>

</input>

</operation>

</sequence>

</process>

SOMU_webapp_selectUserAuditDetails.bp – run in jsp3.jsp

<assign to="paramtype1">String</assign>

<assign to="pool">mysqlPool</assign>

<assign to="query_type">SELECT</assign>

<assign to="result_name">RESULT</assign>

<assign to="sql">select OBJECT_TYPE, OBJECT_NAME, ACTION_TYPE, ACTION_VALUE, TIME from admin_audit where PRINCIPAL = ?</assign>

</output>

</input>

</operation>

</output>

</input>

</operation>

</sequence>

</process>

7. Build web application – SOMU_webApp.war

Submitted by Mirjana on Tue, 02/14/2012 - 04:37

Web Extension

1st way - build.xml ant script, in eclipse, that will build a war file

</target>

</target>

</project>

2nd way - batch script that can build the war file

C:\path_to_root_folder_for_web_app\SOMU_webApp

set PATH=%PATH%;C:\j2sdk1.4.2_12\bin

jar cvf SOMU_webApp.war *

Move .war file to SI server

When .war file is created, you can copy it to SI server, at any place thatcan be accesible from SI installation

6. web.xml - deployment descriptor file

Submitted by Mirjana on Tue, 02/14/2012 - 04:34

Web Extension

<?xml version="1.0" encoding="UTF-8"?>

<web-app>

<display-name>

SOMU_webApp</display-name>

<welcome-file-list>

<welcome-file>index.html</welcome-file>

<welcome-file>index.htm</welcome-file>

<welcome-file>index.jsp</welcome-file>

<welcome-file>default.html</welcome-file>

<welcome-file>default.htm</welcome-file>

<welcome-file>default.jsp</welcome-file>

</welcome-file-list>

<error-page>

<error-code>404</error-code>

<location>/html/error404.html</location>

</error-page>

<error-page>

<error-code>500</error-code>

<location>/html/error500.html</location>

</error-page>

<taglib-uri>http://www.stercomm.com/uix/security</taglib-uri>

<taglib-location>tld/userautho.tld</taglib-location>

</taglib>

<taglib-uri>http://jakarta.apache.org/taglibs/xtags-1.0</taglib-uri>

<taglib-location>tld/taglibs-xtags.tld</taglib-location>

</taglib>

</web-app>

5. Error pages – in html folder

Submitted by Mirjana on Tue, 02/14/2012 - 04:16

Web Extension

error404.html

<HTML>

<HEAD>

<TITLE>Test error 404 page</TITLE>

</HEAD>

<TBODY>

<ul>

<br/>

<br/>Nothing

on this server matches the url you provided!<br/>

</font>

<br/>

</ul>

</TD>

</TR>

</TBODY>

</TABLE>

</BODY>

</HTML>

error500.html

<HTML>

<HEAD>

<TITLE>Test error 500 page</TITLE>

</HEAD>

<TBODY>

<ul>

<br/>

<br/>An internal error occurred!</font>

<br/>

</ul>

</TD>

</TR>

</TBODY>

</TABLE>

</BODY>

</HTML>

4. JSP pages - code - in jsps folder

Submitted by Mirjana on Tue, 02/14/2012 - 04:10

Web Extension

index.html

<html>

location.href='jsps/login.jsp';

</script>

<body/>

</html>

login.jsp

<html>

String _logoutusr = (String)session.getAttribute("username");

if (_logoutusr != null) session.invalidate();

String message = request.getParameter("message");

if (message == null) message = "Please log in";

String title = request.getParameter("title");

if (title == null) title= "Please log in";

<head>

<title>Login</title>

</head>

<table>

<tr>

</tr>

<tr>

<td align='right'>Username</td>

</tr>

<tr>

<td align='right'>Password</td>

</tr>

<tr>

</tr>

<tr>

</tr>

</table>

</form>

</html>

checkautho.jsp

<%@page contentType="text/html"%>

<%@ page import="java.util.*"%>

<%@ page import="com.sterlingcommerce.woodstock.security.*" %>

<%@ taglib uri='http://www.stercomm.com/uix/security' prefix='sec' %>

String strUser = request.getParameter("username");

String strPass = request.getParameter("password");

<sec:authenticate user="<%=strUser%>" pass="<%=strPass%>" login="login.jsp?title=USERNAME/PASSWORD INCORRECT!!!" />

User u = (User) session.getAttribute("user");

int intTimeOut = u.getTimeout();

session.setAttribute("timeout", String.valueOf(intTimeOut));

session.setMaxInactiveInterval(intTimeOut);

session.setAttribute("username", strUser);

session.setAttribute("fullName", u.getFullName());

session.setAttribute("token", u.getUserToken());

<jsp:forward page='jsp1.jsp'/>

<html>

<body>

</body>

</html>

jsp1.jsp

<%@page contentType="text/html; charset=UTF-8" pageEncoding="ISO-8859-1"%>

<%@page import="java.util.*,java.text.*"%>

<%@page import="org.w3c.dom.Document"%>

<%@page import="com.sterlingcommerce.woodstock.util.xml.XMLUtil"%>

<%@page import="com.sterlingcommerce.woodstock.security.*"%>

<%@page import="com.sterlingcommerce.woodstock.security.util.*"%>

<%@taglib uri="http://www.stercomm.com/uix/security" prefix="sec"%>

<%@taglib uri="http://jakarta.apache.org/taglibs/xtags-1.0" prefix="xtags"%>

<sec:validSession login="login.jsp?message=Session expired. Please log in again"/>

SimpleDateFormat formatter = new SimpleDateFormat("yyyy-MM-dd");

String currentDate = formatter.format(new Date());

<html>

<head>

</head>

<br/>

<table>

<tr>

<td>Enter the first parameter:</td>

</tr>

<tr>

<td>Enter the second parameter:</td>

</tr>

<tr>

</tr>

</table>

</form>

</body>

</html>

jsp2.jsp

<%@page contentType="text/html; charset=UTF-8" pageEncoding="ISO-8859-1"%>

<%@page import="java.util.*,java.text.*"%>

<%@page import="org.w3c.dom.Document"%>

<%@ page import="org.dom4j.*" %>

<%@page import="com.sterlingcommerce.woodstock.util.xml.XMLUtil"%>

<%@page import="com.sterlingcommerce.woodstock.security.*"%>

<%@page import="com.sterlingcommerce.woodstock.security.util.*"%>

<%@taglib uri="http://www.stercomm.com/uix/security" prefix="sec"%>

<%@taglib uri="http://jakarta.apache.org/taglibs/xtags-1.0" prefix="xtags"%>

<sec:validSession login="login.jsp?message=Session expired. Please log in again"/>

// taking username from the session

String strUser = (String)session.getAttribute("username");

// taking request params from jsp1.jsp

String firstParam = request.getParameter("firstParam");

String secondParam = request.getParameter("secondParam");

// creating name value pair for sending params in Process Data

StringBuffer stringBufferForPD = new StringBuffer();

stringBufferForPD.append("firstParam=");

stringBufferForPD.append(firstParam);

stringBufferForPD.append("&");

stringBufferForPD.append("secondParam=");

stringBufferForPD.append(secondParam);

String strNvp = stringBufferForPD.toString();

// creating XML for Primary Document

StringBuffer stringBufferForPrimaryDocument = new StringBuffer();

stringBufferForPrimaryDocument.append("<inputDocument>\n");

stringBufferForPrimaryDocument.append("<firstParam>");

stringBufferForPrimaryDocument.append(firstParam);

stringBufferForPrimaryDocument.append("</firstParam>\n");

stringBufferForPrimaryDocument.append("<secondParam>");

stringBufferForPrimaryDocument.append(request.getParameter("secondParam"));

stringBufferForPrimaryDocument.append("</secondParam>\n");

stringBufferForPrimaryDocument.append("</inputDocument>\n");

String inputDocumentString = stringBufferForPrimaryDocument.toString();

// define BP that will be run in SI system, when submitting this form

String strBP = "SOMU_webapp_selectUsers";

<sec:autho permission="<%=strBP%>" checkExistence="true">

<sec:runBP user="<%=strUser%>" nvp="<%=strNvp%>" pridoc="<%=inputDocumentString%>" bpname="<%=strBP%>">

String strBPResults = XMLUtil.documentToString(bpResults, false);

org.dom4j.Document d = new org.dom4j.io.DOMReader().read(bpResults);

pageContext.setAttribute("org.apache.taglibs.xtags.taglib.Context", d);

</sec:runBP>

</sec:autho>

<html>

<head>

</head>

<hr/>

List of users from Sterling Integrator:

<hr/>

<br/>

<tr>

<th>First name</th>

<th>Email</th>

<th>Session timeout</th>

<th>Person info key</th>

</tr>

<xtags:forEach select="//RESULT/ROW">

<tr>

</tr>

</xtags:forEach>

</table>

<br/>

</body>

</html>

jsp3.jsp

<%@page contentType="text/html; charset=UTF-8" pageEncoding="ISO-8859-1"%>

<%@page import="java.util.*,java.text.*"%>

<%@page import="org.w3c.dom.Document"%>

<%@ page import="org.dom4j.*" %>

<%@page import="com.sterlingcommerce.woodstock.util.xml.XMLUtil"%>

<%@page import="com.sterlingcommerce.woodstock.security.*"%>

<%@page import="com.sterlingcommerce.woodstock.security.util.*"%>

<%@taglib uri="http://www.stercomm.com/uix/security" prefix="sec"%>

<%@taglib uri="http://jakarta.apache.org/taglibs/xtags-1.0" prefix="xtags"%>

<sec:validSession login="login.jsp?message=Session expired. Please log in again"/>

//taking username from the session

String strUser = (String) session.getAttribute("username");

//BP name that will be run

String strBP = "SOMU_webapp_selectUserAuditDetails";

//taking userParam from request

String userParam = request.getParameter("userParam");

//defining userParam for nvp, will be set in the Process Data

String nvp = "userParam=" + userParam;

<sec:autho permission="<%=strBP%>" checkExistence="true">

<sec:runBP user="<%=strUser%>" nvp="<%=nvp%>" pridoc="" bpname="<%=strBP%>">

String strBPResults = XMLUtil.documentToString(bpResults, false);

org.dom4j.Document d = new org.dom4j.io.DOMReader().read(bpResults);

pageContext.setAttribute("org.apache.taglibs.xtags.taglib.Context", d);

</sec:runBP>

</sec:autho>

<html>

<head>

</head>

<hr/>

<table>

<tr>

<td>Audit details for the user <i style="color:red;"><%=userParam%></i></td>

</tr>

</table>

<hr/>

<br/>

<table>

<tr>

<th align="left">Object type</th>

<th align="left">Object name</th>

<th align="left">Action type</th>

<th align="left">Action value</th>

<th align="left">Time of changes</th>

</tr>

<xtags:forEach select="//RESULT/ROW">

<tr>

</tr>

</xtags:forEach>

</table>

</form>

</body>

</html>

3. Web application structure in Eclipse

Submitted by Mirjana on Tue, 02/14/2012 - 04:07

Web Extension

After configuring all tag libraries, you should add 3 external java packages in order to resolve all possible build paths problems.

They are:

Studio-API.jar
platform_library.jar

Both jars mentioned above could be found in install SI folder (SI_install\mesa\studio), and some other places, but better to use both from

\plugins\com.sterlingcommerce.mesa.servicesdk_3207.0.0\lib\3000 that you can see in your eclipse workspace after putting plugin for MESA Developer Studio from SI

You can see they are not of the same size.

Note: I do not know why we cannot find full size jars in SI installation folder, but just when they are taken into eclipe during installing MESA plug in into eclipse.

dom4j.jar

dom4j.jar should be used because document from BP should be loaded as org.dom4j.Document in order to be parsed by XTags. Can be found in installDir/SI/jar/dom4j/1_5_2 folder

2. Base file system structure for web application

Submitted by Mirjana on Tue, 02/14/2012 - 03:51

Web Extension

Here is the structure of the folders for a web application:

SOMU_webApp (folder)

css (folder)

html (folder)

images (folder)

jsps (folder)

index.html

...

WEB-INF (folder)

tld (folder)

web.xml

... tld files has to be placed into tld folder

There are 2 files we have to have for SI web app development.

In the same time we have to have 2 corresponding packages (jars) containing classes used for creating tag libraries:

You can find paths for both tld files that are used in the test web application.

.tld/.jar

Description

Folder

userautho.tld

userautho.jar

contains tags for connection/authentication/validation at SI

installDir/jar/gis/4.3/gis.jar

install/container/Applications/helloworld/WEB-INF/tld

taglibs-xtags.tld

taglibs-xtags.jar

contains tags for presentation part in the forms (similar to XSLT)

installDir/SI/jar/xtags/1_0/taglibs-xtags.jar

/install/container/Applications/dashboard/WEB-INF/templates/jsp/tld

1. TAGS - describe, specify, declare and use in this web app

Submitted by Mirjana on Tue, 02/14/2012 - 03:42

Web Extension

To define a tag, you need to:

Develop a tag handler and helper classes for the tag (we will use 2 tag libraries already developed, one by IBM/Sterling Commerce, i.e. userautho and Apache one i.e. taglibs-xtags). In a table below, you can see where you can find them and load into your project, either in file system or in eclipse.
Describe the tag in a tag library descriptor, tld file.
Specify tags in web.xml descriptor file
Declare the tag in web page where it is used

Describe the tag – .tld files in WEB-INF/tld

Descibe the tag in a tag library descriptor file (WEB-INF/tld/userautho.tld).

It is just an example of tld file, for this test web application, you can take userautho.tld and taglibs-xtags.tld from SI installation system and bundle them into your final war file. Paths for the tld files are given in a table below.

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE taglib PUBLIC "-//Sun Microsystems, Inc.//DTD JSP Tag Library 1.2//EN" "http://java.sun.com/dtd/web-jsptaglibrary_1_2.dtd">

<tlib-version>1.0</tlib-version>

<jsp-version>1.2</jsp-version>

<short-name>security</short-name>

<uri>http://www.stercomm.com/uix/security</uri>

<display-name>Security</display-name>

<description> This tag library contains functionality specific to the User Authentication and Authorization </description>

<tag>

<name>autho</name>

<tag-class>

com.sterlingcommerce.woodstock.uix.taglib.common.security.AuthorizeUserAction

</tag-class>

………

<tag>

<name>validSession</name>

<tag-class>com.sterlingcommerce.woodstock.uix.taglib.common.security.ValidateSession</tag-class>

<body-content>empty</body-content>

<description> Performs user session validation if fails, then attempts to forward to login/error page </description>

<name>login</name>

<description>relative page url to which user should be forwarded in case of session being invalid/expired failure</description>

</attribute>

</tag>

</taglib>

Specify the tag – in web.xml

Specify the location of your JSP tag library in your Web application’s WEB-INF/web.xml file. Type the following code between the <web-app> and </web-app> tags:

….

<taglib-uri>http://www.stercomm.com/uix/security</taglib-uri>

<taglib-location>tld/userautho.tld</taglib-location>

</taglib>

<taglib-uri>http://jakarta.apache.org/taglibs/xtags-1.0</taglib-uri>

<taglib-location>tld/taglibs-xtags.tld</taglib-location>

</taglib>

…

Declare the tag – in .jsp page

You declare that a JSP page will use tags defined in a tag library by including a taglib directive in the page before any custom tag is used:

<%@ taglib uri=" http://www.stercomm.com/uix/security" prefix="sec" %>

The uri attribute refers to a URI that uniquely identifies the tag library. This URI can be relative or absolute. If it is relative it must be mapped to an absolute location in the taglib element of a Web application deployment descriptor, the configuration file associated with Web applications developed according to the Java Servlet and JavaServer Pages specifications. The prefix attribute defines the prefix that distinguishes tags provided by a given tag library from those provided by other tag libraries.

Usage of tags – in .jsp page

<sec:validSession login="login.jsp?message=Session expired. Please log in again"/>

Donate via PayPal

Select amount

About donation

As you all know I've been doing this for over a decade and have never asked for anything from anybody. I do not have any sponsors; and all the time and money I've invested over the years has been accumulating. Now I request, if you can, please show your appreciation to the site by making a small donation for servers and site maintenance.

World of Integration

Web Extension

10. JSP pages - web application in action

9. Http Server Adapter setting

8. BPs used in the web application

7. Build web application – SOMU_webApp.war

6. web.xml - deployment descriptor file

5. Error pages – in html folder

4. JSP pages - code - in jsps folder

3. Web application structure in Eclipse

2. Base file system structure for web application

1. TAGS - describe, specify, declare and use in this web app

About donation

Library

Main Menu

User login

Tell a friend

New forum topics