com.sun.xml.ws.security.policy.EncryptedParts 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

The newest version!

/*
 * Copyright (c) 1997, 2022 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.ws.security.policy;

import java.util.Iterator;

/**
 * Identifies targets that if present in the message should be confidentiality protected.
 *
 *  {@code
 *   
 *      <sp:EncryptedParts ... >
 *          <sp:Body/>?
 *          <sp:Header Name="xs:NCName"? Namespace="xs:anyURI" ... />*
 *              ...
 *      </sp:EncryptedParts>
 *    
 *   }
 * @author [email protected]
 */
public interface EncryptedParts extends Target {

    /**
     *
     * @return true if the body is part of the target list.
     */
    boolean hasBody();

    /**
     *
     * @return true if attachments are part of the target list.
     */
    boolean hasAttachments();

    /**
     * returns list of SOAP Headers that need to protected.
     * @return {@link java.util.Iterator} over the list of SOAP Headers
     */
    Iterator getTargets();


    /**
     * removes SOAP Body from the list of targets to be confidentiality protected.
     */
    void removeBody();
}