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.sla;
36  
37  import org.ggf.schemas.jsdl.x2005.x11.jsdl.ApplicationType;
38  import org.ggf.schemas.jsdl.x2005.x11.jsdl.JobDefinitionType;
39  import org.ggf.schemas.jsdl.x2005.x11.jsdl.ResourcesType;
40  import org.ogf.graap.wsag.api.pattern.ChoosableComputeApplicationPattern;
41  import org.ogf.graap.wsag.api.pattern.ComputeResourcePattern;
42  import org.ogf.graap.wsag.api.types.TemplateType;
43  import org.ogf.schemas.graap.wsAgreement.AgreementTemplateType;
44  import org.ogf.schemas.graap.wsAgreement.TermCompositorType;
45  
46  /**
47   * AbstractComputeJobTemplate
48   * 
49   * The protocol of this class is as follows. First one must select an application using
50   * {@link #selectApplication(ApplicationType)} or {@link #selectApplication(String, String)}. This service
51   * selection is instantly registered in the underlying template.
52   * <p>
53   * 
54   * Subsequent modifications to the selected applications are possible by using functions such as
55   * {@link #getSelectedApplication()} or {@link #getSelectedJobDefinition()}. Modifications to the returned
56   * objects are not registered in the template until {@link #updateSelectedApplication()} is executed.
57   * 
58   * @author Oliver Waeldrich
59   * 
60   */
61  public abstract class AbstractComputeJobTemplate extends TemplateType
62  {
63  
64      private ChoosableComputeApplicationPattern computeTemplate;
65  
66      private ComputeResourcePattern resourceTemplate;
67  
68      /**
69       * @param template
70       *            the XML template object
71       */
72      public AbstractComputeJobTemplate( AgreementTemplateType template )
73      {
74          super( template );
75  
76          //
77          // use the internal XML object for creating the pattern
78          //
79          template = getXMLObject();
80  
81          TermCompositorType compositor = template.getTerms().getAll().getExactlyOneArray( 0 );
82          computeTemplate = new ChoosableComputeApplicationPattern( compositor );
83          resourceTemplate = new ComputeResourcePattern( template.getTerms().getAll() );
84      }
85  
86      /**
87       * @return the resource definition
88       * @see ComputeResourcePattern#getResourceDefinition()
89       */
90      public ResourcesType getResourceDefinition()
91      {
92          return resourceTemplate.getResourceDefinition();
93      }
94  
95      /**
96       * @return the selected application
97       * @see ChoosableComputeApplicationPattern#getSelectedApplication()
98       */
99      public ApplicationType getSelectedApplication()
100     {
101         return computeTemplate.getSelectedApplication();
102     }
103 
104     /**
105      * @return a list of all available application
106      * @see ChoosableComputeApplicationPattern#listApplications()
107      */
108     public ApplicationType[] listApplications()
109     {
110         return computeTemplate.listApplications();
111     }
112 
113     /**
114      * @param application
115      *            the application to select
116      * @return true if the application was selected, otherwise false
117      * @see ChoosableComputeApplicationPattern#selectApplication(org.ggf.schemas.jsdl.x2005.x11.jsdl.ApplicationType)
118      */
119     public boolean selectApplication( ApplicationType application )
120     {
121         return computeTemplate.selectApplication( application );
122     }
123 
124     /**
125      * @param name
126      *            application name
127      * @param version
128      *            application version
129      * @return true if the chosen application was selected, otherwise false
130      * @see ChoosableComputeApplicationPattern#selectApplication(java.lang.String, java.lang.String)
131      */
132     public boolean selectApplication( String name, String version )
133     {
134         return computeTemplate.selectApplication( name, version );
135     }
136 
137     /**
138      * 
139      * @see ChoosableComputeApplicationPattern#updateSelectedApplication()
140      */
141     public void updateSelectedApplication()
142     {
143         computeTemplate.updateSelectedApplication();
144     }
145 
146     /**
147      * @return the job definition that contains the currently selected application
148      * @see ChoosableComputeApplicationPattern#getSelectedJobDefinition()
149      */
150     public JobDefinitionType getSelectedJobDefinition()
151     {
152         return computeTemplate.getSelectedJobDefinition();
153     }
154 }