All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.sun.xml.ws.api.pipe.PipelineAssembler Maven / Gradle / Ivy

There is a newer version: 4.0.3
Show newest version
/*
 * Copyright (c) 1997, 2021 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.xml.ws.api.model.SEIModel;
import com.sun.istack.NotNull;

import jakarta.xml.ws.Dispatch;
import jakarta.xml.ws.Service;
import jakarta.xml.ws.WebServiceException;

/**
 * Creates a pipeline.
 *
 * 

* This pluggability layer enables the upper layer to * control exactly how the pipeline 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 PipelineAssemblerFactory} for how {@link PipelineAssembler}s * are located. * *

* TODO: the JAX-WS team felt that no {@link Pipe} should be relying * on the {@link SEIModel}, so it is no longer given to the assembler. * Talk to us if you need it. * * @see ClientPipeAssemblerContext * * @author Kohsuke Kawaguchi */ public interface PipelineAssembler { /** * Creates a new pipeline for clients. * *

* When a JAX-WS client creates a proxy or a {@link Dispatch} from * a {@link Service}, JAX-WS runtime internally uses this method * to create a new pipeline as a part of the initilization. * * @param context * Object that captures various contextual information * that can be used to determine the pipeline to be assembled. * * @return * non-null freshly created pipeline. * * @throws WebServiceException * if there's any configuration error that prevents the * pipeline from being constructed. This exception will be * propagated into the application, so it must have * a descriptive error. */ @NotNull Pipe createClient(@NotNull ClientPipeAssemblerContext context); /** * Creates a new pipeline for servers. * *

* When a JAX-WS server deploys a new endpoint, it internally * uses this method to create a new pipeline as a part of the * initialization. * *

* Note that this method is called only once to set up a * 'master pipeline', and it gets {@link Pipe#copy(PipeCloner) copied} * from it. * * @param context * Object that captures various contextual information * that can be used to determine the pipeline to be assembled. * * @return * non-null freshly created pipeline. * * @throws WebServiceException * if there's any configuration error that prevents the * pipeline from being constructed. This exception will be * propagated into the container, so it must have * a descriptive error. * */ @NotNull Pipe createServer(@NotNull ServerPipeAssemblerContext context); }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy