org.apache.nifi.web.api

Class ConnectionResource

java.lang.Object

org.apache.nifi.web.api.ApplicationResource

org.apache.nifi.web.api.ConnectionResource

public class ConnectionResource
extends ApplicationResource

RESTful endpoint for managing a Connection.

Field Summary

Fields

Modifier and Type	Field and Description
private WebClusterManager	clusterManager
private String	groupId
private static org.slf4j.Logger	logger
private NiFiProperties	properties
private NiFiServiceFacade	serviceFacade

Fields inherited from class org.apache.nifi.web.api.ApplicationResource

CLIENT_ID, CLUSTER_CONTEXT_HTTP_HEADER, PROXIED_ENTITIES_CHAIN_HTTP_HEADER, PROXIED_ENTITY_USER_DETAILS_HTTP_HEADER, PROXY_CONTEXT_PATH_HTTP_HEADER, PROXY_HOST_HTTP_HEADER, PROXY_PORT_HTTP_HEADER, PROXY_SCHEME_HTTP_HEADER, VERSION

Constructor Summary

Constructors

Constructor and Description
ConnectionResource()

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createConnection(javax.servlet.http.HttpServletRequest httpServletRequest, ConnectionEntity connectionEntity) Creates a new connection.
javax.ws.rs.core.Response	createConnection(javax.servlet.http.HttpServletRequest httpServletRequest, LongParameter version, ClientIdParameter clientId, String name, String sourceId, String sourceGroupId, ConnectableTypeParameter sourceType, Set<String> relationships, List<String> bends, String flowFileExpiration, LongParameter backPressureObjectThreshold, String backPressureDataSizeThreshold, List<String> prioritizers, String destinationId, String destinationGroupId, ConnectableTypeParameter destinationType, javax.ws.rs.core.MultivaluedMap<String,String> formParams) Creates a connection.
javax.ws.rs.core.Response	deleteRelationshipTarget(javax.servlet.http.HttpServletRequest httpServletRequest, LongParameter version, ClientIdParameter clientId, String id) Removes the specified connection.
javax.ws.rs.core.Response	getConnection(ClientIdParameter clientId, String id) Retrieves the specified connection.
javax.ws.rs.core.Response	getConnections(ClientIdParameter clientId) Gets all the connections.
javax.ws.rs.core.Response	getConnectionStatusHistory(ClientIdParameter clientId, String id) Retrieves the specified connection status history.
private ConnectionDTO	populateRemainingConnectionContent(ConnectionDTO connection) Populate the uri's for the specified processor and its relationships.
Set<ConnectionDTO>	populateRemainingConnectionsContent(Set<ConnectionDTO> connections) Populate the uri's for the specified processors and their relationships.
void	setClusterManager(WebClusterManager clusterManager)
void	setGroupId(String groupId)
void	setProperties(NiFiProperties properties)
void	setServiceFacade(NiFiServiceFacade serviceFacade)
javax.ws.rs.core.Response	updateConnection(javax.servlet.http.HttpServletRequest httpServletRequest, LongParameter version, ClientIdParameter clientId, String connectionId, String name, Set<String> relationships, List<String> bends, IntegerParameter labelIndex, LongParameter zIndex, String flowFileExpiration, LongParameter backPressureObjectThreshold, String backPressureDataSizeThreshold, List<String> prioritizers, String destinationId, String destinationGroupId, ConnectableTypeParameter destinationType, javax.ws.rs.core.MultivaluedMap<String,String> formParams) Updates the specified relationship target.
javax.ws.rs.core.Response	updateConnection(javax.servlet.http.HttpServletRequest httpServletRequest, String id, ConnectionEntity connectionEntity) Updates the specified connection.

Methods inherited from class org.apache.nifi.web.api.ApplicationResource

clusterContext, generateContinueResponse, generateCreatedResponse, generateOkResponse, generateOkResponse, generateResourceUri, getAbsolutePath, getClusterContextFromRequest, getHeaders, getHeaders, getRequestParameters, getRequestParameters, noCache, updateClientId

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final org.slf4j.Logger logger

serviceFacade

private NiFiServiceFacade serviceFacade

clusterManager

private WebClusterManager clusterManager

properties

private NiFiProperties properties

groupId

private String groupId

Constructor Detail

ConnectionResource

public ConnectionResource()

Method Detail

populateRemainingConnectionsContent

public Set<ConnectionDTO> populateRemainingConnectionsContent(Set<ConnectionDTO> connections)

Populate the uri's for the specified processors and their relationships.

Parameters:

connections -

Returns:

populateRemainingConnectionContent

private ConnectionDTO populateRemainingConnectionContent(ConnectionDTO connection)

Populate the uri's for the specified processor and its relationships.

Parameters:

connection -

Returns:

getConnections

@PreAuthorize(value="hasAnyRole(\'ROLE_MONITOR\', \'ROLE_DFM\', \'ROLE_ADMIN\')")
public javax.ws.rs.core.Response getConnections(ClientIdParameter clientId)

Gets all the connections.

Parameters:

clientId - Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.

Returns:

A connectionsEntity.

getConnection

@PreAuthorize(value="hasAnyRole(\'ROLE_MONITOR\', \'ROLE_DFM\', \'ROLE_ADMIN\')")
public javax.ws.rs.core.Response getConnection(ClientIdParameter clientId,
                                                   String id)

Retrieves the specified connection.

Parameters:

clientId - Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.

id - The id of the connection.

Returns:

A connectionEntity.

getConnectionStatusHistory

@PreAuthorize(value="hasAnyRole(\'ROLE_MONITOR\', \'ROLE_DFM\', \'ROLE_ADMIN\')")
public javax.ws.rs.core.Response getConnectionStatusHistory(ClientIdParameter clientId,
                                                                String id)

