Struts2 + Rest web service example please

[saravanan sambandam]

Is struts2 supports rest webservice?? If 'Yes' Please provide me the link. I tired but i am not getting any link.

My application was built on struts2 with rest webservice. When they tried to access those service from outside (other application). They are passing client certificate and other keystore file, then they consuming those service.
Our requirement is -- those services need to consume by LDAP based authentication. So i removed all the filters on web.xml which was mapped with the service. Then i tried to hit the url from rest client. Then it says no action is mapped with service.

My doubt is whether struts2 framework will supports rest service?

Please help me to resolve my issue

[Joe Ess]

saravanan sambandam wrote:Is struts2 supports rest webservice?
...
My application was built on struts2 with rest webservice.

These two sentences contradict each other. Either your application is a REST webservice (and therefore REST works with Struts 2) or it isn't.

saravanan sambandam wrote:
I removed all the filters on web.xml which was mapped with the service. Then i tried to hit the url from rest client. Then it says no action is mapped with service.

So you removed all the mappings and the application correctly said there were no mappings. Sounds like it worked as designed.

saravanan sambandam wrote:Our requirement is -- those services need to consume by LDAP based authentication.

This sounds like your actual question: Does Struts 2 REST work with LDAP authentication.
That I don't know. Usually, a Struts application would use the standard declarative security mechanism specified in JEE. I assume the same mechanism would work with REST. The actual source for credentials (i.e. LDAP) is configured in your application container. Your client would need some way to communicate its credentials according to the authentication method specified by the application.
Did you write this application or are you taking over an existing project?

[saravanan sambandam]

Yes, I am taking an existing project.

my struts.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE struts PUBLIC
    "-//Apache Software Foundation//DTD Struts Configuration 2.0//EN"
    "http://struts.apache.org/dtds/struts-2.0.dtd">

