SecurityCheckConfiguration (MobileFirst Java server-side API)

Skip navigation links

Frames

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

All Known Implementing Classes:

ExternalizableSecurityCheckConfig, SecurityCheckConfigurationBase
```
public interface SecurityCheckConfiguration
```
Represents the configuration of a security check.
Is created during deployment via SecurityCheck.createConfiguration(Properties), and used at runtime.
The subclasses are responsible for reading the configuration data from the Properties object and validating it. Validation errors are reported automatically to the deployment UI.

Method Summary

Methods
Modifier and Type	Method and Description
`java.util.Map`	`getErrors()` Get validation errors as a map with property name as key and error message as value
`java.util.Map`	`getInfo()` Get validation warnings as a map with property name as key and warning message as value
`java.util.Map`	`getWarnings()` Get validation warnings as a map with property name as key and warning message as value
`void`	`validateExpirationLimit(int expirationLimitSec)` Make sure the configuration values representing expiration or inactivity don't exceed the given limit. The implementation can use this method to implement other time-related validations, for example that inactivity is less than expiration, etc. The implementation may decide to fix the discovered problems by replacing too large values with the limit, and report a warning.

- Method Detail
  - getErrors
```
java.util.Map getErrors()
```
    Get validation errors as a map with property name as key and error message as value
    
    Returns:
    validation errors, may be null
  - getWarnings
```
java.util.Map getWarnings()
```
    Get validation warnings as a map with property name as key and warning message as value
    
    Returns:
    validation warnings, may be null
  - getInfo
```
java.util.Map getInfo()
```
    Get validation warnings as a map with property name as key and warning message as value
    
    Returns:
    validation warnings, may be null
  - validateExpirationLimit
```
void validateExpirationLimit(int expirationLimitSec)
```
    Make sure the configuration values representing expiration or inactivity don't exceed the given limit.
    The implementation can use this method to implement other time-related validations, for example that inactivity is less than expiration, etc.
    The implementation may decide to fix the discovered problems by replacing too large values with the limit, and report a warning.
    
    Parameters:
    expirationLimitSec - - max time the security check state can be preserved