View Javadoc

1   /*$Id: ApplicationDescriptionEnvironment.java,v 1.11 2006/03/17 17:50:58 clq2 Exp $
2    * Created on 16-Jun-2004
3    *
4    * Copyright (C) AstroGrid. All rights reserved.
5    *
6    * This software is published under the terms of the AstroGrid 
7    * Software License version 1.2, a copy of which has been included 
8    * with this distribution in the LICENSE.txt file.  
9    *
10  **/
11  package org.astrogrid.applications.description.base;
12  
13  import org.astrogrid.applications.manager.AppAuthorityIDResolver;
14  import org.astrogrid.applications.manager.idgen.IdGen;
15  import org.astrogrid.applications.parameter.protocol.ProtocolLibrary;
16  import org.astrogrid.component.descriptor.ComponentDescriptor;
17  
18  import junit.framework.Test;
19  
20  /*** A container for some components generally used within {@link org.astrogrid.applications.description.ApplicationDescription} implementations.
21   * <p>
22   * The components are bundled into this container to make it simpler to add further ones later
23   * <p />
24   * At present, this class containts a unique-id-generator, and library of indirection handlers.
25   * @todo could add hash map, so providers can stuff their own things in here? -becomes a kind of context object. unsure whether this is a good idea - extension may be better.
26   * @author Noel Winstanley nw@jb.man.ac.uk 16-Jun-2004
27   *
28   */
29  public class ApplicationDescriptionEnvironment implements ComponentDescriptor {
30      /*** Construct a new ApplicationDescriptionEnvironment
31       * 
32       */
33      public ApplicationDescriptionEnvironment(IdGen id,
34                                               ProtocolLibrary lib, 
35                                               AppAuthorityIDResolver resolver) {        
36          super();
37          this.id =id;
38          this.lib = lib;
39          this.authIDresolver = resolver;
40      }
41      protected final IdGen id;
42      protected final ProtocolLibrary lib;
43      protected final AppAuthorityIDResolver authIDresolver;
44     
45      
46      /***Access the unique id generator
47       * @return the IdGen for this server
48       * @see org.astrogrid.applications.manager.idgen
49       */
50      public IdGen getIdGen() {
51          return this.id;
52      }
53      
54      /*** Access the library of protcols that paramters can be indirected through
55       * @return the protocol library.
56       * @see org.astrogrid.applications.param.indirect
57       */
58      public ProtocolLibrary getProtocolLib() {
59          return this.lib;
60      }
61      
62      /***Access the resolver that will return the appropriate authorityID that applications can be registered under.
63      * @return the resolver
64      */
65     public AppAuthorityIDResolver getAuthIDResolver()
66      {
67         return this.authIDresolver;
68      }
69  
70      /***
71       * @see org.astrogrid.component.descriptor.ComponentDescriptor#getName()
72       */
73      public String getName() {
74          return "ApplicationDescriptionEnvironment";
75      }
76  
77      /***
78       * @see org.astrogrid.component.descriptor.ComponentDescriptor#getDescription()
79       */
80      public String getDescription() {
81          return "Container for components used by applications";
82      }
83  
84      /***
85       * @see org.astrogrid.component.descriptor.ComponentDescriptor#getInstallationTest()
86       */
87      public Test getInstallationTest() {
88          return null;
89      }
90      
91    
92      
93  }
94  
95  
96  /* 
97  $Log: ApplicationDescriptionEnvironment.java,v $
98  Revision 1.11  2006/03/17 17:50:58  clq2
99  gtr_1489_cea correted version
100 
101 Revision 1.9  2006/03/07 21:45:25  clq2
102 gtr_1489_cea
103 
104 Revision 1.6.38.3  2005/12/22 13:58:27  gtr
105 *** empty log message ***
106 
107 Revision 1.6.38.2  2005/12/19 18:12:30  gtr
108 Refactored: changes in support of the fix for 1492.
109 
110 Revision 1.6.38.1  2005/12/18 14:48:24  gtr
111 Refactored to allow the component managers to pass their unit tests and the fingerprint JSP to work. See BZ1492.
112 
113 Revision 1.6  2005/07/05 08:27:01  clq2
114 paul's 559b and 559c for wo/apps and jes
115 
116 Revision 1.5.68.1  2005/06/09 08:47:32  pah
117 result of merging branch cea_pah_559b into HEAD
118 
119 Revision 1.5.54.1  2005/06/02 14:57:29  pah
120 merge the ProvidesVODescription interface into the MetadataService interface
121 
122 Revision 1.5  2004/11/27 13:20:02  pah
123 result of merge of pah_cea_bz561 branch
124 
125 Revision 1.4.70.1  2004/11/09 09:21:16  pah
126 initial attempt to rationalise authorityID use & self registering
127 
128 Revision 1.4  2004/07/26 12:07:38  nw
129 renamed indirect package to protocol,
130 renamed classes and methods within protocol package
131 javadocs
132 
133 Revision 1.3  2004/07/26 00:58:22  nw
134 javadoc
135 
136 Revision 1.2  2004/07/01 11:16:22  nw
137 merged in branch
138 nww-itn06-componentization
139 
140 Revision 1.1.2.2  2004/07/01 01:42:47  nw
141 final version, before merge
142 
143 Revision 1.1.2.1  2004/06/17 09:21:23  nw
144 finished all major functionality additions to core
145  
146 */