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 apiService work for additional information
5    *   regarding copyright ownership.  The ASF licenses apiService file
6    *   to you under the Apache License, Version 2.0 (the
7    *   "License"); you may not use apiService 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.codec.standalone;
21  
22  
23  import java.util.Map;
24  
25  import org.apache.directory.api.ldap.codec.api.ControlFactory;
26  import org.apache.directory.api.ldap.codec.api.ExtendedOperationFactory;
27  import org.apache.directory.api.ldap.codec.api.LdapApiService;
28  import org.apache.directory.api.ldap.codec.controls.cascade.CascadeFactory;
29  import org.apache.directory.api.ldap.codec.controls.manageDsaIT.ManageDsaITFactory;
30  import org.apache.directory.api.ldap.codec.controls.search.entryChange.EntryChangeFactory;
31  import org.apache.directory.api.ldap.codec.controls.search.pagedSearch.PagedResultsFactory;
32  import org.apache.directory.api.ldap.codec.controls.search.persistentSearch.PersistentSearchFactory;
33  import org.apache.directory.api.ldap.codec.controls.search.subentries.SubentriesFactory;
34  import org.apache.directory.api.ldap.codec.controls.sort.SortRequestFactory;
35  import org.apache.directory.api.ldap.codec.controls.sort.SortResponseFactory;
36  import org.apache.directory.api.ldap.extras.controls.ad.AdDirSync;
37  import org.apache.directory.api.ldap.extras.controls.ad.AdDirSyncFactory;
38  import org.apache.directory.api.ldap.extras.controls.ppolicy.PasswordPolicy;
39  import org.apache.directory.api.ldap.extras.controls.ppolicy_impl.PasswordPolicyFactory;
40  import org.apache.directory.api.ldap.extras.controls.syncrepl.syncDone.SyncDoneValue;
41  import org.apache.directory.api.ldap.extras.controls.syncrepl.syncInfoValue.SyncInfoValue;
42  import org.apache.directory.api.ldap.extras.controls.syncrepl.syncInfoValue.SyncRequestValue;
43  import org.apache.directory.api.ldap.extras.controls.syncrepl.syncState.SyncStateValue;
44  import org.apache.directory.api.ldap.extras.controls.syncrepl_impl.SyncDoneValueFactory;
45  import org.apache.directory.api.ldap.extras.controls.syncrepl_impl.SyncInfoValueFactory;
46  import org.apache.directory.api.ldap.extras.controls.syncrepl_impl.SyncRequestValueFactory;
47  import org.apache.directory.api.ldap.extras.controls.syncrepl_impl.SyncStateValueFactory;
48  import org.apache.directory.api.ldap.extras.extended.ads_impl.cancel.CancelFactory;
49  import org.apache.directory.api.ldap.extras.extended.ads_impl.certGeneration.CertGenerationFactory;
50  import org.apache.directory.api.ldap.extras.extended.ads_impl.gracefulDisconnect.GracefulDisconnectFactory;
51  import org.apache.directory.api.ldap.extras.extended.ads_impl.gracefulShutdown.GracefulShutdownFactory;
52  import org.apache.directory.api.ldap.extras.extended.ads_impl.pwdModify.PasswordModifyFactory;
53  import org.apache.directory.api.ldap.extras.extended.ads_impl.startTls.StartTlsFactory;
54  import org.apache.directory.api.ldap.extras.extended.ads_impl.storedProcedure.StoredProcedureFactory;
55  import org.apache.directory.api.ldap.extras.extended.ads_impl.whoAmI.WhoAmIFactory;
56  import org.apache.directory.api.ldap.model.message.controls.Cascade;
57  import org.apache.directory.api.ldap.model.message.controls.EntryChange;
58  import org.apache.directory.api.ldap.model.message.controls.ManageDsaIT;
59  import org.apache.directory.api.ldap.model.message.controls.PagedResults;
60  import org.apache.directory.api.ldap.model.message.controls.PersistentSearch;
61  import org.apache.directory.api.ldap.model.message.controls.SortRequest;
62  import org.apache.directory.api.ldap.model.message.controls.SortResponse;
63  import org.apache.directory.api.ldap.model.message.controls.Subentries;
64  import org.slf4j.Logger;
65  import org.slf4j.LoggerFactory;
66  
67  
68  /**
69   * A utility class for adding Codec and extended operation factories.
70   *
71   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
72   */
73  public class CodecFactoryUtil
74  {
75      private static final Logger LOG = LoggerFactory.getLogger( CodecFactoryUtil.class );
76  
77  
78      /**
79       * Loads the Controls implement out of the box in the codec.
80       */
81      public static void loadStockControls( Map<String, ControlFactory<?>> controlFactories, LdapApiService apiService )
82      {
83          ControlFactory<Cascade> cascadeFactory = new CascadeFactory( apiService );
84          controlFactories.put( cascadeFactory.getOid(), cascadeFactory );
85          LOG.info( "Registered pre-bundled control factory: {}", cascadeFactory.getOid() );
86  
87          ControlFactory<EntryChange> entryChangeFactory = new EntryChangeFactory( apiService );
88          controlFactories.put( entryChangeFactory.getOid(), entryChangeFactory );
89          LOG.info( "Registered pre-bundled control factory: {}", entryChangeFactory.getOid() );
90  
91          ControlFactory<ManageDsaIT> manageDsaITFactory = new ManageDsaITFactory( apiService );
92          controlFactories.put( manageDsaITFactory.getOid(), manageDsaITFactory );
93          LOG.info( "Registered pre-bundled control factory: {}", manageDsaITFactory.getOid() );
94  
95          ControlFactory<PagedResults> pagedResultsFactory = new PagedResultsFactory( apiService );
96          controlFactories.put( pagedResultsFactory.getOid(), pagedResultsFactory );
97          LOG.info( "Registered pre-bundled control factory: {}", pagedResultsFactory.getOid() );
98  
99          ControlFactory<PersistentSearch> persistentSearchFactory = new PersistentSearchFactory( apiService );
100         controlFactories.put( persistentSearchFactory.getOid(), persistentSearchFactory );
101         LOG.info( "Registered pre-bundled control factory: {}", persistentSearchFactory.getOid() );
102 
103         ControlFactory<Subentries> SubentriesFactory = new SubentriesFactory( apiService );
104         controlFactories.put( SubentriesFactory.getOid(), SubentriesFactory );
105         LOG.info( "Registered pre-bundled control factory: {}", SubentriesFactory.getOid() );
106 
107         ControlFactory<PasswordPolicy> passwordPolicyFactory = new PasswordPolicyFactory( apiService );
108         controlFactories.put( passwordPolicyFactory.getOid(), passwordPolicyFactory );
109         LOG.info( "Registered pre-bundled control factory: {}", passwordPolicyFactory.getOid() );
110 
111         ControlFactory<SyncDoneValue> SyncDoneValueFactory = new SyncDoneValueFactory( apiService );
112         controlFactories.put( SyncDoneValueFactory.getOid(), SyncDoneValueFactory );
113         LOG.info( "Registered pre-bundled control factory: {}", SyncDoneValueFactory.getOid() );
114 
115         ControlFactory<SyncInfoValue> syncInfoValueFactory = new SyncInfoValueFactory( apiService );
116         controlFactories.put( syncInfoValueFactory.getOid(), syncInfoValueFactory );
117         LOG.info( "Registered pre-bundled control factory: {}", syncInfoValueFactory.getOid() );
118 
119         ControlFactory<SyncRequestValue> syncRequestValueFactory = new SyncRequestValueFactory( apiService );
120         controlFactories.put( syncRequestValueFactory.getOid(), syncRequestValueFactory );
121         LOG.info( "Registered pre-bundled control factory: {}", syncRequestValueFactory.getOid() );
122 
123         ControlFactory<SyncStateValue> syncStateValueFactory = new SyncStateValueFactory( apiService );
124         controlFactories.put( syncStateValueFactory.getOid(), syncStateValueFactory );
125         LOG.info( "Registered pre-bundled control factory: {}", syncStateValueFactory.getOid() );
126 
127         ControlFactory<SortRequest> sortRequestFactory = new SortRequestFactory( apiService );
128         controlFactories.put( sortRequestFactory.getOid(), sortRequestFactory );
129         LOG.info( "Registered pre-bundled control factory: {}", sortRequestFactory.getOid() );
130 
131         ControlFactory<SortResponse> sortResponseFactory = new SortResponseFactory( apiService );
132         controlFactories.put( sortResponseFactory.getOid(), sortResponseFactory );
133         LOG.info( "Registered pre-bundled control factory: {}", sortResponseFactory.getOid() );
134         
135         ControlFactory<AdDirSync> adDirSyncFactory = new AdDirSyncFactory( apiService );
136         controlFactories.put( adDirSyncFactory.getOid(), adDirSyncFactory );
137         LOG.info( "Registered pre-bundled control factory: {}", adDirSyncFactory.getOid() );
138     }
139 
140 
141     public static void loadStockExtendedOperations(
142         Map<String, ExtendedOperationFactory> extendendOperationsFactories, LdapApiService apiService )
143     {
144         CancelFactory cancelFactory = new CancelFactory( apiService );
145         extendendOperationsFactories.put( cancelFactory.getOid(), cancelFactory );
146         LOG.info( "Registered pre-bundled extended operation factory: {}", cancelFactory.getOid() );
147 
148         CertGenerationFactory certGenerationFactory = new CertGenerationFactory( apiService );
149         extendendOperationsFactories.put( certGenerationFactory.getOid(), certGenerationFactory );
150         LOG.info( "Registered pre-bundled extended operation factory: {}", certGenerationFactory.getOid() );
151 
152         GracefulShutdownFactory gracefulShutdownFactory = new GracefulShutdownFactory( apiService );
153         extendendOperationsFactories.put( gracefulShutdownFactory.getOid(), gracefulShutdownFactory );
154         LOG.info( "Registered pre-bundled extended operation factory: {}", gracefulShutdownFactory.getOid() );
155 
156         StoredProcedureFactory storedProcedureFactory = new StoredProcedureFactory( apiService );
157         extendendOperationsFactories.put( storedProcedureFactory.getOid(), storedProcedureFactory );
158         LOG.info( "Registered pre-bundled extended operation factory: {}", storedProcedureFactory.getOid() );
159 
160         GracefulDisconnectFactory gracefulDisconnectFactory = new GracefulDisconnectFactory( apiService );
161         extendendOperationsFactories.put( gracefulDisconnectFactory.getOid(), gracefulDisconnectFactory );
162         LOG.info( "Registered pre-bundled extended operation factory: {}", gracefulDisconnectFactory.getOid() );
163 
164         PasswordModifyFactory passwordModifyFactory = new PasswordModifyFactory( apiService );
165         extendendOperationsFactories.put( passwordModifyFactory.getOid(), passwordModifyFactory );
166         LOG.info( "Registered pre-bundled extended operation factory: {}", passwordModifyFactory.getOid() );
167 
168         WhoAmIFactory whoAmIFactory = new WhoAmIFactory( apiService );
169         extendendOperationsFactories.put( whoAmIFactory.getOid(), whoAmIFactory );
170         LOG.info( "Registered pre-bundled extended operation factory: {}", whoAmIFactory.getOid() );
171 
172         StartTlsFactory startTlsFactory = new StartTlsFactory( apiService );
173         extendendOperationsFactories.put( startTlsFactory.getOid(), startTlsFactory );
174         LOG.info( "Registered pre-bundled extended operation factory: {}", startTlsFactory.getOid() );
175     }
176 }