|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjp.terasoluna.fw.web.thin.AbstractControlFilter<ServerBlockageController>
jp.terasoluna.fw.web.thin.ServerBlockageControlFilter
public class ServerBlockageControlFilter
Checks if server is in blocked state.
This class calls any ServerBlockageController
instance which is specified in deployment descriptor (web.xml) and transfers the business blockage status check process of specified path.
The ServerBlockageController instance performs the filter process of the request received from browser.
When the server is in blocked state, ServerBlockageException
is thrown.
To use this function, perform the following settings in deployment descriptor (web.xml)
and Bean definition file.
"Id" attribute which is defined in Bean definition file sets the class that implements the
ServerBlockageController
interface in the "class" attribute of <bean> element. The <bean> element is sampleServerBlockageController.
Deployment descriptor (web.xml)
Bean definition file
<filter>
<filter-name>serverBlockageControlFilter</filter-name>
<filter-class>
jp.terasoluna.fw.web.common.ServerBlockageControlFilter
</filter-class>
<init-param>
<param-name>controller</param-name>
<param-value>
"sampleServerBlockageController"
</param-value>
</init-param>
</filter>
<filter-mapping>
<filter-name>serverBlockageControlFilter</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
<init-param> element can be omitted from the <filter> element in deployment descriptor (web.xml)
at the time of setting the id attribute of <bean> element which is defined in Bean definition file,
in the "serverBlockageController". serverBlockageController is the default value.
<bean id="sampleServerBlockageController"
class="jp.terasoluna...SampleServerBlockageController" />
AuthorizationControlFilter
,
AuthorizationController
,
AuthenticationControlFilter
,
AuthenticationController
,
BlockageControlFilter
,
BlockageController
,
ServerBlockageController
Field Summary | |
---|---|
protected static ServerBlockageController |
controller
ServerBlockageController instance. |
static java.lang.String |
DEFAULT_SERVER_BLOCKAGE_BEAN_ID
Default id which is used in "id" attribute of <bean> element to fetch implementation class of controller from DI container. |
private static org.apache.commons.logging.Log |
log
Log class. |
private static java.lang.Class |
SERVER_BLOCKAGE_CONTROLLER_CLASS
Controller class that transfers the server blockage process. |
private static java.lang.String |
SERVER_BLOCKAGE_CONTROLLER_ERROR
Error code which indicates the failure in generating the server blockage controller. |
static java.lang.String |
SERVER_BLOCKAGE_THRU_KEY
Key of "request" attribute which indicates that the request has passed through filter. |
Fields inherited from class jp.terasoluna.fw.web.thin.AbstractControlFilter |
---|
config |
Constructor Summary | |
---|---|
ServerBlockageControlFilter()
|
Method Summary | |
---|---|
void |
doFilter(javax.servlet.ServletRequest req,
javax.servlet.ServletResponse res,
javax.servlet.FilterChain chain)
Performs server blockage check. |
protected java.lang.Class |
getControllerClass()
Returns interface which should be implemented by the class that performs access control. |
java.lang.String |
getDefaultControllerBeanId()
Returns default id at the time of fetching controller from DI container. |
protected java.lang.String |
getErrorCode()
Returns error code that indicates the failure in generating the controller. |
static ServerBlockageController |
getServerBlockageController()
Returns ServerBlockageController. |
void |
init(javax.servlet.FilterConfig config)
This method is called by the container when filter changes to Service Start state. After creating an instance of the Filter, container calls init method only once. In order to request the Filter to execute the filter process, init method should finish normally. Container cannot change the Filter to service state when the init method is any of the following. ServletException is thrown, It does not get recovered within the time defined by container, The implementation class of the controller does not exist or settings are abnormal. |
Methods inherited from class jp.terasoluna.fw.web.thin.AbstractControlFilter |
---|
destroy, getController, setConfig |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String SERVER_BLOCKAGE_THRU_KEY
public static final java.lang.String DEFAULT_SERVER_BLOCKAGE_BEAN_ID
private static final java.lang.String SERVER_BLOCKAGE_CONTROLLER_ERROR
private static final java.lang.Class SERVER_BLOCKAGE_CONTROLLER_CLASS
private static org.apache.commons.logging.Log log
protected static ServerBlockageController controller
Constructor Detail |
---|
public ServerBlockageControlFilter()
Method Detail |
---|
public static ServerBlockageController getServerBlockageController()
public void init(javax.servlet.FilterConfig config) throws javax.servlet.ServletException
init
in interface javax.servlet.Filter
init
in class AbstractControlFilter<ServerBlockageController>
config
- FilterConfig instance.
javax.servlet.ServletException
- Exception which is thrown at the time of abnormal initialization.Filter.init(javax.servlet.FilterConfig)
,
AbstractControlFilter
public void doFilter(javax.servlet.ServletRequest req, javax.servlet.ServletResponse res, javax.servlet.FilterChain chain) throws java.io.IOException, javax.servlet.ServletException
doFilter
in interface javax.servlet.Filter
doFilter
in class AbstractControlFilter<ServerBlockageController>
req
- HTTP requestres
- HTTP responsechain
- Filter chain
java.io.IOException
- I/O error
javax.servlet.ServletException
- Servlet exceptionFilter.doFilter(javax.servlet.ServletRequest,
javax.servlet.ServletResponse,
javax.servlet.FilterChain)
protected java.lang.Class getControllerClass()
getControllerClass
in class AbstractControlFilter<ServerBlockageController>
protected java.lang.String getErrorCode()
getErrorCode
in class AbstractControlFilter<ServerBlockageController>
public java.lang.String getDefaultControllerBeanId()
getDefaultControllerBeanId
in class AbstractControlFilter<ServerBlockageController>
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |