org.springframework.cloud.servicebroker.model

Class BrokerApiVersion

java.lang.Object

org.springframework.cloud.servicebroker.model.BrokerApiVersion

public class BrokerApiVersion
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	API_VERSION_ANY
static java.lang.String	API_VERSION_CURRENT
static java.lang.String	DEFAULT_API_VERSION_HEADER

Constructor Summary

Constructors

Constructor and Description
BrokerApiVersion() Specify that service broker API validation should be disabled.
BrokerApiVersion(java.lang.String apiVersion) Specify the service broker API version supported by the service broker.
BrokerApiVersion(java.lang.String apiVersionHeader, java.lang.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 and Description
java.lang.String	getApiVersion() Get the service broker API version supported by the service broker.
java.lang.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 Detail

DEFAULT_API_VERSION_HEADER

public static final java.lang.String DEFAULT_API_VERSION_HEADER

See Also:

Constant Field Values

API_VERSION_ANY

public static final java.lang.String API_VERSION_ANY

See Also:

Constant Field Values

API_VERSION_CURRENT

public static final java.lang.String API_VERSION_CURRENT

See Also:

Constant Field Values

Constructor Detail

BrokerApiVersion

public BrokerApiVersion(java.lang.String apiVersionHeader,
                        java.lang.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(java.lang.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 Detail

getApiVersion

public java.lang.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 java.lang.String getBrokerApiVersionHeader()

Get the name of the service broker API version header.

Returns:

the name of the service broker API version header