jp.terasoluna.fw.web.thin
Interface BlockageController


public interface BlockageController

Interface that performs business blockage check in Filter.

Class that implements this interface provides the business blockage check function.

The implementation class of this interface should be thread safe.

*For the configuration method of the implementation class of this interface, refer to BlockageControlFilter.

See Also:
AuthenticationControlFilter, AuthenticationController, AuthorizationControlFilter, AuthorizationController, BlockageControlFilter, ServerBlockageControlFilter, ServerBlockageController

Method Summary
 void blockade(java.lang.String path)
          Sets the path that needs to be changed to blocked state.
 void blockade(java.lang.String path, javax.servlet.ServletRequest req)
          Sets the path that needs to be changed to blocked state.
 boolean isBlockaded(java.lang.String path)
          Checks if the action of specified path is in "Business blockage state".
 boolean isBlockaded(java.lang.String path, javax.servlet.ServletRequest req)
          Checks if the action of specified path is in "Business blockage" state.
 boolean isCheckRequired(javax.servlet.ServletRequest req)
          Checks if the business blockage check is required.
 void open(java.lang.String path)
          Releases the path which is in blocked state.
 void open(java.lang.String path, javax.servlet.ServletRequest req)
          Releases the path which is in blocked state.
 

Method Detail

blockade

void blockade(java.lang.String path)
Sets the path that needs to be changed to blocked state.

Parameters:
path - Path that needs to be changed to blocked state

blockade

void blockade(java.lang.String path,
              javax.servlet.ServletRequest req)
Sets the path that needs to be changed to blocked state.

Parameters:
path - Path information
req - HTTP request

isBlockaded

boolean isBlockaded(java.lang.String path)
Checks if the action of specified path is in business blockage state.

Parameters:
path - Path information
Returns:
It is true if it is in business blockage state

isBlockaded

boolean isBlockaded(java.lang.String path,
                    javax.servlet.ServletRequest req)
Checks if the action of specified path is in business blockage state.

Parameters:
path - Path information
req - HTTP request
Returns:
It is true if it is in busines blockage state

isCheckRequired

boolean isCheckRequired(javax.servlet.ServletRequest req)
Checks if the business blockage check is required.

Parameters:
req - ServletRequest instance to be checked
Returns:
It is true if check is required

open

void open(java.lang.String path)
Releases the path which is in blocked state.

Parameters:
path - Path to be released

open

void open(java.lang.String path,
          javax.servlet.ServletRequest req)
Releases the path which is in blocked state.

Parameters:
path - Path to be released
req - HTTP request