com.sun.xml.wss.impl.policy.spi.PolicyVerifier Maven / Gradle / Ivy

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.wss.impl.policy.spi;

import com.sun.xml.wss.impl.PolicyViolationException;
import com.sun.xml.wss.impl.policy.SecurityPolicy;

/**
 * This is an internal interface not exposed to developer.
 *
 * @author [email protected]
 */

public interface PolicyVerifier {

    /**
     * A concrete PolicyVerifier can indicate to the runtime the
     * ID of the alternative that satisfied the incoming request's
     * policy.
     *
     * The ID is then used by the runtime to get the correct response policy for
     * securing the response messages.
     */
    String POLICY_ALTERNATIVE_ID="policy-alternative-id";
    /**
     *
     * @param configPolicy Policy configured for the incoming message, can be
     * a single MessagePolicy or PolicyAlternatives.
     * @param recvdPolicy policy inferred from the incoming message.
     * @throws PolicyViolationException when policy inferred from incoming message does not match with what
     * is configured.
     *
     */
    void verifyPolicy(SecurityPolicy recvdPolicy, SecurityPolicy configPolicy)throws PolicyViolationException;
}