com.sun.xml.ws.api.pipe.PipelineAssemblerFactory Maven / Gradle / Ivy
/*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the License). You may not use this file except in
* compliance with the License.
*
* You can obtain a copy of the license at
* https://glassfish.dev.java.net/public/CDDLv1.0.html.
* See the License for the specific language governing
* permissions and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* Header Notice in each file and include the License file
* at https://glassfish.dev.java.net/public/CDDLv1.0.html.
* If applicable, add the following below the CDDL Header,
* with the fields enclosed by brackets [] replaced by
* you own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* Copyright 2006 Sun Microsystems Inc. All Rights Reserved
*/
package com.sun.xml.ws.api.pipe;
import com.sun.xml.ws.api.BindingID;
import com.sun.xml.ws.util.ServiceFinder;
import javax.xml.ws.soap.SOAPBinding;
import java.util.logging.Logger;
/**
* Creates {@link PipelineAssembler}.
*
*
* To create a pipeline,
* the JAX-WS runtime locates {@link PipelineAssemblerFactory}s through
* the META-INF/services/com.sun.xml.ws.api.pipe.PipelineAssemblerFactory files.
* Factories found are checked to see if it supports the given binding ID one by one,
* and the first valid {@link PipelineAssembler} returned will be used to create
* a pipeline.
*
*
* TODO: is bindingId really extensible? for this to be extensible,
* someone seems to need to hook into WSDL parsing.
*
*
* TODO: JAX-WSA might not define its own binding ID -- it may just go to an extension element
* of WSDL. So this abstraction might need to be worked on.
*
* @author Kohsuke Kawaguchi
* @deprecated
* Use {@link TubelineAssemblerFactory} instead.
*/
public abstract class PipelineAssemblerFactory {
/**
* Creates a {@link PipelineAssembler} applicable for the given binding ID.
*
* @param bindingId
* The binding ID for which a pipeline will be created,
* such as {@link SOAPBinding#SOAP11HTTP_BINDING}.
* Must not be null.
*
* @return
* null if this factory doesn't recognize the given binding ID.
*/
public abstract PipelineAssembler doCreate(BindingID bindingId);
/**
* Locates {@link PipelineAssemblerFactory}s and create
* a suitable {@link PipelineAssembler}.
*
* @param bindingId
* The binding ID string for which the new {@link PipelineAssembler}
* is created. Must not be null.
* @return
* Always non-null, since we fall back to our default {@link PipelineAssembler}.
*/
public static PipelineAssembler create(ClassLoader classLoader, BindingID bindingId) {
for (PipelineAssemblerFactory factory : ServiceFinder.find(PipelineAssemblerFactory.class,classLoader)) {
PipelineAssembler assembler = factory.doCreate(bindingId);
if(assembler!=null) {
logger.fine(factory.getClass()+" successfully created "+assembler);
return assembler;
}
}
// default binding IDs that are known
// TODO: replace this with proper ones
return new com.sun.xml.ws.util.pipe.StandalonePipeAssembler();
}
private static final Logger logger = Logger.getLogger(PipelineAssemblerFactory.class.getName());
}