Restlet Framework 2.2.1
OSGi Environments

org.restlet.ext.osgi
Class BaseFilterProvider

java.lang.Object
  extended by org.restlet.ext.osgi.BaseRestletProvider
      extended by org.restlet.ext.osgi.BaseFilterProvider
All Implemented Interfaces:
FilterProvider, RestletProvider

public abstract class BaseFilterProvider
extends BaseRestletProvider
implements FilterProvider

This class provides an implementation of FilterProvider. You register this class as an OSGi declarative service. The service declaration should look like:

 <?xml version="1.0" encoding="UTF-8"?>
 <scr:component xmlns:scr="http://www.osgi.org/xmlns/scr/v1.1.0" immediate="true" name="org.example.app.filter">
   <implementation class="org.restlet.ext.osgi.BaseFilterProvider"/>
   <service>
     <provide interface="org.restlet.ext.osgi.FilterProvider"/>
   </service>
 </scr:component>
 
 

The referenced services are:

The provided services are:

Since filter providers have a reference to filter provider, filters can be chained together. To get the filters in the desired order, add a service property to a filter, and then place a target filter on the reference declaration. For example:

 
 

Author:
Bryan Hunt

Constructor Summary
BaseFilterProvider()
           
 
Method Summary
protected abstract  Filter createFilter(Context context)
          Called to construct the actual filter instance.
 Filter getFilter()
           
protected  Restlet getFilteredRestlet()
          Called by getInboundRoot() to determine the filtered restlet that is next in the chain.
 Restlet getInboundRoot(Context context)
           
 
Methods inherited from class org.restlet.ext.osgi.BaseRestletProvider
bindFilterProvider, unbindFilterProvider
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BaseFilterProvider

public BaseFilterProvider()
Method Detail

createFilter

protected abstract Filter createFilter(Context context)
Called to construct the actual filter instance.

Returns:
the newly constructed filter instance.

getFilter

public Filter getFilter()
Specified by:
getFilter in interface FilterProvider
Returns:
the filter instance

getFilteredRestlet

protected Restlet getFilteredRestlet()
Description copied from class: BaseRestletProvider
Called by getInboundRoot() to determine the filtered restlet that is next in the chain.

Specified by:
getFilteredRestlet in class BaseRestletProvider
Returns:
the restlet to be filtered

getInboundRoot

public Restlet getInboundRoot(Context context)
Specified by:
getInboundRoot in interface RestletProvider
Overrides:
getInboundRoot in class BaseRestletProvider
Parameters:
context - the Restlet application context
Returns:
the node to be used as the inbound root of the handling chain

Restlet Framework 2.2.1
OSGi Environments

Copyright © 2005-2014 Restlet.