Package com.isode.dsapi.internal

Enum Class IsodeDirectorySession.DsaVersion

java.lang.Object

java.lang.Enum<IsodeDirectorySession.DsaVersion>

com.isode.dsapi.internal.IsodeDirectorySession.DsaVersion

All Implemented Interfaces:

Serializable, Comparable<IsodeDirectorySession.DsaVersion>, Constable

Enclosing class:

IsodeDirectorySession

public static enum IsodeDirectorySession.DsaVersion
extends Enum<IsodeDirectorySession.DsaVersion>

This enum indicates the DSA version of the Isode directory or Unknown. More recent versions have higher ordinal values (e.g. D3.ordinal() > D2.ordinal()).

Since:

15.0

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
D2	A "D2" DSA is one prior to R15.0
D3	A "D3" DSA is a r15.0 or higher DSA (This definition may be changed in the future).
UNKNOWN	A DSA whose version was not one of those recognised by this class.

Method Summary

Modifier and Type	Method	Description
static IsodeDirectorySession.DsaVersion	getDsaVersion(String dsaVersion, String vendorName, String vendorVersion)	Determine the DsaVersion number based on attributes read from the root entry.
static IsodeDirectorySession.DsaVersion	getLatestDsaVersion()	Determine the latest DSA version available.
static IsodeDirectorySession.DsaVersion	valueOf(String name)	Returns the enum constant of this class with the specified name.
static IsodeDirectorySession.DsaVersion[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UNKNOWN

public static final IsodeDirectorySession.DsaVersion UNKNOWN

A DSA whose version was not one of those recognised by this class.

D2

public static final IsodeDirectorySession.DsaVersion D2

A "D2" DSA is one prior to R15.0

D3

public static final IsodeDirectorySession.DsaVersion D3

A "D3" DSA is a r15.0 or higher DSA (This definition may be changed in the future).

Method Details

values

public static IsodeDirectorySession.DsaVersion[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static IsodeDirectorySession.DsaVersion valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getDsaVersion

public static IsodeDirectorySession.DsaVersion getDsaVersion(String dsaVersion,
 String vendorName,
 String vendorVersion)

Determine the DsaVersion number based on attributes read from the root entry.

The current implemenation will return

• D3 if dsaVersion starts with "d3", or else
• D2 if vendorName contains "isode limited" or else
• UNKNOWN

This algorithm is correct for the initial implementation, but may change as the D3 code fills in vendorname etc.

Parameters:

dsaVersion - "dsaversion" value on root entry; may be null

vendorName - "vendorname" on root entry; may be null

vendorVersion - "vendorversion" on root entry; may be null

Returns:

the corresponding DsaVersion (which may be UNKNOWN)

getLatestDsaVersion

public static IsodeDirectorySession.DsaVersion getLatestDsaVersion()

Determine the latest DSA version available.

Returns:

dsa version