software.amazon.awssdk.codegen.protocol

Interface ProtocolMetadataProvider

All Superinterfaces:

Serializable

All Known Implementing Classes:

ApiGatewayProtocolMetadataProvider, AwsCborProtocolMetadataProvider, AwsJsonProtocolMetadataProvider, BaseJsonProtocolMetadataProvider, BaseProtocolMetadataProvider, BaseXmlProtocolMetadataProvider, Ec2ProtocolMetadataProvider, IonProtocolMetadataProvider, QueryProtocolMetadataProvider, RestJsonProtocolMetadataProvider, RestXmlProtocolMetadataProvider

public interface ProtocolMetadataProvider
extends Serializable

Provides various pieces of information that are specific to certain protocols.

Method Summary

Modifier and Type	Method and Description
String	getBaseExceptionFqcn()
String	getContentType()
String	getExceptionUnmarshallerImpl()
String	getProtocolFactoryImplFqcn()
String	getRequestBaseFqcn()
String	getUnmarshallerContextClassName()
boolean	isCborProtocol()
boolean	isIonProtocol()
boolean	isJsonProtocol()
boolean	isXmlProtocol()

Method Detail

isJsonProtocol

boolean isJsonProtocol()

Returns:

True if protocol uses some form of JSON wire format. False otherwise.

isXmlProtocol

boolean isXmlProtocol()

Returns:

True if protocol uses XML as the wire format. False otherwise.

isCborProtocol

boolean isCborProtocol()

Returns:

True if protocol uses CBOR as the wire format. False otherwise.

isIonProtocol

boolean isIonProtocol()

Returns:

True if protocol uses Ion as the wire format. False otherwise.

getContentType

String getContentType()

Returns:

The content type to use when sending requests. Currently only respected by JSON protocols.

getUnmarshallerContextClassName

String getUnmarshallerContextClassName()

Returns:

The name of the Unmarshaller Context class used by the generated unmarshaller classes.

getExceptionUnmarshallerImpl

String getExceptionUnmarshallerImpl()

Returns:

The default implementation of exception unmarshallers to use or derive from. Currently only used by XML protocols.

getProtocolFactoryImplFqcn

String getProtocolFactoryImplFqcn()

Returns:

The protocol factory implementation to use for JSON services.

getBaseExceptionFqcn

String getBaseExceptionFqcn()

Returns:

The fully qualified class name of the exception class that all service exceptions will be inherited from. Not to be confused with the service specific base exception which would extend from this base exception.

getRequestBaseFqcn

String getRequestBaseFqcn()

Returns:

The fully qualified class name of the base request class.