org.apache.synapse.rest.version

Interface VersionStrategy

All Known Implementing Classes:

AbstractVersionStrategy, DefaultStrategy, URLBasedVersionStrategy

public interface VersionStrategy

This class is responsible for version delegation for API resources

Method Summary

Modifier and Type	Method and Description
String	getVersion() get the assigned version for the delegated object
String	getVersionParam() returns type information ie:- location regex/string that can be used t extract version..
String	getVersionType() returns version type information.
boolean	isMatchingVersion(Object versionInfoObj) check if version matches from the version ifo object.

Method Detail

isMatchingVersion

boolean isMatchingVersion(Object versionInfoObj)

check if version matches from the version ifo object.

Parameters:

versionInfoObj - object that can be used to extract data about the version

Returns:

getVersion

String getVersion()

get the assigned version for the delegated object

Returns:

string representation for the version

getVersionType

String getVersionType()

returns version type information. ie:- version can be embedded in request URL , HTTP header , etc

Returns:

version type String

getVersionParam

String getVersionParam()

returns type information ie:- location regex/string that can be used t extract version..

Returns:

version param