com.sun.xml.ws.client.HandlerConfiguration 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.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;
}
}