org.opensaml.soap.wsaddressing.messaging.impl.AddMessageIDHandler Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of opensaml-soap-impl Show documentation
There is a newer version: 4.0.1
/*
 * Licensed to the University Corporation for Advanced Internet Development, 
 * Inc. (UCAID) under one or more contributor license agreements.  See the 
 * NOTICE file distributed with this work for additional information regarding
 * copyright ownership. The UCAID 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.opensaml.soap.wsaddressing.messaging.impl;

import java.util.UUID;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import net.shibboleth.utilities.java.support.component.ComponentSupport;
import net.shibboleth.utilities.java.support.security.IdentifierGenerationStrategy;

import org.opensaml.core.xml.util.XMLObjectSupport;
import org.opensaml.messaging.context.MessageContext;
import org.opensaml.messaging.handler.MessageHandlerException;
import org.opensaml.soap.messaging.AbstractHeaderGeneratingMessageHandler;
import org.opensaml.soap.messaging.SOAPMessagingSupport;
import org.opensaml.soap.wsaddressing.MessageID;
import org.opensaml.soap.wsaddressing.messaging.WSAddressingContext;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Handler implementation that adds a wsa:MessageID header to the outbound SOAP envelope.
 * 
 * 
 * The value from {@link WSAddressingContext#getMessageIDURI()} will be used, if present. If not,
 * then the value generated via the locally-configured strategy {@link #getIdentifierGenerationStrategy()}
 * will be used. If neither of those sources are available, then a random "urn:uuid:..." URI value will be
 * generated internally using {@link UUID}.
 * 
 */
public class AddMessageIDHandler extends AbstractHeaderGeneratingMessageHandler {
    
    /** Logger. */
    private Logger log = LoggerFactory.getLogger(AddMessageIDHandler.class);
    
    /** Strategy for generating identifiers. */
    private IdentifierGenerationStrategy identifierGenerationStrategy;
    
    /**
     * Get the identifier generation strategy.
     * 
     * @return the strategy, or null
     */
    @Nullable public IdentifierGenerationStrategy getIdentifierGenerationStrategy() {
        return identifierGenerationStrategy;
    }

    /**
     * Set the identifier generation strategy.
     * 
     * @param strategy the new strategy
     */
    public void setIdentifierGenerationStrategy(@Nullable final IdentifierGenerationStrategy strategy) {
        ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
        ComponentSupport.ifDestroyedThrowDestroyedComponentException(this);
        identifierGenerationStrategy = strategy;
    }

    /** {@inheritDoc} */
    protected void doInvoke(@Nonnull final MessageContext messageContext) throws MessageHandlerException {
        String id = getMessageID(messageContext);
        log.debug("Issuing WS-Addressing MessageID: {}", id);
        MessageID messageID = (MessageID) XMLObjectSupport.buildXMLObject(MessageID.ELEMENT_NAME);
        messageID.setValue(id);
        decorateGeneratedHeader(messageContext, messageID);
        SOAPMessagingSupport.addHeaderBlock(messageContext, messageID);
    }

    /**
     * Get the effective message ID value to issue in the outbound message. 
     * 
     * @param messageContext the current message context
     * 
     * @return the retrieved or generated message ID
     */
    @Nonnull protected String getMessageID(MessageContext messageContext) {
        WSAddressingContext addressing = messageContext.getSubcontext(WSAddressingContext.class, false);
        if (addressing != null && addressing.getMessageIDURI() != null) {
            return addressing.getMessageIDURI();
        } else if (getIdentifierGenerationStrategy() != null) {
            return getIdentifierGenerationStrategy().generateIdentifier(false);
        } else {
            return "urn:uuid:" + UUID.randomUUID().toString();
        }
    }
    
}