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 *
66 * @param context
67 * invocation context
68 *
69 * @return the created agreement instance
70 *
71 * @throws AgreementFactoryException
72 * Indicates that the agreement offer was rejected or another fault occurred.
73 */
74 Agreement createAgreement( AgreementOffer offer, Map<String, Object> context )
75 throws AgreementFactoryException;
76
77 /**
78 * Creates a new pending agreement based on an offer.
79 *
80 * @param offer
81 * agreement offer
82 *
83 * @param context
84 * invocation context
85 *
86 * @param listener
87 * the listener, when provided, receives the agreement acceptance events once the creation
88 * process is finished
89 *
90 * @return the created agreement instance
91 * @throws AgreementFactoryException
92 * Indicates that the agreement offer was rejected or another fault occurred.
93 */
94 Agreement createPendingAgreement( AgreementOffer offer, PendingAgreementListener listener,
95 Map<String, Object> context ) throws AgreementFactoryException;
96
97 /**
98 * Initializes a new negotiation instance. This method creates a new negotiation instance based on the
99 * provided negotiation context, taking into account the critical and non-critical extensions.
100 *
101 * @param context
102 * The negotiation context defines the roles and obligations of the negotiating parties.
103 * Furthermore, it defines the nature of the negotiation process (e.g. negotiation or
104 * re-negotiation).
105 * @param criticalExtensions
106 * Critical extensions must be supported during the negotiation process. If a critical
107 * extension is not understood or supported by the negotiation factory, it must throw an @see
108 * NegotiationFactoryException.
109 * @param nonCriticalExtensions
110 * Non-critical extensions should be supported during the negotiation process. If a
111 * non-critical extension is not understood or supported by the negotiation factory, it can be
112 * ignored. Alternatively, an @see NegotiationFactoryException could be thrown.
113 * @param environment
114 * Provides access to additional variables provided by the calling instance. These environment
115 * variables are domain specific.
116 * @return the new initiated negotiation instance
117 * @throws NegotiationFactoryException
118 * indicates that an error occurred while instantiating the negotiation process
119 */
120 Negotiation initiateNegotiation( NegotiationContextType context, XmlObject[] criticalExtensions,
121 XmlObject[] nonCriticalExtensions, Map<String, Object> environment )
122
123 throws NegotiationFactoryException;
124
125 /**
126 * Returns the factory context.
127 *
128 * @return the context for this agreement factory
129 */
130 AgreementFactoryContext getFactoryContext();
131
132 /**
133 * Sets the factory context.
134 *
135 * @param context
136 * sets the context for this agreement factory
137 */
138 void setFactoryContext( AgreementFactoryContext context );
139
140 }