com.sun.xml.ws.api.pipe.TubelineAssembler Maven / Gradle / Ivy
Show all versions of webservices-rt Show documentation
/*
* Copyright (c) 1997, 2018 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Distribution License v. 1.0, which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
package com.sun.xml.ws.api.pipe;
import com.sun.istack.NotNull;
/**
* Creates a tubeline.
*
*
* This pluggability layer enables the upper layer to
* control exactly how the tubeline is composed.
*
*
* JAX-WS is going to have its own default implementation
* when used all by itself, but it can be substituted by
* other implementations.
*
*
* See {@link TubelineAssemblerFactory} for how {@link TubelineAssembler}s
* are located.
*
*
* @see com.sun.xml.ws.api.pipe.ClientTubeAssemblerContext
*
* @author Kohsuke Kawaguchi
* @author Jitendra Kotamraju
*/
public interface TubelineAssembler {
/**
* Creates a new tubeline for clients.
*
*
* When a JAX-WS client creates a proxy or a {@link javax.xml.ws.Dispatch} from
* a {@link javax.xml.ws.Service}, JAX-WS runtime internally uses this method
* to create a new tubeline as a part of the initilization.
*
* @param context
* Object that captures various contextual information
* that can be used to determine the tubeline to be assembled.
*
* @return
* non-null freshly created tubeline.
*
* @throws javax.xml.ws.WebServiceException
* if there's any configuration error that prevents the
* tubeline from being constructed. This exception will be
* propagated into the application, so it must have
* a descriptive error.
*/
@NotNull Tube createClient(@NotNull ClientTubeAssemblerContext context);
/**
* Creates a new tubeline for servers.
*
*
* When a JAX-WS server deploys a new endpoint, it internally
* uses this method to create a new tubeline as a part of the
* initialization.
*
*
* Note that this method is called only once to set up a
* 'master tubeline', and it gets {@link Tube#copy(TubeCloner) copied}
* from it.
*
* @param context
* Object that captures various contextual information
* that can be used to determine the tubeline to be assembled.
*
* @return
* non-null freshly created tubeline.
*
* @throws javax.xml.ws.WebServiceException
* if there's any configuration error that prevents the
* tubeline from being constructed. This exception will be
* propagated into the container, so it must have
* a descriptive error.
*
*/
@NotNull Tube createServer(@NotNull ServerTubeAssemblerContext context);
}