gerrit.onap Code Review - ccsdk/features.git/blob

   1 /*
   2  * ============LICENSE_START========================================================================
   3  * ONAP : ccsdk feature sdnr wt
   4  * =================================================================================================
   5  * Copyright (C) 2019 highstreet technologies GmbH Intellectual Property. All rights reserved.
   6  * =================================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
   8  * in compliance 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, software distributed under the License
  13  * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
  14  * or implied. See the License for the specific language governing permissions and limitations under
  15  * the License.
  16  * ============LICENSE_END==========================================================================
  17  */
  18 package org.onap.ccsdk.features.sdnr.wt.dataprovider.model.types;
  19
  20 import java.time.LocalDateTime;
  21 import java.time.OffsetDateTime;
  22 import java.time.ZoneOffset;
  23 import java.time.ZonedDateTime;
  24 import java.time.format.DateTimeFormatter;
  25 import java.time.format.DateTimeParseException;
  26 import java.util.Date;
  27 import org.onap.ccsdk.features.sdnr.wt.dataprovider.model.NetconfTimeStamp;
  28 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime;
  29 import org.slf4j.Logger;
  30 import org.slf4j.LoggerFactory;
  31
  32 /**
  33  * 2019/06/17 Redesign to ZonedDateTime because of sync problems.
  34  *
  35  * Function is handling the NETCONF and the format used by database and restconf communication.
  36  *
  37  * Input supported for the formats used in NETCONF messages:
  38  *
  39  * Format1 ISO 8601 2017-01-18T11:44:49.482-05:00
  40  *
  41  * Format2 NETCONF - pattern from ietf-yang-types "2013-07-15" Pattern:
  42  * "\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[\+\-](\d{2}):(\d{2}))"
  43  *
  44  * Format3 NETCONF DateAndTime CoreModel-CoreFoundationModule-TypeDefinitions vom 2016-07-01 Example1: 20170118114449.1Z
  45  * Example2: 20170118114449.1-0500 Pattern: "\d{4}\d{2}\d{2}\d{2}\d{2}\d{2}.\d+?(Z|[\+\-](\d{2})(\d{2}))" typedef
  46  * DateAndTime { description "This primitive type defines the date and time according to the following structure:
  47  * 'yyyyMMddhhmmss.s[Z|{+|-}HHMm]' where: yyyy '0000'..'9999' year MM '01'..'12' month dd '01'..'31' day hh '00'..'23'
  48  * hour mm '00'..'59' minute ss '00'..'59' second s '.0'..'.9' tenth of second (set to '.0' if EMS or NE cannot support
  49  * this granularity) Z 'Z' indicates UTC (rather than local time) {+|-} '+' or '-' delta from UTC HH '00'..'23' time
  50  * zone difference in hours Mm '00'..'59' time zone difference in minutes."; type string; } Format4 E/// specific
  51  * Example1: 2017-01-23T13:32:38-05:00 Example2: 2017-01-23T13:32-05:00
  52  *
  53  * Input formats netconfTime as String according the formats given above
  54  *
  55  * Return format is String in ISO8601 Format for database and presentation.
  56  *
  57  * Example formats: 1) ISO8601. Example 2017-01-18T11:44:49.482-05:00 2) Microwave ONF. Examples 20170118114449.1Z,
  58  * 20170118114449.1-0500 3.1) Ericson. Example: 2017-01-23T13:32:38-05:00 3.2) Ericson. Example: 2017-01-23T13:32-05:00
  59  * Always 10 Groups, 1:Year 2:Month 3:day 4:Hour 5:minute 6:optional sec 7:optional ms 8:optional Z or 9:offset
  60  * signedhour 10:min
  61  *
  62  * Template: private static final NetconfTimeStamp NETCONFTIME_CONVERTER = NetconfTimeStamp.getConverter();
  63  */
  64
  65 public class NetconfTimeStampImpl implements NetconfTimeStamp {
  66     private static final Logger LOG = LoggerFactory.getLogger(NetconfTimeStamp.class);
  67
  68     private static final NetconfTimeStamp CONVERTER = new NetconfTimeStampImpl();
  69
  70     /**
  71      * Specify the input format expected from netconf, and from specific devices.
  72      */
  73     private static DateTimeFormatter formatterInput =
  74             DateTimeFormatter.ofPattern("" + "[yyyy-MM-dd'T'HH:mm[:ss][.SSS][.SS][.S][xxx][xx][X][Z]]"
  75                     + "[yyyyMMddHHmmss[.SSS][.SS][.S][xxx][xx][X][Z]]").withZone(ZoneOffset.UTC);
  76
  77     /**
  78      * Specify output format that is used internally
  79      */
  80     private static DateTimeFormatter formatterOutput =
  81             DateTimeFormatter.ofPattern("yyyy-MM-dd'T'HH:mm:ss.S'Z'").withZone(ZoneOffset.UTC);
  82
  83     /**
  84      * Use static access
  85      */
  86     private NetconfTimeStampImpl() {}
  87
  88     /*
  89      * ------------------------------------ Public function
  90      */
  91
  92     /**
  93      * Use this function to get the converter
  94      *
  95      * @return global converter
  96      */
  97     public static NetconfTimeStamp getConverter() {
  98         return CONVERTER;
  99     }
 100
 101     /**
 102      * Get actual timestamp as NETCONF specific type NETCONF/YANG 1.0 Format
 103      *
 104      * @return String with Date in NETCONF/YANG Format Version 1.0.
 105      */
 106     @Override
 107     public String getTimeStampAsNetconfString() {
 108         return ZonedDateTime.now(ZoneOffset.UTC).format(formatterOutput);
 109     }
 110
 111     /**
 112      * Get actual timestamp as NETCONF specific type NETCONF/YANG 1.0 Format
 113      *
 114      * @return String with Date in NETCONF/YANG Format Version 1.0.
 115      */
 116     @Override
 117     public String getTimeStampAsNetconfString(Date date) {
 118         return ZonedDateTime.ofInstant(date.toInstant(), ZoneOffset.UTC).format(formatterOutput);
 119     }
 120
 121
 122
 123     /**
 124      * Get actual timestamp as NETCONF specific type NETCONF/YANG 1.0 Format in GMT
 125      *
 126      * @return DateAndTime Type 1.0. Date in NETCONF/YANG Format Version 1.0.
 127      */
 128     @Override
 129     public DateAndTime getTimeStamp() {
 130         return DateAndTime.getDefaultInstance(getTimeStampAsNetconfString());
 131     }
 132
 133     /**
 134      * Get time from date as NETCONF specific type NETCONF/YANG 1.0 Format in GMT
 135      *
 136      * @param date specifying the date and time
 137      * @return DateAndTime Type 1.0. Date in NETCONF/YANG Format Version 1.0.
 138      */
 139     @Override
 140     public DateAndTime getTimeStamp(Date date) {
 141         return DateAndTime.getDefaultInstance(getTimeStampAsNetconfString(date));
 142     }
 143
 144     /**
 145      * Get time from date as NETCONF specific type NETCONF/YANG 1.0 Format in GMT
 146      *
 147      * @param date specifying the date and time
 148      * @return DateAndTime Type 1.0. Date in NETCONF/YANG Format Version 1.0.
 149      */
 150     @Override
 151     public DateAndTime getTimeStamp(String date) {
 152         return DateAndTime.getDefaultInstance(date);
 153     }
 154
 155     /**
 156      * Return the String with a NETCONF time converted to long
 157      *
 158      * @param netconfTime as String according the formats given above
 159      * @return Epoch milliseconds
 160      * @throws IllegalArgumentException In case of no compliant time format definition for the string
 161      */
 162     @Override
 163     public long getTimeStampFromNetconfAsMilliseconds(String netconfTime) throws IllegalArgumentException {
 164         try {
 165             long utcMillis = doParse(netconfTime).toInstant().toEpochMilli();
 166             return utcMillis;
 167         } catch (DateTimeParseException e) {
 168             throw new IllegalArgumentException(
 169                     "No pattern for NETCONF data string: " + netconfTime + " Msg:" + e.getMessage());
 170         }
 171     }
 172
 173     /**
 174      * Deliver String result.
 175      *
 176      * @param netconfTime as String according the formats given above
 177      * @return If successful: String in ISO8601 Format for database and presentation. If "wrong formed input" the Input
 178      *         string with the prefix "Maleformed date" is delivered back.
 179      */
 180     @Override
 181     public String getTimeStampFromNetconf(String netconfTime) {
 182         try {
 183             String inputUTC = doParse(netconfTime).format(formatterOutput);
 184             return inputUTC;
 185         } catch (Exception e) {
 186             LOG.info(e.getMessage());
 187         }
 188         LOG.debug("No pattern for NETCONF data string: {}", netconfTime);
 189         return "Malformed date: " + netconfTime; // Error handling
 190     }
 191
 192     /*----------------------------------------------------
 193      * Private functions
 194      */
 195
 196     private OffsetDateTime doParse(String netconfTime) {
 197         return OffsetDateTime.parse(netconfTime, formatterInput);
 198     }
 199
 200     @Override
 201     public Date getDateFromNetconf(String netconfTime) {
 202         return Date.from(LocalDateTime.parse(netconfTime, formatterInput).atZone(ZoneOffset.UTC).toInstant());
 203     }
 204
 205     @Override
 206     public String getTimeStampAsNetconfString(LocalDateTime dt) {
 207         return formatterOutput.format(dt);
 208     }
 209
 210 }