<struts>

	<constant name="struts.enable.DynamicMethodInvocation" value="false" />
	<constant name="struts.devMode" value="false" />
	<constant name="struts.custom.i18n.resources"
		value="global,massComConfig" />
	<constant name="struts.action.excludePattern" value="/MascomWS/.*?"/>
	<package name="Mascomdefault" namespace="/"
		extends="struts-default,json-default">

		<result-types>
			<result-type name="tiles"
				class="org.apache.struts2.views.tiles.TilesResult" />
		</result-types>

		<interceptors>
			<interceptor name="bCrumbs"
				class="com.lotus.Mascom.ui.bCrumbs.bCrumbsInterceptor" />
			<interceptor name="authent"
				class="com.lotus.Mascom.util.secure.AuthenticationInterceptor" />
			<interceptor name="Permiss"
				class="com.lotus.Mascom.util.secure.PermissInterceptor" />

			<interceptor-stack name="defaultauthentStack">
				<interceptor-ref name="exception">
					<param name="logEnabled">true</param>
					<param name="logLevel">ERROR</param>
				</interceptor-ref>
				<interceptor-ref name="alias" />
				<interceptor-ref name="servletConfig" />
				<interceptor-ref name="authent" />
				<interceptor-ref name="Permiss" />
				<interceptor-ref name="bCrumbs">
					<param name="wildCardSeparator">_</param>
					<param name="uniqueCrumbsOnly">true</param>
					<param name="getRequestsOnly">true</param>
					<param name="crumbMax">24</param>
					<param name="excludeMethods">save,update,remove</param>
				</interceptor-ref>
				<interceptor-ref name="i18n" />
				<interceptor-ref name="prepare" />
				<interceptor-ref name="chain" />
				<interceptor-ref name="debugging" />
				<interceptor-ref name="profiling" />
				<interceptor-ref name="scopedModelDriven" />
				<interceptor-ref name="modelDriven" />
				<interceptor-ref name="fileUpload" />
				<interceptor-ref name="checkbox" />
				<interceptor-ref name="staticParams" />
				<interceptor-ref name="actionMappingParams" />
				<interceptor-ref name="params">
					<param name="excludeParams">dojo\..*,^struts\..*</param>
				</interceptor-ref>
				<interceptor-ref name="conversionError" />
				<interceptor-ref name="validation">
					<param name="excludeMethods">input,back,cancel,browse</param>
				</interceptor-ref>
				<interceptor-ref name="workflow">
					<param name="excludeMethods">input,back,cancel,browse</param>
				</interceptor-ref>
			</interceptor-stack>

			<interceptor-stack name="defaultInsecureStack">
				<interceptor-ref name="exception" />
				<interceptor-ref name="alias" />
				<interceptor-ref name="servletConfig" />
				<interceptor-ref name="i18n" />
				<interceptor-ref name="prepare" />
				<interceptor-ref name="chain" />
				<interceptor-ref name="debugging" />
				<interceptor-ref name="profiling" />
				<interceptor-ref name="scopedModelDriven" />
				<interceptor-ref name="modelDriven" />
				<interceptor-ref name="fileUpload" />
				<interceptor-ref name="checkbox" />
				<interceptor-ref name="staticParams" />
				<interceptor-ref name="actionMappingParams" />
				<interceptor-ref name="params">
					<param name="excludeParams">dojo\..*,^struts\..*</param>
				</interceptor-ref>
				<interceptor-ref name="conversionError" />
				<interceptor-ref name="validation">
					<param name="excludeMethods">input,back,cancel,browse</param>
				</interceptor-ref>
				<interceptor-ref name="workflow">
					<param name="excludeMethods">input,back,cancel,browse</param>
				</interceptor-ref>
			</interceptor-stack>
		</interceptors>

		<!-- Make the defaultauthentStack the default one used for all actions unless 
			otherwise configured. -->
		<default-interceptor-ref name="defaultauthentStack" />

		<default-action-ref name="index" />

		<global-results>
			<result name="authent" type="redirectAction">index</result>
			<result name="authenterror" type="redirectAction">
				<param name="actionName">index.action</param>
				
			</result>
			<result name="loggedin" type="tiles">Home.tiles</result>
			<result name="error">/WEB-INF/jsp/error.jsp</result>
			<result name="ACCESS DENIED">/WEB-INF/jsp/ACCESSdenied.jsp</result>
		</global-results>

		<global-exception-mappings>
			<exception-mapping exception="java.lang.Exception"
				result="error" />
		</global-exception-mappings>

		<action name="index">
			<result name="success">general_jsp/index.jsp</result>
			<result name="input">general_jsp/index.jsp</result>
		</action>

		<action name="secureauthent">
			<result name="input">/WEB-INF/jsp/authent.jsp</result>
			<result name="success">/WEB-INF/jsp/authent.jsp</result>
		</action>
	</package>	
	<!-- Add packages here -->
	<include file="Mascom.xml" />
	<include file="Mascomjs.xml" />
</struts>

