aoqi@0: /*
aoqi@0:  * Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package com.sun.xml.internal.ws.policy.spi;
aoqi@0: 
aoqi@0: import com.sun.xml.internal.ws.policy.AssertionSet;
aoqi@0: import com.sun.xml.internal.ws.policy.PolicyAssertion;
aoqi@0: import com.sun.xml.internal.ws.policy.sourcemodel.AssertionData;
aoqi@0: import java.util.Collection;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * The interface defines contract for custom (domain specific) policy assertion
aoqi@0:  * factories. The implementations are discovered using service provider mechanism
aoqi@0:  * described in the
aoqi@0:  * <a href="http://java.sun.com/j2se/1.5.0/docs/guide/jar/jar.html#Service%20Provider">J2SE JAR File Specification</a>.
aoqi@0:  *<p/>
aoqi@0:  * Every implementation of policy assertion creator is expected to <b>fully</b>
aoqi@0:  * handle the creation of assertions for the domain (namespace) it claims to
aoqi@0:  * support by returning the namespace string from the {link #getSupportedDomainNamespaceUri()}
aoqi@0:  * method. To handle creation of domain-specific assertions that are not intended
aoqi@0:  * to be customized, the default policy assertion creator (passed as one of the
aoqi@0:  * input parameters into the {@link #createAssertion(AssertionData, Collection, AssertionSet, PolicyAssertionCreator)} method)
aoqi@0:  * shall be used.
aoqi@0:  *
aoqi@0:  * @author Marek Potociar
aoqi@0:  */
aoqi@0: public interface PolicyAssertionCreator {
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * This method returns the namespace URIs of the domains that are supported by the implementation of
aoqi@0:      * this inteface. There can be multiple URIs supported per single implementation.
aoqi@0:      * <p/>
aoqi@0:      * Supporting domain namespace URI means that particular {@code PolicyAssertionCreator} implementation
aoqi@0:      * is able to create assertion instances for the domains identified by the namespace URIs returned from this
aoqi@0:      * method. It is required that each {@code PolicyAssertionCreator} implementation handles the policy
aoqi@0:      * assertion creation for <b>each</b> assertion in every domain it claims to support.
aoqi@0:      *
aoqi@0:      * @return string array representing the namespace URIs of the supported domains. It is expected that multiple calls on this method return the
aoqi@0:      * same value each time. <b>Returned string array must be neither {@code null} nor empty. Also each string value in the array must not be {@code null}
aoqi@0:      * nor empty.</b>
aoqi@0:      *
aoqi@0:      */
aoqi@0:     String[] getSupportedDomainNamespaceURIs();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Creates domain-specific policy assertion instance according to assertion data provided. For the provided
aoqi@0:      * assertion data and this policy assertion creator instance, it will allways be true that assertion namespace
aoqi@0:      * URI equals to one of supported domain namespace URIs.
aoqi@0:      *<p/>
aoqi@0:      * Additional method parameter (which must not be {@code null}) supplied by the policy framework specifies a default policy
aoqi@0:      * assertion creator that might be used to handle creation of unsupported domain assertion in the default way. This is
aoqi@0:      * to give policy assertion creator a chance to handle also creation of "unsupported" domain assertions and to encourage
aoqi@0:      * implemetors to use class composition instad of class inheritance.
aoqi@0:      *
aoqi@0:      * @param data assertion creation data specifying the details of newly created assertion
aoqi@0:      * @param assertionParameters collection of assertions parameters of this policy assertion. May be {@code null}.
aoqi@0:      * @param nestedAlternative assertion set specifying nested policy alternative. May be {@code null}.
aoqi@0:      * @param defaultCreator default policy assertion creator implementation that shall be used to handle creation of assertions
aoqi@0:      * which are not explicitly supported by this policy assertion creator implementation
aoqi@0:      * @return domain specific policy assertion implementation according to assertion data provided.
aoqi@0:      *
aoqi@0:      * @throws AssertionCreationException in case of assertion creation failure
aoqi@0:      */
aoqi@0:     PolicyAssertion createAssertion(AssertionData data, Collection<PolicyAssertion> assertionParameters, AssertionSet nestedAlternative, PolicyAssertionCreator defaultCreator) throws AssertionCreationException;
aoqi@0: }