com.sun.xml.wss.XWSSProcessor Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of webservices-osgi Show documentation
Metro Web Services Runtime OSGi Bundle
There is a newer version: 4.0.3
/*
 * Copyright (c) 1997, 2021 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Distribution License v. 1.0, which is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */

package com.sun.xml.wss;

import com.sun.xml.wss.impl.WssSoapFaultException;
import jakarta.xml.soap.SOAPMessage;


/**
 *XWSSProcessor interface defines methods for
 *
 *     Securing an outbound SOAPMessage
 *    
 Verifying the security in an inbound SOAPMessage
 *
 *
 * An XWSSProcessor can add/verify Security in a 
 * SOAPMessage as defined by the OASIS WSS 1.0 specification.
 */
public interface XWSSProcessor {

    /**
     *  Adds Security to an outbound SOAPMessage according to
     *  the Security Policy inferred from the SecurityConfiguration
     *  with which this XWSSProcessor was initialized.
     *
     * @param  messageCntxt the SOAP ProcessingContext containing 
     *         the outgoing  SOAPMessage to be secured
     *
     * @return the resultant Secure SOAPMessage
     *
     * @exception XWSSecurityException if there was an error in securing 
     *            the message.
     */
    public  SOAPMessage secureOutboundMessage(
        ProcessingContext messageCntxt) 
        throws XWSSecurityException;

    /**
     *  Verifies Security in an inbound SOAPMessage according to
     *  the Security Policy inferred from the SecurityConfiguration
     *  with which this XWSSProcessor was initialized.
     *
     * @param  messageCntxt the SOAP ProcessingContext containing the 
     *         outgoing  SOAPMessage to be secured
     *
     * @return the resultant SOAPMessage after successful
     *         verification of security in the message
     * 
     *
     * @exception XWSSecurityException if there was an unexpected error 
     *     while verifying the message.OR if the security in the incoming     
     * message violates the Security policy that was applied to the message.
     * @exception WssSoapFaultException when security in the incoming message
     *     is in direct violation of the OASIS WSS specification. 
     *     When a WssSoapFaultException is thrown the getFaultCode() method on it
     *     will return a QName which would correspond to the 
     *     WSS defined fault.
     */
    public SOAPMessage verifyInboundMessage(
        ProcessingContext messageCntxt) 
        throws XWSSecurityException;


    /**
     * Create a Processing Context initialized with the given SOAPMessage
     * @param msg the SOAPMessage with which to initialize the ProcessingContext
     * @return  A ProcessingContext instance.
     */
    public ProcessingContext createProcessingContext(SOAPMessage msg) throws XWSSecurityException ;
}