View Javadoc
1   /*
2    * Portions of this software was developed by employees of the National Institute
3    * of Standards and Technology (NIST), an agency of the Federal Government and is
4    * being made available as a public service. Pursuant to title 17 United States
5    * Code Section 105, works of NIST employees are not subject to copyright
6    * protection in the United States. This software may be subject to foreign
7    * copyright. Permission in the United States and in foreign countries, to the
8    * extent that NIST may hold copyright, to use, copy, modify, create derivative
9    * works, and distribute this software and its documentation without fee is hereby
10   * granted on a non-exclusive basis, provided that this notice and disclaimer
11   * of warranty appears in all copies.
12   *
13   * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
14   * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
15   * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
16   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
17   * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
18   * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE.  IN NO EVENT
19   * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
20   * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
21   * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
22   * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
23   * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
24   * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
25   */
26  
27  package gov.nist.secauto.metaschema.core.datatype.adapter;
28  
29  import com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatTypes;
30  
31  import gov.nist.secauto.metaschema.core.datatype.AbstractDataTypeAdapter;
32  import gov.nist.secauto.metaschema.core.metapath.item.atomic.IIPv4AddressItem;
33  import gov.nist.secauto.metaschema.core.util.ObjectUtils;
34  
35  import java.util.List;
36  
37  import edu.umd.cs.findbugs.annotations.NonNull;
38  import inet.ipaddr.AddressStringException;
39  import inet.ipaddr.IPAddressString;
40  import inet.ipaddr.IPAddressStringParameters;
41  import inet.ipaddr.IncompatibleAddressException;
42  import inet.ipaddr.ipv4.IPv4Address;
43  
44  public class IPv4AddressAdapter
45      extends AbstractDataTypeAdapter<IPv4Address, IIPv4AddressItem> {
46    @NonNull
47    private static final List<String> NAMES = ObjectUtils.notNull(
48        List.of("ip-v4-address"));
49    private static final IPAddressStringParameters IP_V_4;
50  
51    static {
52      IP_V_4 = new IPAddressStringParameters.Builder().allowIPv6(false).allowEmpty(false).allowSingleSegment(false)
53          .allowWildcardedSeparator(false).getIPv4AddressParametersBuilder().allowBinary(false).allowLeadingZeros(false)
54          .allowPrefixesBeyondAddressSize(false).getParentBuilder().toParams();
55    }
56  
57    IPv4AddressAdapter() {
58      super(IPv4Address.class);
59    }
60  
61    @Override
62    public List<String> getNames() {
63      return NAMES;
64    }
65  
66    @Override
67    public JsonFormatTypes getJsonRawType() {
68      return JsonFormatTypes.STRING;
69    }
70  
71    @SuppressWarnings("null")
72    @Override
73    public IPv4Address parse(String value) {
74      try {
75        return (IPv4Address) new IPAddressString(value, IP_V_4).toAddress();
76      } catch (AddressStringException | IncompatibleAddressException ex) {
77        throw new IllegalArgumentException(ex.getLocalizedMessage(), ex);
78      }
79    }
80  
81    @Override
82    public IPv4Address copy(Object obj) {
83      // value is immutable
84      return (IPv4Address) obj;
85    }
86  
87    @Override
88    public Class<IIPv4AddressItem> getItemClass() {
89      return IIPv4AddressItem.class;
90    }
91  
92    @Override
93    public IIPv4AddressItem newItem(Object value) {
94      IPv4Address item = toValue(value);
95      return IIPv4AddressItem.valueOf(item);
96    }
97  }