org.oddjob.rest

Interface OddjobApi

All Known Implementing Classes:

OddjobApiImpl

@Path(value="/api")
public interface OddjobApi

Definition of the Oddjob Restful Web Service.

Author:

rob

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	actionForm(java.lang.String nodeId, java.lang.String actionName, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	actionForm2(java.lang.String nodeId, java.lang.String actionName, javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> formParams)
javax.ws.rs.core.Response	actionsFor(java.lang.String nodeId)
javax.ws.rs.core.Response	consoleLines(java.lang.String nodeId, java.lang.String logSeq)
javax.ws.rs.core.Response	dialogFor(java.lang.String nodeId, java.lang.String actionName)
javax.ws.rs.core.Response	iconFor(java.lang.String iconId)
javax.ws.rs.core.Response	logLines(java.lang.String nodeId, java.lang.String logSeq)
javax.ws.rs.core.Response	nodeInfo(java.lang.String nodeIds, long eventSeq)
javax.ws.rs.core.Response	performAction(java.lang.String nodeId, java.lang.String actionName)
javax.ws.rs.core.Response	properties(java.lang.String nodeId)
javax.ws.rs.core.Response	state(java.lang.String nodeId)
javax.ws.rs.core.Response	summariesFor(java.lang.String componentPaths)

Method Detail

summariesFor

@GET
 @Path(value="summariesFor")
 @Produces(value="application/json")
javax.ws.rs.core.Response summariesFor(@QueryParam(value="paths")
                                                                                                                 java.lang.String componentPaths)

nodeInfo

@GET
 @Path(value="nodeInfo")
 @Produces(value="application/json")
javax.ws.rs.core.Response nodeInfo(@QueryParam(value="nodeIds")
                                                                                                         java.lang.String nodeIds,
                                                                                                         @QueryParam(value="eventSeq")
                                                                                                         long eventSeq)

iconFor

@GET
 @Path(value="icon/{iconId}")
 @Produces(value="image/gif")
javax.ws.rs.core.Response iconFor(@PathParam(value="iconId")
                                                                                                      java.lang.String iconId)

actionsFor

@GET
 @Path(value="actionsFor/{nodeId}")
 @Produces(value="application/json")
javax.ws.rs.core.Response actionsFor(@PathParam(value="nodeId")
                                                                                                                      java.lang.String nodeId)

performAction

@GET
 @Path(value="action/{nodeId}/{actionName}")
 @Produces(value="application/json")
javax.ws.rs.core.Response performAction(@PathParam(value="nodeId")
                                                                                                                                  java.lang.String nodeId,
                                                                                                                                  @PathParam(value="actionName")
                                                                                                                                  java.lang.String actionName)

dialogFor

@GET
 @Path(value="dialogFor/{nodeId}/{actionName}")
 @Produces(value="application/json")
javax.ws.rs.core.Response dialogFor(@PathParam(value="nodeId")
                                                                                                                                 java.lang.String nodeId,
                                                                                                                                 @PathParam(value="actionName")
                                                                                                                                 java.lang.String actionName)

actionForm2

@POST
 @Consumes(value="application/x-www-form-urlencoded")
 @Path(value="formAction/{nodeId}/{actionName}")
 @Produces(value="application/json")
javax.ws.rs.core.Response actionForm2(@PathParam(value="nodeId")
                                                                                                                                                                                            java.lang.String nodeId,
                                                                                                                                                                                            @PathParam(value="actionName")
                                                                                                                                                                                            java.lang.String actionName,
                                                                                                                                                                                            javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> formParams)

actionForm

@POST
 @Path(value="formAction/{nodeId}/{actionName}")
 @Consumes(value="multipart/form-data")
javax.ws.rs.core.Response actionForm(@PathParam(value="nodeId")
                                                                                                                                       java.lang.String nodeId,
                                                                                                                                       @PathParam(value="actionName")
                                                                                                                                       java.lang.String actionName,
                                                                                                                                       @Context
                                                                                                                                       javax.servlet.http.HttpServletRequest request)

state

@GET
 @Path(value="state/{nodeId}")
 @Produces(value="application/json")
javax.ws.rs.core.Response state(@PathParam(value="nodeId")
                                                                                                            java.lang.String nodeId)

consoleLines

@GET
 @Path(value="consoleLines/{nodeId}")
 @Produces(value="application/json")
javax.ws.rs.core.Response consoleLines(@PathParam(value="nodeId")
                                                                                                                          java.lang.String nodeId,
                                                                                                                          @QueryParam(value="logSeq")
                                                                                                                          java.lang.String logSeq)

logLines

@GET
 @Path(value="logLines/{nodeId}")
 @Produces(value="application/json")
javax.ws.rs.core.Response logLines(@PathParam(value="nodeId")
                                                                                                                  java.lang.String nodeId,
                                                                                                                  @QueryParam(value="logSeq")
                                                                                                                  java.lang.String logSeq)

properties

@GET
 @Path(value="properties/{nodeId}")
 @Produces(value="application/json")
javax.ws.rs.core.Response properties(@PathParam(value="nodeId")
                                                                                                                      java.lang.String nodeId)