Package org.apache.pekko.http.scaladsl.marshalling

Class Marshaller<A,B>

java.lang.Object
org.apache.pekko.http.scaladsl.marshalling.Marshaller<A,B>
public abstract class Marshaller<A,B> extends Object

  • Constructor Details

    • Marshaller

      public Marshaller()

  • Method Details

    • fromRequest

      public static Marshaller<HttpRequest,HttpRequest> fromRequest()

    • fromResponse

      public static Marshaller<HttpResponse,HttpResponse> fromResponse()

    • fromStatusCode

      public static Marshaller<StatusCode,HttpResponse> fromStatusCode()

    • fromStatusCodeAndHeaders

      public static Marshaller<scala.Tuple2<StatusCode,scala.collection.immutable.Seq<HttpHeader>>,HttpResponse> fromStatusCodeAndHeaders()

    • ByteArrayMarshaller

      public static Marshaller<byte[],RequestEntity> ByteArrayMarshaller()

    • ByteStringMarshaller

      public static Marshaller<org.apache.pekko.util.ByteString,RequestEntity> ByteStringMarshaller()

    • CharArrayMarshaller

      public static Marshaller<char[],RequestEntity> CharArrayMarshaller()

    • DoneMarshaller

      public static Marshaller<org.apache.pekko.Done,RequestEntity> DoneMarshaller()

    • StringMarshaller

      public static Marshaller<String,RequestEntity> StringMarshaller()

    • FormDataMarshaller

      public static Marshaller<FormData,RequestEntity> FormDataMarshaller()

    • MessageEntityMarshaller

      public static Marshaller<RequestEntity,RequestEntity> MessageEntityMarshaller()

    • strict

      public static <A, B> Marshaller<A,B> strict(scala.Function1<A,Marshalling<B>> f)
      Helper for creating a Marshaller using the given function.
      Parameters:
      f - (undocumented)
      Returns:
      (undocumented)

    • oneOf

      public static <A, B> Marshaller<A,B> oneOf(scala.collection.immutable.Seq<Marshaller<A,B>> marshallers)
      Helper for creating a "super-marshaller" from a number of "sub-marshallers". Content-negotiation determines, which "sub-marshaller" eventually gets to do the job.

      Please note that all marshallers will actually be invoked in order to get the Marshalling object out of them, and later decide which of the marshallings should be returned. This is by-design, however in ticket as discussed in ticket https://github.com/akka/akka-http/issues/243 it MAY be changed in later versions of Pekko HTTP.

      Parameters:
      marshallers - (undocumented)
      Returns:
      (undocumented)

    • oneOf

      public static <T, A, B> Marshaller<A,B> oneOf(scala.collection.immutable.Seq<T> values, scala.Function1<T,Marshaller<A,B>> f)
      Helper for creating a "super-marshaller" from a number of values and a function producing "sub-marshallers" from these values. Content-negotiation determines, which "sub-marshaller" eventually gets to do the job.

      Please note that all marshallers will actually be invoked in order to get the Marshalling object out of them, and later decide which of the marshallings should be returned. This is by-design, however in ticket as discussed in ticket https://github.com/akka/akka-http/issues/243 it MAY be changed in later versions of Pekko HTTP.

      Parameters:
      values - (undocumented)
      f - (undocumented)
      Returns:
      (undocumented)

    • withFixedContentType

      public static <A, B> Marshaller<A,B> withFixedContentType(ContentType contentType, scala.Function1<A,B> marshal)
      Helper for creating a synchronous Marshaller to content with a fixed charset from the given function.
      Parameters:
      contentType - (undocumented)
      marshal - (undocumented)
      Returns:
      (undocumented)

    • withOpenCharset

      public static <A, B> Marshaller<A,B> withOpenCharset(MediaType.WithOpenCharset mediaType, scala.Function2<A,HttpCharset,B> marshal)
      Helper for creating a synchronous Marshaller to content with a negotiable charset from the given function.
      Parameters:
      mediaType - (undocumented)
      marshal - (undocumented)
      Returns:
      (undocumented)

    • opaque

      public static <A, B> Marshaller<A,B> opaque(scala.Function1<A,B> marshal)
      Helper for creating a synchronous Marshaller to non-negotiable content from the given function.
      Parameters:
      marshal - (undocumented)
      Returns:
      (undocumented)

    • combined

      public static <A, B, C> Marshaller<A,C> combined(scala.Function1<A,B> marshal, Marshaller<B,C> m2)
      Helper for creating a Marshaller combined of the provided marshal function and an implicit Marshaller which is able to produce the required final type.
      Parameters:
      marshal - (undocumented)
      m2 - (undocumented)
      Returns:
      (undocumented)

    • liftMarshallerConversion

      public static <T> Marshaller<T,HttpResponse> liftMarshallerConversion(Marshaller<T,RequestEntity> m)

    • liftMarshaller

      public static <T> Marshaller<T,HttpResponse> liftMarshaller(Marshaller<T,RequestEntity> m)

    • fromEntityStreamingSupportAndEntityMarshaller

      public static <T, M> Marshaller<org.apache.pekko.stream.scaladsl.Source<T,M>,HttpResponse> fromEntityStreamingSupportAndEntityMarshaller(EntityStreamingSupport s, Marshaller<T,RequestEntity> m, scala.reflect.ClassTag<T> tag)

    • fromEntityStreamingSupportAndByteStringSourceMarshaller

      public static <T, M> Marshaller<org.apache.pekko.stream.scaladsl.Source<T,M>,HttpResponse> fromEntityStreamingSupportAndByteStringSourceMarshaller(EntityStreamingSupport s, Marshaller<T,org.apache.pekko.stream.scaladsl.Source<org.apache.pekko.util.ByteString,?>> m, scala.reflect.ClassTag<T> evidence$2)

    • throwableMarshaller

      public static <T> Marshaller<Throwable,T> throwableMarshaller()

    • optionMarshaller

      public static <A, B> Marshaller<scala.Option<A>,B> optionMarshaller(Marshaller<A,B> m, EmptyValue<B> empty)

    • eitherMarshaller

      public static <A1, A2, B> Marshaller<scala.util.Either<A1,A2>,B> eitherMarshaller(Marshaller<A1,B> m1, Marshaller<A2,B> m2)

    • futureMarshaller

      public static <A, B> Marshaller<scala.concurrent.Future<A>,B> futureMarshaller(Marshaller<A,B> m)

    • tryMarshaller

      public static <A, B> Marshaller<scala.util.Try<A>,B> tryMarshaller(Marshaller<A,B> m)

    • multipartMarshaller

      public static <T extends Multipart> Marshaller<T,RequestEntity> multipartMarshaller(org.apache.pekko.event.LoggingAdapter log)

    • multipartMarshaller$default$1

      public static <T extends Multipart> org.apache.pekko.event.LoggingAdapter multipartMarshaller$default$1()

    • multipartBoundaryRandom

      protected static Random multipartBoundaryRandom()

    • multipartBoundaryLength

      protected static int multipartBoundaryLength()

    • randomBoundary

      protected static String randomBoundary()

    • byteArrayMarshaller

      public static Marshaller<byte[],RequestEntity> byteArrayMarshaller(ContentType contentType)

    • byteStringMarshaller

      public static Marshaller<org.apache.pekko.util.ByteString,RequestEntity> byteStringMarshaller(ContentType contentType)

    • charArrayMarshaller

      public static Marshaller<char[],RequestEntity> charArrayMarshaller(MediaType.WithOpenCharset mediaType)

    • charArrayMarshaller

      public static Marshaller<char[],RequestEntity> charArrayMarshaller(MediaType.WithFixedCharset mediaType)

    • stringMarshaller

      public static Marshaller<String,RequestEntity> stringMarshaller(MediaType.WithOpenCharset mediaType)

    • stringMarshaller

      public static Marshaller<String,RequestEntity> stringMarshaller(MediaType.WithFixedCharset mediaType)

    • org$apache$pekko$http$scaladsl$marshalling$PredefinedToEntityMarshallers$_setter_$ByteArrayMarshaller_$eq

      protected abstract static void org$apache$pekko$http$scaladsl$marshalling$PredefinedToEntityMarshallers$_setter_$ByteArrayMarshaller_$eq(Marshaller<byte[],RequestEntity> x$1)

    • org$apache$pekko$http$scaladsl$marshalling$PredefinedToEntityMarshallers$_setter_$ByteStringMarshaller_$eq

      protected abstract static void org$apache$pekko$http$scaladsl$marshalling$PredefinedToEntityMarshallers$_setter_$ByteStringMarshaller_$eq(Marshaller<org.apache.pekko.util.ByteString,RequestEntity> x$1)

    • org$apache$pekko$http$scaladsl$marshalling$PredefinedToEntityMarshallers$_setter_$CharArrayMarshaller_$eq

      protected abstract static void org$apache$pekko$http$scaladsl$marshalling$PredefinedToEntityMarshallers$_setter_$CharArrayMarshaller_$eq(Marshaller<char[],RequestEntity> x$1)

    • org$apache$pekko$http$scaladsl$marshalling$PredefinedToEntityMarshallers$_setter_$DoneMarshaller_$eq

      protected abstract static void org$apache$pekko$http$scaladsl$marshalling$PredefinedToEntityMarshallers$_setter_$DoneMarshaller_$eq(Marshaller<org.apache.pekko.Done,RequestEntity> x$1)

    • org$apache$pekko$http$scaladsl$marshalling$PredefinedToEntityMarshallers$_setter_$StringMarshaller_$eq

      protected abstract static void org$apache$pekko$http$scaladsl$marshalling$PredefinedToEntityMarshallers$_setter_$StringMarshaller_$eq(Marshaller<String,RequestEntity> x$1)

    • org$apache$pekko$http$scaladsl$marshalling$PredefinedToEntityMarshallers$_setter_$FormDataMarshaller_$eq

      protected abstract static void org$apache$pekko$http$scaladsl$marshalling$PredefinedToEntityMarshallers$_setter_$FormDataMarshaller_$eq(Marshaller<FormData,RequestEntity> x$1)

    • org$apache$pekko$http$scaladsl$marshalling$PredefinedToEntityMarshallers$_setter_$MessageEntityMarshaller_$eq

      protected abstract static void org$apache$pekko$http$scaladsl$marshalling$PredefinedToEntityMarshallers$_setter_$MessageEntityMarshaller_$eq(Marshaller<RequestEntity,RequestEntity> x$1)

    • fromToEntityMarshaller

      public static <T> Marshaller<T,HttpResponse> fromToEntityMarshaller(StatusCode status, scala.collection.immutable.Seq<HttpHeader> headers, Marshaller<T,RequestEntity> m)

    • fromToEntityMarshaller$default$1

      public static <T> StatusCode fromToEntityMarshaller$default$1()

    • fromToEntityMarshaller$default$2

      public static <T> scala.collection.immutable.Seq<HttpHeader> fromToEntityMarshaller$default$2()

    • fromStatusCodeAndValue

      public static <S, T> Marshaller<scala.Tuple2<S,T>,HttpResponse> fromStatusCodeAndValue(scala.Function1<S,StatusCode> sConv, Marshaller<T,RequestEntity> mt)

    • fromStatusCodeConvertibleAndHeadersAndT

      public static <S, T> Marshaller<scala.Tuple3<S,scala.collection.immutable.Seq<HttpHeader>,T>,HttpResponse> fromStatusCodeConvertibleAndHeadersAndT(scala.Function1<S,StatusCode> sConv, Marshaller<T,RequestEntity> mt)

    • fromStatusCodeAndHeadersAndValue

      public static <T> Marshaller<scala.Tuple3<StatusCode,scala.collection.immutable.Seq<HttpHeader>,T>,HttpResponse> fromStatusCodeAndHeadersAndValue(Marshaller<T,RequestEntity> mt)

    • fromEntityStreamingSupportAndByteStringMarshaller

      public static <T, M> Marshaller<org.apache.pekko.stream.scaladsl.Source<T,M>,HttpResponse> fromEntityStreamingSupportAndByteStringMarshaller(scala.reflect.ClassTag<T> evidence$1, EntityStreamingSupport s, Marshaller<T,org.apache.pekko.util.ByteString> m)

    • org$apache$pekko$http$scaladsl$marshalling$PredefinedToResponseMarshallers$_setter_$fromResponse_$eq

      protected abstract static void org$apache$pekko$http$scaladsl$marshalling$PredefinedToResponseMarshallers$_setter_$fromResponse_$eq(Marshaller<HttpResponse,HttpResponse> x$1)

    • org$apache$pekko$http$scaladsl$marshalling$PredefinedToResponseMarshallers$_setter_$fromStatusCode_$eq

      protected abstract static void org$apache$pekko$http$scaladsl$marshalling$PredefinedToResponseMarshallers$_setter_$fromStatusCode_$eq(Marshaller<StatusCode,HttpResponse> x$1)

    • org$apache$pekko$http$scaladsl$marshalling$PredefinedToResponseMarshallers$_setter_$fromStatusCodeAndHeaders_$eq

      protected abstract static void org$apache$pekko$http$scaladsl$marshalling$PredefinedToResponseMarshallers$_setter_$fromStatusCodeAndHeaders_$eq(Marshaller<scala.Tuple2<StatusCode,scala.collection.immutable.Seq<HttpHeader>>,HttpResponse> x$1)

    • fromUri

      public static Marshaller<Uri,HttpRequest> fromUri()

    • fromMethodAndUriAndValue

      public static <S, T> Marshaller<scala.Tuple3<HttpMethod,Uri,T>,HttpRequest> fromMethodAndUriAndValue(Marshaller<T,RequestEntity> mt)

    • fromMethodAndUriAndHeadersAndValue

      public static <T> Marshaller<scala.Tuple4<HttpMethod,Uri,scala.collection.immutable.Seq<HttpHeader>,T>,HttpRequest> fromMethodAndUriAndHeadersAndValue(Marshaller<T,RequestEntity> mt)

    • org$apache$pekko$http$scaladsl$marshalling$PredefinedToRequestMarshallers$_setter_$fromRequest_$eq

      protected abstract static void org$apache$pekko$http$scaladsl$marshalling$PredefinedToRequestMarshallers$_setter_$fromRequest_$eq(Marshaller<HttpRequest,HttpRequest> x$1)

    • apply

      public abstract scala.concurrent.Future<scala.collection.immutable.List<Marshalling<B>>> apply(A value, scala.concurrent.ExecutionContext ec)

    • map

      public <C> Marshaller<A,C> map(scala.Function1<B,C> f)

    • wrap

      public <C, D> Marshaller<C,D> wrap(MediaType newMediaType, scala.Function1<C,A> f, ContentTypeOverrider<D> mto)
      Reuses this Marshaller's logic to produce a new Marshaller from another type C which overrides the pekko.http.scaladsl.model.MediaType of the marshalling result with the given one. Note that not all wrappings are legal. f the underlying pekko.http.scaladsl.model.MediaType has constraints with regard to the charsets it allows the new pekko.http.scaladsl.model.MediaType must be compatible, since pekko-http will never recode entities. If the wrapping is illegal the Future produced by the resulting marshaller will contain a RuntimeException.
      Parameters:
      newMediaType - (undocumented)
      f - (undocumented)
      mto - (undocumented)
      Returns:
      (undocumented)

    • wrapWithEC

      public <C, D> Marshaller<C,D> wrapWithEC(MediaType newMediaType, scala.Function1<scala.concurrent.ExecutionContext,scala.Function1<C,A>> f, ContentTypeOverrider<D> cto)
      Reuses this Marshaller's logic to produce a new Marshaller from another type C which overrides the pekko.http.scaladsl.model.MediaType of the marshalling result with the given one. Note that not all wrappings are legal. f the underlying pekko.http.scaladsl.model.MediaType has constraints with regard to the charsets it allows the new pekko.http.scaladsl.model.MediaType must be compatible, since pekko-http will never recode entities. If the wrapping is illegal the Future produced by the resulting marshaller will contain a RuntimeException.
      Parameters:
      newMediaType - (undocumented)
      f - (undocumented)
      cto - (undocumented)
      Returns:
      (undocumented)

    • compose

      public <C> Marshaller<C,B> compose(scala.Function1<C,A> f)

    • composeWithEC

      public <C> Marshaller<C,B> composeWithEC(scala.Function1<scala.concurrent.ExecutionContext,scala.Function1<C,A>> f)