web.xml

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
	xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
	id="WebApp_ID" version="2.5">
	<display-name>LOTTUES</display-name>
	<servlet>
		<servlet-name>MascomWSResourceConfig</servlet-name>
		<servlet-class>org.glassfish.jersey.servlet.ServletContainer</servlet-class>
		<init-param>
			<param-name>jersey.config.server.provider.packages</param-name>
			<param-value>com.lotus.Mascom.webservice.resources,com.lotus.Mascom.webservice.util.secure</param-value>
		</init-param>
		<init-param>
    		<param-name>jersey.config.server.provider.scanning.recursive</param-name>
    		<param-value>false</param-value>
		</init-param>
		<load-on-startup>1</load-on-startup>
	</servlet>
	<servlet-mapping>
		<servlet-name>MascomWSResourceConfig</servlet-name>
		<url-pattern>/MascomWS/*</url-pattern>
	</servlet-mapping>
	
	<context-param>
		<param-name>tilesDefinitions</param-name>
		<param-value>/WEB-INF/tiles.xml</param-value>
	</context-param>

	<listener>
		<listener-class>org.apache.struts2.tiles.StrutsTilesListener</listener-class>
	</listener>

	
	<filter>
		<filter-name>CompressingFilter</filter-name>
		<filter-class>com.planetj.servlet.filter.compression.CompressingFilter</filter-class>
		<init-param>
			<param-name>includeContentTypes</param-name>
			<param-value>text/html,application/xhtml+xml,application/xml,application/json,text/css,application/x-javascript,text/javascript</param-value>
		</init-param>
		<init-param>
			<param-name>compressionThreshold</param-name>
			<param-value>256</param-value>
		</init-param>
	</filter>

	<filter-mapping>
		<filter-name>CompressingFilter</filter-name>
		<url-pattern>/*</url-pattern>
	</filter-mapping>

	<filter>
		<filter-name>struts2</filter-name>
		<filter-class>org.apache.struts2.dispatcher.ng.filter.StrutsPrepareAndExecuteFilter</filter-class>
	</filter>

	<filter-mapping>
		<filter-name>struts2</filter-name>
		<url-pattern>/*</url-pattern>
	</filter-mapping>
	
	<welcome-file-list>
		<welcome-file>general_jsp/index.jsp</welcome-file>
		<welcome-file>general_jsp/MaintenancePage.jsp</welcome-file>
	</welcome-file-list>

	<resource-ref>
		<description>LOTUSDb</description>
		<res-ref-name>jdbc/lotus</res-ref-name>
		<res-type>javax.sql.DataSource</res-type>
		<res-auth>Container</res-auth>
	</resource-ref>

	<listener>
		<listener-class>com.note.Mascom.cache.InitLoader</listener-class>
	</listener>

	<session-config>
		<session-timeout>120</session-timeout>
	</session-config>

	<security-constraint>
		<web-resource-collection>
			<web-resource-name>private-resources</web-resource-name>
			<url-pattern>/index.action</url-pattern>
			<http-method>HEAD</http-method>
			<http-method>GET</http-method>
			<http-method>POST</http-method>
			<http-method>PUT</http-method>
			<http-method>DELETE</http-method>
		</web-resource-collection>
		<auth-constraint>
			<role-name>MascomUsers</role-name>
		</auth-constraint>
	</security-constraint>
	<!-- Default authent configuration uses form-based authentication, CLIENT-CERT is used by Mascom web services module -->
	<authent-config>
		<auth-method>FORM</auth-method>
		<realm-name>secure realm</realm-name>
		<form-authent-config>
			<form-authent-page>/general_jsp/secureauthent.jsp</form-authent-page>
			<form-error-page>/general_jsp/secureauthent.jsp?error=authenterror</form-error-page>
		</form-authent-config>
	</authent-config>
	<error-page>
		<error-code>403</error-code>
		<location>/general_jsp/accessdenied.jsp</location>
	</error-page>
	<security-role>
    	<role-name>MascomUsers</role-name>
	</security-role>	
</web-app>

Java class

package com.note.mascom.webservice.sample;

import java.util.ArrayList;
import java.util.List;

import javax.ws.rs.DefaultValue;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.MediaType;

import com.lotus.mascom.exception.SystemException;
import com.lotus.mascom.util.logger.ILogger;
import com.lotus.mascom.util.logger.LoggerUtil;
import com.lotus.mascom.webservice.dao.journals.LanguageDAO;
import com.lotus.mascom.webservice.model.Language;

/**
 * <dl>
 * <dd>This is the resource class which has methods mapped to URL's of a particular web service request.</dd>
 * </dl>
 * 
 * @author saran
 * @version 1.0.0
 */
@Path("/languageResource")
public class LanguageResource {
	
	private static final ILogger logger = LoggerUtil.getLogger(LanguageResource.class);
	

