All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.greenpepper.server.rpc.RpcServerService Maven / Gradle / Ivy

package com.greenpepper.server.rpc;

import java.util.Vector;

/**
 * The XmlRpcService provides an XML-RPC interface into GreenPepper Server.
 * All available methods are documented here.
 * 

* Copyright (c) 2006 Pyxis technologies inc. All Rights Reserved. * * @author JCHUET * @version $Id: $Id */ public interface RpcServerService { /** Constant SERVICE_HANDLER="greenpepper1" */ String SERVICE_HANDLER = "greenpepper1"; /** * Test the connection to the server. *

* * @return success. */ String testConnection(); /** * Pings the server. *

* * @param repositoryParams a {@link java.util.Vector} object. * @return success. */ String ping(Vector repositoryParams); /** * Retrieves the EnvironmentTypes available. *

* * @return all the EnvironmentTypes available. */ Vector getAllEnvironmentTypes(); /** * Retrieves the runner for a given the name. *

* * @param name a {@link java.lang.String} object. * @return the runner for a given the name. */ Vector getRunner(String name); /** * Retrieves all available Runners. *

* * @return all available Runners */ Vector getAllRunners(); /** * Creates a new Runner. *

* * @param runnerParams Runner['name','cmd',['envtypename'],'servername','serverport','mainclass',['cp1','cp2'],'secured'] * @return error id if an error occured */ String createRunner(Vector runnerParams); /** * Updates the Runner. *

* * @param oldRunnerName a {@link java.lang.String} object. * @param runnerParams a {@link java.util.Vector} object. * @return error id if an error occured */ String updateRunner(String oldRunnerName, Vector runnerParams); /** * Creates a new Runner. *

* * @param name a {@link java.lang.String} object. * @return error id if an error occured */ String removeRunner(String name); /** * Retrieves the Repository for the uid. *

* * @param repositoryParams a {@link java.util.Vector} object. * @return the Repository for the uid. */ Vector getRegisteredRepository(Vector repositoryParams); /** * Registers the repository in GreenPepper-server. * If project not found it will be created. *

* * @param repositoryParams a {@link java.util.Vector} object. * @return the registered repository. */ Vector registerRepository(Vector repositoryParams); /** * Updates the Repository Registration. * If project not found it will be created. *

* * @param repositoryParams a {@link java.util.Vector} object. * @return a {@link java.lang.String} object. */ String updateRepositoryRegistration(Vector repositoryParams); /** * Removes the Repository if this one doesnt hold any specifications. *

* * @param repositoryUid a {@link java.lang.String} object. * @return a {@link java.lang.String} object. */ String removeRepository(String repositoryUid); /** * Retrieves the complete project list. *

* * @return the complete project list. */ Vector getAllProjects(); /** * Retrieves all the Specification repository grouped by project * or an error id in a Hastable if an error occured. *

* * @return the Specification repository list grouped by types for the project * or an error id in a Hastable if an error occured. */ Vector getAllSpecificationRepositories(); /** * Retrieves the Specification repository list grouped by types for the project associated with * the specified repository or an error id in a Hastable if an error occured. *

* * @param repositoryParams a {@link java.util.Vector} object. * @return the Specification repository list grouped by types for the project associated with * the specified repository or an error id in a Hastable if an error occured. */ Vector getSpecificationRepositoriesOfAssociatedProject(Vector repositoryParams); /** * Retrieves the Repository list for the project associated with * the specified system under test or an error id in a Hastable if an error occured. *

* * @param systemUnderTestParams a {@link java.util.Vector} object. * @return the repository list for the project associated with * the specified systemUnderTest or an error id in a Hastable if an error occured. */ Vector getAllRepositoriesForSystemUnderTest(Vector systemUnderTestParams); /** * Retrieves the Specification repository list grouped by types for the project associated with * the specified SystemUnderTest or an error id in a Hastable if an error occured. *

* * @param systemUnderTestParams a {@link java.util.Vector} object. * @return the Specification repository list grouped by types for the project associated with * the specified SystemUnderTest or an error id in a Hastable if an error occured. */ Vector getSpecificationRepositoriesForSystemUnderTest(Vector systemUnderTestParams); /** * Retrieves the Requirement repository list for the project associated with * the specified repository or an error id in a Hastable if an error occured. *

* * @param repositoryParams a {@link java.util.Vector} object. * @return the Requirement repository list for the project associated with * the specified repository or an error id in a Hastable if an error occured. */ Vector getRequirementRepositoriesOfAssociatedProject(Vector repositoryParams); /** * Retrieves the SystemUnderTest list for the project associated with * the specified repository or an error id in a Hastable if an error occured. *

* * @param repositoryParams a {@link java.util.Vector} object. * @return the SystemUnderTest list for the project associated with * the specified repository or an error id in a Hastable if an error occured. */ Vector getSystemUnderTestsOfAssociatedProject(Vector repositoryParams); /** * Retrieves the SystemUnderTest list for the project associated * or an error id in a Hastable if an error occured. *

* * @param projectName a {@link java.lang.String} object. * @return the SystemUnderTest list for the project associated * or an error id in a Hastable if an error occured. */ Vector getSystemUnderTestsOfProject(String projectName); /** * Adds the SystemUnderTest to the SystemUnderTest list of the Specification. *

* * @param systemUnderTestParams SUT[name,Project[name]] * @param specificationParams Spec[name, Repo[name,uid]] * @return error id if an error occured */ String addSpecificationSystemUnderTest(Vector systemUnderTestParams, Vector specificationParams); /** * Removes the SystemUnderTest to the SystemUnderTest list of the Specification. *

* * @param systemUnderTestParams a {@link java.util.Vector} object. * @param specificationParams a {@link java.util.Vector} object. * @return error id if an error occured */ String removeSpecificationSystemUnderTest(Vector systemUnderTestParams, Vector specificationParams); /** * Checks if the Specification is in atleast one reference. *

* * @param specificationParams a {@link java.util.Vector} object. * @return true if the Specification is in atleast one reference. */ String doesSpecificationHasReferences(Vector specificationParams); /** * Retrieves the references list of the specified Specification *

* * @param specificationParams a {@link java.util.Vector} object. * @return the references list of the specified Specification */ Vector getSpecificationReferences(Vector specificationParams); /** * Checks if the Requirement is in atleast one Reference. *

* * @param requirementParams a {@link java.util.Vector} object. * @return true if the Requirement is in atleast one Reference. */ String doesRequirementHasReferences(Vector requirementParams); /** * Retrieves the References list of the specified requirement *

* * @param requirementParams a {@link java.util.Vector} object. * @return the References list of the specified requirement */ Vector getRequirementReferences(Vector requirementParams); /** * Retrieves the Reference. *

* * @param referenceParams a {@link java.util.Vector} object. * @return the Reference. */ Vector getReference(Vector referenceParams); /** * Retrieves the systemUnderTest *

* * @param systemUnderTestParams a {@link java.util.Vector} object. * @param repositoryParams a {@link java.util.Vector} object. * @return error id if an error occured */ Vector getSystemUnderTest(Vector systemUnderTestParams, Vector repositoryParams); /** * Creates the systemUnderTest *

* * @param systemUnderTestParams Vector[name, Vector[project parameters], Vector[seeds classPaths], Vector[fixture classPaths], fixturefactory, * fixturefactoryargs, isdefault, * Runner['name','cmd',['envtypename'],'servername','serverport','mainclass',['cp1','cp2'],'secured'], * projectdependencydescriptor] * @param repositoryParams REPO[name, uid] * @return error id if an error occured */ String createSystemUnderTest(Vector systemUnderTestParams, Vector repositoryParams); /** * Updates the systemUnderTest *

* * @param oldSystemUnderTestName a {@link java.lang.String} object. * @param systemUnderTestParams a {@link java.util.Vector} object. * @param repositoryParams a {@link java.util.Vector} object. * @return error id if an error occured */ String updateSystemUnderTest(String oldSystemUnderTestName, Vector systemUnderTestParams, Vector repositoryParams); /** * Removes the systemUnderTest *

* * @param systemUnderTestParams SUT[name, project[name]] * @param repositoryParams REPO[name,uid] * @return error id if an error occured */ String removeSystemUnderTest(Vector systemUnderTestParams, Vector repositoryParams); /** * Sets the systemUnderTest as the project default SystemUnderTest *

* * @param systemUnderTestParams a {@link java.util.Vector} object. * @param repositoryParams a {@link java.util.Vector} object. * @return error id if an error occured */ String setSystemUnderTestAsDefault(Vector systemUnderTestParams, Vector repositoryParams); /** * Removes the Requirement. *

* * @param requirementParams a {@link java.util.Vector} object. * @return error id if an error occured */ String removeRequirement(Vector requirementParams); /** * Retrieves the Specification *

* * @param specificationParams [name,repository[name,uid]] * @return the Specification */ Vector getSpecification(Vector specificationParams); /** * Retrieves all Specifications for a given SystemUnderTest and Repository *

* * @param systemUnderTestParams a {@link java.util.Vector} object. * @param repositoryParams a {@link java.util.Vector} object. * @return all Specifications for a given SystemUnderTest and Repository */ Vector getSpecifications(Vector systemUnderTestParams, Vector repositoryParams); /** * Retrieves the Specification location list for a given SystemUnderTest and Repository *

* * @param repositoryUID a {@link java.lang.String} object. * @param systemUnderTestName a {@link java.lang.String} object. * @return the Specification location list for a given SystemUnderTest and Repository */ Vector getListOfSpecificationLocations(String repositoryUID, String systemUnderTestName); /** * Creates the Specification *

* * @param specificationParams a {@link java.util.Vector} object. * @return the new Specification */ Vector createSpecification(Vector specificationParams); /** * Updates the Specification. *

* * @param oldSpecificationParams a {@link java.util.Vector} object. * @param newSpecificationParams a {@link java.util.Vector} object. * @return error id if an error occured */ String updateSpecification(Vector oldSpecificationParams, Vector newSpecificationParams); /** * Removes the Specification. *

* * @param specificationParams a {@link java.util.Vector} object. * @return error id if an error occured */ String removeSpecification(Vector specificationParams); /** * Creates a Reference *

* * @param referenceParams a {@link java.util.Vector} object. * @return error id if an error occured */ String createReference(Vector referenceParams); /** * Update the Reference. * The Old one will be deleted based on the oldReferenceParams and a new One * will be created based on the newReferenceParams. *

* * @param oldReferenceParams a {@link java.util.Vector} object. * @param newReferenceParams a {@link java.util.Vector} object. * @return the updated Reference */ Vector updateReference(Vector oldReferenceParams, Vector newReferenceParams); /** * Deletes the specified Reference. *

* * @param referenceParams a {@link java.util.Vector} object. * @return error id if an eror occured */ String removeReference(Vector referenceParams); /** * Executes the Specification over the selected SystemUnderTest. *

* * @param systemUnderTestParams a {@link java.util.Vector} object. * @param specificationParams a {@link java.util.Vector} object. * @param implementedVersion a boolean. * @param locale a {@link java.lang.String} object. * @return the Execution of the Specification over the selected SystemUnderTest. */ Vector runSpecification(Vector systemUnderTestParams, Vector specificationParams, boolean implementedVersion, String locale); /** * Executes the Reference. *

* * @param referenceParams a {@link java.util.Vector} object. * @param locale a {@link java.lang.String} object. * @return the Reference executed */ Vector runReference(Vector referenceParams, String locale); /** * Retrieves the Requirement summary. *

* * @param requirementParams a {@link java.util.Vector} object. * @return the Requirement summary. */ Vector getRequirementSummary(Vector requirementParams); /** * Retrieve the specifications hierarchy for a Repository. *

* * @param repositoryParams a {@link java.util.Vector} object. * @param sutParams a {@link java.util.Vector} object. * @return the TestCase executed */ Vector getSpecificationHierarchy(Vector repositoryParams, Vector sutParams); }