View Javadoc

1   /* 
2    * Copyright (c) 2007, Fraunhofer-Gesellschaft
3    * All rights reserved.
4    * 
5    * Redistribution and use in source and binary forms, with or without
6    * modification, are permitted provided that the following conditions are
7    * met:
8    * 
9    * (1) Redistributions of source code must retain the above copyright
10   *     notice, this list of conditions and the disclaimer at the end.
11   *     Redistributions in binary form must reproduce the above copyright
12   *     notice, this list of conditions and the following disclaimer in
13   *     the documentation and/or other materials provided with the
14   *     distribution.
15   * 
16   * (2) Neither the name of Fraunhofer nor the names of its
17   *     contributors may be used to endorse or promote products derived
18   *     from this software without specific prior written permission.
19   * 
20   * DISCLAIMER
21   * 
22   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23   * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24   * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25   * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26   * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29   * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30   * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31   * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33   *  
34   */
35  package org.ogf.graap.wsag.api;
36  
37  import java.util.Map;
38  
39  import org.apache.xmlbeans.XmlObject;
40  import org.ogf.graap.wsag.api.exceptions.AgreementFactoryException;
41  import org.ogf.graap.wsag.api.exceptions.NegotiationFactoryException;
42  import org.ogf.schemas.graap.wsAgreement.AgreementTemplateType;
43  import org.ogf.schemas.graap.wsAgreement.negotiation.NegotiationContextType;
44  
45  /**
46   * This interface defines the operations of an AgreementFactory. Components can query the supported templates
47   * of a factory, initiate negotiation processes and create new agreements using this interface.
48   * 
49   * @see Agreement
50   * @author Oliver Waeldrich
51   */
52  public interface AgreementFactory
53  {
54  
55      /**
56       * @return the agreement templates exposed by this factory
57       */
58      AgreementTemplateType[] getTemplates();
59  
60      /**
61       * Creates a new agreement based on an offer.
62       * 
63       * @param offer
64       *            agreement offer
65       * @return the created agreement instance
66       * @throws AgreementFactoryException
67       *             Indicates that the agreement offer was rejected or another fault occurred.
68       */
69      Agreement createAgreement( AgreementOffer offer ) throws AgreementFactoryException;
70  
71      /**
72       * Initializes a new negotiation instance. This method creates a new negotiation instance based on the
73       * provided negotiation context, taking into account the critical and non-critical extensions.
74       * 
75       * @param context
76       *            The negotiation context defines the roles and obligations of the negotiating parties.
77       *            Furthermore, it defines the nature of the negotiation process (e.g. negotiation or
78       *            re-negotiation).
79       * @param criticalExtensions
80       *            Critical extensions must be supported during the negotiation process. If a critical
81       *            extension is not understood or supported by the negotiation factory, it must throw an @see
82       *            NegotiationFactoryException.
83       * @param nonCriticalExtensions
84       *            Non-critical extensions should be supported during the negotiation process. If a
85       *            non-critical extension is not understood or supported by the negotiation factory, it can be
86       *            ignored. Alternatively, an @see NegotiationFactoryException could be thrown.
87       * @param environment
88       *            Provides access to additional variables provided by the calling instance. These environment
89       *            variables are domain specific.
90       * @return the new initiated negotiation instance
91       * @throws NegotiationFactoryException
92       *             indicates that an error occurred while instantiating the negotiation process
93       */
94      Negotiation initiateNegotiation( NegotiationContextType context, XmlObject[] criticalExtensions,
95                                       XmlObject[] nonCriticalExtensions, Map<String, Object> environment )
96  
97      throws NegotiationFactoryException;
98  
99  }