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.server.actions;
36  
37  import java.util.Map;
38  
39  import org.ogf.graap.wsag.server.engine.GenericNegotiation;
40  
41  /**
42   * <!-- begin-UML-doc --> AbstractCreateAgreementAction
43   * 
44   * Abstract base class for agreement creation actions.
45   * 
46   * @author Oliver Waeldrich
47   * 
48   *         <!-- end-UML-doc -->
49   * 
50   * @author Oliver Waeldrich
51   * @generated "UML to Java (com.ibm.xtools.transform.uml2.java5.internal.UML2JavaTransform)"
52   */
53  public abstract class AbstractNegotiationAction
54      implements INegotiationAction
55  {
56  
57      /**
58       * <!-- begin-UML-doc --> <!-- end-UML-doc -->
59       * 
60       * @generated "UML to Java (com.ibm.xtools.transform.uml2.java5.internal.UML2JavaTransform)"
61       */
62      private IActionHandlerContext handlerContext;
63  
64      /**
65       * <!-- begin-UML-doc --> Returns the context of this action handler.
66       * 
67       * {@inheritDoc} <!-- end-UML-doc -->
68       * 
69       * @return Returns the context of this action handler.
70       * 
71       * @generated "UML to Java (com.ibm.xtools.transform.uml2.java5.internal.UML2JavaTransform)"
72       */
73      @Override
74      public IActionHandlerContext getHandlerContext()
75      {
76          // begin-user-code
77          return handlerContext;
78          // end-user-code
79      }
80  
81      /**
82       * <!-- begin-UML-doc --> Sets the context for this action handler.
83       * 
84       * {@inheritDoc} <!-- end-UML-doc -->
85       * 
86       * @param context
87       * @generated "UML to Java (com.ibm.xtools.transform.uml2.java5.internal.UML2JavaTransform)"
88       */
89      @Override
90      public void setHandlerContext( IActionHandlerContext context )
91      {
92          // begin-user-code
93          this.handlerContext = context;
94          // end-user-code
95      }
96  
97      /**
98       * <!-- begin-UML-doc --> Default implementation of action initialization. Subclasses may overwrite this
99       * method in order to provide a custom initialization of a handler.
100      * 
101      * {@inheritDoc} <!-- end-UML-doc -->
102      * 
103      * @throws ActionInitializationException
104      * @generated "UML to Java (com.ibm.xtools.transform.uml2.java5.internal.UML2JavaTransform)"
105      */
106     @Override
107     public void initialize() throws ActionInitializationException
108     {
109         // begin-user-code
110 
111         // nothing to do here
112 
113         // end-user-code
114     }
115 
116     /**
117      * Returns the negotiation context for the current invocation.
118      * 
119      * @param invocationContext
120      *            the invocation context provided to the negotiation action
121      * 
122      * @return the context of the negotiation instance
123      */
124     @SuppressWarnings( "unchecked" )
125     public Map<String, Object> getNegotiationContext( Map invocationContext )
126     {
127         return (Map<String, Object>) invocationContext.get( GenericNegotiation.NEGOTIATION_CONTEXT );
128     }
129 }