Package io.vertx.httpproxy
Interface BodyTransformers
-
public interface BodyTransformersRange of transformers ready to be used.
-
-
Field Summary
Fields Modifier and Type Field Description static longDEFAULT_MAX_BUFFERED_SIZEThe default maximum amount of bytes synchronous transformers apply
-
Method Summary
Static Methods Modifier and Type Method Description static BodyTransformerdiscard()Create a transformer that discards the body, the transformer consumes any media type.static BodyTransformerjsonArray(long maxBufferedBytes, Function<JsonArray,JsonArray> transformer)Create a body transformer that transforms JSON array to JSON array, the transformer consumes and producesapplication/json.static BodyTransformerjsonArray(Function<JsonArray,JsonArray> transformer)LikejsonArray(long, Function)withDEFAULT_MAX_BUFFERED_SIZEmaximum buffered bytes.static BodyTransformerjsonObject(long maxBufferedBytes, Function<JsonObject,JsonObject> transformer)Create a body transformer that transforms JSON object to JSON object, the transformer consumes and producesapplication/json.static BodyTransformerjsonObject(Function<JsonObject,JsonObject> transformer)LikejsonObject(long, Function)withDEFAULT_MAX_BUFFERED_SIZEmaximum buffered bytes.static BodyTransformerjsonValue(long maxBufferedBytes, Function<Object,Object> transformer)Create a body transformer that transforms JSON value to JSON value, the transformer consumes and producesapplication/json.static BodyTransformerjsonValue(Function<Object,Object> transformer)LikejsonValue(long, Function)withDEFAULT_MAX_BUFFERED_SIZEmaximum buffered bytes.static BodyTransformertext(long maxBufferedBytes, Function<String,String> transformer, String encoding)Create a transformer that transforms text to text, the transformer consumes and producestext/plain.static BodyTransformertext(Function<String,String> transformer, String encoding)Liketext(long, Function, String)withDEFAULT_MAX_BUFFERED_SIZEmaximum buffered bytes.static BodyTransformertransform(MediaType consumes, MediaType produces, long maxBufferedBytes, Function<Buffer,Buffer> transformer)Create a body transformer that transformsconsumesmedia type to theproducesmedia type, by applying thetransformerfunction.static BodyTransformertransform(MediaType consumes, MediaType produces, Function<Buffer,Buffer> transformer)Liketransform(MediaType, MediaType, long, Function)withDEFAULT_MAX_BUFFERED_SIZEmaximum buffered bytes.
-
-
-
Field Detail
-
DEFAULT_MAX_BUFFERED_SIZE
static final long DEFAULT_MAX_BUFFERED_SIZE
The default maximum amount of bytes synchronous transformers apply- See Also:
- Constant Field Values
-
-
Method Detail
-
transform
static BodyTransformer transform(MediaType consumes, MediaType produces, Function<Buffer,Buffer> transformer)
Liketransform(MediaType, MediaType, long, Function)withDEFAULT_MAX_BUFFERED_SIZEmaximum buffered bytes.
-
transform
static BodyTransformer transform(MediaType consumes, MediaType produces, long maxBufferedBytes, Function<Buffer,Buffer> transformer)
Create a body transformer that transforms
consumesmedia type to theproducesmedia type, by applying thetransformerfunction.The transformer buffers up to
maxBufferedBytesand then apply thetransformerfunction. When the body exceeds the limit, the transformes signal an error and fail the transformation.- Parameters:
consumes- the consumed media typeproduces- the produced media typemaxBufferedBytes- the maximum amount of bytes buffered by the body transformertransformer- the transformer- Returns:
- the body transformer
-
jsonObject
static BodyTransformer jsonObject(long maxBufferedBytes, Function<JsonObject,JsonObject> transformer)
Create a body transformer that transforms JSON object to JSON object, the transformer consumes and producesapplication/json.- Parameters:
maxBufferedBytes- the maximum amount of bytes buffered by the body transformertransformer- the transformer function- Returns:
- the transformer instance
-
jsonObject
static BodyTransformer jsonObject(Function<JsonObject,JsonObject> transformer)
LikejsonObject(long, Function)withDEFAULT_MAX_BUFFERED_SIZEmaximum buffered bytes.
-
jsonArray
static BodyTransformer jsonArray(long maxBufferedBytes, Function<JsonArray,JsonArray> transformer)
Create a body transformer that transforms JSON array to JSON array, the transformer consumes and producesapplication/json.- Parameters:
maxBufferedBytes- the maximum amount of bytes buffered by the body transformertransformer- the transformer function- Returns:
- the transformer instance
-
jsonArray
static BodyTransformer jsonArray(Function<JsonArray,JsonArray> transformer)
LikejsonArray(long, Function)withDEFAULT_MAX_BUFFERED_SIZEmaximum buffered bytes.
-
jsonValue
static BodyTransformer jsonValue(long maxBufferedBytes, Function<Object,Object> transformer)
Create a body transformer that transforms JSON value to JSON value, the transformer consumes and producesapplication/json.- Parameters:
maxBufferedBytes- the maximum amount of bytes buffered by the body transformertransformer- the transformer function- Returns:
- the transformer instance
-
jsonValue
static BodyTransformer jsonValue(Function<Object,Object> transformer)
LikejsonValue(long, Function)withDEFAULT_MAX_BUFFERED_SIZEmaximum buffered bytes.
-
text
static BodyTransformer text(long maxBufferedBytes, Function<String,String> transformer, String encoding)
Create a transformer that transforms text to text, the transformer consumes and producestext/plain.- Parameters:
maxBufferedBytes- the maximum amount of bytes buffered by the body transformertransformer- the transformer function- Returns:
- the transformer instance
-
text
static BodyTransformer text(Function<String,String> transformer, String encoding)
Liketext(long, Function, String)withDEFAULT_MAX_BUFFERED_SIZEmaximum buffered bytes.
-
discard
static BodyTransformer discard()
Create a transformer that discards the body, the transformer consumes any media type.- Returns:
- the transformer instance
-
-