KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > blojsom > servlet > ServletConfigFactoryBean


1 /**
2  * Copyright (c) 2003-2006, David A. Czarnecki
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * Redistributions of source code must retain the above copyright notice, this list of conditions and the
9  * following disclaimer.
10  * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
11  * following disclaimer in the documentation and/or other materials provided with the distribution.
12  * Neither the name of "David A. Czarnecki" and "blojsom" nor the names of its contributors may be used to
13  * endorse or promote products derived from this software without specific prior written permission.
14  * Products derived from this software may not be called "blojsom", nor may "blojsom" appear in their name,
15  * without prior written permission of David A. Czarnecki.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
18  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
19  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
20  * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
21  * EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
26  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
27  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
29  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31 package org.blojsom.servlet;
32
33 import javax.servlet.ServletConfig JavaDoc;
34
35 import org.springframework.beans.factory.config.AbstractFactoryBean;
36
37 /**
38  * Factory bean to return an instance of a {@link ServletConfig} object
39  *
40  * @author David Czarnecki
41  * @since blojsom 3.0
42  * @version $Id: ServletConfigFactoryBean.java,v 1.1 2006/03/20 21:31:17 czarneckid Exp $
43  */
44 public class ServletConfigFactoryBean extends AbstractFactoryBean {
45
46     private static ServletConfig JavaDoc servletConfig;
47
48     /**
49      * Return an instance of the {@link ServletConfig} object
50      *
51      * @return {@link ServletConfig}
52      * @throws Exception If the servlet config has not been set on this factory bean
53      */
54     protected final Object JavaDoc createInstance() throws Exception JavaDoc {
55         verifyState();
56
57         return servletConfig;
58     }
59
60     /**
61      * Returns <code>ServletConfig.class</code>
62      *
63      * @return <code>ServletConfig.class</code>
64      */
65     public final Class JavaDoc getObjectType() {
66         return ServletConfig JavaDoc.class;
67     }
68
69     /**
70      * Static method to set the servlet config instance
71      *
72      * @param servletConfig {@link ServletConfig} instance
73      */
74     public static void setServletConfig(ServletConfig JavaDoc servletConfig) {
75         ServletConfigFactoryBean.servletConfig = servletConfig;
76     }
77
78     /**
79      * Verify that the {@link ServletConfig} instance has been set on this bean
80      *
81      * @throws IllegalStateException If the {@link ServletConfig} instance has not been set
82      */
83     protected final void verifyState() throws IllegalStateException JavaDoc {
84         if (servletConfig == null) {
85             throw new IllegalStateException JavaDoc("You invoke the ServletConfigFactoryBean.setServletConfig() " +
86                     "method prior to attempting to get the ServletConfig.");
87         }
88     }
89 }
90
91
Popular Tags