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.client.api.impl;
36  
37  import org.ogf.graap.wsag.api.exceptions.NegotiationException;
38  import org.ogf.graap.wsag.api.exceptions.ResourceUnavailableException;
39  import org.ogf.graap.wsag.api.exceptions.ResourceUnknownException;
40  import org.ogf.graap.wsag.client.api.NegotiationClient;
41  import org.ogf.schemas.graap.wsAgreement.AgreementTemplateType;
42  import org.ogf.schemas.graap.wsAgreement.negotiation.NegotiationContextType;
43  import org.ogf.schemas.graap.wsAgreement.negotiation.NegotiationOfferType;
44  
45  /**
46   * Default implementation of a negotiation client. Concrete implementations must provide a proper
47   * implementation of the server interaction.
48   * 
49   * @author hrasheed
50   */
51  public abstract class NegotiationClientImpl extends AbstractClient
52      implements NegotiationClient
53  {
54  
55      /**
56       * {@inheritDoc}
57       */
58      public abstract NegotiationContextType getNegotiationContext()
59          throws ResourceUnknownException, ResourceUnavailableException;
60  
61      /**
62       * {@inheritDoc}
63       */
64      public abstract AgreementTemplateType[] getNegotiableTemplates()
65          throws ResourceUnknownException, ResourceUnavailableException;
66  
67      /**
68       * {@inheritDoc}
69       */
70      public abstract NegotiationOfferType[] getNegotiationOffers()
71          throws ResourceUnknownException, ResourceUnavailableException;
72  
73      /**
74       * {@inheritDoc}
75       */
76      public abstract NegotiationOfferType[] negotiate( NegotiationOfferType[] quotes )
77          throws NegotiationException, ResourceUnknownException, ResourceUnavailableException;
78  
79      /**
80       * {@inheritDoc}
81       */
82      public abstract void advertise( NegotiationOfferType[] quotes )
83          throws NegotiationException, ResourceUnknownException, ResourceUnavailableException;
84  
85      /**
86       * {@inheritDoc}
87       */
88      public NegotiationOfferType getNegotiationOffer( String offerID )
89          throws ResourceUnknownException, ResourceUnavailableException
90      {
91          NegotiationOfferType[] offers = getNegotiationOffers();
92          for ( int i = 0; i < offers.length; i++ )
93          {
94              NegotiationOfferType offer = offers[i];
95              if ( offerID.equals( offer.getOfferId() ) )
96              {
97                  return offer;
98              }
99          }
100 
101         throw new ResourceUnavailableException( "no negotiationoffer found for offer id: " + offerID );
102     }
103 
104     /**
105      * {@inheritDoc}
106      */
107     public abstract void terminate() throws ResourceUnknownException, ResourceUnavailableException;
108 
109     /**
110      * {@inheritDoc}
111      */
112     public abstract void destroy() throws ResourceUnknownException, ResourceUnavailableException;
113 
114     /**
115      * {@inheritDoc}
116      */
117     @Override
118     public abstract NegotiationClient clone() throws CloneNotSupportedException;
119 }