org.opensaml.ws.message.BaseMessageContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openws Show documentation
The OpenWS library provides a growing set of tools to work with web services at a low level. These tools include classes for creating and reading SOAP messages, transport-independent clients for connecting to web services, and various transports for use with those clients.
There is a newer version: 1.5.2
Show newest version
/*
 * 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.ws.message;

import org.opensaml.ws.message.handler.HandlerChainResolver;
import org.opensaml.ws.security.SecurityPolicyResolver;
import org.opensaml.ws.transport.InTransport;
import org.opensaml.ws.transport.OutTransport;
import org.opensaml.xml.XMLObject;
import org.opensaml.xml.util.DatatypeHelper;

/**
 * Base class for message context implementations.
 */
public class BaseMessageContext implements MessageContext {
    
    /** Unique id of the communication profile in use. */
    private String communicationProfile;

    /** The inbound message. */
    private XMLObject inboundMessage;

    /** Issuer of the inbound message. */
    private String inboundMessageIssuer;

    /** Inbound message transport. */
    private InTransport inboundTransport;

    /** Outbound message. */
    private XMLObject outboundMessage;

    /** Issuer of the outbound message. */
    private String outboundMessageIssuer;

    /** Outbound message transport. */
    private OutTransport outboundTransport;
    
    /** Resolver used to determine active security policy. */
    private SecurityPolicyResolver securityPolicyResolver;
    
    /** Pre-SecurityPolicy inbound handler chain. */
    private HandlerChainResolver preSecurityInboundHandlerChainResolver;
    
    /** Post-SecurityPolicy inbound handler chain. */
    private HandlerChainResolver postSecurityInboundHandlerChainResolver;
    
    /** Inbound handler chain. */
    private HandlerChainResolver outboundHandlerChainResolver;
    
    /** {@inheritDoc} */
    public String getCommunicationProfileId() {
        return communicationProfile;
    }
    
    /** {@inheritDoc} */
    public XMLObject getInboundMessage() {
        return inboundMessage;
    }
    
    /** {@inheritDoc} */
    public String getInboundMessageIssuer() {
        return inboundMessageIssuer;
    }
    
    /** {@inheritDoc} */
    public InTransport getInboundMessageTransport() {
        return inboundTransport;
    }
    
    /** {@inheritDoc} */
    public XMLObject getOutboundMessage() {
        return outboundMessage;
    }
    
    /** {@inheritDoc} */
    public String getOutboundMessageIssuer() {
        return outboundMessageIssuer;
    }

    /** {@inheritDoc} */
    public OutTransport getOutboundMessageTransport() {
        return outboundTransport;
    }

    /** {@inheritDoc} */
    public SecurityPolicyResolver getSecurityPolicyResolver() {
        return securityPolicyResolver;
    }

    /** {@inheritDoc} */
    public void setCommunicationProfileId(String id) {
        communicationProfile = DatatypeHelper.safeTrimOrNullString(id);
    }

    /** {@inheritDoc} */
    public void setInboundMessage(XMLObject message) {
        inboundMessage = message;
    }

    /** {@inheritDoc} */
    public void setInboundMessageIssuer(String issuer) {
        inboundMessageIssuer = issuer;
    }

    /** {@inheritDoc} */
    public void setInboundMessageTransport(InTransport transport) {
        inboundTransport = transport;
    }

    /** {@inheritDoc} */
    public void setOutboundMessage(XMLObject message) {
        outboundMessage = message;
    }

    /** {@inheritDoc} */
    public void setOutboundMessageIssuer(String issuer) {
        outboundMessageIssuer = issuer;
    }

    /** {@inheritDoc} */
    public void setOutboundMessageTransport(OutTransport transport) {
        outboundTransport = transport;
    }

    /** {@inheritDoc} */
    public void setSecurityPolicyResolver(SecurityPolicyResolver resolver) {
        securityPolicyResolver = resolver;
    }
    
    /** {@inheritDoc} */
    public boolean isIssuerAuthenticated() {
            return getInboundMessageTransport().isAuthenticated();
    }

    /** {@inheritDoc} */
    public HandlerChainResolver getPreSecurityInboundHandlerChainResolver() {
        return preSecurityInboundHandlerChainResolver;
    }
    
    /** {@inheritDoc} */
    public HandlerChainResolver getPostSecurityInboundHandlerChainResolver() {
        return postSecurityInboundHandlerChainResolver;
    }

    /** {@inheritDoc} */
    public HandlerChainResolver getOutboundHandlerChainResolver() {
        return outboundHandlerChainResolver;
    }

    /** {@inheritDoc} */
    public void setPreSecurityInboundHandlerChainResolver(HandlerChainResolver newHandlerChainResolver) {
        preSecurityInboundHandlerChainResolver = newHandlerChainResolver;
    }
    
    /** {@inheritDoc} */
    public void setPostSecurityInboundHandlerChainResolver(HandlerChainResolver newHandlerChainResolver) {
        postSecurityInboundHandlerChainResolver = newHandlerChainResolver;
    }

    /** {@inheritDoc} */
    public void setOutboundHandlerChainResolver(HandlerChainResolver newHandlerChainResolver) {
        outboundHandlerChainResolver = newHandlerChainResolver;
    }
}