View Javadoc
1   /*
2    * #%L
3    * wcm.io
4    * %%
5    * Copyright (C) 2015 wcm.io
6    * %%
7    * Licensed under the Apache License, Version 2.0 (the "License");
8    * you may not use this file except in compliance with the License.
9    * You may obtain a copy of the License at
10   *
11   *      http://www.apache.org/licenses/LICENSE-2.0
12   *
13   * Unless required by applicable law or agreed to in writing, software
14   * distributed under the License is distributed on an "AS IS" BASIS,
15   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16   * See the License for the specific language governing permissions and
17   * limitations under the License.
18   * #L%
19   */
20  package io.wcm.caravan.hal.docs.impl.augmenter;
21  
22  import io.wcm.caravan.hal.docs.HalDocsAugmenter;
23  import io.wcm.caravan.hal.docs.HalDocsAugmenterFactory;
24  import io.wcm.caravan.hal.docs.impl.DocsPath;
25  import io.wcm.caravan.hal.docs.impl.reader.ServiceModelReader;
26  import io.wcm.caravan.hal.resource.HalResource;
27  
28  import org.apache.felix.scr.annotations.Component;
29  import org.apache.felix.scr.annotations.Service;
30  import org.osgi.framework.Bundle;
31  
32  /**
33   * Reads service information from model metadata stored in bundle with hal-docs-maven-plugin.
34   */
35  @Component
36  @Service(value = HalDocsAugmenterFactory.class, serviceFactory = true)
37  public class HalDocsAugmenterFactoryImpl implements HalDocsAugmenterFactory {
38  
39    private static final HalDocsAugmenter NOOP_AUGMENTER = new HalDocsAugmenter() {
40      @Override
41      public void augment(HalResource resource) {
42        // do nothing
43      }
44    };
45  
46    @Override
47    public HalDocsAugmenter create(Bundle bundle) {
48      if (bundle != null) {
49        String docsPath = DocsPath.get(bundle);
50        if (docsPath != null) {
51          io.wcm.caravan.hal.docs.impl.model.Service serviceModel = ServiceModelReader.read(bundle);
52          if (serviceModel != null) {
53            return new HalDocsAugmenterImpl(serviceModel, docsPath);
54          }
55        }
56      }
57      return NOOP_AUGMENTER;
58    }
59  
60  }