Main > 1.0.8 > Examples > Simple field filter

Simple field filter

In the next examples used additional sample classes

Example of response of Rest Service without filtration of fields

In the next example you can see typical implementation of Spring Rest Service We defined signIn method, which requires email and password input params, and response User object

@RestController
public class SessionService {
    @Autowired
    private UserController userController;   
    
    @RequestMapping(value = "/users/signIn",
            params = {"email", "password"}, method = RequestMethod.POST,
            consumes = {MediaType.APPLICATION_FORM_URLENCODED_VALUE},
            produces = {MediaType.APPLICATION_JSON_VALUE})            
    public User signIn(@RequestParam("email") String email, @RequestParam("password") String password) {
        return userController.signInUser(email, password);
    }
}

• Service JSON response

{
  "id": 10,
  "email": "janedoe@gmail.com", 
  "fullName": "Jane Doe",
  "password": "12345",
  "secretKey": "54321",
  "address": {
    "id": 15,
    "apartmentNumber": 22,
    "street": {
      "id": 155,
      "streetName": "Bourbon Street",
      "streetNumber": 15
    }
  }
}

As you can see some fields could be excess and not required in response. It could be “id”, “password”, “secretKey” and so on.

Also we can use Spring @View annotation for exclude these fields For more information please follow official Spring documentation link

But this solution is not flexible in situations when you need to send in different responses of the Service same classes with different “visible” fields. As example: in one response you need to send only user’s information, in other one you need to send user’s information including his security information like “password” and etc. So you can use JFilter for field filtration.

Filtration of fields of the specified class

For field filtration you need just add next annotation

 @FieldFilterSetting(className = User.class, fields = {"id", "password", "secretKey"})

This annotation contains:

• className - class name whose fields need to be filtered
• fields - an array of fields name

In the following example we will try to filter fields: “id”, “password” and “secretKey” in User class

• Example

    @FieldFilterSetting(className = User.class, fields = {"id", "password", "secretKey"})
    @RequestMapping(value = "/users/signIn",
            params = {"email", "password"}, method = RequestMethod.POST,
            consumes = {MediaType.APPLICATION_FORM_URLENCODED_VALUE},
            produces = {MediaType.APPLICATION_JSON_VALUE})            
    public User signIn(@RequestParam("email") String email, @RequestParam("password") String password) {
        return userController.signInUser(email, password);
    }

• Service JSON response:

{ 
  "email": "janedoe@gmail.com", 
  "fullName": "Jane Doe",
  "address": {
    "id": 15,
    "apartmentNumber": 22,
    "street": {
      "id": 155,
      "streetName": "Bourbon Street",
      "streetNumber": 15
    }
  }
}

Filtration of fields on class and subclasses

If you need to filter some fields in all classes and subclasses just add FieldFilterSetting annotation without className

• Example

    @FieldFilterSetting(fields = {"id"})
    @RequestMapping(value = "/users/signIn",
            params = {"email", "password"}, method = RequestMethod.POST,
            consumes = {MediaType.APPLICATION_FORM_URLENCODED_VALUE},
            produces = {MediaType.APPLICATION_JSON_VALUE})            
    public User signIn(@RequestParam("email") String email, @RequestParam("password") String password) {
        return userController.signInUser(email, password);
    }    

• Service JSON response:

{ 
  "email": "janedoe@gmail.com", 
  "fullName": "Jane Doe",
  "password": "12345",
  "secretKey": "54321",
  "address": {  
    "apartmentNumber": 22,
    "street": {    
      "streetName": "Bourbon Street",
      "streetNumber": 15
    }
  }
}

As you can see all fields with name “id” has been removed from the Service response

Multiple field filtration

If you need to specify filtration of fields of each class separately you need to add and configure FieldFilterSetting annotation for each required class. Let’s look to the next example

• Example

 @FieldFilterSetting(className = User.class, fields = {"id", "password", "secretKey"})
 @FieldFilterSetting(className = Address.class, fields = {"apartmentNumber"})
 @FieldFilterSetting(className = Street.class, fields = {"streetNumber"})
 ...

• Service JSON response

{
  "email": "janedoe@gmail.com", 
  "fullName": "Jane Doe",
  "address": {
    "id": 15,
    "street": {
      "id": 155,
      "streetName": "Bourbon Street"
    }
  }
}

As you can see fields “id”, “password”, “secretKey” has been removed from User class, “apartmentNumber” from Address class and “streetNumber” field from Street class.

Thus, you can filtrate each response of the service.