ProviderInterface


1   /*
2    *  This software is OSI Certified Open Source Software.
3    *  OSI Certified is a certification mark of the Open Source Initiative.
4    *  The license (Mozilla version 1.0) can be read at the MMBase site.
5    *  See http://www.MMBase.org/license
6    */
7   package org.mmbase.applications.packaging.providerhandlers;
8   
9   import java.io.BufferedInputStream  ;
10  import java.util.jar.JarFile  ;
11  
12  import org.mmbase.applications.packaging.bundlehandlers.BundleInterface;
13  import org.mmbase.applications.packaging.installhandlers.installStep;
14  import org.mmbase.applications.packaging.packagehandlers.PackageInterface;
15  import org.mmbase.applications.packaging.projects.packageStep;
16  import org.mmbase.applications.packaging.projects.creators.CreatorInterface;
17  
18  /**
19   * Interface for all the provider handlers
20   *
21   * @author     danielockeloen
22   */
23  public interface ProviderInterface {
24  
25      /**
26       *  Gets the name attribute of the ProviderInterface object
27       *
28       * @return    The name value
29       */
30      public String   getName();
31  
32  
33      /**
34       *  Gets the method attribute of the ProviderInterface object
35       *
36       * @return    The method value
37       */
38      public String   getMethod();
39  
40  
41      /**
42       *  Gets the path attribute of the ProviderInterface object
43       *
44       * @return    The path value
45       */
46      public String   getPath();
47  
48  
49      /**
50       *  Gets the state attribute of the ProviderInterface object
51       *
52       * @return    The state value
53       */
54      public String   getState();
55  
56  
57      /**
58       *  Gets the maintainer attribute of the ProviderInterface object
59       *
60       * @return    The maintainer value
61       */
62      public String   getMaintainer();
63  
64  
65      /**
66       *  Gets the description attribute of the ProviderInterface object
67       *
68       * @return    The description value
69       */
70      public String   getDescription();
71  
72  
73      /**
74       *  Sets the maintainer attribute of the ProviderInterface object
75       *
76       * @param  maintainer  The new maintainer value
77       */
78      public void setMaintainer(String   maintainer);
79  
80  
81      /**
82       *  Sets the path attribute of the ProviderInterface object
83       *
84       * @param  path  The new path value
85       */
86      public void setPath(String   path);
87  
88      /**
89       *  Sets the installStep attribute of the ProviderInterface object
90       *
91       * @param  step  The installstep
92       */
93      public void setInstallStep(installStep step);
94  
95      public void setPackageStep(packageStep step);
96  
97      /**
98       *  Sets the description attribute of the ProviderInterface object
99       *
100      * @param  description  The new description value
101      */
102     public void setDescription(String   description);
103 
104 
105     /**
106      *  Sets the state attribute of the ProviderInterface object
107      *
108      * @param  state  The new state value
109      */
110     public void setState(String   state);
111 
112 
113     /**
114      *  Sets the account attribute of the ProviderInterface object
115      *
116      * @param  account  The new account value
117      */
118     public void setAccount(String   account);
119 
120 
121     /**
122      *  Sets the password attribute of the ProviderInterface object
123      *
124      * @param  password  The new password value
125      */
126     public void setPassword(String   password);
127 
128 
129     /**
130      *  Gets the baseScore attribute of the ProviderInterface object
131      *
132      * @return    The baseScore value
133      */
134     public int getBaseScore();
135 
136 
137     /**
138      *  Gets the jarFile attribute of the ProviderInterface object
139      *
140      * @param  path     Description of the Parameter
141      * @param  id       Description of the Parameter
142      * @param  version  Description of the Parameter
143      * @return          The jarFile value
144      */
145     public JarFile   getJarFile(String   path, String   id, String   version);
146 
147 
148     /**
149      *  Gets the includedPackageJarFile attribute of the ProviderInterface object
150      *
151      * @param  path            Description of the Parameter
152      * @param  id              Description of the Parameter
153      * @param  version         Description of the Parameter
154      * @param  packageid       Description of the Parameter
155      * @param  packageversion  Description of the Parameter
156      * @return                 The includedPackageJarFile value
157      */
158     public JarFile   getIncludedPackageJarFile(String   path, String   id, String   version, String   packageid, String   packageversion);
159 
160 
161     /**
162      *  Gets the jarStream attribute of the ProviderInterface object
163      *
164      * @param  path  Description of the Parameter
165      * @return       The jarStream value
166      */
167     public BufferedInputStream   getJarStream(String   path);
168 
169 
170     /**
171      *  Description of the Method
172      */
173     public void signalUpdate();
174 
175 
176     /**
177      *  Description of the Method
178      *
179      * @return    Description of the Return Value
180      */
181     public long lastSeen();
182 
183 
184     /**
185      *  Description of the Method
186      *
187      * @return    Description of the Return Value
188      */
189     public boolean close();
190 
191 
192     /**
193      *  Gets the packages attribute of the ProviderInterface object
194      */
195     public void getPackages();
196 
197 
198     /**
199      *  Description of the Method
200      *
201      * @param  n           Description of the Parameter
202      * @param  name        Description of the Parameter
203      * @param  method      Description of the Parameter
204      * @param  maintainer  Description of the Parameter
205      */
206     public void init(org.w3c.dom.Node   n, String   name, String   method, String   maintainer);
207 
208 
209     /**
210      *  Description of the Method
211      *
212      * @param  name        Description of the Parameter
213      * @param  method      Description of the Parameter
214      * @param  maintainer  Description of the Parameter
215      * @param  path        Description of the Parameter
216      */
217     public void init(String   name, String   method, String   maintainer, String   path);
218 
219     public boolean publish(CreatorInterface creator, BundleInterface bundle,String   sharepassword);
220 
221     public boolean publish(CreatorInterface creator, PackageInterface p,String   sharepassword);
222 }
223 
224
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags