Package org.apache.commons.net.ntp
Class NtpV3Impl
- java.lang.Object
-
- org.apache.commons.net.ntp.NtpV3Impl
-
- All Implemented Interfaces:
NtpV3Packet
public class NtpV3Impl extends java.lang.Object implements NtpV3Packet
Implementation of NtpV3Packet with methods converting Java objects to/from the Network Time Protocol (NTP) data message header format described in RFC-1305.- Version:
- $Revision: 1741829 $
-
-
Field Summary
Fields Modifier and Type Field Description private byte[]
buf
private java.net.DatagramPacket
dp
private static int
LI_INDEX
private static int
LI_SHIFT
private static int
MODE_INDEX
private static int
MODE_SHIFT
private static int
ORIGINATE_TIMESTAMP_INDEX
private static int
POLL_INDEX
private static int
PRECISION_INDEX
private static int
RECEIVE_TIMESTAMP_INDEX
private static int
REFERENCE_ID_INDEX
private static int
REFERENCE_TIMESTAMP_INDEX
private static int
ROOT_DELAY_INDEX
private static int
ROOT_DISPERSION_INDEX
private static int
STRATUM_INDEX
private static int
TRANSMIT_TIMESTAMP_INDEX
private static int
VERSION_INDEX
private static int
VERSION_SHIFT
-
Fields inherited from interface org.apache.commons.net.ntp.NtpV3Packet
LI_ALARM_CONDITION, LI_LAST_MINUTE_HAS_59_SECONDS, LI_LAST_MINUTE_HAS_61_SECONDS, LI_NO_WARNING, MODE_BROADCAST, MODE_CLIENT, MODE_CONTROL_MESSAGE, MODE_PRIVATE, MODE_RESERVED, MODE_SERVER, MODE_SYMMETRIC_ACTIVE, MODE_SYMMETRIC_PASSIVE, NTP_MAXCLOCK, NTP_MAXPOLL, NTP_MINCLOCK, NTP_MINPOLL, NTP_PORT, TYPE_DAYTIME, TYPE_ICMP, TYPE_NTP, TYPE_TIME, VERSION_3, VERSION_4
-
-
Constructor Summary
Constructors Constructor Description NtpV3Impl()
Creates a new instance of NtpV3Impl
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
Compares this object against the specified object.java.net.DatagramPacket
getDatagramPacket()
Returns the datagram packet with the NTP details already filled in.private int
getInt(int index)
int
getLeapIndicator()
Returns leap indicator as defined in RFC-1305 which is a two-bit code: 0=no warning 1=last minute has 61 seconds 2=last minute has 59 seconds 3=alarm condition (clock not synchronized)private long
getLong(int index)
Get Long value represented by bits starting at specified index.int
getMode()
Returns mode as defined in RFC-1305 which is a 3-bit integer whose value is indicated by the MODE_xxx parameters.java.lang.String
getModeName()
Return human-readable name of message mode type as described in RFC 1305.TimeStamp
getOriginateTimeStamp()
Returns the originate time as defined in RFC-1305.int
getPoll()
Returns poll interval as defined in RFC-1305, which is an eight-bit signed integer indicating the maximum interval between successive messages, in seconds to the nearest power of two (e.g.int
getPrecision()
Returns precision as defined in RFC-1305 encoded as an 8-bit signed integer (seconds to nearest power of two).TimeStamp
getReceiveTimeStamp()
Returns receive timestamp as defined in RFC-1305.int
getReferenceId()
Returns the reference id as defined in RFC-1305, which is a 32-bit integer whose value is dependent on several criteria.java.lang.String
getReferenceIdString()
Returns the reference id string.TimeStamp
getReferenceTimeStamp()
Returns the reference time as defined in RFC-1305.int
getRootDelay()
Return root delay as defined in RFC-1305, which is the total roundtrip delay to the primary reference source, in seconds.double
getRootDelayInMillisDouble()
Return root delay as defined in RFC-1305 in milliseconds, which is the total roundtrip delay to the primary reference source, in seconds.int
getRootDispersion()
Returns root dispersion as defined in RFC-1305.long
getRootDispersionInMillis()
Returns root dispersion (as defined in RFC-1305) in milliseconds.double
getRootDispersionInMillisDouble()
Returns root dispersion (as defined in RFC-1305) in milliseconds as double precision value.int
getStratum()
Returns Stratum as defined in RFC-1305, which indicates the stratum level of the local clock, with values defined as follows: 0=unspecified, 1=primary ref clock, and all others a secondary reference (via NTP).private TimeStamp
getTimestamp(int index)
Get NTP Timestamp at specified starting index.TimeStamp
getTransmitTimeStamp()
Returns the transmit timestamp as defined in RFC-1305.java.lang.String
getType()
Return type of time packet.int
getVersion()
Returns NTP version number as defined in RFC-1305.int
hashCode()
Computes a hashcode for this object.private java.lang.String
idAsHex()
private java.lang.String
idAsIPAddress()
Returns Reference id as dotted IP address.private java.lang.String
idAsString()
void
setDatagramPacket(java.net.DatagramPacket srcDp)
Set the contents of this object from source datagram packet.private void
setInt(int idx, int value)
Set integer value at index position.void
setLeapIndicator(int li)
Set leap indicator as defined in RFC-1305.void
setMode(int mode)
Set mode as defined in RFC-1305.void
setOriginateTimeStamp(TimeStamp ts)
Set originate timestamp given NTP TimeStamp object.void
setPoll(int poll)
Set poll interval as defined in RFC-1305.void
setPrecision(int precision)
Set precision as defined in RFC-1305.void
setReceiveTimeStamp(TimeStamp ts)
Set receive timestamp given NTP TimeStamp object.void
setReferenceId(int refId)
Set reference clock identifier field with 32-bit unsigned integer value.void
setReferenceTime(TimeStamp ts)
Set Reference time with NTP timestamp.void
setRootDelay(int delay)
Set root delay as defined in RFC-1305.void
setRootDispersion(int dispersion)
Set root dispersion as defined in RFC-1305.void
setStratum(int stratum)
Set stratum level as defined in RFC-1305.private void
setTimestamp(int index, TimeStamp t)
Sets the NTP timestamp at the given array index.void
setTransmitTime(TimeStamp ts)
Set transmit time with NTP timestamp.void
setVersion(int version)
Set NTP version as defined in RFC-1305.java.lang.String
toString()
Returns details of NTP packet as a string.protected static int
ui(byte b)
Convert byte to unsigned integer.protected static long
ul(byte b)
Convert byte to unsigned long.
-
-
-
Field Detail
-
MODE_INDEX
private static final int MODE_INDEX
- See Also:
- Constant Field Values
-
MODE_SHIFT
private static final int MODE_SHIFT
- See Also:
- Constant Field Values
-
VERSION_INDEX
private static final int VERSION_INDEX
- See Also:
- Constant Field Values
-
VERSION_SHIFT
private static final int VERSION_SHIFT
- See Also:
- Constant Field Values
-
LI_INDEX
private static final int LI_INDEX
- See Also:
- Constant Field Values
-
LI_SHIFT
private static final int LI_SHIFT
- See Also:
- Constant Field Values
-
STRATUM_INDEX
private static final int STRATUM_INDEX
- See Also:
- Constant Field Values
-
POLL_INDEX
private static final int POLL_INDEX
- See Also:
- Constant Field Values
-
PRECISION_INDEX
private static final int PRECISION_INDEX
- See Also:
- Constant Field Values
-
ROOT_DELAY_INDEX
private static final int ROOT_DELAY_INDEX
- See Also:
- Constant Field Values
-
ROOT_DISPERSION_INDEX
private static final int ROOT_DISPERSION_INDEX
- See Also:
- Constant Field Values
-
REFERENCE_ID_INDEX
private static final int REFERENCE_ID_INDEX
- See Also:
- Constant Field Values
-
REFERENCE_TIMESTAMP_INDEX
private static final int REFERENCE_TIMESTAMP_INDEX
- See Also:
- Constant Field Values
-
ORIGINATE_TIMESTAMP_INDEX
private static final int ORIGINATE_TIMESTAMP_INDEX
- See Also:
- Constant Field Values
-
RECEIVE_TIMESTAMP_INDEX
private static final int RECEIVE_TIMESTAMP_INDEX
- See Also:
- Constant Field Values
-
TRANSMIT_TIMESTAMP_INDEX
private static final int TRANSMIT_TIMESTAMP_INDEX
- See Also:
- Constant Field Values
-
buf
private final byte[] buf
-
dp
private volatile java.net.DatagramPacket dp
-
-
Method Detail
-
getMode
public int getMode()
Returns mode as defined in RFC-1305 which is a 3-bit integer whose value is indicated by the MODE_xxx parameters.- Specified by:
getMode
in interfaceNtpV3Packet
- Returns:
- mode as defined in RFC-1305.
-
getModeName
public java.lang.String getModeName()
Return human-readable name of message mode type as described in RFC 1305.- Specified by:
getModeName
in interfaceNtpV3Packet
- Returns:
- mode name as string.
-
setMode
public void setMode(int mode)
Set mode as defined in RFC-1305.- Specified by:
setMode
in interfaceNtpV3Packet
- Parameters:
mode
- the mode to set
-
getLeapIndicator
public int getLeapIndicator()
Returns leap indicator as defined in RFC-1305 which is a two-bit code: 0=no warning 1=last minute has 61 seconds 2=last minute has 59 seconds 3=alarm condition (clock not synchronized)- Specified by:
getLeapIndicator
in interfaceNtpV3Packet
- Returns:
- leap indicator as defined in RFC-1305.
-
setLeapIndicator
public void setLeapIndicator(int li)
Set leap indicator as defined in RFC-1305.- Specified by:
setLeapIndicator
in interfaceNtpV3Packet
- Parameters:
li
- leap indicator.
-
getPoll
public int getPoll()
Returns poll interval as defined in RFC-1305, which is an eight-bit signed integer indicating the maximum interval between successive messages, in seconds to the nearest power of two (e.g. value of six indicates an interval of 64 seconds. The values that can appear in this field range from NTP_MINPOLL to NTP_MAXPOLL inclusive.- Specified by:
getPoll
in interfaceNtpV3Packet
- Returns:
- poll interval as defined in RFC-1305.
-
setPoll
public void setPoll(int poll)
Set poll interval as defined in RFC-1305.- Specified by:
setPoll
in interfaceNtpV3Packet
- Parameters:
poll
- poll interval.
-
getPrecision
public int getPrecision()
Returns precision as defined in RFC-1305 encoded as an 8-bit signed integer (seconds to nearest power of two). Values normally range from -6 to -20.- Specified by:
getPrecision
in interfaceNtpV3Packet
- Returns:
- precision as defined in RFC-1305.
-
setPrecision
public void setPrecision(int precision)
Set precision as defined in RFC-1305.- Specified by:
setPrecision
in interfaceNtpV3Packet
- Parameters:
precision
- the precision to set- Since:
- 3.4
-
getVersion
public int getVersion()
Returns NTP version number as defined in RFC-1305.- Specified by:
getVersion
in interfaceNtpV3Packet
- Returns:
- NTP version number.
-
setVersion
public void setVersion(int version)
Set NTP version as defined in RFC-1305.- Specified by:
setVersion
in interfaceNtpV3Packet
- Parameters:
version
- NTP version.
-
getStratum
public int getStratum()
Returns Stratum as defined in RFC-1305, which indicates the stratum level of the local clock, with values defined as follows: 0=unspecified, 1=primary ref clock, and all others a secondary reference (via NTP).- Specified by:
getStratum
in interfaceNtpV3Packet
- Returns:
- Stratum level as defined in RFC-1305.
-
setStratum
public void setStratum(int stratum)
Set stratum level as defined in RFC-1305.- Specified by:
setStratum
in interfaceNtpV3Packet
- Parameters:
stratum
- stratum level.
-
getRootDelay
public int getRootDelay()
Return root delay as defined in RFC-1305, which is the total roundtrip delay to the primary reference source, in seconds. Values can take positive and negative values, depending on clock precision and skew.- Specified by:
getRootDelay
in interfaceNtpV3Packet
- Returns:
- root delay as defined in RFC-1305.
-
setRootDelay
public void setRootDelay(int delay)
Set root delay as defined in RFC-1305.- Specified by:
setRootDelay
in interfaceNtpV3Packet
- Parameters:
delay
- root delay- Since:
- 3.4
-
getRootDelayInMillisDouble
public double getRootDelayInMillisDouble()
Return root delay as defined in RFC-1305 in milliseconds, which is the total roundtrip delay to the primary reference source, in seconds. Values can take positive and negative values, depending on clock precision and skew.- Specified by:
getRootDelayInMillisDouble
in interfaceNtpV3Packet
- Returns:
- root delay in milliseconds
-
getRootDispersion
public int getRootDispersion()
Returns root dispersion as defined in RFC-1305.- Specified by:
getRootDispersion
in interfaceNtpV3Packet
- Returns:
- root dispersion.
-
setRootDispersion
public void setRootDispersion(int dispersion)
Set root dispersion as defined in RFC-1305.- Specified by:
setRootDispersion
in interfaceNtpV3Packet
- Parameters:
dispersion
- root dispersion- Since:
- 3.4
-
getRootDispersionInMillis
public long getRootDispersionInMillis()
Returns root dispersion (as defined in RFC-1305) in milliseconds.- Specified by:
getRootDispersionInMillis
in interfaceNtpV3Packet
- Returns:
- root dispersion in milliseconds
-
getRootDispersionInMillisDouble
public double getRootDispersionInMillisDouble()
Returns root dispersion (as defined in RFC-1305) in milliseconds as double precision value.- Specified by:
getRootDispersionInMillisDouble
in interfaceNtpV3Packet
- Returns:
- root dispersion in milliseconds
-
setReferenceId
public void setReferenceId(int refId)
Set reference clock identifier field with 32-bit unsigned integer value. See RFC-1305 for description.- Specified by:
setReferenceId
in interfaceNtpV3Packet
- Parameters:
refId
- reference clock identifier.
-
getReferenceId
public int getReferenceId()
Returns the reference id as defined in RFC-1305, which is a 32-bit integer whose value is dependent on several criteria.- Specified by:
getReferenceId
in interfaceNtpV3Packet
- Returns:
- the reference id as defined in RFC-1305.
-
getReferenceIdString
public java.lang.String getReferenceIdString()
Returns the reference id string. String cannot be null but value is dependent on the version of the NTP spec supported and stratum level. Value can be an empty string, clock type string, IP address, or a hex string.- Specified by:
getReferenceIdString
in interfaceNtpV3Packet
- Returns:
- the reference id string.
-
idAsIPAddress
private java.lang.String idAsIPAddress()
Returns Reference id as dotted IP address.- Returns:
- refId as IP address string.
-
idAsString
private java.lang.String idAsString()
-
idAsHex
private java.lang.String idAsHex()
-
getTransmitTimeStamp
public TimeStamp getTransmitTimeStamp()
Returns the transmit timestamp as defined in RFC-1305.- Specified by:
getTransmitTimeStamp
in interfaceNtpV3Packet
- Returns:
- the transmit timestamp as defined in RFC-1305. Never returns a null object.
-
setTransmitTime
public void setTransmitTime(TimeStamp ts)
Set transmit time with NTP timestamp. Ifts
is null then zero time is used.- Specified by:
setTransmitTime
in interfaceNtpV3Packet
- Parameters:
ts
- NTP timestamp
-
setOriginateTimeStamp
public void setOriginateTimeStamp(TimeStamp ts)
Set originate timestamp given NTP TimeStamp object. Ifts
is null then zero time is used.- Specified by:
setOriginateTimeStamp
in interfaceNtpV3Packet
- Parameters:
ts
- NTP timestamp
-
getOriginateTimeStamp
public TimeStamp getOriginateTimeStamp()
Returns the originate time as defined in RFC-1305.- Specified by:
getOriginateTimeStamp
in interfaceNtpV3Packet
- Returns:
- the originate time. Never returns null.
-
getReferenceTimeStamp
public TimeStamp getReferenceTimeStamp()
Returns the reference time as defined in RFC-1305.- Specified by:
getReferenceTimeStamp
in interfaceNtpV3Packet
- Returns:
- the reference time as
TimeStamp
object. Never returns null.
-
setReferenceTime
public void setReferenceTime(TimeStamp ts)
Set Reference time with NTP timestamp. Ifts
is null then zero time is used.- Specified by:
setReferenceTime
in interfaceNtpV3Packet
- Parameters:
ts
- NTP timestamp
-
getReceiveTimeStamp
public TimeStamp getReceiveTimeStamp()
Returns receive timestamp as defined in RFC-1305.- Specified by:
getReceiveTimeStamp
in interfaceNtpV3Packet
- Returns:
- the receive time. Never returns null.
-
setReceiveTimeStamp
public void setReceiveTimeStamp(TimeStamp ts)
Set receive timestamp given NTP TimeStamp object. Ifts
is null then zero time is used.- Specified by:
setReceiveTimeStamp
in interfaceNtpV3Packet
- Parameters:
ts
- timestamp
-
getType
public java.lang.String getType()
Return type of time packet. The values (e.g. NTP, TIME, ICMP, ...) correspond to the protocol used to obtain the timing information.- Specified by:
getType
in interfaceNtpV3Packet
- Returns:
- packet type string identifier which in this case is "NTP".
-
getInt
private int getInt(int index)
- Returns:
- 4 bytes as 32-bit int
-
setInt
private void setInt(int idx, int value)
Set integer value at index position.- Parameters:
idx
- index positionvalue
- 32-bit int value
-
getTimestamp
private TimeStamp getTimestamp(int index)
Get NTP Timestamp at specified starting index.- Parameters:
index
- index into data array- Returns:
- TimeStamp object for 64 bits starting at index
-
getLong
private long getLong(int index)
Get Long value represented by bits starting at specified index.- Returns:
- 8 bytes as 64-bit long
-
setTimestamp
private void setTimestamp(int index, TimeStamp t)
Sets the NTP timestamp at the given array index.- Parameters:
index
- index into the byte array.t
- TimeStamp.
-
getDatagramPacket
public java.net.DatagramPacket getDatagramPacket()
Returns the datagram packet with the NTP details already filled in.- Specified by:
getDatagramPacket
in interfaceNtpV3Packet
- Returns:
- a datagram packet.
-
setDatagramPacket
public void setDatagramPacket(java.net.DatagramPacket srcDp)
Set the contents of this object from source datagram packet.- Specified by:
setDatagramPacket
in interfaceNtpV3Packet
- Parameters:
srcDp
- source DatagramPacket to copy contents from, never null.- Throws:
java.lang.IllegalArgumentException
- if srcDp is null or byte length is less than minimum length of 48 bytes
-
equals
public boolean equals(java.lang.Object obj)
Compares this object against the specified object. The result istrue
if and only if the argument is notnull
and is aNtpV3Impl
object that contains the same values as this object.- Overrides:
equals
in classjava.lang.Object
- Parameters:
obj
- the object to compare with.- Returns:
true
if the objects are the same;false
otherwise.- Since:
- 3.4
-
hashCode
public int hashCode()
Computes a hashcode for this object. The result is the exclusive OR of the values of this object stored as a byte array.- Overrides:
hashCode
in classjava.lang.Object
- Returns:
- a hash code value for this object.
- Since:
- 3.4
-
ui
protected static final int ui(byte b)
Convert byte to unsigned integer. Java only has signed types so we have to do more work to get unsigned ops.- Parameters:
b
- input byte- Returns:
- unsigned int value of byte
-
ul
protected static final long ul(byte b)
Convert byte to unsigned long. Java only has signed types so we have to do more work to get unsigned ops- Parameters:
b
- input byte- Returns:
- unsigned long value of byte
-
toString
public java.lang.String toString()
Returns details of NTP packet as a string.- Overrides:
toString
in classjava.lang.Object
- Returns:
- details of NTP packet as a string.
-
-