io.mosip.authentication.common.service.filter

Class BaseIDAFilter

java.lang.Object

io.mosip.authentication.common.service.filter.BaseIDAFilter

All Implemented Interfaces:

javax.servlet.Filter

Direct Known Subclasses:

BaseAuthFilter, DefaultIDAFilter

public abstract class BaseIDAFilter
extends Object
implements javax.servlet.Filter

The Class BaseIDAFilter - The Base IDA Filter that does all necessary authentication/authorization before allowing the request to the respective controllers.

Author:

Sanjay Murali

Field Summary

Fields

Modifier and Type	Field and Description
protected org.springframework.core.env.Environment	env The env.
protected KeyManager	keyManager The key manager.
protected com.fasterxml.jackson.databind.ObjectMapper	mapper The mapper.

Constructor Summary

Constructors

Constructor and Description
BaseIDAFilter()

Method Summary

Modifier and Type	Method and Description
protected abstract void	authenticateRequest(ResettableStreamHttpServletRequest requestWrapper) authenticateRequest method used to validate the JSON signature pay load and the certificate
protected void	consumeRequest(ResettableStreamHttpServletRequest requestWrapper, Map<String,Object> requestBody) consumeRequest method is used to manipulate the request where the request is first reached and along this all validation are done further after successful decipher.
void	destroy()
void	doFilter(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain)
protected String	fetchId(ResettableStreamHttpServletRequest requestWrapper, String attribute) fetchId used to fetch and determine the id of request
protected Map<String,Object>	getRequestBody(InputStream requestBody) getRequestBody used to get the request body from the raw input stream
void	init(javax.servlet.FilterConfig filterConfig)
protected boolean	isDate(String date) To validate a string whether its a date or not.
protected String	mapResponse(ResettableStreamHttpServletRequest requestWrapper, io.mosip.authentication.common.service.filter.CharResponseWrapper responseWrapper, java.time.temporal.Temporal requestTime) mapResponse method is used to construct the response for the successful authentication.
protected Map<String,Object>	removeNullOrEmptyFieldsInResponse(Map<String,Object> responseMap) removeNullOrEmptyFieldsInResponse method is used to remove all the empty and null values present in the response
protected Map<String,Object>	setResponseParams(Map<String,Object> requestBody, Map<String,Object> responseBody) setResponseParams method is set the transaction ID and response time based on the request time zone
protected Map<String,Object>	transformResponse(Map<String,Object> responseMap) transformResponse used to manipulate the response if any.
protected void	validateId(Map<String,Object> requestBody, String id) validateId is used to validate the id present in the request
protected void	validateRequest(ResettableStreamHttpServletRequest requestWrapper, Map<String,Object> requestBody) validateRequest method is used to validate the version and the ID passed for the each request

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

env

protected org.springframework.core.env.Environment env

The env.

mapper

protected com.fasterxml.jackson.databind.ObjectMapper mapper

The mapper.

keyManager

protected KeyManager keyManager

The key manager.

Constructor Detail

BaseIDAFilter

public BaseIDAFilter()

Method Detail

init

public void init(javax.servlet.FilterConfig filterConfig)
          throws javax.servlet.ServletException

Specified by:

init in interface javax.servlet.Filter

Throws:

javax.servlet.ServletException

doFilter

public void doFilter(javax.servlet.ServletRequest request,
                     javax.servlet.ServletResponse response,
                     javax.servlet.FilterChain chain)
              throws IOException,
                     javax.servlet.ServletException

Specified by:

doFilter in interface javax.servlet.Filter

Throws:

IOException

javax.servlet.ServletException

removeNullOrEmptyFieldsInResponse

protected Map<String,Object> removeNullOrEmptyFieldsInResponse(Map<String,Object> responseMap)

removeNullOrEmptyFieldsInResponse method is used to remove all the empty and null values present in the response

Parameters:

responseMap - the response got after the authentication

Returns:

the map consists of filter response without null or empty

consumeRequest

protected void consumeRequest(ResettableStreamHttpServletRequest requestWrapper,
                              Map<String,Object> requestBody)
                       throws IdAuthenticationAppException

consumeRequest method is used to manipulate the request where the request is first reached and along this all validation are done further after successful decipher.

Parameters:

requestWrapper - ResettableStreamHttpServletRequest

requestBody - the request body

Throws:

IdAuthenticationAppException - the id authentication app exception

validateRequest

protected void validateRequest(ResettableStreamHttpServletRequest requestWrapper,
                               Map<String,Object> requestBody)
                        throws IdAuthenticationAppException

validateRequest method is used to validate the version and the ID passed for the each request

Parameters:

requestWrapper - ResettableStreamHttpServletRequest

requestBody - the request body is the request body fetched from input stream

Throws:

IdAuthenticationAppException - the id authentication app exception

fetchId

protected String fetchId(ResettableStreamHttpServletRequest requestWrapper,
                         String attribute)

fetchId used to fetch and determine the id of request

Parameters:

requestWrapper - the ResettableStreamHttpServletRequest

Returns:

the string

validateId

protected void validateId(Map<String,Object> requestBody,
                          String id)
                   throws IdAuthenticationAppException

validateId is used to validate the id present in the request

Parameters:

requestBody - the request body

id - the id

Throws:

IdAuthenticationAppException - the id authentication app exception

mapResponse

protected String mapResponse(ResettableStreamHttpServletRequest requestWrapper,
                             io.mosip.authentication.common.service.filter.CharResponseWrapper responseWrapper,
                             java.time.temporal.Temporal requestTime)
                      throws IdAuthenticationAppException

mapResponse method is used to construct the response for the successful authentication.

Parameters:

requestWrapper - ResettableStreamHttpServletRequest

responseWrapper - CharResponseWrapper

requestTime - the request time

Returns:

the string response finally built

Throws:

IdAuthenticationAppException - the id authentication app exception

setResponseParams

protected Map<String,Object> setResponseParams(Map<String,Object> requestBody,
                                               Map<String,Object> responseBody)
                                        throws IdAuthenticationAppException

setResponseParams method is set the transaction ID and response time based on the request time zone

Parameters:

requestBody - the request body

responseBody - the response body

Returns:

the map

Throws:

IdAuthenticationAppException - the id authentication app exception

transformResponse

protected Map<String,Object> transformResponse(Map<String,Object> responseMap)
                                        throws IdAuthenticationAppException

transformResponse used to manipulate the response if any.

Parameters:

responseMap - the response map

Returns:

the map

Throws:

IdAuthenticationAppException - the id authentication app exception

getRequestBody

protected Map<String,Object> getRequestBody(InputStream requestBody)
                                     throws IdAuthenticationAppException

getRequestBody used to get the request body from the raw input stream

Parameters:

requestBody - ResettableStreamHttpServletRequest get request as input stream

Returns:

the request body

Throws:

IdAuthenticationAppException - the id authentication app exception

isDate

protected boolean isDate(String date)

To validate a string whether its a date or not.

Parameters:

date - the date

Returns:

true, if is date

authenticateRequest

protected abstract void authenticateRequest(ResettableStreamHttpServletRequest requestWrapper)
                                     throws IdAuthenticationAppException

authenticateRequest method used to validate the JSON signature pay load and the certificate

Parameters:

requestWrapper - ResettableStreamHttpServletRequest

Throws:

IdAuthenticationAppException - the id authentication app exception

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Filter