org.springframework.cloud.contract.verifier.http

Class ContractVerifierHttpMetaData

java.lang.Object

org.springframework.cloud.contract.verifier.http.ContractVerifierHttpMetaData

All Implemented Interfaces:

SpringCloudContractMetadata

public class ContractVerifierHttpMetaData
extends Object
implements SpringCloudContractMetadata

Metadata representation of the Contract Verifier's HTTP communication. Warning! This API is experimental and can change in time.

Since:

3.0.0

Author:

Marcin Grzejszczak

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ContractVerifierHttpMetaData.Protocol Taken from OKHttp's Protocol Protocol.
static class	ContractVerifierHttpMetaData.Scheme HTTP communication scheme.

Field Summary

Fields

Modifier and Type	Field and Description
static String	METADATA_KEY Metadata entry in the contract.

Constructor Summary

Constructors

Constructor and Description
ContractVerifierHttpMetaData()

Method Summary

Modifier and Type	Method and Description
String	description() Short description of the metadata.
static ContractVerifierHttpMetaData	fromMetadata(Map<String,Object> metadata)
ContractVerifierHttpMetaData.Protocol	getProtocol()
ContractVerifierHttpMetaData.Scheme	getScheme()
String	key() Name of the key under which this metadata entry will be present in contract's metadata.
void	setProtocol(ContractVerifierHttpMetaData.Protocol protocol)
void	setProtocol(String protocol)
void	setScheme(ContractVerifierHttpMetaData.Scheme scheme)
void	setScheme(String scheme)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.cloud.contract.verifier.util.SpringCloudContractMetadata

additionalClassesToLookAt

Field Detail

METADATA_KEY

public static final String METADATA_KEY

Metadata entry in the contract.

See Also:

Constant Field Values

Constructor Detail

ContractVerifierHttpMetaData

public ContractVerifierHttpMetaData()

Method Detail

fromMetadata

@NonNull
public static ContractVerifierHttpMetaData fromMetadata(Map<String,Object> metadata)

key

public String key()

Description copied from interface: SpringCloudContractMetadata

Name of the key under which this metadata entry will be present in contract's metadata.

Specified by:

key in interface SpringCloudContractMetadata

Returns:

key name

description

public String description()

Description copied from interface: SpringCloudContractMetadata

Short description of the metadata. Will be used in the generated documentation.

Specified by:

description in interface SpringCloudContractMetadata

Returns:

description of the metadata.

getScheme

public ContractVerifierHttpMetaData.Scheme getScheme()

setScheme

public void setScheme(ContractVerifierHttpMetaData.Scheme scheme)

setScheme

public void setScheme(String scheme)

getProtocol

public ContractVerifierHttpMetaData.Protocol getProtocol()

setProtocol

public void setProtocol(ContractVerifierHttpMetaData.Protocol protocol)

setProtocol

public void setProtocol(String protocol)