Retrieves the specified connection status history.

Parameters:

clientId - Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.

id - The id of the connection to retrieve.

Returns:

A statusHistoryEntity.

createConnection

@PreAuthorize(value="hasRole(\'ROLE_DFM\')")
public javax.ws.rs.core.Response createConnection(@Context
                                                      javax.servlet.http.HttpServletRequest httpServletRequest,
                                                      LongParameter version,
                                                      ClientIdParameter clientId,
                                                      String name,
                                                      String sourceId,
                                                      String sourceGroupId,
                                                      ConnectableTypeParameter sourceType,
                                                      Set<String> relationships,
                                                      List<String> bends,
                                                      String flowFileExpiration,
                                                      LongParameter backPressureObjectThreshold,
                                                      String backPressureDataSizeThreshold,
                                                      List<String> prioritizers,
                                                      String destinationId,
                                                      String destinationGroupId,
                                                      ConnectableTypeParameter destinationType,
                                                      javax.ws.rs.core.MultivaluedMap<String,String> formParams)

Creates a connection.

Parameters:

httpServletRequest -

version - The revision is used to verify the client is working with the latest version of the flow.

clientId - Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.

name - The name of the connection.

sourceId - The id of the source connectable.

sourceGroupId - The parent group id for the source.

sourceType - The type of the source connectable.

bends - Array of bend points in string form ["x,y", "x,y", "x,y"]

relationships - Array of relationships.

flowFileExpiration - The flow file expiration in minutes

backPressureObjectThreshold - The object count for when to apply back pressure.

backPressureDataSizeThreshold - The object size for when to apply back pressure.

prioritizers - Array of prioritizer types. These types should refer to one of the types in the GET /controller/prioritizers response. If this parameter is not specified no change will be made. If this parameter appears with no value (empty string), it will be treated as an empty array.

destinationId - The id of the destination connectable.

destinationGroupId - The parent group id for the destination.

destinationType - The type of the destination connectable.

formParams -

Returns:

A connectionEntity.

createConnection

@PreAuthorize(value="hasRole(\'ROLE_DFM\')")
public javax.ws.rs.core.Response createConnection(@Context
                                                      javax.servlet.http.HttpServletRequest httpServletRequest,
                                                      ConnectionEntity connectionEntity)

Creates a new connection.

Parameters:

httpServletRequest -

connectionEntity - A connectionEntity.

Returns:

A connectionEntity.

updateConnection

@PreAuthorize(value="hasRole(\'ROLE_DFM\')")
public javax.ws.rs.core.Response updateConnection(@Context
                                                      javax.servlet.http.HttpServletRequest httpServletRequest,
                                                      LongParameter version,
                                                      ClientIdParameter clientId,
                                                      String connectionId,
                                                      String name,
                                                      Set<String> relationships,
                                                      List<String> bends,
                                                      IntegerParameter labelIndex,
                                                      LongParameter zIndex,
                                                      String flowFileExpiration,
                                                      LongParameter backPressureObjectThreshold,
                                                      String backPressureDataSizeThreshold,
                                                      List<String> prioritizers,
                                                      String destinationId,
                                                      String destinationGroupId,
                                                      ConnectableTypeParameter destinationType,
                                                      javax.ws.rs.core.MultivaluedMap<String,String> formParams)

Updates the specified relationship target.

Parameters:

httpServletRequest -

version - The revision is used to verify the client is working with the latest version of the flow.

clientId - Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.

connectionId - The id of the source processor.

name - The name of the connection.

relationships - Array of relationships.

bends - Array of bend points in string form ["x,y", "x,y", "x,y"]

labelIndex - The control point index for the connection label

zIndex - The zIndex for this connection

flowFileExpiration - The flow file expiration in minutes

backPressureObjectThreshold - The object count for when to apply back pressure.

backPressureDataSizeThreshold - The object size for when to apply back pressure.

prioritizers - Array of prioritizer types. These types should refer to one of the types in the GET /controller/prioritizers response. If this parameter is not specified no change will be made. If this parameter appears with no value (empty string), it will be treated as an empty array.

destinationId - The id of the destination connectable.

destinationGroupId - The group id of the destination.

destinationType - The type of the destination type.

formParams -

Returns:

A connectionEntity.

updateConnection

@PreAuthorize(value="hasRole(\'ROLE_DFM\')")
public javax.ws.rs.core.Response updateConnection(@Context
                                                      javax.servlet.http.HttpServletRequest httpServletRequest,
                                                      String id,
                                                      ConnectionEntity connectionEntity)

Updates the specified connection.

Parameters:

httpServletRequest -

id - The id of the connection.

connectionEntity - A connectionEntity.

Returns:

A connectionEntity.

deleteRelationshipTarget

@PreAuthorize(value="hasRole(\'ROLE_DFM\')")
public javax.ws.rs.core.Response deleteRelationshipTarget(@Context
                                                              javax.servlet.http.HttpServletRequest httpServletRequest,
                                                              LongParameter version,
                                                              ClientIdParameter clientId,
                                                              String id)

Removes the specified connection.

Parameters:

httpServletRequest -

version - The revision is used to verify the client is working with the latest version of the flow.

clientId - Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.

id - The id of the connection.

Returns:

An Entity containing the client id and an updated revision.

setServiceFacade

public void setServiceFacade(NiFiServiceFacade serviceFacade)

setGroupId

public void setGroupId(String groupId)

setClusterManager

public void setClusterManager(WebClusterManager clusterManager)

setProperties

public void setProperties(NiFiProperties properties)