    /**
     * Method returns a list of  Language fields when neither the Title Id, nor the ISBN values are passed.
     * 
     * @param firstRun
     * @return pl - A {@link List} instance containing  Language fields.
     * @throws SystemException If a naming error occurs while looking up JDBC resource.
     */
    @GET
    @Produces(MediaType.TEXT_XML)
    @Path("/Language")
    public List<Language> getLanguage(@DefaultValue("false") @QueryParam("firstRun") Boolean firstRun) throws SystemException {
    	logger.info("<-----------getLanguage() ---------->");
        final List<Language> pl = new ArrayList<Language>();
        pl.addAll(LanguageDAO.instance.getLanguage(firstRun).values());
        return pl;
    }

    /**
     * Method returns a list of  Language fields for a Title Id.
     * 
     * @param titleId The Title Id
     * @return pl - A {@link List} instance containing  Language fields.
     * @throws SystemException If a naming error occurs while looking up JDBC resource.
     */
    @GET
    @Produces(MediaType.TEXT_XML)
    @Path("/Language/titleId/{titleId}")
    public List<Language> getLanguageWithTitleId(@PathParam("titleId") Long titleId) throws SystemException {
    	logger.info("<-----------getLanguageWithTitleId() ---------->");
        final List<Language> pl = new ArrayList<Language>();
        pl.addAll(LanguageDAO.instance.getLanguageWithTitleId(new Language(titleId)).values());
        return pl;
    }
}

[saravanan sambandam]

http://localhost:8080/Lottus/languageResource/ - when i hit this URL from browser, i am getting error message no action is mapped with this action. Could you please help me out to resolve this issue. Where i made the mistakes on above.

I am new to strust2 framework and rest service is also new.

[Joe Ess]

saravanan sambandam wrote:http://localhost:8080/Lottus/languageResource/ - when i hit this URL from browser, i am getting error message no action is mapped with this action. Could you please help me out to resolve this issue. Where i made the mistakes on above.

Is the URL correct? The display name of the application according to web.xml is "LOTTUES". Can you open your server console and see where the application was deployed?
If it is the correct URL or if you get the correct URL and you still get an error, do you see any errors in the server log?

saravanan sambandam wrote:
I am new to strust2 framework and rest service is also new.

It will be very difficult for you to pick up a working application and make changes to it without understanding the framework it uses. I recommend running through the tutorials and introduce the desired functionality (authentication, REST) one at a time rather than trying to tackle everything at once.
I see you are using the javax.ws.rs classes. I don't have any experience with them and I don't know if Struts plays nice with them. That would be something you would want to sort out by going through the tutorials and documentation. I would probably rely on the Struts REST plugin to add REST functionality to a Struts app.

[saravanan sambandam]

Hi, Thanks for your reply. My url is correct, bu the changes in web.xml (LOTTUES --> LOTUS).

Implemented with Struts ActionMapper.java class

public class CustomActionMapper extends DefaultActionMapper {

	private static final ILogger logger = LoggerUtil.getLogger(CustomActionMapper.class);

    public ActionMapping getMapping(HttpServletRequest request, ConfigurationManager configManager) {
        return getActionMapper(request, configManager).getMapping(request, configManager);
    }

    private ActionMapper getActionMapper(HttpServletRequest request, ConfigurationManager configManager) {
    	logger.info("<-----------------CustomActionMapper   --- getActionMapper()-------------->"); 
        ActionMapping actionMapping = new ActionMapping();  
        parseNameAndNamespace(request.getRequestURI(), actionMapping, configManager);
        if (!(actionMapping.getNamespace()).contains("/MascomWS")) {
            return container.getInstance(ActionMapper.class, "struts");
        } else {
            return container.getInstance(ActionMapper.class, "MascomWS");
        }
    }
}

also on struts.xml

  <bean type="org.apache.struts2.dispatcher.mapper.ActionMapper" name="myActionMapper" class="com.lotus.mascom.action.CustomActionMapper" />
    <constant name="struts.mapper.class"   value="myActionMapper" />
    <constant name="struts.convention.action.suffix"     value="Controller"/>
    <constant name="struts.convention.action.mapAllMatches"   value="true"/>
    <constant name="struts.convention.default.parent.package"   value="rest-default"/>
    <constant name="struts.convention.package.locators"  value="sample"/> 
    <constant name="struts.action.extension" value="action,xhtml,,xml,json"/> 

