documentation/_attachments/apidocs/dependencymanager.annotations/r9/org/apache/felix/dm/annotation/api/AdapterService.html - felix-site-pub - Git at Google

 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
 <!-- NewPage -->
 <html lang="en">
 <head>
 <!-- Generated by javadoc (1.8.0_102) on Tue Feb 14 08:05:47 CET 2017 -->
 <title>AdapterService</title>
 <meta name="date" content="2017-02-14">
 <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../../../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
             parent.document.title="AdapterService";
         }
     }
     catch(err) {
     }
 //-->
 </script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 <!-- ========= START OF TOP NAVBAR ======= -->
 <div class="topNav"><a name="navbar.top">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
 <a name="navbar.top.firstrow">
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
 <li><a href="../../../../../../org/apache/felix/dm/annotation/api/package-summary.html">Package</a></li>
 <li class="navBarCell1Rev">Class</li>
 <li><a href="package-tree.html">Tree</a></li>
 <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
 <li><a href="../../../../../../index-all.html">Index</a></li>
 <li><a href="../../../../../../help-doc.html">Help</a></li>
 </ul>
 </div>
 <div class="subNav">
 <ul class="navList">
 <li>Prev&nbsp;Class</li>
 <li><a href="../../../../../../org/apache/felix/dm/annotation/api/AspectService.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../../../index.html?org/apache/felix/dm/annotation/api/AdapterService.html" target="_top">Frames</a></li>
 <li><a href="AdapterService.html" target="_top">No&nbsp;Frames</a></li>
 </ul>
 <ul class="navList" id="allclasses_navbar_top">
 <li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
 </ul>
 <div>
 <script type="text/javascript"><!--
   allClassesLink = document.getElementById("allclasses_navbar_top");
   if(window==top) {
     allClassesLink.style.display = "block";
   }
   else {
     allClassesLink.style.display = "none";
   }
   //-->
 </script>
 </div>
 <div>
 <ul class="subNavList">
 <li>Summary:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#annotation.type.required.element.summary">Required</a>&nbsp;|&nbsp;</li>
 <li><a href="#annotation.type.optional.element.summary">Optional</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#annotation.type.element.detail">Element</a></li>
 </ul>
 </div>
 <a name="skip.navbar.top">
 <!--   -->
 </a></div>
 <!-- ========= END OF TOP NAVBAR ========= -->
 <!-- ======== START OF CLASS DATA ======== -->
 <div class="header">
 <div class="subTitle">org.apache.felix.dm.annotation.api</div>
 <h2 title="Annotation Type AdapterService" class="title">Annotation Type AdapterService</h2>
 </div>
 <div class="contentContainer">
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
 <hr>
 <br>
 <pre>@Retention(value=CLASS)
  @Target(value=TYPE)
 public @interface <span class="memberNameLabel">AdapterService</span></pre>
 <div class="block">Annotates an Adapater service. Adapters, like <a href="../../../../../../org/apache/felix/dm/annotation/api/AspectService.html" title="annotation in org.apache.felix.dm.annotation.api"><code>AspectService</code></a>, are used to "extend"
  existing services, and can publish different services based on the existing one.
  An example would be implementing a management interface for an existing service, etc ....
  <p>When you annotate an adapter class with the <code>@AdapterService</code> annotation, it will be applied
  to any service that matches the implemented interface and filter. The adapter will be registered
  with the specified interface and existing properties from the original service plus any extra
  properties you supply here. If you declare the original service as a member it will be injected.

  <p> For "add", "change", "remove" callbacks, the following method signatures are supported:

  <pre><code>
  (Component comp, ServiceReference ref, Service service)
  (Component comp, ServiceReference ref, Object service)
  (Component comp, ServiceReference ref)
  (Component comp, Service service)
  (Component comp, Object service)
  (Component comp)
  (Component comp, Map properties, Service service)
  (ServiceReference ref, Service service)
  (ServiceReference ref, Object service)
  (ServiceReference ref)
  (Service service)
  (Service service, Map propeerties)
  (Map properties, Service, service)
  (Service service, Dictionary properties)
  (Dictionary properties, Service service)
  (Object service)
  </code></pre>

  <p> For "swap" callbacks, the following method signatures are supported:

  <pre><code>
  (Service old, Service replace)
  (Object old, Object replace)
  (ServiceReference old, Service old, ServiceReference replace, Service replace)
  (ServiceReference old, Object old, ServiceReference replace, Object replace)
  (Component comp, Service old, Service replace)
  (Component comp, Object old, Object replace)
  (Component comp, ServiceReference old, Service old, ServiceReference replace, Service replace)
  (Component comp, ServiceReference old, Object old, ServiceReference replace, Object replace)
  (ServiceReference old, ServiceReference replace)
  (Component comp, ServiceReference old, ServiceReference replace)
  </code></pre>

  <h3>Usage Examples</h3>

  <p> Here, the AdapterService is registered into the OSGI registry each time an AdapteeService
  is found from the registry. The AdapterImpl class adapts the AdapteeService to the AdapterService.
  The AdapterService will also have a service property (param=value), and will also include eventual
  service properties found from the AdapteeService:
  <blockquote>
  <pre>

  &#64;AdapterService(adapteeService = AdapteeService.class)
  &#64;Property(name="param", value="value")
  class AdapterImpl implements AdapterService {
      // The service we are adapting (injected by reflection)
      protected AdapteeService adaptee;

      public void doWork() {
         adaptee.mehod1();
         adaptee.method2();
      }
  }
  </pre>
  </blockquote></div>
 </li>
 </ul>
 </div>
 <div class="summary">
 <ul class="blockList">
 <li class="blockList">
 <!-- =========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY =========== -->
 <ul class="blockList">
 <li class="blockList"><a name="annotation.type.required.element.summary">
 <!--   -->
 </a>
 <h3>Required Element Summary</h3>
 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Required Element Summary table, listing required elements, and an explanation">
 <caption><span>Required Elements</span><span class="tabEnd">&nbsp;</span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colLast" scope="col">Required Element and Description</th>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>java.lang.Class&lt;?&gt;</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/AdapterService.html#adapteeService--">adapteeService</a></span></code>
 <div class="block">Sets the adaptee service interface this adapter is applying to.</div>
 </td>
 </tr>
 </table>
 </li>
 </ul>
 <!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
 <ul class="blockList">
 <li class="blockList"><a name="annotation.type.optional.element.summary">
 <!--   -->
 </a>
 <h3>Optional Element Summary</h3>
 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation">
 <caption><span>Optional Elements</span><span class="tabEnd">&nbsp;</span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colLast" scope="col">Optional Element and Description</th>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>java.lang.String</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/AdapterService.html#adapteeFilter--">adapteeFilter</a></span></code>
 <div class="block">Sets the filter condition to use with the adapted service interface.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>java.lang.String</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/AdapterService.html#added--">added</a></span></code>
 <div class="block">The callback method to be invoked when the original service is available.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>java.lang.String</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/AdapterService.html#changed--">changed</a></span></code>
 <div class="block">The callback method to be invoked when the original service properties have changed.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>java.lang.String</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/AdapterService.html#factoryMethod--">factoryMethod</a></span></code>
 <div class="block">Sets the static method used to create the adapter service implementation instance.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>java.lang.String</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/AdapterService.html#field--">field</a></span></code>
 <div class="block">Sets the field name where to inject the original service.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/AdapterService.html#propagate--">propagate</a></span></code>
 <div class="block">Specifies if adaptee service properties should be propagated to the adapter service.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code><a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html" title="annotation in org.apache.felix.dm.annotation.api">Property</a>[]</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/AdapterService.html#properties--">properties</a></span></code>
 <div class="block">Sets some additional properties to use with the adapter service registration.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>java.lang.Class&lt;?&gt;[]</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/AdapterService.html#provides--">provides</a></span></code>
 <div class="block">Sets the adapter service interface(s).</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>java.lang.String</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/AdapterService.html#removed--">removed</a></span></code>
 <div class="block">The callback method to invoke when the service is lost.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>java.lang.String</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/AdapterService.html#swap--">swap</a></span></code>
 <div class="block">name of the callback method to invoke on swap.</div>
 </td>
 </tr>
 </table>
 </li>
 </ul>
 </li>
 </ul>
 </div>
 <div class="details">
 <ul class="blockList">
 <li class="blockList">
 <!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
 <ul class="blockList">
 <li class="blockList"><a name="annotation.type.element.detail">
 <!--   -->
 </a>
 <h3>Element Detail</h3>
 <a name="adapteeService--">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>adapteeService</h4>
 <pre>public abstract&nbsp;java.lang.Class&lt;?&gt;&nbsp;adapteeService</pre>
 <div class="block">Sets the adaptee service interface this adapter is applying to.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the adaptee service interface this adapter is applying to.</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
 <ul class="blockList">
 <li class="blockList"><a name="provides--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>provides</h4>
 <pre>public abstract&nbsp;java.lang.Class&lt;?&gt;[]&nbsp;provides</pre>
 <div class="block">Sets the adapter service interface(s). By default, the directly implemented interface(s) is (are) used.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the adapter service interface(s)</dd>
 </dl>
 <dl>
 <dt>Default:</dt>
 <dd>{}</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="properties--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>properties</h4>
 <pre>public abstract&nbsp;<a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html" title="annotation in org.apache.felix.dm.annotation.api">Property</a>[]&nbsp;properties</pre>
 <div class="block">Sets some additional properties to use with the adapter service registration. By default,
  the adapter will inherit all adaptee service properties.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>some additional properties</dd>
 </dl>
 <dl>
 <dt>Default:</dt>
 <dd>{}</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="adapteeFilter--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>adapteeFilter</h4>
 <pre>public abstract&nbsp;java.lang.String&nbsp;adapteeFilter</pre>
 <div class="block">Sets the filter condition to use with the adapted service interface.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the adaptee filter</dd>
 </dl>
 <dl>
 <dt>Default:</dt>
 <dd>""</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="factoryMethod--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>factoryMethod</h4>
 <pre>public abstract&nbsp;java.lang.String&nbsp;factoryMethod</pre>
 <div class="block">Sets the static method used to create the adapter service implementation instance.
  By default, the default constructor of the annotated class is used.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the factory method</dd>
 </dl>
 <dl>
 <dt>Default:</dt>
 <dd>""</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="field--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>field</h4>
 <pre>public abstract&nbsp;java.lang.String&nbsp;field</pre>
 <div class="block">Sets the field name where to inject the original service. By default, the original service is injected
  in any attributes in the aspect implementation that are of the same type as the aspect interface.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the field used to inject the original service</dd>
 </dl>
 <dl>
 <dt>Default:</dt>
 <dd>""</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="added--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>added</h4>
 <pre>public abstract&nbsp;java.lang.String&nbsp;added</pre>
 <div class="block">The callback method to be invoked when the original service is available. This attribute can't be mixed with
  the field attribute.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the add callback</dd>
 </dl>
 <dl>
 <dt>Default:</dt>
 <dd>""</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="changed--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>changed</h4>
 <pre>public abstract&nbsp;java.lang.String&nbsp;changed</pre>
 <div class="block">The callback method to be invoked when the original service properties have changed. When this attribute is used,
  then the added attribute must also be used.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the changed callback</dd>
 </dl>
 <dl>
 <dt>Default:</dt>
 <dd>""</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="swap--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>swap</h4>
 <pre>public abstract&nbsp;java.lang.String&nbsp;swap</pre>
 <div class="block">name of the callback method to invoke on swap.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the swap callback</dd>
 </dl>
 <dl>
 <dt>Default:</dt>
 <dd>""</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="removed--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>removed</h4>
 <pre>public abstract&nbsp;java.lang.String&nbsp;removed</pre>
 <div class="block">The callback method to invoke when the service is lost. When this attribute is used, then the added attribute
  must also be used.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the remove callback</dd>
 </dl>
 <dl>
 <dt>Default:</dt>
 <dd>""</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="propagate--">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>propagate</h4>
 <pre>public abstract&nbsp;boolean&nbsp;propagate</pre>
 <div class="block">Specifies if adaptee service properties should be propagated to the adapter service.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the service propagation flag</dd>
 </dl>
 <dl>
 <dt>Default:</dt>
 <dd>true</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 </li>
 </ul>
 </div>
 </div>
 <!-- ========= END OF CLASS DATA ========= -->
 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 <div class="bottomNav"><a name="navbar.bottom">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
 <a name="navbar.bottom.firstrow">
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
 <li><a href="../../../../../../org/apache/felix/dm/annotation/api/package-summary.html">Package</a></li>
 <li class="navBarCell1Rev">Class</li>
 <li><a href="package-tree.html">Tree</a></li>
 <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
 <li><a href="../../../../../../index-all.html">Index</a></li>
 <li><a href="../../../../../../help-doc.html">Help</a></li>
 </ul>
 </div>
 <div class="subNav">
 <ul class="navList">
 <li>Prev&nbsp;Class</li>
 <li><a href="../../../../../../org/apache/felix/dm/annotation/api/AspectService.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../../../index.html?org/apache/felix/dm/annotation/api/AdapterService.html" target="_top">Frames</a></li>
 <li><a href="AdapterService.html" target="_top">No&nbsp;Frames</a></li>
 </ul>
 <ul class="navList" id="allclasses_navbar_bottom">
 <li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
 </ul>
 <div>
 <script type="text/javascript"><!--
   allClassesLink = document.getElementById("allclasses_navbar_bottom");
   if(window==top) {
     allClassesLink.style.display = "block";
   }
   else {
     allClassesLink.style.display = "none";
   }
   //-->
 </script>
 </div>
 <div>
 <ul class="subNavList">
 <li>Summary:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#annotation.type.required.element.summary">Required</a>&nbsp;|&nbsp;</li>
 <li><a href="#annotation.type.optional.element.summary">Optional</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#annotation.type.element.detail">Element</a></li>
 </ul>
 </div>
 <a name="skip.navbar.bottom">
 <!--   -->
 </a></div>
 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 </body>
 </html>
	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
	<!-- NewPage -->
	<html lang="en">
	<head>
	<!-- Generated by javadoc (1.8.0_102) on Tue Feb 14 08:05:47 CET 2017 -->
	<title>AdapterService</title>
	<meta name="date" content="2017-02-14">
	<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
	<script type="text/javascript" src="../../../../../../script.js"></script>
	</head>
	<body>
	<script type="text/javascript"><!--
	try {
	if (location.href.indexOf('is-external=true') == -1) {
	parent.document.title="AdapterService";
	}
	}
	catch(err) {
	}
	//-->
	</script>
	<noscript>
	<div>JavaScript is disabled on your browser.</div>
	</noscript>
	<!-- ========= START OF TOP NAVBAR ======= -->
	<div class="topNav"><a name="navbar.top">
	<!-- -->
	</a>
	<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
	<a name="navbar.top.firstrow">
	<!-- -->
	</a>
	<ul class="navList" title="Navigation">
	<li><a href="../../../../../../org/apache/felix/dm/annotation/api/package-summary.html">Package</a></li>
	<li class="navBarCell1Rev">Class</li>
	<li><a href="package-tree.html">Tree</a></li>
	<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
	<li><a href="../../../../../../index-all.html">Index</a></li>
	<li><a href="../../../../../../help-doc.html">Help</a></li>
	</ul>
	</div>
	<div class="subNav">
	<ul class="navList">
	<li>Prev Class</li>
	<li><a href="../../../../../../org/apache/felix/dm/annotation/api/AspectService.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Next Class</span></a></li>
	</ul>
	<ul class="navList">
	<li><a href="../../../../../../index.html?org/apache/felix/dm/annotation/api/AdapterService.html" target="_top">Frames</a></li>
	<li><a href="AdapterService.html" target="_top">No Frames</a></li>
	</ul>
	<ul class="navList" id="allclasses_navbar_top">
	<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
	</ul>
	<div>
	<script type="text/javascript"><!--
	allClassesLink = document.getElementById("allclasses_navbar_top");
	if(window==top) {
	allClassesLink.style.display = "block";
	}
	else {
	allClassesLink.style.display = "none";
	}
	//-->
	</script>
	</div>
	<div>
	<ul class="subNavList">
	<li>Summary: </li>
	<li>Field \| </li>
	<li><a href="#annotation.type.required.element.summary">Required</a> \| </li>
	<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
	</ul>
	<ul class="subNavList">
	<li>Detail: </li>
	<li>Field \| </li>
	<li><a href="#annotation.type.element.detail">Element</a></li>
	</ul>
	</div>
	<a name="skip.navbar.top">
	<!-- -->
	</a></div>
	<!-- ========= END OF TOP NAVBAR ========= -->
	<!-- ======== START OF CLASS DATA ======== -->
	<div class="header">
	<div class="subTitle">org.apache.felix.dm.annotation.api</div>
	<h2 title="Annotation Type AdapterService" class="title">Annotation Type AdapterService</h2>
	</div>
	<div class="contentContainer">
	<div class="description">
	<ul class="blockList">
	<li class="blockList">
	<hr>
	<br>
	<pre>@Retention(value=CLASS)
	@Target(value=TYPE)
	public @interface <span class="memberNameLabel">AdapterService</span></pre>
	<div class="block">Annotates an Adapater service. Adapters, like <a href="../../../../../../org/apache/felix/dm/annotation/api/AspectService.html" title="annotation in org.apache.felix.dm.annotation.api"><code>AspectService</code></a>, are used to "extend"
	existing services, and can publish different services based on the existing one.
	An example would be implementing a management interface for an existing service, etc ....
	<p>When you annotate an adapter class with the <code>@AdapterService</code> annotation, it will be applied
	to any service that matches the implemented interface and filter. The adapter will be registered
	with the specified interface and existing properties from the original service plus any extra
	properties you supply here. If you declare the original service as a member it will be injected.

	<p> For "add", "change", "remove" callbacks, the following method signatures are supported:

	<pre><code>
	(Component comp, ServiceReference ref, Service service)
	(Component comp, ServiceReference ref, Object service)
	(Component comp, ServiceReference ref)
	(Component comp, Service service)
	(Component comp, Object service)
	(Component comp)
	(Component comp, Map properties, Service service)
	(ServiceReference ref, Service service)
	(ServiceReference ref, Object service)
	(ServiceReference ref)
	(Service service)
	(Service service, Map propeerties)
	(Map properties, Service, service)
	(Service service, Dictionary properties)
	(Dictionary properties, Service service)
	(Object service)
	</code></pre>

	<p> For "swap" callbacks, the following method signatures are supported:

	<pre><code>
	(Service old, Service replace)
	(Object old, Object replace)
	(ServiceReference old, Service old, ServiceReference replace, Service replace)
	(ServiceReference old, Object old, ServiceReference replace, Object replace)
	(Component comp, Service old, Service replace)
	(Component comp, Object old, Object replace)
	(Component comp, ServiceReference old, Service old, ServiceReference replace, Service replace)
	(Component comp, ServiceReference old, Object old, ServiceReference replace, Object replace)
	(ServiceReference old, ServiceReference replace)
	(Component comp, ServiceReference old, ServiceReference replace)
	</code></pre>

	<h3>Usage Examples</h3>

	<p> Here, the AdapterService is registered into the OSGI registry each time an AdapteeService
	is found from the registry. The AdapterImpl class adapts the AdapteeService to the AdapterService.
	The AdapterService will also have a service property (param=value), and will also include eventual
	service properties found from the AdapteeService:
	<blockquote>
	<pre>

	@AdapterService(adapteeService = AdapteeService.class)
	@Property(name="param", value="value")
	class AdapterImpl implements AdapterService {
	// The service we are adapting (injected by reflection)
	protected AdapteeService adaptee;

	public void doWork() {
	adaptee.mehod1();
	adaptee.method2();
	}
	}
	</pre>
	</blockquote></div>
	</li>
	</ul>
	</div>
	<div class="summary">
	<ul class="blockList">
	<li class="blockList">
	<!-- =========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY =========== -->
	<ul class="blockList">
	<li class="blockList"><a name="annotation.type.required.element.summary">
	<!-- -->
	</a>
	<h3>Required Element Summary</h3>
	<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Required Element Summary table, listing required elements, and an explanation">
	<caption><span>Required Elements</span><span class="tabEnd"> </span></caption>
	<tr>
	<th class="colFirst" scope="col">Modifier and Type</th>
	<th class="colLast" scope="col">Required Element and Description</th>
	</tr>
	<tr class="altColor">
	<td class="colFirst"><code>java.lang.Class<?></code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/AdapterService.html#adapteeService--">adapteeService</a></span></code>
	<div class="block">Sets the adaptee service interface this adapter is applying to.</div>
	</td>
	</tr>
	</table>
	</li>
	</ul>
	<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
	<ul class="blockList">
	<li class="blockList"><a name="annotation.type.optional.element.summary">
	<!-- -->
	</a>
	<h3>Optional Element Summary</h3>
	<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation">
	<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption>
	<tr>
	<th class="colFirst" scope="col">Modifier and Type</th>
	<th class="colLast" scope="col">Optional Element and Description</th>
	</tr>
	<tr class="altColor">
	<td class="colFirst"><code>java.lang.String</code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/AdapterService.html#adapteeFilter--">adapteeFilter</a></span></code>
	<div class="block">Sets the filter condition to use with the adapted service interface.</div>
	</td>
	</tr>
	<tr class="rowColor">
	<td class="colFirst"><code>java.lang.String</code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/AdapterService.html#added--">added</a></span></code>
	<div class="block">The callback method to be invoked when the original service is available.</div>
	</td>
	</tr>
	<tr class="altColor">
	<td class="colFirst"><code>java.lang.String</code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/AdapterService.html#changed--">changed</a></span></code>
	<div class="block">The callback method to be invoked when the original service properties have changed.</div>
	</td>
	</tr>
	<tr class="rowColor">
	<td class="colFirst"><code>java.lang.String</code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/AdapterService.html#factoryMethod--">factoryMethod</a></span></code>
	<div class="block">Sets the static method used to create the adapter service implementation instance.</div>
	</td>
	</tr>
	<tr class="altColor">
	<td class="colFirst"><code>java.lang.String</code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/AdapterService.html#field--">field</a></span></code>
	<div class="block">Sets the field name where to inject the original service.</div>
	</td>
	</tr>
	<tr class="rowColor">
	<td class="colFirst"><code>boolean</code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/AdapterService.html#propagate--">propagate</a></span></code>
	<div class="block">Specifies if adaptee service properties should be propagated to the adapter service.</div>
	</td>
	</tr>
	<tr class="altColor">
	<td class="colFirst"><code><a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html" title="annotation in org.apache.felix.dm.annotation.api">Property</a>[]</code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/AdapterService.html#properties--">properties</a></span></code>
	<div class="block">Sets some additional properties to use with the adapter service registration.</div>
	</td>
	</tr>
	<tr class="rowColor">
	<td class="colFirst"><code>java.lang.Class<?>[]</code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/AdapterService.html#provides--">provides</a></span></code>
	<div class="block">Sets the adapter service interface(s).</div>
	</td>
	</tr>
	<tr class="altColor">
	<td class="colFirst"><code>java.lang.String</code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/AdapterService.html#removed--">removed</a></span></code>
	<div class="block">The callback method to invoke when the service is lost.</div>
	</td>
	</tr>
	<tr class="rowColor">
	<td class="colFirst"><code>java.lang.String</code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/felix/dm/annotation/api/AdapterService.html#swap--">swap</a></span></code>
	<div class="block">name of the callback method to invoke on swap.</div>
	</td>
	</tr>
	</table>
	</li>
	</ul>
	</li>
	</ul>
	</div>
	<div class="details">
	<ul class="blockList">
	<li class="blockList">
	<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
	<ul class="blockList">
	<li class="blockList"><a name="annotation.type.element.detail">
	<!-- -->
	</a>
	<h3>Element Detail</h3>
	<a name="adapteeService--">
	<!-- -->
	</a>
	<ul class="blockListLast">
	<li class="blockList">
	<h4>adapteeService</h4>
	<pre>public abstract java.lang.Class<?> adapteeService</pre>
	<div class="block">Sets the adaptee service interface this adapter is applying to.</div>
	<dl>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>the adaptee service interface this adapter is applying to.</dd>
	</dl>
	</li>
	</ul>
	</li>
	</ul>
	<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
	<ul class="blockList">
	<li class="blockList"><a name="provides--">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>provides</h4>
	<pre>public abstract java.lang.Class<?>[] provides</pre>
	<div class="block">Sets the adapter service interface(s). By default, the directly implemented interface(s) is (are) used.</div>
	<dl>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>the adapter service interface(s)</dd>
	</dl>
	<dl>
	<dt>Default:</dt>
	<dd>{}</dd>
	</dl>
	</li>
	</ul>
	</li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a name="properties--">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>properties</h4>
	<pre>public abstract <a href="../../../../../../org/apache/felix/dm/annotation/api/Property.html" title="annotation in org.apache.felix.dm.annotation.api">Property</a>[] properties</pre>
	<div class="block">Sets some additional properties to use with the adapter service registration. By default,
	the adapter will inherit all adaptee service properties.</div>
	<dl>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>some additional properties</dd>
	</dl>
	<dl>
	<dt>Default:</dt>
	<dd>{}</dd>
	</dl>
	</li>
	</ul>
	</li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a name="adapteeFilter--">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>adapteeFilter</h4>
	<pre>public abstract java.lang.String adapteeFilter</pre>
	<div class="block">Sets the filter condition to use with the adapted service interface.</div>
	<dl>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>the adaptee filter</dd>
	</dl>
	<dl>
	<dt>Default:</dt>
	<dd>""</dd>
	</dl>
	</li>
	</ul>
	</li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a name="factoryMethod--">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>factoryMethod</h4>
	<pre>public abstract java.lang.String factoryMethod</pre>
	<div class="block">Sets the static method used to create the adapter service implementation instance.
	By default, the default constructor of the annotated class is used.</div>
	<dl>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>the factory method</dd>
	</dl>
	<dl>
	<dt>Default:</dt>
	<dd>""</dd>
	</dl>
	</li>
	</ul>
	</li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a name="field--">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>field</h4>
	<pre>public abstract java.lang.String field</pre>
	<div class="block">Sets the field name where to inject the original service. By default, the original service is injected
	in any attributes in the aspect implementation that are of the same type as the aspect interface.</div>
	<dl>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>the field used to inject the original service</dd>
	</dl>
	<dl>
	<dt>Default:</dt>
	<dd>""</dd>
	</dl>
	</li>
	</ul>
	</li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a name="added--">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>added</h4>
	<pre>public abstract java.lang.String added</pre>
	<div class="block">The callback method to be invoked when the original service is available. This attribute can't be mixed with
	the field attribute.</div>
	<dl>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>the add callback</dd>
	</dl>
	<dl>
	<dt>Default:</dt>
	<dd>""</dd>
	</dl>
	</li>
	</ul>
	</li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a name="changed--">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>changed</h4>
	<pre>public abstract java.lang.String changed</pre>
	<div class="block">The callback method to be invoked when the original service properties have changed. When this attribute is used,
	then the added attribute must also be used.</div>
	<dl>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>the changed callback</dd>
	</dl>
	<dl>
	<dt>Default:</dt>
	<dd>""</dd>
	</dl>
	</li>
	</ul>
	</li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a name="swap--">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>swap</h4>
	<pre>public abstract java.lang.String swap</pre>
	<div class="block">name of the callback method to invoke on swap.</div>
	<dl>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>the swap callback</dd>
	</dl>
	<dl>
	<dt>Default:</dt>
	<dd>""</dd>
	</dl>
	</li>
	</ul>
	</li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a name="removed--">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>removed</h4>
	<pre>public abstract java.lang.String removed</pre>
	<div class="block">The callback method to invoke when the service is lost. When this attribute is used, then the added attribute
	must also be used.</div>
	<dl>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>the remove callback</dd>
	</dl>
	<dl>
	<dt>Default:</dt>
	<dd>""</dd>
	</dl>
	</li>
	</ul>
	</li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a name="propagate--">
	<!-- -->
	</a>
	<ul class="blockListLast">
	<li class="blockList">
	<h4>propagate</h4>
	<pre>public abstract boolean propagate</pre>
	<div class="block">Specifies if adaptee service properties should be propagated to the adapter service.</div>
	<dl>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>the service propagation flag</dd>
	</dl>
	<dl>
	<dt>Default:</dt>
	<dd>true</dd>
	</dl>
	</li>
	</ul>
	</li>
	</ul>
	</li>
	</ul>
	</div>
	</div>
	<!-- ========= END OF CLASS DATA ========= -->
	<!-- ======= START OF BOTTOM NAVBAR ====== -->
	<div class="bottomNav"><a name="navbar.bottom">
	<!-- -->
	</a>
	<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
	<a name="navbar.bottom.firstrow">
	<!-- -->
	</a>
	<ul class="navList" title="Navigation">
	<li><a href="../../../../../../org/apache/felix/dm/annotation/api/package-summary.html">Package</a></li>
	<li class="navBarCell1Rev">Class</li>
	<li><a href="package-tree.html">Tree</a></li>
	<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
	<li><a href="../../../../../../index-all.html">Index</a></li>
	<li><a href="../../../../../../help-doc.html">Help</a></li>
	</ul>
	</div>
	<div class="subNav">
	<ul class="navList">
	<li>Prev Class</li>
	<li><a href="../../../../../../org/apache/felix/dm/annotation/api/AspectService.html" title="annotation in org.apache.felix.dm.annotation.api"><span class="typeNameLink">Next Class</span></a></li>
	</ul>
	<ul class="navList">
	<li><a href="../../../../../../index.html?org/apache/felix/dm/annotation/api/AdapterService.html" target="_top">Frames</a></li>
	<li><a href="AdapterService.html" target="_top">No Frames</a></li>
	</ul>
	<ul class="navList" id="allclasses_navbar_bottom">
	<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
	</ul>
	<div>
	<script type="text/javascript"><!--
	allClassesLink = document.getElementById("allclasses_navbar_bottom");
	if(window==top) {
	allClassesLink.style.display = "block";
	}
	else {
	allClassesLink.style.display = "none";
	}
	//-->
	</script>
	</div>
	<div>
	<ul class="subNavList">
	<li>Summary: </li>
	<li>Field \| </li>
	<li><a href="#annotation.type.required.element.summary">Required</a> \| </li>
	<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
	</ul>
	<ul class="subNavList">
	<li>Detail: </li>
	<li>Field \| </li>
	<li><a href="#annotation.type.element.detail">Element</a></li>
	</ul>
	</div>
	<a name="skip.navbar.bottom">
	<!-- -->
	</a></div>
	<!-- ======== END OF BOTTOM NAVBAR ======= -->
	</body>
	</html>