Package org.springframework.cloud.servicebroker.model

Class BrokerApiVersion

java.lang.Object

org.springframework.cloud.servicebroker.model.BrokerApiVersion

public class BrokerApiVersion
extends Object

Object for configuring the version of the API supported by the service broker.

Author:

Scott Frederick, Roy Clarkson

Field Summary

Fields

Modifier and Type	Field	Description
static final String	API_VERSION_ANY	API Version value representing any version.
static final String	API_VERSION_CURRENT	Current API Version supported by this library.
static final String	DEFAULT_API_VERSION_HEADER	API Version header.

Constructor Summary

Constructors

Constructor	Description
BrokerApiVersion()	Specify that service broker API validation should be disabled.
BrokerApiVersion(String apiVersion)	Specify the service broker API version supported by the service broker.
BrokerApiVersion(String apiVersionHeader, String apiVersion)	Specify the name of the service broker API version header and the API version supported by the service broker.

Method Summary

Modifier and Type	Method	Description
String	getApiVersion()	Get the service broker API version supported by the service broker.
String	getBrokerApiVersionHeader()	Get the name of the service broker API version header.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_API_VERSION_HEADER

public static final String DEFAULT_API_VERSION_HEADER

API Version header.

See Also:

• Constant Field Values

API_VERSION_ANY

public static final String API_VERSION_ANY

API Version value representing any version.

See Also:

• Constant Field Values

API_VERSION_CURRENT

public static final String API_VERSION_CURRENT

Current API Version supported by this library.

See Also:

• Constant Field Values

Constructor Details

BrokerApiVersion

public BrokerApiVersion(String apiVersionHeader,
 String apiVersion)

Specify the name of the service broker API version header and the API version supported by the service broker.

Parameters:

apiVersionHeader - the name of the HTTP header field expected to contain the service broker API version of the service broker client

apiVersion - the version of the service broker API supported by the broker; a value of null or API_VERSION_ANY will disable API version validation

BrokerApiVersion

public BrokerApiVersion(String apiVersion)

Specify the service broker API version supported by the service broker.

Parameters:

apiVersion - the version of the broker API supported by the broker; a value of null or API_VERSION_ANY will disable API version validation

BrokerApiVersion

public BrokerApiVersion()

Specify that service broker API validation should be disabled.

Method Details

getApiVersion

public String getApiVersion()

Get the service broker API version supported by the service broker.

Returns:

the service broker API version supported by the service broker

getBrokerApiVersionHeader

public String getBrokerApiVersionHeader()

Get the name of the service broker API version header.

Returns:

the name of the service broker API version header