org.opends.server.schema

Class GeneralizedTimeSyntax

java.lang.Object

org.opends.server.api.AttributeSyntax<AttributeSyntaxCfg>

org.opends.server.schema.GeneralizedTimeSyntax

public class GeneralizedTimeSyntax
extends AttributeSyntax<AttributeSyntaxCfg>

This class defines the generalized time attribute syntax, which is a way of representing time in a form like "YYYYMMDDhhmmssZ". The actual form is somewhat flexible, and may omit the minute and second information, or may include sub-second information. It may also replace "Z" with a time zone offset like "-0500" for representing values that are not in UTC.

Constructor Summary

Constructors

Constructor and Description
GeneralizedTimeSyntax() Creates a new instance of this syntax.

Method Summary

Methods

Modifier and Type	Method and Description
static org.forgerock.opendj.ldap.ByteString	createGeneralizedTimeValue(long time) Retrieves an attribute value containing a generalized time representation of the provided date.
static long	decodeGeneralizedTimeValue(org.forgerock.opendj.ldap.ByteSequence value) Decodes the provided normalized value as a generalized time value and retrieves a timestamp containing its representation.
static String	format(Date d) Retrieves the generalized time representation of the provided date.
static String	format(long t) Retrieves the generalized time representation of the provided date.
String	getDescription() Retrieves a description for this attribute syntax.
String	getName() Retrieves the common name for this attribute syntax.
String	getOID() Retrieves the OID for this attribute syntax.
org.forgerock.opendj.ldap.schema.Syntax	getSDKSyntax(org.forgerock.opendj.ldap.schema.Schema schema) Returns the SDK Syntax equivalent to this syntax.

Methods inherited from class org.opends.server.api.AttributeSyntax

equals, finalizeSyntax, getApproximateMatchingRule, getEqualityMatchingRule, getOrderingMatchingRule, getSubstringMatchingRule, hashCode, initializeSyntax, isBEREncodingRequired, isConfigurationAcceptable, isHumanReadable, toString, toString, valueIsAcceptable

Methods inherited from class java.lang.Object

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

Constructor Detail

GeneralizedTimeSyntax

public GeneralizedTimeSyntax()

Creates a new instance of this syntax. Note that the only thing that should be done here is to invoke the default constructor for the superclass. All initialization should be performed in the initializeSyntax method.

Method Detail

getSDKSyntax

public org.forgerock.opendj.ldap.schema.Syntax getSDKSyntax(org.forgerock.opendj.ldap.schema.Schema schema)

Returns the SDK Syntax equivalent to this syntax.

This method allow smooth migration to SDK syntax. It will disappear once the the migration to SDK schema is complete, together with this class and all its implementation.

Specified by:

getSDKSyntax in class AttributeSyntax<AttributeSyntaxCfg>

Parameters:

schema - Schema to use to retrieve the syntax

Returns:

the equivalent SDK syntax.

getName

public String getName()

Retrieves the common name for this attribute syntax.

Specified by:

getName in class AttributeSyntax<AttributeSyntaxCfg>

Returns:

The common name for this attribute syntax.

getOID

public String getOID()

Retrieves the OID for this attribute syntax.

Specified by:

getOID in class AttributeSyntax<AttributeSyntaxCfg>

Returns:

The OID for this attribute syntax.

getDescription

public String getDescription()

Retrieves a description for this attribute syntax.

Specified by:

getDescription in class AttributeSyntax<AttributeSyntaxCfg>

Returns:

A description for this attribute syntax.

format

public static String format(Date d)

Retrieves the generalized time representation of the provided date.

Parameters:

d - The date to retrieve in generalized time form.

Returns:

The generalized time representation of the provided date.

format

public static String format(long t)

Retrieves the generalized time representation of the provided date.

Parameters:

t - The timestamp to retrieve in generalized time form.

Returns:

The generalized time representation of the provided date.

createGeneralizedTimeValue

public static org.forgerock.opendj.ldap.ByteString createGeneralizedTimeValue(long time)

Retrieves an attribute value containing a generalized time representation of the provided date.

Parameters:

time - The time for which to retrieve the generalized time value.

Returns:

The attribute value created from the date.

decodeGeneralizedTimeValue

public static long decodeGeneralizedTimeValue(org.forgerock.opendj.ldap.ByteSequence value)
                                       throws DirectoryException

Decodes the provided normalized value as a generalized time value and retrieves a timestamp containing its representation.

Parameters:

value - The normalized value to decode using the generalized time syntax.

Returns:

The timestamp created from the provided generalized time value.

Throws:

DirectoryException - If the provided value cannot be parsed as a valid generalized time string.