VertX Gateway Component Not Found For BufferFactoryComponentImpl

[shekarnode]

Hi Eric/Marc,

I am trying to use a custom policy in VertX gateway along with BufferFactoryComponentImpl for creating a buffer.

ApiVersion : apiman-distro-vertx-1.5.7.Final

following is the code for creating buffer:

final BufferFactoryComponentImpl bufferFactory  = context.getComponent(BufferFactoryComponentImpl.class);
private IApimanBuffer readBuffer = bufferFactory.createBuffer();

I'am getting following error.

** ERROR: Component not found: io.apiman.gateway.platforms.vertx3.components.BufferFactoryComponentImpl **
io.apiman.gateway.engine.beans.exceptions.ComponentNotFoundException: Component not found: 

io.apiman.gateway.platforms.vertx3.components.BufferFactoryComponentImpl
----------------
** ERROR: Component not found: io.apiman.gateway.platforms.vertx3.components.BufferFactoryComponentImpl **
io.apiman.gateway.engine.beans.exceptions.ComponentNotFoundException: Component not found: io.apiman.gateway.platforms.vertx3.components.BufferFactoryComponentImpl
	at io.apiman.gateway.engine.impl.ConfigDrivenComponentRegistry.createAndRegisterComponent(ConfigDrivenComponentRegistry.java:116)
	at io.apiman.gateway.engine.impl.ConfigDrivenComponentRegistry.getComponent(ConfigDrivenComponentRegistry.java:72)
	at io.apiman.gateway.engine.policy.PolicyContextImpl.getComponent(PolicyContextImpl.java:91)

[msavy]

You likely want to do:

final IBufferFactoryComponent bufferFactory = context.getComponent(IBufferFactoryComponent.class);

Does that work for you?

[msavy]

Sorry, I’m not entirely clear on which code this error pertains to.

Does the method of looking up the component I posted not work?

If not, can you please post your Vert.x Apiman Gateway JSON configuration.

[shekarnode]

Hi Marc,

Thanks for response.

My use case for custom policy :
Currently I am using apiman’s gateway as a gateway for my microservice architecture . Initially we were using zuul api gateway in which we were adding LOG ID or transaction ID for each incoming request. Also we were storing the success and failures of each request at the zuul api gateway level. We are trying to achieve similar functionality using apiman gateway. It could be either wildly or vertx . We want to add LOG ID or transaction ID to incoming input Json. Also we want to capture statistics based on response code of the end service response .

I have written one custom policy which is working fine with wildly server but similar policy when added in vertx gateway I am getting above error for POST requests or sometimes for GET requests

Old Implementation by me :
below is the previous custom policy implementation of creating bufferFactory ( which you also have mentioned in your response).

	final IBufferFactoryComponent bufferFactory = context.getComponent(IBufferFactoryComponent.class);
        private IApimanBuffer readBuffer = bufferFactory.createBuffer();

But with this implementation in vertx gateway , I m getting below error :
Error:

