org.ow2.proactive_grid_cloud_portal.studio

Interface StudioInterface

@Path(value="/studio")
 @Produces(value="application/json")
public interface StudioInterface

Method Summary

Modifier and Type	Method and Description
String	createClass(String sessionId, org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataInput multipart)
String	createScript(String sessionId, String name, String content)
Workflow	createWorkflow(String sessionId, Workflow workflow)
String	currentUser(String sessionId)
UserData	currentUserData(String sessionId)
void	deleteWorkflow(String sessionId, String workflowId)
ArrayList<String>	getClasses(String sessionId)
List<String>	getDomains()
List<Script>	getScripts(String sessionId)
String	getVisualization(String sessionId, String jobId)
Workflow	getWorkflow(String sessionId, String workflowId)
List<Workflow>	getWorkflows(String sessionId)
String	getWorkflowXmlContent(String sessionId, String workflowId)
boolean	isConnected(String sessionId)
String	login(String username, String password)
String	loginWithCredential(LoginForm multipart)
void	logout(String sessionId)
JobIdData	submit(String sessionId, javax.ws.rs.core.PathSegment pathSegment, org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataInput multipart, javax.ws.rs.core.UriInfo contextInfos) Submits a job to the scheduler
String	submitPlannings(String sessionId, javax.ws.rs.core.PathSegment pathSegment, Map<String,String> jobContentXmlString) Submit a job to job planner
String	updateScript(String sessionId, String name, String content)
boolean	updateVisualization(String sessionId, String jobId, String visualization)
Workflow	updateWorkflow(String sessionId, String workflowId, Workflow workflow)
JobValidationData	validate(String sessionId, javax.ws.rs.core.PathSegment pathSegment, org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataInput multipart) Validates a job.

Method Detail

login

@POST
 @Path(value="login")
String login(@FormParam(value="username")
                                         String username,
                                         @FormParam(value="password")
                                         String password)
                                  throws KeyException,
                                         LoginException,
                                         SchedulerRestException

Throws:

KeyException

LoginException

SchedulerRestException

loginWithCredential

@POST
 @Consumes(value="multipart/form-data")
 @Path(value="login")
String loginWithCredential(LoginForm multipart)
                                                                                        throws IOException,
                                                                                               KeyException,
                                                                                               LoginException,
                                                                                               SchedulerRestException

Throws:

IOException

KeyException

LoginException

SchedulerRestException

logout

@PUT
 @Path(value="logout")
void logout(@HeaderParam(value="sessionid")
                                        String sessionId)
                                 throws RestException

Throws:

RestException

isConnected

@GET
 @Path(value="connected")
boolean isConnected(@HeaderParam(value="sessionid")
                                                   String sessionId)

currentUser

@GET
 @Path(value="currentuser")
String currentUser(@HeaderParam(value="sessionid")
                                                    String sessionId)

currentUserData

@GET
 @Path(value="currentuserdata")
UserData currentUserData(@HeaderParam(value="sessionid")
                                                              String sessionId)

getDomains

@GET
 @Path(value="domains")
 @Produces(value="application/json")
List<String> getDomains()

getWorkflows

@GET
 @Path(value="workflows")
List<Workflow> getWorkflows(@HeaderParam(value="sessionid")
                                                           String sessionId)
                                                    throws NotConnectedRestException,
                                                           IOException

Throws:

NotConnectedRestException

IOException

createWorkflow

@POST
 @Path(value="workflows")
 @Consumes(value="application/json")
Workflow createWorkflow(@HeaderParam(value="sessionid")
                                                                                             String sessionId,
                                                                                             Workflow workflow)
                                                                                      throws NotConnectedRestException,
                                                                                             IOException

Throws:

NotConnectedRestException

IOException

getWorkflow

@GET
 @Path(value="workflows/{id}")
 @Produces(value="application/json")
Workflow getWorkflow(@HeaderParam(value="sessionid")
                                                                                              String sessionId,
                                                                                              @PathParam(value="id")
                                                                                              String workflowId)
                                                                                       throws NotConnectedRestException,
                                                                                              IOException

Throws:

NotConnectedRestException

IOException

getWorkflowXmlContent

@GET
 @Path(value="workflows/{id}/xml")
 @Produces(value="application/xml")
String getWorkflowXmlContent(@HeaderParam(value="sessionid")
                                                                                                         String sessionId,
                                                                                                         @PathParam(value="id")
                                                                                                         String workflowId)
                                                                                                  throws NotConnectedRestException,
                                                                                                         IOException

Throws:

NotConnectedRestException

IOException

updateWorkflow

@PUT
 @Path(value="workflows/{id}")
 @Consumes(value="application/json")
Workflow updateWorkflow(@HeaderParam(value="sessionid")
                                                                                                 String sessionId,
                                                                                                 @PathParam(value="id")
                                                                                                 String workflowId,
                                                                                                 Workflow workflow)
                                                                                          throws NotConnectedRestException,
                                                                                                 IOException

Throws:

NotConnectedRestException

IOException

deleteWorkflow

@DELETE
 @Path(value="workflows/{id}")
