com.sun.xml.ws.security.policy.Binding Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wsit-impl Show documentation

This module contains the Metro WSIT runtime code.

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;


/**
 * Base Interface for Security Policy Binding assertions, identifies Algorithms that are supported,describes the layout of
 * the security header.
 * @author [email protected]
 */
public interface Binding{

    String ENCRYPT_SIGN = "EncryptBeforeSigning";
    String SIGN_ENCRYPT = "SignBeforeEncrypting";

    /**
     * returns the {@link AlgorithmSuite} assertions defined in the policy.
     * @return {@link AlgorithmSuite}
     */
    AlgorithmSuite getAlgorithmSuite();

    /**
     * returns true if TimeStamp property is enabled in this binding
     * @return true or false
     */
    boolean isIncludeTimeStamp();


    boolean isDisableTimestampSigning();

    /**
     * returns the Layout {@link MessageLayout }of  the SecurityHeader.
     * @return one of {@link MessageLayout }
     */
    MessageLayout getLayout();
    /**
     * returns true if body and header content only has to be signed, false if entire body and header has to be signed.
     * @return true if body and header content only has to be signed, false if entire body and header has to be signed.
     */
    boolean isSignContent();


    /**
     * gets data protection order should be one one of Binding.SIGN_ENCRYPT or Binding.ENCRYPT_SIGN
     * @return one of Binding.SIGN_ENCRYPT or Binding.ENCRYPT_SIGN
     */
    String getProtectionOrder();


    /**
     *
     * @return true if token has to be protected else false.
     */
    boolean getTokenProtection();

    /**
     *
     * @return true if signature has to be encrypted else false.
     */
    boolean getSignatureProtection();

    /**
     *
     * @return the version of Security Policy
     */
    SecurityPolicyVersion getSecurityPolicyVersion();
}