com.sun.xml.ws.client.HandlerConfiguration Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, 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/CDDL+GPL.html
* or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [year]
* [name of copyright owner]"
*
* Contributor(s):
*
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.xml.ws.client;
import javax.xml.namespace.QName;
import javax.xml.ws.handler.Handler;
import javax.xml.ws.handler.LogicalHandler;
import javax.xml.ws.handler.soap.SOAPHandler;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
/**
* This class holds the handler information on the BindingProvider.
* HandlerConfiguration is immutable, and a new object is created
* when the BindingImpl is created or User calls Binding.setHandlerChain() or
* SOAPBinding.setRoles()
* During inovcation in Stub.process(), snapshot of the handler configuration is set in
* Packet.handlerConfig
* The information in the HandlerConfiguration is used by MUPipe and HandlerTube
* implementations.
*
* @author Rama Pulavarthi
*/
public class HandlerConfiguration {
private final Set roles;
/**
* This chain may contain both soap and logical handlers.
*/
private final List handlerChain;
private final List logicalHandlers;
private final List soapHandlers;
private Set knownHeaders;
private Set handlerKnownHeaders;
/**
* @param roles This contains the roles assumed by the Binding implementation.
* @param portKnownHeaders This contains the headers that are bound to the current WSDL Port
* @param handlerChain This contains the handler chain set on the Binding
* @param logicalHandlers
* @param soapHandlers
* @param handlerKnownHeaders The set is comprised of headers returned from SOAPHandler.getHeaders()
* method calls.
*/
public HandlerConfiguration(Set roles, Set portKnownHeaders,
List handlerChain,
List logicalHandlers, List soapHandlers,
Set handlerKnownHeaders) {
this.roles = roles;
this.handlerChain = handlerChain;
this.logicalHandlers = logicalHandlers;
this.soapHandlers = soapHandlers;
this.handlerKnownHeaders = handlerKnownHeaders;
this.knownHeaders = new HashSet();
if(portKnownHeaders != null)
knownHeaders.addAll(portKnownHeaders);
if(handlerKnownHeaders != null)
knownHeaders.addAll(handlerKnownHeaders);
}
public Set getRoles() {
return roles;
}
/**
*
* @return return a copy of handler chain
*/
public List getHandlerChain() {
if(handlerChain == null)
return Collections.emptyList();
return new ArrayList(handlerChain);
}
public List getLogicalHandlers() {
return logicalHandlers;
}
public List getSoapHandlers() {
return soapHandlers;
}
public Set getKnownHeaders() {
return knownHeaders;
}
public Set getHandlerKnownHeaders() {
return handlerKnownHeaders;
}
}