com.sharneng.webservlet.package-info Maven / Gradle / Ivy
Show all versions of web-servlet Show documentation
/*
* Copyright (c) 2011 Original Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* Classes in this package provide the ability to use Dependency Injection frameworks with servlets and filters.
*
* With the help of {@link com.sharneng.webservlet.InjectableServlet} interface and supporting classes, one can have their
* servlets managed by dependency injection frameworks.
*
* Binder for Spring Framework is provided in this package. Binder for other dependency injection framework can be
* easily implemented by inheriting from {@link com.sharneng.webservlet.AbstractBinder} class.
*
* Let's demonstrate the use of {@link com.sharneng.webservlet.InjectableServlet} by using a "Hello World" example.
*
* First we create a servlet extends from {@link com.sharneng.webservlet.AbstractInjectableServlet}. It say hello to a name set
* by {@code setName} method. The actually name will be injected through Spring.
*
* {@code
* public class GreetingServlet extends AbstractWebServlet {
* private String name;
*
* public void setName(String name) {
* this.name = name;
* }
*
* protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
* resp.getOutputStream().println("Hello " + name);
* }
* }
* }
*
* Second, we declare a bean for our newly created servlet class in Spring context configuration and set the name
* property to "World". This servlet now will print "Hello World".
*
* {@code
*
*
* }
*
* Lastly, let's add the servlet to the web.xml file. The servlet class must the
* {@link com.sharneng.webservlet.SpringBinder}. Use the servlet init parameter to connect to the real servlet.
*
* {@code
*
* Hello World Servlet
* com.sharneng.webservlet.SpringBinder
*
* WebServletName
* helloWorldServlet
*
*
* }
*
* That's all to manage your servlet in dependency injection framework. Just add servlet mapping as usual and servlet
* can be accessed.
*
* Managing servlet filter in dependency framework is relatively easier. Binder for Spring framework is provided. Binder for
* other dependency framework can be implemented by extending {@link com.sharneng.webservlet.AbstractFilterBinder} class.
*
* Filters can be developed just like any POJO as long as they implement {@link javax.servlet.Filter} interface and register
* the filter in the dependency injection framework.
*
* For example, filter is declared as a bean in Spring configuration.
*
* {@code
*
*
* }
*
* Then use the {@link com.sharneng.webservlet.SpringFilterBinder} to define the filter in web.xml and add filter mapping as
* usual.
*
* {@code
*
* Append Text Filter
* com.sharneng.webservlet.SpringFilterBinder
*
* WebFilterName
* appendTextFilter
*
*
* }
*
*
*
* In addition, class {@link com.sharneng.webservlet.FilterBase} is provided to help simplify the development of the filters.
* @author Kenneth Xu
*/
package com.sharneng.webservlet;