View Javadoc

1   /**
2    * Copyright 2005-2006 the original author or authors.
3    *
4    * Licensed under the Gnu General Pubic License, Version 2.0 (the
5    * "License"); you may not use this file except in compliance with
6    * the License. You may obtain a copy of the License at
7    *
8    *      http://www.opensource.org/licenses/gpl-license.php
9    *
10   * This program is distributed in the hope that it will be useful,
11   * but WITHOUT ANY WARRANTY; without even the implied warranty of
12   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
13   * See the Gnu General Public License for more details.
14   */
15  package org.figure8.join.services.remoting;
16  
17  import org.figure8.join.services.remoting.beans.RemoteParameter;
18  
19  import java.rmi.RemoteException;
20  /**
21   * Remote service interface definition. This service allow to retrieve
22   * deployment parameters for an environment. This may helps customizing the
23   * software project build to deployment target and environment.
24   * @author <a href="mailto:laurent.broudoux@free.fr">Laurent Broudoux</a>
25   * @version $Revision: 1.1 $
26   */
27  public interface ParameterService extends AuthenticatedService{
28  
29     // Public -------------------------------------------------------------------
30  
31     /**
32      * Retrieve all the deployment parameters corresponding to specified deployment
33      * target and environments. This provides a set of rendered name/value pairs wrapped
34      * into thin RemoteParameter objects.
35      * @param token Authentication token provided earlier by login() method
36      * @param environmentKey The unique key of environment to get parameters for
37      * @param targetName The name of deployment targets to get parameters for
38      * @return An array of {@link RemoteParameter} objects
39      * @throws InvalidSessionException if user has no valid session on server-side
40      * @throws RemoteException RemoteException if an exception occurs during the remote conversation
41      */
42     public abstract RemoteParameter[] getDeploymentParameters(String token, String environmentKey, String targetName) throws InvalidSessionException, RemoteException;
43  }