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.samples.site;
36  
37  import org.apache.log4j.Logger;
38  import org.ogf.graap.wsag.api.AgreementOffer;
39  import org.ogf.graap.wsag.api.types.AbstractAgreementType;
40  import org.ogf.schemas.graap.wsAgreement.TerminateInputType;
41  import org.w3c.dom.Node;
42  
43  /**
44   * This agreement implementation is used as example for the project documentation.
45   * 
46   * @author Oliver Waeldrich
47   * 
48   */
49  public class ExampleAgreement extends AbstractAgreementType
50  {
51  
52      private static Logger log = Logger.getLogger( ExampleAgreement.class );
53  
54      private ExampleService service;
55  
56      /**
57       * Creates an new agreement instance based on an agreement offer. The agreement properties of the
58       * agreement are initialized based on the offer. Additionally, for each service description term
59       * (guarantee term) specified in the offer a corresponding service term state (guarantee term state) is
60       * initialized.
61       * 
62       * @param offer
63       *            the agreement offer for which the agreement is created
64       */
65      public ExampleAgreement( AgreementOffer offer )
66      {
67          super( offer );
68      }
69  
70      /**
71       * Sets the service associated with this agreement instance.
72       * 
73       * @param service
74       *            the service to set
75       */
76      public void setService( ExampleService service )
77      {
78          this.service = service;
79      }
80  
81      /**
82       * This method is invoked when an agreement is terminated. Implementations can add domain-specific
83       * functionality here in order to shutdown services or free resources.
84       * 
85       * {@inheritDoc}
86       */
87      public void terminate( TerminateInputType reason )
88      {
89          Node terminateReson = reason.getDomNode().getFirstChild();
90          if ( terminateReson != null )
91          {
92              // find out what the reason is and take the appropriate action
93              if ( log.isInfoEnabled() )
94              {
95                  log.info( "The greement was terminated for the following reason: " + reason.xmlText() );
96              }
97          }
98  
99          //
100         // Implementations can add domain-specific code here, for example
101         // to terminate associated services and free allocated resources.
102         //
103         service.interrupt();
104     }
105 
106 }