View Javadoc
1   /*
2    *   Licensed to the Apache Software Foundation (ASF) under one
3    *   or more contributor license agreements.  See the NOTICE file
4    *   distributed with this work for additional information
5    *   regarding copyright ownership.  The ASF licenses this file
6    *   to you under the Apache License, Version 2.0 (the
7    *   "License"); you may not use this file except in compliance
8    *   with the License.  You may obtain a copy of the License at
9    *
10   *     http://www.apache.org/licenses/LICENSE-2.0
11   *
12   *   Unless required by applicable law or agreed to in writing,
13   *   software distributed under the License is distributed on an
14   *   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   *   KIND, either express or implied.  See the License for the
16   *   specific language governing permissions and limitations
17   *   under the License.
18   *
19   */
20  package org.apache.directory.api.ldap.extras;
21  
22  
23  import org.apache.directory.api.ldap.codec.api.ControlFactory;
24  import org.apache.directory.api.ldap.codec.api.LdapApiService;
25  import org.apache.directory.api.ldap.extras.controls.ad.AdShowDeleted;
26  import org.apache.directory.api.ldap.extras.controls.ad.AdDirSync;
27  import org.apache.directory.api.ldap.extras.controls.ad_impl.AdShowDeletedFactory;
28  import org.apache.directory.api.ldap.extras.controls.ad_impl.AdDirSyncFactory;
29  import org.apache.directory.api.ldap.extras.controls.changeNotifications.ChangeNotifications;
30  import org.apache.directory.api.ldap.extras.controls.changeNotifications_impl.ChangeNotificationsFactory;
31  import org.apache.directory.api.ldap.extras.controls.permissiveModify.PermissiveModify;
32  import org.apache.directory.api.ldap.extras.controls.permissiveModify_impl.PermissiveModifyFactory;
33  import org.apache.directory.api.ldap.extras.controls.ppolicy.PasswordPolicy;
34  import org.apache.directory.api.ldap.extras.controls.ppolicy_impl.PasswordPolicyFactory;
35  import org.apache.directory.api.ldap.extras.controls.syncrepl.syncDone.SyncDoneValue;
36  import org.apache.directory.api.ldap.extras.controls.syncrepl.syncInfoValue.SyncInfoValue;
37  import org.apache.directory.api.ldap.extras.controls.syncrepl.syncInfoValue.SyncRequestValue;
38  import org.apache.directory.api.ldap.extras.controls.syncrepl.syncState.SyncStateValue;
39  import org.apache.directory.api.ldap.extras.controls.syncrepl_impl.SyncDoneValueFactory;
40  import org.apache.directory.api.ldap.extras.controls.syncrepl_impl.SyncInfoValueFactory;
41  import org.apache.directory.api.ldap.extras.controls.syncrepl_impl.SyncRequestValueFactory;
42  import org.apache.directory.api.ldap.extras.controls.syncrepl_impl.SyncStateValueFactory;
43  import org.apache.directory.api.ldap.extras.controls.vlv.VirtualListViewRequest;
44  import org.apache.directory.api.ldap.extras.controls.vlv.VirtualListViewResponse;
45  import org.apache.directory.api.ldap.extras.controls.vlv_impl.VirtualListViewRequestFactory;
46  import org.apache.directory.api.ldap.extras.controls.vlv_impl.VirtualListViewResponseFactory;
47  import org.apache.directory.api.ldap.extras.extended.ads_impl.cancel.CancelFactory;
48  import org.apache.directory.api.ldap.extras.extended.ads_impl.certGeneration.CertGenerationFactory;
49  import org.apache.directory.api.ldap.extras.extended.ads_impl.gracefulDisconnect.GracefulDisconnectFactory;
50  import org.apache.directory.api.ldap.extras.extended.ads_impl.gracefulShutdown.GracefulShutdownFactory;
51  import org.apache.directory.api.ldap.extras.extended.ads_impl.pwdModify.PasswordModifyFactory;
52  import org.apache.directory.api.ldap.extras.extended.ads_impl.startTls.StartTlsFactory;
53  import org.apache.directory.api.ldap.extras.extended.ads_impl.storedProcedure.StoredProcedureFactory;
54  import org.apache.directory.api.ldap.extras.extended.ads_impl.whoAmI.WhoAmIFactory;
55  import org.apache.directory.api.ldap.extras.extended.cancel.CancelRequest;
56  import org.apache.directory.api.ldap.extras.extended.certGeneration.CertGenerationRequest;
57  import org.apache.directory.api.ldap.extras.extended.gracefulDisconnect.GracefulDisconnectResponse;
58  import org.apache.directory.api.ldap.extras.extended.gracefulShutdown.GracefulShutdownRequest;
59  import org.apache.directory.api.ldap.extras.extended.pwdModify.PasswordModifyRequest;
60  import org.apache.directory.api.ldap.extras.extended.startTls.StartTlsRequest;
61  import org.apache.directory.api.ldap.extras.extended.storedProcedure.StoredProcedureRequest;
62  import org.apache.directory.api.ldap.extras.extended.whoAmI.WhoAmIRequest;
63  import org.osgi.framework.BundleActivator;
64  import org.osgi.framework.BundleContext;
65  import org.osgi.framework.ServiceReference;
66  import org.osgi.util.tracker.ServiceTracker;
67  import org.osgi.util.tracker.ServiceTrackerCustomizer;
68  
69  
70  /**
71   * A BundleActivator for the ldap codec extras extension: extra ApacheDS and 
72   * Apache Directory Studio specific controls and extended operations. 
73   *
74   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
75   */
76  public class ExtrasBundleActivator implements BundleActivator
77  {
78  
79      private ServiceTracker<LdapApiService, LdapApiService> serviceTracker;
80  
81      class LdapApiServiceTracker implements ServiceTrackerCustomizer<LdapApiService, LdapApiService>
82      {
83  
84          private BundleContext context;
85  
86  
87          LdapApiServiceTracker( BundleContext context )
88          {
89              this.context = context;
90          }
91  
92  
93          @Override
94          public LdapApiService addingService( ServiceReference<LdapApiService> reference )
95          {
96              LdapApiService ldapApiService = context.getService( reference );
97              registerExtrasControls( ldapApiService );
98              registerExtrasExtendedOps( ldapApiService );
99              return ldapApiService;
100         }
101 
102 
103         @Override
104         public void modifiedService( ServiceReference<LdapApiService> reference, LdapApiService ldapApiService )
105         {
106         }
107 
108 
109         @Override
110         public void removedService( ServiceReference<LdapApiService> reference, LdapApiService ldapApiService )
111         {
112             unregisterExtrasControls( ldapApiService );
113             unregisterExtrasExtendedOps( ldapApiService );
114         }
115 
116 
117         /**
118          * Registers all the extras extended operations present in this control pack.
119          *
120          * @param codec The codec service.
121          */
122         private void registerExtrasExtendedOps( LdapApiService codec )
123         {
124             // --------------------------------------------------------------------
125             // Register Extended Request Factories
126             // --------------------------------------------------------------------
127 
128             CancelFactory cancelFactory = new CancelFactory( codec );
129             codec.registerExtendedRequest( cancelFactory );
130 
131             CertGenerationFactory certGenerationFactory = new CertGenerationFactory( codec );
132             codec.registerExtendedRequest( certGenerationFactory );
133 
134             GracefulShutdownFactory gracefulShutdownFactory = new GracefulShutdownFactory( codec );
135             codec.registerExtendedRequest( gracefulShutdownFactory );
136 
137             StoredProcedureFactory storedProcedureFactory = new StoredProcedureFactory( codec );
138             codec.registerExtendedRequest( storedProcedureFactory );
139 
140             PasswordModifyFactory passwordModifyFactory = new PasswordModifyFactory( codec );
141             codec.registerExtendedRequest( passwordModifyFactory );
142 
143             GracefulDisconnectFactory gracefulDisconnectFactory = new GracefulDisconnectFactory( codec );
144             codec.registerExtendedRequest( gracefulDisconnectFactory );
145 
146             WhoAmIFactory whoAmIFactory = new WhoAmIFactory( codec );
147             codec.registerExtendedRequest( whoAmIFactory );
148 
149             StartTlsFactory startTlsFactory = new StartTlsFactory( codec );
150             codec.registerExtendedRequest( startTlsFactory );
151         }
152 
153 
154         private void unregisterExtrasControls( LdapApiService codec )
155         {
156             codec.unregisterControl( SyncDoneValue.OID );
157             codec.unregisterControl( SyncInfoValue.OID );
158             codec.unregisterControl( SyncRequestValue.OID );
159             codec.unregisterControl( SyncStateValue.OID );
160             codec.unregisterControl( PasswordPolicy.OID );
161             codec.unregisterControl( AdDirSync.OID );
162             codec.unregisterControl( AdShowDeleted.OID );
163         }
164 
165 
166         private void unregisterExtrasExtendedOps( LdapApiService codec )
167         {
168             codec.unregisterExtendedRequest( CancelRequest.EXTENSION_OID );
169             codec.unregisterExtendedRequest( CertGenerationRequest.EXTENSION_OID );
170             codec.unregisterExtendedRequest( GracefulShutdownRequest.EXTENSION_OID );
171             codec.unregisterExtendedRequest( StoredProcedureRequest.EXTENSION_OID );
172             codec.unregisterExtendedRequest( GracefulDisconnectResponse.EXTENSION_OID );
173             codec.unregisterExtendedRequest( PasswordModifyRequest.EXTENSION_OID );
174             codec.unregisterExtendedRequest( WhoAmIRequest.EXTENSION_OID );
175             codec.unregisterExtendedRequest( StartTlsRequest.EXTENSION_OID );
176         }
177 
178 
179         /**
180          * Registers all the extras controls present in this control pack.
181          *
182          * @param codec The codec service.
183          */
184         private void registerExtrasControls( LdapApiService codec )
185         {
186             ControlFactory<AdDirSync> adDirSyncFactory = new AdDirSyncFactory( codec );
187             codec.registerControl( adDirSyncFactory );
188             
189             ControlFactory<AdShowDeleted> adDeletedFactory = new AdShowDeletedFactory( codec );
190             codec.registerControl( adDeletedFactory );
191             
192             ControlFactory<ChangeNotifications> changeNotificationsFactory = new ChangeNotificationsFactory( codec );
193             codec.registerControl( changeNotificationsFactory );
194 
195             ControlFactory<PasswordPolicy> passwordPolicyFactory = new PasswordPolicyFactory( codec );
196             codec.registerControl( passwordPolicyFactory );
197 
198             ControlFactory<PermissiveModify> permissiveModifyFactory = new PermissiveModifyFactory( codec );
199             codec.registerControl( permissiveModifyFactory );
200             
201             ControlFactory<SyncDoneValue> syncDoneValuefactory = new SyncDoneValueFactory( codec );
202             codec.registerControl( syncDoneValuefactory );
203 
204             ControlFactory<SyncInfoValue> syncInfoValueFactory = new SyncInfoValueFactory( codec );
205             codec.registerControl( syncInfoValueFactory );
206 
207             ControlFactory<SyncRequestValue> syncRequestValueFactory = new SyncRequestValueFactory( codec );
208             codec.registerControl( syncRequestValueFactory );
209 
210             ControlFactory<SyncStateValue> syncStateValuefactory = new SyncStateValueFactory( codec );
211             codec.registerControl( syncStateValuefactory );
212 
213             ControlFactory<VirtualListViewRequest> virtualListViewRequestFactory = new VirtualListViewRequestFactory( codec );
214             codec.registerControl( virtualListViewRequestFactory );
215 
216             ControlFactory<VirtualListViewResponse> virtualListViewResponseFactory = new VirtualListViewResponseFactory(
217                 codec );
218             codec.registerControl( virtualListViewResponseFactory );
219         }
220     }
221 
222 
223     /**
224      * {@inheritDoc}
225      */
226     @Override
227     public void start( BundleContext context ) throws Exception
228     {
229         LdapApiServiceTracker ldapApiServiceTracker = new LdapApiServiceTracker( context );
230         serviceTracker = new ServiceTracker<>(
231             context, LdapApiService.class, ldapApiServiceTracker );
232         serviceTracker.open();
233     }
234 
235 
236     /**
237      * {@inheritDoc}
238      */
239     @Override
240     public void stop( BundleContext context ) throws Exception
241     {
242         serviceTracker.close();
243     }
244 }