org.apache.kerby.kerberos.kerb.type

Class KerberosTime

java.lang.Object

org.apache.kerby.asn1.type.Asn1Object

org.apache.kerby.asn1.type.Asn1Encodeable

org.apache.kerby.asn1.type.AbstractAsn1Type<T>

org.apache.kerby.asn1.type.Asn1Simple<Date>

org.apache.kerby.asn1.type.Asn1GeneralizedTime

org.apache.kerby.kerberos.kerb.type.KerberosTime

All Implemented Interfaces:

org.apache.kerby.asn1.type.Asn1Type

public class KerberosTime
extends org.apache.kerby.asn1.type.Asn1GeneralizedTime

A specialization of the ASN.1 GeneralTime. The Kerberos time contains date and time up to the seconds, but with no fractional seconds. It's also always expressed as UTC timeZone, thus the 'Z' at the end of its string representation.

Author:

Apache Directory Project

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.kerby.asn1.type.Asn1Type

org.apache.kerby.asn1.type.Asn1Type.EncodingType

Field Summary

Fields

Modifier and Type	Field and Description
static int	DAY The number of milliseconds in a day.
static int	MINUTE The number of milliseconds in a minute.
static KerberosTime	NEVER Constant for the KerberosTime "infinity."
static int	WEEK The number of milliseconds in a week.

Fields inherited from class org.apache.kerby.asn1.type.Asn1Encodeable

bodyLength, outerEncodeable

Constructor Summary

Constructors

Constructor and Description
KerberosTime() Creates a new instance of a KerberosTime object with the current time
KerberosTime(long time)

Method Summary

Modifier and Type	Method and Description
KerberosTime	copy()
long	diff(KerberosTime kerberosTime) Return the difference between the currentKerberosTime and the provided one
boolean	equals(Object that)
KerberosTime	extend(long duration) Create a KerberosTime based on a time in milliseconds.
long	getTime()
long	getTimeInSeconds() Gets the time in seconds
boolean	greaterThan(KerberosTime ktime) Compare the KerberosTime with another one, and return true if it's greater than the provided one
boolean	greaterThanWithSkew(KerberosTime ktime, long skew) Compare the KerberosTime with another one, and return true if it's greater than the provided one with time skew
int	hashCode()
boolean	isInClockSkew(long clockSkew) Check if the KerberosTime is within the provided clock skew
boolean	lessThan(KerberosTime ktime) Compare the KerberosTime with another one, and return true if it's lesser than the provided one
boolean	lessThan(long time) Compare the KerberosTime with a time, and return true if it's lesser than the provided one
boolean	lessThanWithSkew(KerberosTime ktime, long skew) Compare the KerberosTime with another one, and return true if it's lesser than the provided one with time skew
static KerberosTime	now()
void	setTime(long time) Set the Kerberos time

Methods inherited from class org.apache.kerby.asn1.type.Asn1GeneralizedTime

toBytes, toValue

Methods inherited from class org.apache.kerby.asn1.type.Asn1Simple

createSimple, createSimple, decodeBody, encodeBody, encodeBody, encodingBodyLength, getBytes, isDefinitiveLength, isSimple, isSimple, isSimple, setBytes, toString

Methods inherited from class org.apache.kerby.asn1.type.AbstractAsn1Type

getValue, setValue

Methods inherited from class org.apache.kerby.asn1.type.Asn1Encodeable

decode, decode, decode, encode, encode, encodingHeaderLength, encodingLength, getBodyLength, getHeaderLength, isBER, isCER, isDER, isImplicit, isPrimitive, resetBodyLength, taggedDecode, taggedDecode, taggedDecode, taggedEncode, taggedEncode, taggedEncodingLength, useBER, useCER, useDefinitiveLength, useDER, useImplicit, usePrimitive

Methods inherited from class org.apache.kerby.asn1.type.Asn1Object

isAppSpecific, isCollection, isContextSpecific, isEOC, isNull, isSimple, isTagSpecific, isUniversal, simpleInfo, tag, tagFlags, tagNo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.kerby.asn1.type.Asn1Type

tag

Field Detail

NEVER

public static final KerberosTime NEVER

Constant for the KerberosTime "infinity."

MINUTE

public static final int MINUTE

The number of milliseconds in a minute.

See Also:

Constant Field Values

DAY

public static final int DAY

The number of milliseconds in a day.

See Also:

Constant Field Values

WEEK

public static final int WEEK

The number of milliseconds in a week.

See Also:

Constant Field Values

Constructor Detail

KerberosTime

public KerberosTime()

Creates a new instance of a KerberosTime object with the current time

KerberosTime

public KerberosTime(long time)

Parameters:

time - in milliseconds

Method Detail

getTime

public long getTime()

Returns:

time in milliseconds

setTime

public void setTime(long time)

Set the Kerberos time

Parameters:

time - set time in milliseconds

getTimeInSeconds

public long getTimeInSeconds()

Gets the time in seconds

Returns:

The time

lessThan

public boolean lessThan(KerberosTime ktime)

Compare the KerberosTime with another one, and return true if it's lesser than the provided one

Parameters:

ktime - in milliseconds

Returns:

true if less

lessThan

public boolean lessThan(long time)

Compare the KerberosTime with a time, and return true if it's lesser than the provided one

Parameters:

time - in milliseconds

Returns:

true if less

lessThanWithSkew

public boolean lessThanWithSkew(KerberosTime ktime,
                                long skew)

Compare the KerberosTime with another one, and return true if it's lesser than the provided one with time skew

Parameters:

ktime -

skew - Maximum time skew in milliseconds

Returns:

true if less

greaterThan

public boolean greaterThan(KerberosTime ktime)

Compare the KerberosTime with another one, and return true if it's greater than the provided one

Parameters:

ktime - compare with milliseconds

Returns:

true if greater

greaterThanWithSkew

public boolean greaterThanWithSkew(KerberosTime ktime,
                                   long skew)

Compare the KerberosTime with another one, and return true if it's greater than the provided one with time skew

Parameters:

ktime -

skew - Maximum time skew in milliseconds

Returns:

true if greater

isInClockSkew

public boolean isInClockSkew(long clockSkew)

Check if the KerberosTime is within the provided clock skew

Parameters:

clockSkew - The clock skew

Returns:

true if in clock skew

copy

public KerberosTime copy()

Returns:

A copy of the KerbeorsTime

extend

public KerberosTime extend(long duration)

Create a KerberosTime based on a time in milliseconds.

Parameters:

duration - The duration

Returns:

The created kerberos time

diff

public long diff(KerberosTime kerberosTime)

Return the difference between the currentKerberosTime and the provided one

Parameters:

kerberosTime - The kerberos time

Returns:

The difference between the two KerberosTime

now

public static KerberosTime now()

Returns:

The current KerberosTime

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

equals

public boolean equals(Object that)

Overrides:

equals in class Object