org.aktin.broker.server

Interface Broker

public interface Broker

Method Summary

Modifier and Type	Method and Description
void	clearRequestTargets(int requestId)
int	createRequest() Create request without specifying content yet.
int	createRequest(String mediaType, Reader content)
void	deleteRequest(int id)
List<Node>	getAllNodes()
Node	getNode(int nodeId)
DateDataSource	getNodeResource(int nodeId, String resourceId)
Reader	getRequestDefinition(int requestId, String mediaType) Get the request definition source for the specified request and media type.
RequestInfo	getRequestInfo(int requestId) Get basic status info for the given request id.
Reader	getRequestNodeStatusMessage(int requestId, int nodeId) Retrieve the status message reported by the specified node for the specified request.
int[]	getRequestTargets(int requestId)
List<String>	getRequestTypes(int requestId)
List<RequestInfo>	listAllRequests()
List<RequestStatusInfo>	listRequestNodeStatus(Integer requestId) Retrieve list with node status for the specified request.
List<RequestInfo>	listRequestsForNode(int nodeId)
boolean	markRequestDeletedForNode(int nodeId, int requestId) Mark a request as deleted for a given node
void	setRequestClosed(int requestId, Instant timestamp)
void	setRequestDefinition(int requestId, String mediaType, Reader content)
void	setRequestNodeStatus(int requestId, int nodeId, RequestStatus status, Instant timestamp)
void	setRequestNodeStatusMessage(int requestId, int nodeId, String messageType, Reader message) Set the node status message.
void	setRequestPublished(int requestId, Instant timestamp)
void	setRequestTargets(int requestId, int[] nodes)

Method Detail

getAllNodes

List<Node> getAllNodes()
                throws SQLException

Throws:

SQLException

getNode

Node getNode(int nodeId)
      throws SQLException

Throws:

SQLException

createRequest

int createRequest(String mediaType,
                  Reader content)
           throws SQLException

Throws:

SQLException

createRequest

int createRequest()
           throws SQLException

Create request without specifying content yet. The request definition must be set afterwards via setRequestDefinition(int, String, Reader)

Returns:

request id

Throws:

SQLException - database error

setRequestDefinition

void setRequestDefinition(int requestId,
                          String mediaType,
                          Reader content)
                   throws SQLException

Throws:

SQLException

deleteRequest

void deleteRequest(int id)
            throws SQLException

Throws:

SQLException

listAllRequests

List<RequestInfo> listAllRequests()
                           throws SQLException

Throws:

SQLException

getRequestTypes

List<String> getRequestTypes(int requestId)
                      throws SQLException

Throws:

SQLException

getRequestDefinition

Reader getRequestDefinition(int requestId,
                            String mediaType)
                     throws SQLException,
                            IOException

Get the request definition source for the specified request and media type.

since the connection will be closed in this method, we cannot stream the CLOB directly from the database. Therefore, we will read the CLOB into memory if small, or a temporary file, if large.

Parameters:

requestId - request id

mediaType - media type

Returns:

reader providing the definition source

Throws:

SQLException - sql error

IOException - io error during CLOB buffering

listRequestsForNode

List<RequestInfo> listRequestsForNode(int nodeId)
                               throws SQLException

Throws:

SQLException

setRequestNodeStatus

void setRequestNodeStatus(int requestId,
                          int nodeId,
                          RequestStatus status,
                          Instant timestamp)
                   throws SQLException

Throws:

SQLException

setRequestNodeStatusMessage

void setRequestNodeStatusMessage(int requestId,
                                 int nodeId,
                                 String messageType,
                                 Reader message)
                          throws SQLException

Set the node status message. The status must be set previously e.g. using setRequestNodeStatus(int, int, RequestStatus, Instant), If there is no status entry for the specified node, this method will fail.

Parameters:

requestId - request id

nodeId - node id

messageType - media type for the status message

message - content of the status message

Throws:

SQLException - sql errror

markRequestDeletedForNode

boolean markRequestDeletedForNode(int nodeId,
                                  int requestId)
                           throws SQLException

Mark a request as deleted for a given node

Parameters:

nodeId - node id

requestId - request id

Returns:

true if the request could be marked as deleted. false if the request was already deleted or could not be found

Throws:

SQLException - sql error

listRequestNodeStatus

List<RequestStatusInfo> listRequestNodeStatus(Integer requestId)
                                       throws SQLException

Retrieve list with node status for the specified request.

Parameters:

requestId - request id

Returns:

Status list or null if request is not found.

Throws:

SQLException - SQL error

getRequestInfo

RequestInfo getRequestInfo(int requestId)
                    throws SQLException

Get basic status info for the given request id.

Parameters:

requestId - request id

Returns:

request info or null if not found

Throws:

SQLException - SQL error

setRequestPublished

void setRequestPublished(int requestId,
                         Instant timestamp)
                  throws SQLException

Throws:

SQLException

setRequestClosed

void setRequestClosed(int requestId,
                      Instant timestamp)
               throws SQLException

Throws:

SQLException

setRequestTargets

void setRequestTargets(int requestId,
                       int[] nodes)
                throws SQLException

Throws:

SQLException

getRequestTargets

int[] getRequestTargets(int requestId)
                 throws SQLException

Throws:

SQLException

clearRequestTargets

void clearRequestTargets(int requestId)
                  throws SQLException

Throws:

SQLException

getRequestNodeStatusMessage

Reader getRequestNodeStatusMessage(int requestId,
                                   int nodeId)
                            throws SQLException,
                                   IOException

Retrieve the status message reported by the specified node for the specified request. TODO also return media type.

Parameters:

requestId - request id

nodeId - node id

Returns:

reader for the status message

Throws:

SQLException

IOException

getNodeResource

DateDataSource getNodeResource(int nodeId,
                               String resourceId)
                        throws SQLException

Throws:

SQLException