After login my application. struts other action are working fine, i just hit the REST URL from browser (http://localhost:8080/lotus/MascomWS/languageResource/Language), now my rest service is calling. But, it shows error message. What & where i done the mistake? Please help me.

HTTP Status 500 -

type Exception report

message

description The server encountered an internal error that prevented it from fulfilling this request.

exception

java.lang.NullPointerException
com.lotus.Mascom.action.CustomActionMapper.getMapping(CustomActionMapper.java:18)
org.apache.struts2.dispatcher.ng.PrepareOperations.findActionMapping(PrepareOperations.java:159)
org.apache.struts2.dispatcher.ng.filter.StrutsPrepareAndExecuteFilter.doFilter(StrutsPrepareAndExecuteFilter.java:84)
com.planetj.servlet.filter.compression.CompressingFilter.doFilter(CompressingFilter.java:270)
note The full stack trace of the root cause is available in the Apache Tomcat/7.0.61 logs.

Apache Tomcat/7.0.61

[Joe Ess]

com.lotus.Mascom.action.CustomActionMapper.getMapping(CustomActionMapper.java:18) 

Looks like you have an exception in line 18. Unfortunately, the code you posted is not complete, so the line numbers don't match up.
Why are you using a custom action mapper?

[saravanan sambandam]

My application having struts actions and rest service. Based on the action this customActionMapper will find and call accordingly. Hence, i decided to go with customActionMapper. Is this wrong? Please advise me. Or else any approach is there? Link also provided - Mapping REST URLs to Struts 2 Actions http://struts.apache.org/docs/rest-plugin.html.

You mentioned that the line no.18 was an issue, and was removed the package name & import statement. The full code is below

package com.lotus.Mascom.action;

import javax.servlet.http.HttpServletRequest;

import org.apache.struts2.dispatcher.mapper.ActionMapper;
import org.apache.struts2.dispatcher.mapper.ActionMapping;
import org.apache.struts2.dispatcher.mapper.DefaultActionMapper;

import com.lotus.Mascom.util.logger.ILogger;
import com.lotus.Mascom.util.logger.LoggerUtil;
import com.opensymphony.xwork2.config.ConfigurationManager;

public class CustomActionMapper extends DefaultActionMapper {
 
    private static final ILogger logger = LoggerUtil.getLogger(CustomActionMapper.class);
 
    public ActionMapping getMapping(HttpServletRequest request, ConfigurationManager configManager) {
       return getActionMapper(request, configManager).getMapping(request, configManager);
    }
 
    private ActionMapper getActionMapper(HttpServletRequest request, ConfigurationManager configManager) {
        logger.info("<-----------------CustomActionMapper   --- getActionMapper()-------------->"); 
        ActionMapping actionMapping = new ActionMapping();  
        parseNameAndNamespace(request.getRequestURI(), actionMapping, configManager);
        if (!(actionMapping.getNamespace()).contains("/MascomWS")) {
            return container.getInstance(ActionMapper.class, "struts");
        } else {
            return container.getInstance(ActionMapper.class, "MascomWS");
        }
    }
}

Can you please help to resolve this issue.

Thanks in advance

[Joe Ess]

saravanan sambandam wrote: Link also provided - Mapping REST URLs to Struts 2 Actions http://struts.apache.org/docs/rest-plugin.html.

I don't see anything at that link indicating that one should use a custom action mapper. There's a mention of RestActionMapper, but that is part of the REST Plugin, which you do not appear to be using.
Again, my recommendation would be for you to start with the basics and build up. You appear to be spinning your wheels trying to wedge functionality you don't understand into an application you didn't write.

[saravanan sambandam]

Ok. I gone through this link and implemented

http://stackoverflow.com/questions/17697432/struts2-rest-plugin-making-both-struts-actions-rest-actions-work-together-but


As you said, i will do the basic simple application which have both struts2 action and rest url.


Thanks