Package com.sun.xml.ws.api.client

Class ClientPipelineHook

java.lang.Object

com.sun.xml.ws.api.client.ClientPipelineHook

Direct Known Subclasses:

ClientPipelineHook

public abstract class ClientPipelineHook
extends Object

Allow the container (primarily Glassfish) to inject their own pipes into the client pipeline.

This interface has a rather ad-hoc set of methods, because we didn't want to define an autonomous pipe-assembly process. (We thought this is a smaller evil compared to that.)

JAX-WS obtains this through Container.getSPI(Class).

Author:

Jitendra Kotamraju

Constructor Summary

Constructors

Constructor	Description
ClientPipelineHook()

Method Summary

Modifier and Type	Method	Description
Pipe	createSecurityPipe(ClientPipeAssemblerContext ctxt, Pipe tail)	Called during the pipeline construction process once to allow a container to register a pipe for security.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClientPipelineHook

public ClientPipelineHook()

Method Detail

createSecurityPipe

@NotNull
public Pipe createSecurityPipe(ClientPipeAssemblerContext ctxt,
                               @NotNull
                               Pipe tail)

Called during the pipeline construction process once to allow a container to register a pipe for security. This pipe will be injected to a point very close to the transport, allowing it to do some security operations.

Parameters:

ctxt - Represents abstraction of SEI, WSDL abstraction etc. Context can be used whether add a new pipe to the head or not.

tail - Head of the partially constructed pipeline. If the implementation wishes to add new pipes, it should do so by extending AbstractFilterPipeImpl and making sure that this Pipe eventually processes messages.

Returns:

The default implementation just returns tail, which means no additional pipe is inserted. If the implementation adds new pipes, return the new head pipe.