001/*
002 * Portions of this software was developed by employees of the National Institute
003 * of Standards and Technology (NIST), an agency of the Federal Government and is
004 * being made available as a public service. Pursuant to title 17 United States
005 * Code Section 105, works of NIST employees are not subject to copyright
006 * protection in the United States. This software may be subject to foreign
007 * copyright. Permission in the United States and in foreign countries, to the
008 * extent that NIST may hold copyright, to use, copy, modify, create derivative
009 * works, and distribute this software and its documentation without fee is hereby
010 * granted on a non-exclusive basis, provided that this notice and disclaimer
011 * of warranty appears in all copies.
012 *
013 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
014 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
015 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
016 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
017 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
018 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE.  IN NO EVENT
019 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
020 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
021 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
022 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
023 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
024 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
025 */
026
027package gov.nist.secauto.metaschema.core.datatype.adapter;
028
029import com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatTypes;
030
031import gov.nist.secauto.metaschema.core.datatype.AbstractDataTypeAdapter;
032import gov.nist.secauto.metaschema.core.metapath.item.atomic.IIPv4AddressItem;
033import gov.nist.secauto.metaschema.core.util.ObjectUtils;
034
035import java.util.List;
036
037import edu.umd.cs.findbugs.annotations.NonNull;
038import inet.ipaddr.AddressStringException;
039import inet.ipaddr.IPAddressString;
040import inet.ipaddr.IPAddressStringParameters;
041import inet.ipaddr.IncompatibleAddressException;
042import inet.ipaddr.ipv4.IPv4Address;
043
044public class IPv4AddressAdapter
045    extends AbstractDataTypeAdapter<IPv4Address, IIPv4AddressItem> {
046  @NonNull
047  private static final List<String> NAMES = ObjectUtils.notNull(
048      List.of("ip-v4-address"));
049  private static final IPAddressStringParameters IP_V_4;
050
051  static {
052    IP_V_4 = new IPAddressStringParameters.Builder().allowIPv6(false).allowEmpty(false).allowSingleSegment(false)
053        .allowWildcardedSeparator(false).getIPv4AddressParametersBuilder().allowBinary(false).allowLeadingZeros(false)
054        .allowPrefixesBeyondAddressSize(false).getParentBuilder().toParams();
055  }
056
057  IPv4AddressAdapter() {
058    super(IPv4Address.class);
059  }
060
061  @Override
062  public List<String> getNames() {
063    return NAMES;
064  }
065
066  @Override
067  public JsonFormatTypes getJsonRawType() {
068    return JsonFormatTypes.STRING;
069  }
070
071  @SuppressWarnings("null")
072  @Override
073  public IPv4Address parse(String value) {
074    try {
075      return (IPv4Address) new IPAddressString(value, IP_V_4).toAddress();
076    } catch (AddressStringException | IncompatibleAddressException ex) {
077      throw new IllegalArgumentException(ex.getLocalizedMessage(), ex);
078    }
079  }
080
081  @Override
082  public IPv4Address copy(Object obj) {
083    // value is immutable
084    return (IPv4Address) obj;
085  }
086
087  @Override
088  public Class<IIPv4AddressItem> getItemClass() {
089    return IIPv4AddressItem.class;
090  }
091
092  @Override
093  public IIPv4AddressItem newItem(Object value) {
094    IPv4Address item = toValue(value);
095    return IIPv4AddressItem.valueOf(item);
096  }
097}