com.sdl.web.client.versions

Class ContentVersionManager

java.lang.Object

com.sdl.web.client.versions.ContentVersionManager

public class ContentVersionManager
extends Object

ContentVersionManager contains methods for managing CIS versions.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_VERSION Default Service version.

Constructor Summary

Constructors

Constructor and Description
ContentVersionManager(String serviceUrl, Map<String,String> properties) Read Service version by handshake request to Service.
ContentVersionManager(String serviceUrl, Properties properties) Read Service version by handshake request to Service.

Method Summary

Modifier and Type	Method and Description
protected List<Class<?>>	getClasses() Get list of loaded classes.
Version	getServiceVersion()
boolean	isCompatible() Checks if all methods from current stacktrace are compatible with CIS version.
boolean	isHigherCISVersion(Version currentVersion) Checks if CIS version is equal to or above specified version.
protected String	loadServiceVersion(String cisUrl, Map<String,String> requestProperties) Read CIS version by $metadata call to CIS.
protected <T extends Annotation> Map<String,T>	methodsWithAnnotation(List<Class<?>> classes, Class<T> annotation) Find all annotated methods in classes loaded by class loader.
protected <T extends Annotation> Set<String>	methodsWithoutAnnotation(List<Class<?>> classes, Class<T> annotation) Find all methods in classes without annotation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_VERSION

public static final String DEFAULT_VERSION

Default Service version.

See Also:

Constant Field Values

Constructor Detail

ContentVersionManager

public ContentVersionManager(String serviceUrl,
                             Map<String,String> properties)

Read Service version by handshake request to Service.

Parameters:

serviceUrl - url to service.

properties - include oauth credentials.

ContentVersionManager

public ContentVersionManager(String serviceUrl,
                             Properties properties)

Read Service version by handshake request to Service.

Parameters:

serviceUrl - url to service.

properties - include oauth credentials.

Method Detail

loadServiceVersion

protected String loadServiceVersion(String cisUrl,
                                    Map<String,String> requestProperties)

Read CIS version by $metadata call to CIS.

Returns:

CIS version.

isCompatible

public boolean isCompatible()

Checks if all methods from current stacktrace are compatible with CIS version. Already analyzed and annotated with SupportedCisVersion methods are stored in Map. If there is at least one out of range version in current stacktrace return false.

Returns:

true if all versions are in allowed range.

getClasses

protected List<Class<?>> getClasses()

Get list of loaded classes.

Returns:

list of loaded classes.

methodsWithAnnotation

protected <T extends Annotation> Map<String,T> methodsWithAnnotation(List<Class<?>> classes,
                                                                     Class<T> annotation)

Find all annotated methods in classes loaded by class loader. Returns Map with `class:method` as key and annotation as value.

Type Parameters:

T - should be implementation of Annotation

Parameters:

annotation - to find.

Returns:

Stream of annotatedMethods.

methodsWithoutAnnotation

protected <T extends Annotation> Set<String> methodsWithoutAnnotation(List<Class<?>> classes,
                                                                      Class<T> annotation)

Find all methods in classes without annotation.

Type Parameters:

T - should be implementation of Annotation

Parameters:

classes - classes to scan.

annotation - this annotation should not be present

Returns:

Set of `class:method` without annotation.

getServiceVersion

public Version getServiceVersion()

isHigherCISVersion

public boolean isHigherCISVersion(Version currentVersion)

Checks if CIS version is equal to or above specified version.

Parameters:

currentVersion - version to compare with CIS version

Returns:

true if CIS version is equal to or above specified version.