LicenseEnforcerFilter (Oxygen XML API)

java.lang.Object
- ro.sync.ecss.extensions.api.webapp.license.LicenseEnforcerFilter

All Implemented Interfaces:

javax.servlet.Filter
```
@API(type=NOT_EXTENDABLE,
     src=PRIVATE)
public class LicenseEnforcerFilter
extends java.lang.Object
implements javax.servlet.Filter
```
A servlet filter that MUST be used to license the WebApp. The path of the license file is specified by the LICENSE_PATH filter parameter configured in the 'web.xml' file. The path is relative to the root of the archive. If not set, the default location is LICENSE_DEFAULT_PATH.

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`LICENSE_DEFAULT_PATH`	The default path for the license file.
`static java.lang.String`	`LICENSE_PATH`	The filter parameter specifying the license path.

Constructor Summary

Constructors
Constructor Description

LicenseEnforcerFilter()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`destroy()`
`void`	`doFilter(javax.servlet.ServletRequest req, javax.servlet.ServletResponse resp, javax.servlet.FilterChain chain)`	The method that takes care of executing the request on behalf of the correct user.
`void`	`init(javax.servlet.FilterConfig config)`	Initializes the filter.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - LICENSE_PATH
```
public static final java.lang.String LICENSE_PATH
```
    The filter parameter specifying the license path.
    
    See Also:
    
    Constant Field Values
  - LICENSE_DEFAULT_PATH
```
public static final java.lang.String LICENSE_DEFAULT_PATH
```
    The default path for the license file.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - LicenseEnforcerFilter
```
public LicenseEnforcerFilter()
```
- Method Detail
  - destroy
```
public void destroy()
```
    Specified by:
    
    destroy in interface javax.servlet.Filter
    
    See Also:
    
    Filter.destroy()
  - doFilter
```
public void doFilter(javax.servlet.ServletRequest req,
                     javax.servlet.ServletResponse resp,
                     javax.servlet.FilterChain chain)
              throws java.io.IOException,
                     javax.servlet.ServletException
```
    The method that takes care of executing the request on behalf of the correct user.
    
    Specified by:
    
    doFilter in interface javax.servlet.Filter
    
    Throws:
    
    java.io.IOException
    
    javax.servlet.ServletException
  - init
```
public void init(javax.servlet.FilterConfig config)
          throws javax.servlet.ServletException
```
    Initializes the filter.
    
    Specified by:
    
    init in interface javax.servlet.Filter
    
    Throws:
    
    javax.servlet.ServletException