Changeset 1173 for raptor-client


Ignore:
Timestamp:
10/26/11 16:55:45 (9 years ago)
Author:
philsmart
Message:
 
File:
1 edited

Legend:

Unmodified
Added
Removed
  • raptor-client/trunk/src/main/java/uk/ac/cardiff/raptor/remoting/server/sei/MultiUnitAggregator.java

    r817 r1173  
    1414 * limitations under the License. 
    1515 */ 
    16 /** 
    17  * 
    18  */ 
     16 
    1917package uk.ac.cardiff.raptor.remoting.server.sei; 
    2018 
     
    3432import uk.ac.cardiff.model.wsmodel.StatisticalUnitInformation; 
    3533 
    36  
    3734/** 
    3835 * @author philsmart 
    39  * 
     36 *  
    4037 */ 
    4138 
     
    4340public interface MultiUnitAggregator { 
    4441 
    45         public String getVersion(); 
     42    /** 
     43     * Gets the internal version number of this MUA. This does not have to correspond to the Maven or SCM raptor-mua 
     44     * release version 
     45     *  
     46     * @return the internal version number of this MUA 
     47     */ 
     48    public String getVersion(); 
    4649 
    47         public Capabilities getCapabilities(); 
     50    /** 
     51     * Returns the capabilities of this MUA. This includes: 
     52     * <ol> 
     53     * <li>A list of statistical operations this MUA can perform.</li> 
     54     * <li>The Service Metadata associated to this MUA.</li> 
     55     * <li>The number of events this MUA has stored</li> 
     56     * <li>Metadata describing the all resource this MUA has 'seen'.</li> 
     57     * <li>Flags and error messages describing processing status</li> 
     58     * </ol> 
     59     *  
     60     * @return 
     61     */ 
     62    public Capabilities getCapabilities(); 
    4863 
    49         public void updateStatisticalUnit(StatisticalUnitInformation statisticalUnitInformation) throws SoapFault; 
     64    /** 
     65     * Updates the statistical unit described in the <code>statisticalUnitInformation</code> parameter. 
     66     *  
     67     * @param statisticalUnitInformation information about the statistical unit to update 
     68     * @throws SoapFault 
     69     */ 
     70    public void updateStatisticalUnit(StatisticalUnitInformation statisticalUnitInformation) throws SoapFault; 
    5071 
    51         public AggregatorGraphModel invokeStatisticalUnit(String statisticName) throws SoapFault; 
     72    /** 
     73     * Invokes the statistical unit with name <code>statisticName</code> and returns the result of that unit as a 
     74     * <code>AggregatorGraphModel</code> 
     75     *  
     76     * @param statisticName the <code>String</code> name of the statistical unit to invoke 
     77     * @return the result of invoking the statistical unit as a <code>AggregatorGraphModel</code> 
     78     * @throws SoapFault 
     79     */ 
     80    public AggregatorGraphModel invokeStatisticalUnit(String statisticName) throws SoapFault; 
    5281 
    53         /** 
    54          * A single shot interface that both updates and then performs a statistic (returning the result) 
    55          * in one go. This is useful if you want to perform both operations while there is a lock on the class 
    56          * so as other operations do not take place between update and invoke. 
    57          * 
    58          * @param statisticalUnitInformation 
    59          * @return 
    60          */ 
    61         public AggregatorGraphModel updateAndInvokeStatisticalUnit(StatisticalUnitInformation statisticalUnitInformation) throws SoapFault; 
     82    /** 
     83     * A single shot interface that both updates and then performs a statistic (returning the result) in one go. This is 
     84     * useful if you want to perform both operations while there is a lock on the class so as other operations do not 
     85     * take place between update and invoke. 
     86     *  
     87     * @param statisticalUnitInformation 
     88     * @return 
     89     */ 
     90    public AggregatorGraphModel updateAndInvokeStatisticalUnit(StatisticalUnitInformation statisticalUnitInformation) 
     91            throws SoapFault; 
    6292 
    63         public boolean performAdministrativeFunction(AdministrativeFunction function) throws SoapFault; 
     93    /** 
     94     * Asks this MUA to perform an administrative function e.g. removeall stored events. 
     95     *  
     96     * @param function information about the function to peform 
     97     * @return true if the administrative function performed successfully, false otherwise 
     98     * @throws SoapFault 
     99     */ 
     100    public boolean performAdministrativeFunction(AdministrativeFunction function) throws SoapFault; 
    64101 
    65         public void addAuthentications(EventPushMessage pushed) throws SoapFault; 
     102    /** 
     103     * Adds events to this MUA 
     104     *  
     105     * @param pushed the <code>EventPushMessage</code> that the events this MUA is to store are encapsulated in 
     106     * @throws SoapFault 
     107     */ 
     108    public void addAuthentications(EventPushMessage pushed) throws SoapFault; 
    66109 
    67         /** Send a batch of log files to the MUA to store */ 
    68         public List<LogFileUploadResult>  batchUpload(List<LogFileUpload> uploadFiles); 
     110    /** 
     111     * Send a batch of log files to the MUA to store 
     112     *  
     113     * @param uploadFiles the files to parse and store events from 
     114     * @return 
     115     */ 
     116    public List<LogFileUploadResult> batchUpload(List<LogFileUpload> uploadFiles); 
    69117 
    70  
    71         public void saveResourceMetadata(List<ResourceMetadata> resourceMetadata); 
     118    /** 
     119     * Save resource information in the <code>resourceMetadata</code> parameter to this MUA's persistent store. 
     120     *  
     121     * @param resourceMetadata 
     122     */ 
     123    public void saveResourceMetadata(List<ResourceMetadata> resourceMetadata); 
    72124 
    73125} 
Note: See TracChangeset for help on using the changeset viewer.