Axis 2 example source code file (AddressingValidationHandler.java)

This example Axis 2 source code file (AddressingValidationHandler.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 - Axis 2 tags/keywords

abstracthandler, addressingfaultshelper, addressingfaultshelper, addressingvalidationhandler, anonymous, axisfault, axisfault, axisoperation, endpointreference, endpointreference, invocationresponse, string, string, usingaddressing

The Axis 2 AddressingValidationHandler.java source code

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.axis2.handlers.addressing;

import org.apache.axis2.AxisFault;
import org.apache.axis2.addressing.AddressingConstants;
import org.apache.axis2.addressing.AddressingFaultsHelper;
import org.apache.axis2.addressing.AddressingHelper;
import org.apache.axis2.addressing.EndpointReference;
import org.apache.axis2.context.MessageContext;
import org.apache.axis2.description.AxisOperation;
import org.apache.axis2.handlers.AbstractHandler;
import org.apache.axis2.util.JavaUtils;
import org.apache.axis2.util.Utils;
import org.apache.axis2.wsdl.WSDLConstants;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

public class AddressingValidationHandler extends AbstractHandler implements AddressingConstants {

    private static final Log log = LogFactory.getLog(AddressingValidationHandler.class);

    /* (non-Javadoc)
    * @see org.apache.axis2.engine.Handler#invoke(org.apache.axis2.context.MessageContext)
    */
    public InvocationResponse invoke(MessageContext msgContext) throws AxisFault {
        Object flag = msgContext.getProperty(IS_ADDR_INFO_ALREADY_PROCESSED);
        if (log.isTraceEnabled()) {
            log.trace("invoke: IS_ADDR_INFO_ALREADY_PROCESSED=" + flag);
        }

        if (JavaUtils.isTrueExplicitly(flag)) {
            // If no AxisOperation has been found at the end of the dispatch phase and addressing
            // is in use we should throw an ActionNotSupported Fault, unless we've been told
            // not to do this check (by Synapse, for instance)
            if (JavaUtils.isTrue(msgContext.getProperty(ADDR_VALIDATE_ACTION), true)) {
                checkAction(msgContext);

                // Check if the wsa:MessageID is required or not.
                checkMessageIDHeader(msgContext);
            }

            // Check that if anonymous flag is in effect that the replyto and faultto are valid
            //checkAnonymous(msgContext);
        }

        if (JavaUtils.isFalseExplicitly(flag)) {
            // Check that if wsaddressing=required that addressing headers were found inbound
            checkUsingAddressing(msgContext);
        }

        return InvocationResponse.CONTINUE;
    }

    /**
     * Check that if the wsaddressing="required" attribute exists on the service definition or
     * <wsaw:UsingAddressing wsdl:required="true" /> was found in the WSDL that WS-Addressing
     * headers were found on the inbound message
     */
    private void checkUsingAddressing(MessageContext msgContext)
            throws AxisFault {
        if (msgContext.getAxisService() == null) {
            if (log.isTraceEnabled()) {
                log.trace("checkUsingAddressing: axisService null, cannot check UsingAddressing");
            }
            return;
        }
        String addressingFlag = msgContext.getAxisService().getWSAddressingFlag();
        if (log.isTraceEnabled()) {
            log.trace("checkUsingAddressing: WSAddressingFlag=" + addressingFlag);
        }
        if (AddressingConstants.ADDRESSING_REQUIRED.equals(addressingFlag)) {
            AddressingFaultsHelper.triggerMessageAddressingRequiredFault(msgContext,
                                                                         AddressingConstants.WSA_ACTION);
        }
    }

    /**
     * Check that if a wsaw:Anonymous value was set on the AxisOperation that the values in the
     * ReplyTo+FaultTo are valid and fault if not.
     */
    private void checkAnonymous(MessageContext msgContext) throws AxisFault {
        String anonymous =
                AddressingHelper.getAnonymousParameterValue(msgContext.getAxisOperation());
        if (log.isTraceEnabled()) {
            log.trace("checkAnonymous: Anonymous=" + anonymous);
        }
        if ("required".equals(anonymous)) {
            if (AddressingHelper.isReplyRedirected(msgContext)) {
                EndpointReference anonEPR =
                        new EndpointReference(AddressingConstants.Final.WSA_ANONYMOUS_URL);
                msgContext.setReplyTo(anonEPR);
                msgContext.setFaultTo(anonEPR);
                AddressingFaultsHelper.triggerOnlyAnonymousAddressSupportedFault(msgContext,
                                                                                 AddressingConstants.WSA_REPLY_TO);
            }
            if (AddressingHelper.isFaultRedirected(msgContext)) {
                EndpointReference anonEPR =
                        new EndpointReference(AddressingConstants.Final.WSA_ANONYMOUS_URL);
                msgContext.setReplyTo(anonEPR);
                msgContext.setFaultTo(anonEPR);
                AddressingFaultsHelper.triggerOnlyAnonymousAddressSupportedFault(msgContext,
                                                                                 AddressingConstants.WSA_FAULT_TO);
            }
        } else if ("prohibited".equals(anonymous)) {
            if (!AddressingHelper.isReplyRedirected(msgContext)) {
                AddressingFaultsHelper.triggerOnlyNonAnonymousAddressSupportedFault(msgContext,
                                                                                    AddressingConstants.WSA_REPLY_TO);
            }
            if (!AddressingHelper.isFaultRedirected(msgContext)) {
                AddressingFaultsHelper.triggerOnlyNonAnonymousAddressSupportedFault(msgContext,
                                                                                    AddressingConstants.WSA_FAULT_TO);
            }
        }
    }

    /**
     * If addressing was found and the dispatch failed we SHOULD (and hence will) return a
     * WS-Addressing ActionNotSupported fault. This will make more sense once the
     * AddressingBasedDsipatcher is moved into the addressing module
     */
    private void checkAction(MessageContext msgContext) throws AxisFault {
        if ((msgContext.getAxisService() == null) || (msgContext.getAxisOperation() == null)) {
            AddressingFaultsHelper
                    .triggerActionNotSupportedFault(msgContext, msgContext.getWSAAction());
        }
    }

    /**
     * Validate that a message id is present when required. The check applied here only applies to
     * WS-Addressing headers that comply with the 2005/08 (final) spec.
     *
     * @param msgContext
     * @throws AxisFault
     * @see AddressingSubmissionInHandler#checkForMandatoryHeaders
     */
    private void checkMessageIDHeader(MessageContext msgContext) throws AxisFault {
        String namespace = (String)msgContext.getProperty(WS_ADDRESSING_VERSION);
        if (!Final.WSA_NAMESPACE.equals(namespace)) {
            return;
        }

        AxisOperation axisOperation = msgContext.getAxisOperation();
        String mep = axisOperation.getMessageExchangePattern();
        int mepConstant = Utils.getAxisSpecifMEPConstant(mep);

        if (mepConstant == WSDLConstants.MEP_CONSTANT_IN_OUT ||
                mepConstant == WSDLConstants.MEP_CONSTANT_IN_OPTIONAL_OUT ||
                mepConstant == WSDLConstants.MEP_CONSTANT_ROBUST_IN_ONLY) {
            String messageId = msgContext.getOptions().getMessageId();
            if (messageId == null || "".equals(messageId)) {
                AddressingFaultsHelper
                        .triggerMessageAddressingRequiredFault(msgContext, WSA_MESSAGE_ID);
            }
        }
    }
}