Class JacksonProtobufDataFormat

  • All Implemented Interfaces:
    AutoCloseable, org.apache.camel.CamelContextAware, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.DataFormat, org.apache.camel.spi.DataFormatContentTypeHeader, org.apache.camel.spi.DataFormatName, org.apache.camel.StatefulService, org.apache.camel.SuspendableService

    @Dataformat("protobuf-jackson")
    @Metadata(firstVersion="3.10.0",
              title="Protobuf Jackson",
              excludeProperties="library,instanceClass,contentTypeFormat,defaultInstance")
    public class JacksonProtobufDataFormat
    extends org.apache.camel.component.jackson.AbstractJacksonDataFormat
    Marshal POJOs to Protobuf and back using Jackson.
    • Field Summary

      • Fields inherited from class org.apache.camel.support.service.BaseService

        BUILT, FAILED, INITIALIZED, INITIALIZING, lock, NEW, SHUTDOWN, SHUTTING_DOWN, STARTED, STARTING, status, STOPPED, STOPPING, SUSPENDED, SUSPENDING
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected com.fasterxml.jackson.dataformat.protobuf.ProtobufMapper createNewObjectMapper()  
      String getDataFormatName()  
      protected String getDefaultContentType()  
      protected Class<? extends com.fasterxml.jackson.databind.ObjectMapper> getObjectMapperClass()  
      • Methods inherited from class org.apache.camel.component.jackson.AbstractJacksonDataFormat

        addModule, disableFeature, disableFeature, disableFeature, doInit, doStart, doStop, enableFeature, enableFeature, enableFeature, getCamelContext, getCollectionType, getCollectionTypeName, getDisableFeatures, getEnableFeatures, getInclude, getJsonView, getJsonViewTypeName, getModuleClassNames, getModuleRefs, getModules, getObjectMapper, getSchemaResolver, getTimezone, getUnmarshalType, getUnmarshalTypeName, isAllowJmsType, isAllowUnmarshallType, isAutoDiscoverObjectMapper, isAutoDiscoverSchemaResolver, isContentTypeHeader, isEnableJacksonTypeConverter, isPrettyPrint, isUseDefaultObjectMapper, isUseList, marshal, setAllowJmsType, setAllowUnmarshallType, setAutoDiscoverObjectMapper, setAutoDiscoverSchemaResolver, setCamelContext, setCollectionType, setCollectionTypeName, setContentTypeHeader, setDisableFeatures, setEnableFeatures, setEnableJacksonTypeConverter, setInclude, setJsonView, setJsonViewTypeName, setModuleClassNames, setModuleRefs, setModules, setObjectMapper, setPrettyPrint, setSchemaResolver, setTimezone, setUnmarshalType, setUnmarshalTypeName, setUseDefaultObjectMapper, setUseList, unmarshal, useList, useMap
      • Methods inherited from class org.apache.camel.support.service.BaseService

        build, doBuild, doFail, doLifecycleChange, doResume, doShutdown, doSuspend, fail, getStatus, init, isBuild, isInit, isNew, isRunAllowed, isShutdown, isStarted, isStarting, isStartingOrStarted, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend
      • Methods inherited from interface org.apache.camel.Service

        build, close, init, start, stop
      • Methods inherited from interface org.apache.camel.ShutdownableService

        shutdown
      • Methods inherited from interface org.apache.camel.StatefulService

        getStatus, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isSuspending
      • Methods inherited from interface org.apache.camel.SuspendableService

        isSuspended, resume, suspend
    • Constructor Detail

      • JacksonProtobufDataFormat

        public JacksonProtobufDataFormat()
        Use the default Jackson ProtobufMapper and Object
      • JacksonProtobufDataFormat

        public JacksonProtobufDataFormat​(Class<?> unmarshalType)
        Use the default Jackson ProtobufMapper and with a custom unmarshal type
        Parameters:
        unmarshalType - the custom unmarshal type
      • JacksonProtobufDataFormat

        public JacksonProtobufDataFormat​(Class<?> unmarshalType,
                                         Class<?> jsonView)
        Use the default Jackson ProtobufMapper and with a custom unmarshal type and JSON view
        Parameters:
        unmarshalType - the custom unmarshal type
        jsonView - marker class to specify properties to be included during marshalling. See also
      • JacksonProtobufDataFormat

        public JacksonProtobufDataFormat​(com.fasterxml.jackson.dataformat.protobuf.ProtobufMapper mapper,
                                         Class<?> unmarshalType)
        Use a custom Jackson ProtobufMapper and and unmarshal type
        Parameters:
        mapper - the custom mapper
        unmarshalType - the custom unmarshal type
      • JacksonProtobufDataFormat

        public JacksonProtobufDataFormat​(com.fasterxml.jackson.dataformat.protobuf.ProtobufMapper mapper,
                                         Class<?> unmarshalType,
                                         Class<?> jsonView)
        Use a custom Jackson ProtobufMapper, unmarshal type and JSON view
        Parameters:
        mapper - the custom mapper
        unmarshalType - the custom unmarshal type
        jsonView - marker class to specify properties to be included during marshalling. See also
    • Method Detail

      • getDataFormatName

        public String getDataFormatName()
        Specified by:
        getDataFormatName in interface org.apache.camel.spi.DataFormatName
        Specified by:
        getDataFormatName in class org.apache.camel.component.jackson.AbstractJacksonDataFormat
      • getDefaultContentType

        protected String getDefaultContentType()
        Specified by:
        getDefaultContentType in class org.apache.camel.component.jackson.AbstractJacksonDataFormat
      • createNewObjectMapper

        protected com.fasterxml.jackson.dataformat.protobuf.ProtobufMapper createNewObjectMapper()
        Specified by:
        createNewObjectMapper in class org.apache.camel.component.jackson.AbstractJacksonDataFormat
      • getObjectMapperClass

        protected Class<? extends com.fasterxml.jackson.databind.ObjectMapper> getObjectMapperClass()
        Specified by:
        getObjectMapperClass in class org.apache.camel.component.jackson.AbstractJacksonDataFormat