org.apache.nifi.web.api

Class OutputPortResource

java.lang.Object

org.apache.nifi.web.api.ApplicationResource

org.apache.nifi.web.api.OutputPortResource

public class OutputPortResource
extends ApplicationResource

RESTful endpoint for managing an Output Port.

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
OutputPortResource()

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createOutputPort(javax.servlet.http.HttpServletRequest httpServletRequest, LongParameter version, ClientIdParameter clientId, DoubleParameter x, DoubleParameter y, String name) Creates a new output port.
javax.ws.rs.core.Response	createOutputPort(javax.servlet.http.HttpServletRequest httpServletRequest, OutputPortEntity portEntity) Creates a new output port.
javax.ws.rs.core.Response	getOutputPort(ClientIdParameter clientId, String id) Retrieves the specified output port.
javax.ws.rs.core.Response	getOutputPorts(ClientIdParameter clientId) Retrieves all the of output ports in this NiFi.
private PortDTO	populateRemainingOutputPortContent(PortDTO outputPort) Populates the uri for the specified output ports.
Set<PortDTO>	populateRemainingOutputPortsContent(Set<PortDTO> outputPorts) Populates the uri for the specified output ports.
javax.ws.rs.core.Response	removeOutputPort(javax.servlet.http.HttpServletRequest httpServletRequest, LongParameter version, ClientIdParameter clientId, String id) Removes the specified output port.
void	setClusterManager(WebClusterManager clusterManager)
void	setGroupId(String groupId)
void	setProperties(NiFiProperties properties)
void	setServiceFacade(NiFiServiceFacade serviceFacade)
javax.ws.rs.core.Response	updateOutputPort(javax.servlet.http.HttpServletRequest httpServletRequest, LongParameter version, ClientIdParameter clientId, String id, DoubleParameter x, DoubleParameter y, String comments, Set<String> groupAccessControl, Set<String> userAccessControl, String name, String state, IntegerParameter concurrentlySchedulableTaskCount, javax.ws.rs.core.MultivaluedMap<String,String> formParams) Updates the specified output port.
javax.ws.rs.core.Response	updateOutputPort(javax.servlet.http.HttpServletRequest httpServletRequest, String id, OutputPortEntity portEntity) Updates the specified output port.

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

OutputPortResource

public OutputPortResource()

Method Detail

populateRemainingOutputPortsContent

public Set<PortDTO> populateRemainingOutputPortsContent(Set<PortDTO> outputPorts)

Populates the uri for the specified output ports.

Parameters:

outputPorts -

Returns:

populateRemainingOutputPortContent

private PortDTO populateRemainingOutputPortContent(PortDTO outputPort)

Populates the uri for the specified output ports.

getOutputPorts

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

Retrieves all the of output ports in this NiFi.

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 outputPortsEntity.

createOutputPort

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

Creates a new output port.

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.

x - The x coordinate for this funnels position.

y - The y coordinate for this funnels position.

name - The output ports name.

Returns:

An outputPortEntity.

createOutputPort

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

Creates a new output port.

Parameters:

httpServletRequest -

portEntity - A outputPortEntity.

Returns:

A outputPortEntity.

getOutputPort

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

Retrieves the specified output port.

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 output port to retrieve

Returns:

A outputPortEntity.

updateOutputPort

@PreAuthorize(value="hasRole(\'ROLE_DFM\')")
public javax.ws.rs.core.Response updateOutputPort(@Context
                                                      javax.servlet.http.HttpServletRequest httpServletRequest,
                                                      LongParameter version,
                                                      ClientIdParameter clientId,
                                                      String id,
                                                      DoubleParameter x,
                                                      DoubleParameter y,
                                                      String comments,
                                                      Set<String> groupAccessControl,
                                                      Set<String> userAccessControl,
                                                      String name,
                                                      String state,
                                                      IntegerParameter concurrentlySchedulableTaskCount,
                                                      javax.ws.rs.core.MultivaluedMap<String,String> formParams)

Updates the specified output port.

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 output port to update.

x - The x coordinate for this output ports position.

y - The y coordinate for this output ports position.

comments - Any comments about this output port.

name - The output ports name.

groupAccessControl - The allowed groups for this output port.

userAccessControl - The allowed users for this output port.

state - The state of this port.

concurrentlySchedulableTaskCount - The number of concurrently schedulable tasks.

formParams -

Returns:

A outputPortEntity.

updateOutputPort

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

Updates the specified output port.

Parameters:

httpServletRequest -

id - The id of the output port to update.

portEntity - A outputPortEntity.

Returns:

A outputPortEntity.

removeOutputPort

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

Removes the specified output port.

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 output port to remove.

Returns:

A outputPortEntity.

setServiceFacade

public void setServiceFacade(NiFiServiceFacade serviceFacade)

setGroupId

public void setGroupId(String groupId)

setClusterManager

public void setClusterManager(WebClusterManager clusterManager)

setProperties

public void setProperties(NiFiProperties properties)