/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package com.sun.xml.internal.ws.policy.spi;

import com.sun.xml.internal.ws.policy.PolicyAssertion;

/**

 *

 *

 * @author Marek Potociar (marek.potociar at sun.com)

 */

public interface PolicyAssertionValidator {

    public static enum Fitness {

        UNKNOWN,

        INVALID,

        UNSUPPORTED,

        SUPPORTED;

        public Fitness combine(Fitness other) {

            if (this.compareTo(other) < 0) {

                return other;

            } else {

                return this;

            }

        }

    }

    /**

     * An implementation of this method must return:

     * <ul>

     *      <li>

     *          {@code Fitness.UNKNOWN} if the policy assertion type is not recognized

     *      </li>

     *      <li>

     *          {@code Fitness.SUPPORTED} if the policy assertion is supported in the

     *          client-side context

     *      </li>

     *      <li>

     *          {@code Fitness.UNSUPPORTED} if the policy assertion is recognized however

     *          it's content is not supported. For each assetion that will be eventually marked with

     *          this validation value, the policy processor will log a WARNING message however

     *          an attempt to call the web service will be made.

     *      </li>

     *      <li>

     *          {@code Fitness.INVALID} if the policy assertion is recognized however

     *          its content (value, parameters, nested assertions) is invalid. For each assetion

     *          that will be eventually marked with this validation value, the policy processor

     *          will log a SEVERE error and throw an exception. No further attempts to call

     *          the web service will be made.

     *      </li>

     * </ul>

     *

     * @param assertion A policy asssertion (See {@link com.sun.xml.internal.ws.policy.PolicyAssertion PolicyAssertion}).

     * May contain nested policies and assertions.

     * @return fitness of the {@code assertion} on in the client-side context. Must not be {@code null}.

     */

    public Fitness validateClientSide(PolicyAssertion assertion);

    /**

     * An implementation of this method must return:

     * <ul>

     *      <li>

     *          {@code Fitness.UNKNOWN} if the policy assertion type is not recognized

     *      </li>

     *      <li>

     *          {@code Fitness.SUPPORTED} if the policy assertion is supported in the

     *          server-side context

     *      </li>

     *      <li>

     *          {@code Fitness.UNSUPPORTED} if the policy assertion is recognized however

     *          it's content is not supported.

     *      </li>

     *      <li>

     *          {@code Fitness.INVALID} if the policy assertion is recognized however

     *          its content (value, parameters, nested assertions) is invalid.

     *      </li>

     * </ul>

     *

     * For each assetion that will be eventually marked with validation value of

     * UNKNOWN, UNSUPPORTED or INVALID, the policy processor will log a SEVERE error

     * and throw an exception.

     *

     * @param assertion A policy asssertion (See {@link com.sun.xml.internal.ws.policy.PolicyAssertion PolicyAssertion}).

     * May contain nested policies and assertions.

     * @return fitness of the {@code assertion} on in the server-side context. Must not be {@code null}.

     */

    public Fitness validateServerSide(PolicyAssertion assertion);

    /**

     * Each service provider that implements this SPI must make sure to identify all possible domains it supports.

     * This operation must be implemented as idempotent (must return same values on multiple calls).

     * <p/>

     * It is legal for two or more {@code PolicyAssertionValidator}s to support the same domain. In such case,

     * the most significant result returned from validation methods will be eventually assigned to the assertion.

     * The significance of validation results is as follows (from most to least significant):

     * <ol>

     *      <li>SUPPORTED</li>

     *      <li>UNSUPPORTED</li>

     *      <li>INVALID</li>

     *      <li>UNKNOWN</li>

     * </ol>

     *

     *

     * @return {@code String} array holding {@code String} representations of identifiers of all supported domains.

     * Usually a domain identifier is represented by a namespace.

     */

    public String[] declareSupportedDomains();

}