org.aktin.broker

Class RequestAdminEndpoint

java.lang.Object

org.aktin.broker.AbstractRequestEndpoint

org.aktin.broker.RequestAdminEndpoint

@Path(value="/broker/request")
public class RequestAdminEndpoint
extends AbstractRequestEndpoint

Constructor Summary

Constructors

Constructor and Description
RequestAdminEndpoint()

Method Summary

Modifier and Type	Method and Description
void	clearRequestTargetNodes(Integer requestId) Delete a restriction to certain target nodes.
void	closeRequest(Integer requestId)
javax.ws.rs.core.Response	createRequest(Reader content, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo info)
javax.ws.rs.core.Response	createRequest(String requestId, Reader content, javax.ws.rs.core.HttpHeaders headers)
String	debugReturnRequestHeaders(javax.ws.rs.core.HttpHeaders headers)
javax.ws.rs.core.Response	deleteRequest(String id)
protected BrokerBackend	getBroker()
javax.ws.rs.core.Response	getRequest(Integer requestId, javax.ws.rs.core.HttpHeaders headers)
RequestStatusList	getRequestInfo(Integer requestId) List status information for the specified request for each node
javax.ws.rs.core.Response	getRequestInfo(int requestId, javax.ws.rs.core.HttpHeaders headers)
javax.ws.rs.core.Response	getRequestNodeStatusMessage(Integer requestId, Integer nodeId)
RequestTargetNodes	getRequestTargetNodes(Integer requestId) Get the targeted nodes for this request.
protected RequestTypeManager	getTypeManager()
javax.ws.rs.core.Response	listAllRequests()
void	publishRequest(Integer requestId)
void	setRequestTargetNodes(Integer requestId, RequestTargetNodes nodes)

Methods inherited from class org.aktin.broker.AbstractRequestEndpoint

getRequest, removeCharsetInfo

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RequestAdminEndpoint

public RequestAdminEndpoint()

Method Detail

createRequest

@POST
public javax.ws.rs.core.Response createRequest(Reader content,
                                                      @Context
                                                      javax.ws.rs.core.HttpHeaders headers,
                                                      @Context
                                                      javax.ws.rs.core.UriInfo info)
                                               throws URISyntaxException

Throws:

URISyntaxException

debugReturnRequestHeaders

@GET
 @Path(value="headers")
 @Produces(value="text/plain")
public String debugReturnRequestHeaders(@Context
                                                                                                       javax.ws.rs.core.HttpHeaders headers)

createRequest

@PUT
 @Path(value="{id}")
public javax.ws.rs.core.Response createRequest(@PathParam(value="id")
                                                                           String requestId,
                                                                           Reader content,
                                                                           @Context
                                                                           javax.ws.rs.core.HttpHeaders headers)
                                                                    throws URISyntaxException

Throws:

URISyntaxException

listAllRequests

@GET
 @Produces(value="application/xml")
public javax.ws.rs.core.Response listAllRequests()

deleteRequest

@DELETE
 @Path(value="{id}")
public javax.ws.rs.core.Response deleteRequest(@PathParam(value="id")
                                                                              String id)

getRequest

@GET
 @Path(value="{id}")
public javax.ws.rs.core.Response getRequest(@PathParam(value="id")
                                                                        Integer requestId,
                                                                        @Context
                                                                        javax.ws.rs.core.HttpHeaders headers)
                                                                 throws SQLException,
                                                                        IOException,
                                                                        javax.ws.rs.NotFoundException

Throws:

SQLException

IOException

javax.ws.rs.NotFoundException

getRequestInfo

@OPTIONS
 @Path(value="{id}")
public javax.ws.rs.core.Response getRequestInfo(@PathParam(value="id")
                                                                                int requestId,
                                                                                @Context
                                                                                javax.ws.rs.core.HttpHeaders headers)
                                                                         throws SQLException,
                                                                                IOException

Throws:

SQLException

IOException

getRequestInfo

@GET
 @Path(value="{id}/status")
 @Produces(value="application/xml")
public RequestStatusList getRequestInfo(@PathParam(value="id")
                                                                                                                Integer requestId)
                                                                                                         throws SQLException,
                                                                                                                IOException

List status information for the specified request for each node

Parameters:

requestId - request

Returns:

status information list

Throws:

SQLException - SQL error

IOException - IO error

getRequestTargetNodes

@GET
 @Path(value="{id}/nodes")
 @Produces(value="application/xml")
public RequestTargetNodes getRequestTargetNodes(@PathParam(value="id")
                                                                                                                       Integer requestId)
                                                                                                                throws SQLException,
                                                                                                                       IOException,
                                                                                                                       javax.ws.rs.NotFoundException

Get the targeted nodes for this request. A resource is only returned, if the request is limited to / targeted at specifig nodes.

Parameters:

requestId - request

Returns:

target node list

Throws:

SQLException - SQL error

IOException - IO error

javax.ws.rs.NotFoundException - if the request is not targeted at specific nodes

clearRequestTargetNodes

@DELETE
 @Path(value="{id}/nodes")
public void clearRequestTargetNodes(@PathParam(value="id")
                                                                         Integer requestId)
                                                                  throws SQLException,
                                                                         IOException,
                                                                         javax.ws.rs.NotFoundException

Delete a restriction to certain target nodes. When the delete is successful, the request can be retrieved by all nodes.

Parameters:

requestId - request id

Throws:

SQLException - SQL error

IOException - IO error

javax.ws.rs.NotFoundException - request not found or request not targeted at specific nodes

setRequestTargetNodes

@PUT
 @Path(value="{id}/nodes")
 @Consumes(value="application/xml")
public void setRequestTargetNodes(@PathParam(value="id")
                                                                                                         Integer requestId,
                                                                                                         RequestTargetNodes nodes)
                                                                                                  throws SQLException,
                                                                                                         IOException,
                                                                                                         javax.ws.rs.NotFoundException

Throws:

SQLException

IOException

javax.ws.rs.NotFoundException

getRequestNodeStatusMessage

@GET
 @Path(value="{id}/status/{nodeId}")
public javax.ws.rs.core.Response getRequestNodeStatusMessage(@PathParam(value="id")
                                                                                                         Integer requestId,
                                                                                                         @PathParam(value="nodeId")
                                                                                                         Integer nodeId)
                                                                                                  throws SQLException,
                                                                                                         IOException

Throws:

SQLException

IOException

publishRequest

@POST
 @Path(value="{id}/publish")
public void publishRequest(@PathParam(value="id")
                                                                Integer requestId)
                                                         throws SQLException

Throws:

SQLException

closeRequest

@POST
 @Path(value="{id}/close")
public void closeRequest(@PathParam(value="id")
                                                            Integer requestId)
                                                     throws SQLException

Throws:

SQLException

getTypeManager

protected RequestTypeManager getTypeManager()

Specified by:

getTypeManager in class AbstractRequestEndpoint

getBroker

protected BrokerBackend getBroker()

Specified by:

getBroker in class AbstractRequestEndpoint