ERROR [vert.x-eventloop-thread-3]: Unhandled exception
java.lang.IllegalArgumentException: Chunk not of expected Vert.x Buffer type.
	at io.apiman.gateway.platforms.vertx3.connector.HttpConnector.write(HttpConnector.java:264) ~[apiman-gateway.jar:?]
	at io.apiman.gateway.engine.impl.ApiRequestExecutorImpl.lambda$null$2(ApiRequestExecutorImpl.java:289) ~[apiman-gateway.jar:?]
	at io.apiman.gateway.engine.io.AbstractStream.handleBody(AbstractStream.java:107) ~[apiman-gateway.jar:?]
	at io.apiman.gateway.engine.policy.Chain.access$000(Chain.java:48) ~[apiman-gateway.jar:?]
	at io.apiman.gateway.engine.policy.Chain$3.handle(Chain.java:122) ~[apiman-gateway.jar:?]
	at io.apiman.gateway.engine.policy.Chain$3.handle(Chain.java:118) ~[apiman-gateway.jar:?]
	at io.apiman.gateway.engine.io.AbstractStream.write(AbstractStream.java:72) ~[apiman-gateway.jar:?]
	at io.apiman.plugins.test_policy.TestPolicy$1.end(TestPolicy.java:199) ~[?:?]
	at io.apiman.gateway.engine.policy.Chain.end(Chain.java:218) ~[apiman-gateway.jar:?]
	at io.apiman.gateway.engine.impl.ApiRequestExecutorImpl$3.end(ApiRequestExecutorImpl.java:756) ~[apiman-gateway.jar:?]
	at io.apiman.gateway.platforms.vertx3.http.HttpPolicyAdapter.lambda$null$4(HttpPolicyAdapter.java:105) ~[apiman-gateway.jar:?]
	at io.vertx.core.http.impl.HttpServerRequestImpl.doEnd(HttpServerRequestImpl.java:537) ~[apiman-gateway.jar:?]
	at io.vertx.core.http.impl.HttpServerRequestImpl.handleEnd(HttpServerRequestImpl.java:526) ~[apiman-gateway.jar:?]
	at io.vertx.core.http.impl.Http1xServerConnection.handleEnd(Http1xServerConnection.java:167) ~[apiman-gateway.jar:?]
	at io.vertx.core.http.impl.Http1xServerConnection.handleContent(Http1xServerConnection.java:157) ~[apiman-gateway.jar:?]
	at io.vertx.core.http.impl.Http1xServerConnection.handleMessage(Http1xServerConnection.java:138) ~[apiman-gateway.jar:?]
	at io.vertx.core.net.impl.ConnectionBase.handleRead(ConnectionBase.java:390) ~[apiman-gateway.jar:?]
	at io.vertx.core.impl.ContextImpl.executeTask(ContextImpl.java:320) [apiman-gateway.jar:?]
	at io.vertx.core.impl.EventLoopContext.execute(EventLoopContext.java:43) [apiman-gateway.jar:?]
	at io.vertx.core.impl.ContextImpl.executeFromIO(ContextImpl.java:188) [apiman-gateway.jar:?]
	at io.vertx.core.net.impl.VertxHandler.channelRead(VertxHandler.java:174) [apiman-gateway.jar:?]
	at io.netty.channel.AbstractChannelHandlerContext.invokeChannelRead(AbstractChannelHandlerContext.java:362) [apiman-gateway.jar:?]
	at io.netty.channel.AbstractChannelHandlerContext.invokeChannelRead(AbstractChannelHandlerContext.java:348) [apiman-gateway.jar:?]
	at io.netty.channel.AbstractChannelHandlerContext.fireChannelRead(AbstractChannelHandlerContext.java:340) [apiman-gateway.jar:?]
	at io.netty.channel.ChannelInboundHandlerAdapter.channelRead(ChannelInboundHandlerAdapter.java:86) [apiman-gateway.jar:?]
	at io.netty.handler.codec.http.websocketx.extensions.WebSocketServerExtensionHandler.channelRead(WebSocketServerExtensionHandler.java:102) [apiman-gateway.jar:?]

New Implementation by me :

So , after some r&d i found that Vert.x Gateway have it's own implementation of buffer component.
Then i have update the code with below component.

final BufferFactoryComponentImpl bufferFactory  = context.getComponent(BufferFactoryComponentImpl.class);
			private IApimanBuffer readBuffer = bufferFactory.createBuffer();

For this , i m getting component not found error .

** ERROR: Component not found: io.apiman.gateway.platforms.vertx3.components.BufferFactoryComponentImpl **
io.apiman.gateway.engine.beans.exceptions.ComponentNotFoundException: Component not found: 

io.apiman.gateway.platforms.vertx3.components.BufferFactoryComponentImpl
----------------
** ERROR: Component not found: io.apiman.gateway.platforms.vertx3.components.BufferFactoryComponentImpl **
io.apiman.gateway.engine.beans.exceptions.ComponentNotFoundException: Component not found: io.apiman.gateway.platforms.vertx3.components.BufferFactoryComponentImpl
	at io.apiman.gateway.engine.impl.ConfigDrivenComponentRegistry.createAndRegisterComponent(ConfigDrivenComponentRegistry.java:116)
	at io.apiman.gateway.engine.impl.ConfigDrivenComponentRegistry.getComponent(ConfigDrivenComponentRegistry.java:72)
	at io.apiman.gateway.engine.policy.PolicyContextImpl.getComponent(PolicyContextImpl.java:91)

Below is the configuration file for vertx gateway.
Vertx Configuration File .txt

[msavy]

The first way is the correct way of accessing the buffer factory. The second is incorrect and will not work.

The issue you are seeing is usually caused by improper buffer handling elsewhere in the plugin code before you try to do the write -- basically you're trying to write something that isn't a Vert.x Buffer. You can sometimes get away with this in the servlet implementation but it'll blow up in the Vert.x gateway (for various technical reasons).

It's hard for me to know specifically without analysing your policy plugin's code.

One tip I can give is to try setting a break point here: https://github.com/apiman/apiman/blob/master/gateway/platforms/vertx3/vertx3/src/main/java/io/apiman/gateway/platforms/vertx3/connector/HttpConnector.java#L261

You can start with the --debug flag and attach your debugger as per normal. Trigger the issue and inspect chunk.getNativeBuffer() -- i.e. what class is it actually? chunk.getNativeBuffer().getClass();

It's probably a fairly simple error that you can easily remediate. For example, if you are manually instantiating a ByteBuffer instance that will not work properly on the Vert.x gateway.

[msavy]

Have you managed to resolve this? If so, please do select/tick whenever response helped so that others can quickly find the answer if they have a similar issue.

And please do share however you fixed your problem so others in the community can learn.

All the best!

[shekarnode]

Hi Marc,

Thanks for response.

I m working on debugging , once corrected and succesful.
Will update on this thread about the solution.