Glassfish example source code file (MessageLayerClientHandler.java)

This example Glassfish source code file (MessageLayerClientHandler.java) is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" ^TM.

Java - Glassfish tags/keywords

clientauthconfig, clientauthcontext, clientauthcontext, clienthandler, handler, jaxrpcexception, jaxrpcexception, log, logging, messagelayerclienthandler, qname, soapmessagecontext, soapmessagecontext, string, string, wss

The Glassfish MessageLayerClientHandler.java source code

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2010 Oracle and/or its affiliates. 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_1_1.html
 * or packager/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 packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [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.
 */

/*
 * ClientWSSHandler.java
 *
 * Created on June 1, 2004, 11:46 AM
 */

package com.sun.enterprise.security.webservices;

import com.sun.enterprise.security.SecurityServicesUtil;
import javax.xml.rpc.handler.Handler;
import javax.xml.rpc.handler.MessageContext;
import javax.xml.rpc.handler.soap.SOAPMessageContext;
import javax.xml.rpc.JAXRPCException;
import javax.xml.namespace.QName;
import javax.xml.soap.SOAPMessage;
import java.util.logging.*;

//security apis
import com.sun.enterprise.security.jauth.*;
import com.sun.enterprise.security.jmac.provider.ClientAuthConfig;
import com.sun.logging.*;

/**
 * Client Side Handler to be invoked from the appclient
 * A similiar copy sans appserver specific logging mechanism should be made available
 * to standalone clients to use our
 * WSS infrastructure.
 * @author Harpreet Singh
 * @version
 * @since
 */
public class MessageLayerClientHandler implements Handler {

    private static Logger _logger=null;
    static {
        _logger = LogDomains.getLogger(MessageLayerClientHandler.class, LogDomains.SECURITY_LOGGER);
    }

    // key to ClientAuthConfig in HandlerInfo
    public static final String CLIENT_AUTH_CONFIG = 
	"com.sun.enterprise.security.jmac.provider.ClientAuthConfig";

    // key to ClientAuthContext in SOAPMessageCOntext
    private static final String CLIENT_AUTH_CONTEXT = 
	"com.sun.enterprise.security.jauth.ClientAuthContext";

    private static String errMsg =
	"Client WSS Handler: MessageContext not of type SOAPMessageContext";

    private ClientAuthConfig config_ = null;

    private QName qname[] = null;

    private boolean isAppclientContainer = false;

    private QName serviceName = null;

    /** Creates a new instance of MessageLayerClientHandler */
    public MessageLayerClientHandler() {
	if(SecurityServicesUtil.getInstance().isACC()){
		isAppclientContainer = true;
	} else{
		isAppclientContainer = false;
	}
    }
    
    public boolean handleFault(MessageContext messageContext) {
        // no need to do any special processing
        if(_logger.isLoggable(Level.FINE)){
            _logger.log(Level.FINE, "wss-auth-client: ClientHandler does not handle" +
            " SOAP faults");
        }
        return true;
    }
    
    public boolean handleRequest(MessageContext messageContext) {
        if(!isSoapMessageContext(messageContext)){
            // cannot process this, as this is not a soap message context
            throw new JAXRPCException(errMsg);
        }
	if (config_ == null) {
	    return true;
	} 
	  
        // get the ClientAuthContext
	SOAPMessageContext smc = (SOAPMessageContext) messageContext;
	SOAPMessage request = smc.getMessage();
	ClientAuthContext cAC = config_.getAuthContext(null,request);
	if (cAC == null) {
	    return true;
	} 

	smc.setProperty(CLIENT_AUTH_CONTEXT, cAC);
	smc.setProperty(javax.xml.ws.handler.MessageContext.WSDL_SERVICE,
            serviceName);

        try{
	    WebServiceSecurity.secureRequest(smc,cAC,isAppclientContainer);
        } catch(Exception e){
            if (_logger.isLoggable(Level.WARNING)){
                _logger.log(Level.WARNING, "ws.error_secure_request", e);
            }
            throw new JAXRPCException(e);
        }
        return true;
    }
    
    public boolean handleResponse(MessageContext messageContext) {
        boolean retValue;
        if(!isSoapMessageContext(messageContext)){
            // cannot process this, as this is not a soap message context
            throw new JAXRPCException(errMsg);
        }
	if (config_ == null) {
	    return true;
	} 

        // get the ClientAuthContext
        SOAPMessageContext smc = (SOAPMessageContext) messageContext;
	ClientAuthContext cAC = 
	    (ClientAuthContext) smc.getProperty(CLIENT_AUTH_CONTEXT);
	if (cAC == null) {
	    return true;
	} 

        try{
	    retValue = WebServiceSecurity.validateResponse(smc,cAC);
        }catch(Exception e){
            if (_logger.isLoggable(Level.WARNING)){
                _logger.log(Level.WARNING, "ws.error_validate_response", e);
            }
            throw new JAXRPCException(e);
        }
        
        return retValue;
    }
    
    // if headers contains the list of understood headers, then we need to make
    // sure that wsse is included; although if so, we need a way to make sure
    // that the provider honors this commitment.
    public javax.xml.namespace.QName[] getHeaders() {
        return qname;
    }
    
    public void destroy() {
        qname = null;
    }
    
    public void init(javax.xml.rpc.handler.HandlerInfo info) {
        // 109 mandates saving qnames in init
        qname = info.getHeaders();
	config_ = (ClientAuthConfig) info.getHandlerConfig().get(CLIENT_AUTH_CONFIG);
        serviceName = (QName)info.getHandlerConfig().get(javax.xml.ws.handler.MessageContext.WSDL_SERVICE);
    }

    /** 109 mandates that each MessageContext be checked to see if it is a
     * a SOAPMessageContext and whether the handler processes it
     */
    private boolean isSoapMessageContext(MessageContext mc){
        boolean retValue =
        (mc instanceof SOAPMessageContext)? true: false;
        if(!retValue && _logger.isLoggable(Level.WARNING)){
            _logger.log(Level.WARNING, "ws.error_not_soap");
        }
        return retValue;
    }

}