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 package org.apache.rat.policy;
20
21 import java.util.Collection;
22 import java.util.Collections;
23 import java.util.SortedSet;
24
25 import org.apache.rat.api.Document;
26 import org.apache.rat.api.MetaData;
27 import org.apache.rat.document.IDocumentAnalyser;
28 import org.apache.rat.license.ILicenseFamily;
29 import org.apache.rat.license.LicenseFamilySetFactory;
30
31 /**
32 * A default Document Analyser that determines if the matched license is in the set of approved licenses.
33 */
34 public class DefaultPolicy implements IDocumentAnalyser {
35 private final SortedSet<ILicenseFamily> approvedLicenseFamilies;
36
37 /**
38 * Constructor with the list of approved license families.
39 * @param approvedLicenseFamilies the approved license families.
40 */
41 public DefaultPolicy(final Collection<ILicenseFamily> approvedLicenseFamilies) {
42 this.approvedLicenseFamilies = LicenseFamilySetFactory.emptyLicenseFamilySet();
43 this.approvedLicenseFamilies.addAll(approvedLicenseFamilies);
44 }
45
46 /**
47 * adds an ILicenseFamily to the list of approved licenses.
48 * @param approvedLicense license to be approved.
49 */
50 public void add(ILicenseFamily approvedLicense) {
51 this.approvedLicenseFamilies.add(approvedLicense);
52 }
53
54 @Override
55 public void analyse(final Document document) {
56 if (document != null) {
57 boolean approval;
58 if (document.getMetaData().value(MetaData.RAT_URL_HEADER_CATEGORY) != null) {
59 ILicenseFamily licenseFamily = ILicenseFamily.builder()
60 .setLicenseFamilyCategory(
61 document.getMetaData().value(MetaData.RAT_URL_HEADER_CATEGORY))
62 .setLicenseFamilyName(document.getMetaData().value(MetaData.RAT_URL_LICENSE_FAMILY_NAME))
63 .build();
64 approval = approvedLicenseFamilies.contains(licenseFamily);
65 reportLicenseApprovalClaim(document, approval);
66 }
67 }
68 }
69
70 /**
71 * Report if the document as either having approved license or not.
72 * @param document the document to approve.
73 * @param isAcceptable {@code true} if the license is an approved one, {@code false} otherwise.
74 */
75 public void reportLicenseApprovalClaim(final Document document, final boolean isAcceptable) {
76 document.getMetaData().set(
77 isAcceptable ? MetaData.RAT_APPROVED_LICENSE_DATUM_TRUE : MetaData.RAT_APPROVED_LICENSE_DATUM_FALSE);
78 }
79
80 /**
81 * Gets an unmodifiable reference to the SortedSet of approved licenses that this policy is holding.
82 * @return sorted set of license family definitions.
83 */
84 public SortedSet<ILicenseFamily> getApprovedLicenseNames() {
85 return Collections.unmodifiableSortedSet(approvedLicenseFamilies);
86 }
87 }