void deleteWorkflow(@HeaderParam(value="sessionid")
                                                           String sessionId,
                                                           @PathParam(value="id")
                                                           String workflowId)
                                                    throws NotConnectedRestException,
                                                           IOException

Throws:

NotConnectedRestException

IOException

getScripts

@GET
 @Path(value="scripts")
List<Script> getScripts(@HeaderParam(value="sessionid")
                                                     String sessionId)
                                              throws NotConnectedRestException,
                                                     IOException

Throws:

NotConnectedRestException

IOException

createScript

@POST
 @Path(value="scripts")
String createScript(@HeaderParam(value="sessionid")
                                                  String sessionId,
                                                  @FormParam(value="name")
                                                  String name,
                                                  @FormParam(value="content")
                                                  String content)
                                           throws NotConnectedRestException,
                                                  IOException

Throws:

NotConnectedRestException

IOException

updateScript

@POST
 @Path(value="scripts/{name}")
String updateScript(@HeaderParam(value="sessionid")
                                                         String sessionId,
                                                         @PathParam(value="name")
                                                         String name,
                                                         @FormParam(value="content")
                                                         String content)
                                                  throws NotConnectedRestException,
                                                         IOException

Throws:

NotConnectedRestException

IOException

getClasses

@GET
 @Path(value="classes")
ArrayList<String> getClasses(@HeaderParam(value="sessionid")
                                                          String sessionId)
                                                   throws NotConnectedRestException

Throws:

NotConnectedRestException

createClass

@POST
 @Path(value="classes")
 @Consumes(value="multipart/form-data")
String createClass(@HeaderParam(value="sessionid")
                                                                                         String sessionId,
                                                                                         org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataInput multipart)
                                                                                  throws NotConnectedRestException,
                                                                                         IOException

Throws:

NotConnectedRestException

IOException

validate

@POST
 @Path(value="{path:validate}")
 @Consumes(value="multipart/form-data")
 @Produces(value="application/json")
JobValidationData validate(@HeaderParam(value="sessionid")
                                                                                                                                              String sessionId,
                                                                                                                                              @PathParam(value="path")
                                                                                                                                              javax.ws.rs.core.PathSegment pathSegment,
                                                                                                                                              org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataInput multipart)
                                                                                                                                       throws NotConnectedRestException

Validates a job.

Parameters:

multipart - a HTTP multipart form which contains the job-descriptor

Returns:

the result of job validation

Throws:

NotConnectedRestException

submit

@POST
 @Path(value="{path:submit}")
 @Consumes(value="multipart/form-data")
JobIdData submit(@HeaderParam(value="sessionid")
                                                                                             String sessionId,
                                                                                             @PathParam(value="path")
                                                                                             javax.ws.rs.core.PathSegment pathSegment,
                                                                                             org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataInput multipart,
                                                                                             @Context
                                                                                             javax.ws.rs.core.UriInfo contextInfos)
                                                                                      throws JobCreationRestException,
                                                                                             NotConnectedRestException,
                                                                                             PermissionRestException,
                                                                                             SubmissionClosedRestException,
                                                                                             IOException

Submits a job to the scheduler

Parameters:

sessionId - a valid session id

multipart - a form with the job file as form data

Returns:

the jobid of the newly created job

Throws:

JobCreationRestException

NotConnectedRestException

PermissionRestException

SubmissionClosedRestException

IOException

submitPlannings

@POST
 @Path(value="{path:plannings}")
 @Consumes(value="application/json")
 @Produces(value="application/json")
String submitPlannings(@HeaderParam(value="sessionid")
                                                                                                                                        String sessionId,
                                                                                                                                        @PathParam(value="path")
                                                                                                                                        javax.ws.rs.core.PathSegment pathSegment,
                                                                                                                                        Map<String,String> jobContentXmlString)
                                                                                                                                 throws JobCreationRestException,
                                                                                                                                        NotConnectedRestException,
                                                                                                                                        PermissionRestException,
                                                                                                                                        SubmissionClosedRestException,
                                                                                                                                        IOException

Submit a job to job planner

Parameters:

sessionId - a valid session id

pathSegment - variables string

jobContentXmlString - job content in xml string

Returns:

true if the job is submitted successfully, false otherwise

Throws:

JobCreationRestException

NotConnectedRestException

PermissionRestException

SubmissionClosedRestException

IOException

getVisualization

@GET
 @Path(value="visualizations/{id}")
String getVisualization(@HeaderParam(value="sessionid")
                                                                 String sessionId,
                                                                 @PathParam(value="id")
                                                                 String jobId)
                                                          throws NotConnectedRestException,
                                                                 IOException

Throws:

NotConnectedRestException

IOException

updateVisualization

@POST
 @Path(value="visualizations/{id}")
boolean updateVisualization(@HeaderParam(value="sessionid")
                                                                      String sessionId,
                                                                      @PathParam(value="id")
                                                                      String jobId,
                                                                      @FormParam(value="visualization")
                                                                      String visualization)
                                                               throws NotConnectedRestException,
                                                                      IOException

Throws:

NotConnectedRestException

IOException