Commit 5181aba9 authored by fabio martelli's avatar fabio martelli
Browse files

Fix for javadoc

parent fdaf7bb5
...@@ -64,15 +64,28 @@ public interface ConsoleInterfaceService extends JAXRSService { ...@@ -64,15 +64,28 @@ public interface ConsoleInterfaceService extends JAXRSService {
@GET @GET
List<CoordinationDelegateTO> cdList(@PathParam("choreographyInstancePK") String choreographyInstancePK); List<CoordinationDelegateTO> cdList(@PathParam("choreographyInstancePK") String choreographyInstancePK);
/**
* Retrieves service instance list.
*
* @param choreographyInstancePK choreography instance
* @return service instance list
*/
@Path("instance/{choreographyInstancePK}/serviceList") @Path("instance/{choreographyInstancePK}/serviceList")
@GET @GET
List<ServiceTO> instanceServiceList(@PathParam("choreographyInstancePK") String choreographyInstancePK); List<ServiceTO> instanceServiceList(@PathParam("choreographyInstancePK") String choreographyInstancePK);
/**
* Retrieves choreography service list
*
* @param choreographyId choreography id
* @return service list
*/
@Path("{choreographyId}/serviceList") @Path("{choreographyId}/serviceList")
@GET @GET
List<ServiceTO> choreographyServiceList(@PathParam("choreographyId") String choreographyId); List<ServiceTO> choreographyServiceList(@PathParam("choreographyId") String choreographyId);
/** /**
* Retrieves CD operations
* *
* @param choreographyInstancePK * @param choreographyInstancePK
* @param cdName * @param cdName
...@@ -86,6 +99,7 @@ public interface ConsoleInterfaceService extends JAXRSService { ...@@ -86,6 +99,7 @@ public interface ConsoleInterfaceService extends JAXRSService {
); );
/** /**
* Retrieves choreography
* *
* @param choreographyId * @param choreographyId
* @return choreography * @return choreography
...@@ -95,6 +109,7 @@ public interface ConsoleInterfaceService extends JAXRSService { ...@@ -95,6 +109,7 @@ public interface ConsoleInterfaceService extends JAXRSService {
ChoreographyTO getChoreography(@PathParam("choreographyId") String choreographyId); ChoreographyTO getChoreography(@PathParam("choreographyId") String choreographyId);
/** /**
* Retrieves choreography instance
* *
* @param choreographyInstancePK * @param choreographyInstancePK
* @return choreography instance * @return choreography instance
...@@ -104,9 +119,10 @@ public interface ConsoleInterfaceService extends JAXRSService { ...@@ -104,9 +119,10 @@ public interface ConsoleInterfaceService extends JAXRSService {
ChoreographyInstanceTO getChoreographyInstance(@PathParam("choreographyInstancePK") String choreographyInstancePK); ChoreographyInstanceTO getChoreographyInstance(@PathParam("choreographyInstancePK") String choreographyInstancePK);
/** /**
* Retrieved Coordination Delegate
* *
* @param choreographyInstancePK * @param choreographyInstancePK choreography instance
* @param cdName * @param cdName coordination delegate name
* @return coordination delegate * @return coordination delegate
*/ */
@Path("/cd/{cdName}/{choreographyInstancePK}") @Path("/cd/{cdName}/{choreographyInstancePK}")
...@@ -116,6 +132,13 @@ public interface ConsoleInterfaceService extends JAXRSService { ...@@ -116,6 +132,13 @@ public interface ConsoleInterfaceService extends JAXRSService {
@PathParam("cdName") String cdName @PathParam("cdName") String cdName
); );
/**
* Retrieves services
*
* @param choreographyInstancePK choreography instance
* @param serviceName service name
* @return service
*/
@Path("/service/{serviceName}/{choreographyInstancePK}") @Path("/service/{serviceName}/{choreographyInstancePK}")
@GET @GET
ServiceTO getService( ServiceTO getService(
...@@ -124,28 +147,53 @@ public interface ConsoleInterfaceService extends JAXRSService { ...@@ -124,28 +147,53 @@ public interface ConsoleInterfaceService extends JAXRSService {
); );
/** /**
* Retrieves average execution time
* *
* @param choreographyId * @param choreographyId choreography id
* @return average execution time * @return average execution time
*/ */
@Path("{choreographyId}/instancesAverage") @Path("{choreographyId}/instancesAverage")
@GET @GET
Double getAverageInstanceExecutionTime(@PathParam("choreographyId") String choreographyId); Double getAverageInstanceExecutionTime(@PathParam("choreographyId") String choreographyId);
/**
* Retrieves average CD execution time
*
* @param choreographyId choreography id
* @return average execution time
*/
@Path("{choreographyId}/averageCds") @Path("{choreographyId}/averageCds")
@GET @GET
List<AVGCoordinationDelegateTO> averageCdList(@PathParam("choreographyId") String choreographyId); List<AVGCoordinationDelegateTO> averageCdList(@PathParam("choreographyId") String choreographyId);
/**
* Retrieves average service execution time
*
* @param choreographyId choreography id
* @return average execution time
*/
@Path("{choreographyId}/averageServices") @Path("{choreographyId}/averageServices")
@GET @GET
List<AVGServiceTO> averageServiceList(@PathParam("choreographyId") String choreographyId); List<AVGServiceTO> averageServiceList(@PathParam("choreographyId") String choreographyId);
/**
* Retrieves average CD execution time
*
* @param choreographyId choreograpy id
* @param cdName coordination delegate
* @return average execution time
*/
@Path("{choreographyId}/{cdName}/averageOperations") @Path("{choreographyId}/{cdName}/averageOperations")
@GET @GET
List<AVGOperationDataTO> averageOperationList( List<AVGOperationDataTO> averageOperationList(
@PathParam("choreographyId") String choreographyId, @PathParam("choreographyId") String choreographyId,
@PathParam("cdName") String cdName); @PathParam("cdName") String cdName);
/**
* Deltes instance
*
* @param choreographyInstancePK choreography instance
*/
@Path("instance/{choreographyInstancePK}") @Path("instance/{choreographyInstancePK}")
@DELETE @DELETE
void deleteInstance(@PathParam("choreographyInstancePK") String choreographyInstancePK); void deleteInstance(@PathParam("choreographyInstancePK") String choreographyInstancePK);
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment