Package com.sun.xml.ws.api.server

Class ServerPipelineHook

java.lang.Object

com.sun.xml.ws.api.server.ServerPipelineHook

Direct Known Subclasses:

ServerPipelineHook

public abstract class ServerPipelineHook
extends Object

Allow the container (primarily Glassfish) to inject their own pipes into the 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:

Kohsuke Kawaguchi

Constructor Summary

Constructors

Constructor	Description
ServerPipelineHook()

Method Summary

Modifier and Type	Method	Description
Pipe	createMonitoringPipe(ServerPipeAssemblerContext ctxt, Pipe tail)	Called during the pipeline construction process once to allow a container to register a pipe for monitoring.
Pipe	createSecurityPipe(ServerPipeAssemblerContext 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

ServerPipelineHook

public ServerPipelineHook()

Method Detail

createMonitoringPipe

@NotNull
public Pipe createMonitoringPipe(ServerPipeAssemblerContext ctxt,
                                 @NotNull
                                 Pipe tail)

Called during the pipeline construction process once to allow a container to register a pipe for monitoring. This pipe will be injected to a point very close to the transport, allowing it to measure the time it takes for processing as well as detecting errors.

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.

createSecurityPipe

@NotNull
public Pipe createSecurityPipe(ServerPipeAssemblerContext 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.