org.apache.nifi.web.api

Class RemoteProcessGroupResource

java.lang.Object

org.apache.nifi.web.api.ApplicationResource

org.apache.nifi.web.api.RemoteProcessGroupResource

public class RemoteProcessGroupResource
extends ApplicationResource

RESTful endpoint for managing a Remote group.

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
private static String	VERBOSE_DEFAULT_VALUE

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

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createRemoteProcessGroup(javax.servlet.http.HttpServletRequest httpServletRequest, LongParameter version, ClientIdParameter clientId, String uri, DoubleParameter x, DoubleParameter y) Creates a new remote process group.
javax.ws.rs.core.Response	createRemoteProcessGroup(javax.servlet.http.HttpServletRequest httpServletRequest, RemoteProcessGroupEntity remoteProcessGroupEntity) Creates a new remote process group.
javax.ws.rs.core.Response	getRemoteProcessGroup(ClientIdParameter clientId, Boolean verbose, String id) Retrieves the specified remote process group.
javax.ws.rs.core.Response	getRemoteProcessGroups(ClientIdParameter clientId, Boolean verbose) Retrieves all the of remote process groups in this NiFi.
javax.ws.rs.core.Response	getRemoteProcessGroupStatusHistory(ClientIdParameter clientId, String id) Retrieves the specified remote process groups status history.
private RemoteProcessGroupDTO	populateRemainingRemoteProcessGroupContent(RemoteProcessGroupDTO remoteProcessGroup) Populates the remaining content for the specified remote process group.
Set<RemoteProcessGroupDTO>	populateRemainingRemoteProcessGroupsContent(Set<RemoteProcessGroupDTO> remoteProcessGroups) Populates the remaining content for each remote process group.
javax.ws.rs.core.Response	removeRemoteProcessGroup(javax.servlet.http.HttpServletRequest httpServletRequest, LongParameter version, ClientIdParameter clientId, String id) Removes the specified remote process group.
void	setClusterManager(WebClusterManager clusterManager)
void	setGroupId(String groupId)
void	setProperties(NiFiProperties properties)
void	setServiceFacade(NiFiServiceFacade serviceFacade)
javax.ws.rs.core.Response	updateRemoteProcessGroup(javax.servlet.http.HttpServletRequest httpServletRequest, LongParameter version, ClientIdParameter clientId, String id, Boolean isTransmitting, DoubleParameter x, DoubleParameter y, String communicationsTimeout, String yieldDuration) Updates the specified remote process group.
javax.ws.rs.core.Response	updateRemoteProcessGroup(javax.servlet.http.HttpServletRequest httpServletRequest, String id, RemoteProcessGroupEntity remoteProcessGroupEntity) Updates the specified remote process group.
javax.ws.rs.core.Response	updateRemoteProcessGroupInputPort(javax.servlet.http.HttpServletRequest httpServletRequest, LongParameter version, ClientIdParameter clientId, String id, String portId, Boolean isTransmitting, Boolean isCompressed, IntegerParameter concurrentlySchedulableTaskCount) Updates the specified remote process group input port.
javax.ws.rs.core.Response	updateRemoteProcessGroupInputPort(javax.servlet.http.HttpServletRequest httpServletRequest, String id, String portId, RemoteProcessGroupPortEntity remoteProcessGroupPortEntity) Updates the specified remote process group input port.
javax.ws.rs.core.Response	updateRemoteProcessGroupOutputPort(javax.servlet.http.HttpServletRequest httpServletRequest, LongParameter version, ClientIdParameter clientId, String id, String portId, Boolean isTransmitting, Boolean isCompressed, IntegerParameter concurrentlySchedulableTaskCount) Updates the specified remote process group output port.
javax.ws.rs.core.Response	updateRemoteProcessGroupOutputPort(javax.servlet.http.HttpServletRequest httpServletRequest, String id, String portId, RemoteProcessGroupPortEntity remoteProcessGroupPortEntity) Updates the specified remote process group 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

VERBOSE_DEFAULT_VALUE

private static final String VERBOSE_DEFAULT_VALUE

See Also:

Constant Field Values

serviceFacade

private NiFiServiceFacade serviceFacade

clusterManager

private WebClusterManager clusterManager

properties

private NiFiProperties properties

groupId

private String groupId

Constructor Detail

RemoteProcessGroupResource

public RemoteProcessGroupResource()

Method Detail

populateRemainingRemoteProcessGroupsContent

public Set<RemoteProcessGroupDTO> populateRemainingRemoteProcessGroupsContent(Set<RemoteProcessGroupDTO> remoteProcessGroups)

Populates the remaining content for each remote process group. The uri must be generated and the remote process groups name must be retrieved.

Parameters:

remoteProcessGroups -

Returns:

populateRemainingRemoteProcessGroupContent

private RemoteProcessGroupDTO populateRemainingRemoteProcessGroupContent(RemoteProcessGroupDTO remoteProcessGroup)

Populates the remaining content for the specified remote process group. The uri must be generated and the remote process groups name must be retrieved.

Parameters:

remoteProcessGroup -

Returns:

getRemoteProcessGroups

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

Retrieves all the of remote process groups 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.

verbose - Optional verbose flag that defaults to false. If the verbose flag is set to true remote group contents (ports) will be included.

Returns:

A remoteProcessGroupEntity.

getRemoteProcessGroup

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

Retrieves the specified remote process group.

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.

verbose - Optional verbose flag that defaults to false. If the verbose flag is set to true remote group contents (ports) will be included.

id - The id of the remote process group to retrieve

Returns:

A remoteProcessGroupEntity.

getRemoteProcessGroupStatusHistory

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

Retrieves the specified remote process groups 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 remote process group to retrieve the status fow.

Returns:

A statusHistoryEntity.

createRemoteProcessGroup

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

Creates a new remote process group.

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.

uri - The uri to the remote process group that is being referenced.

x - The x coordinate for this funnels position.

y - The y coordinate for this funnels position.

Returns:

A remoteProcessGroupEntity.

createRemoteProcessGroup

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

Creates a new remote process group.

Parameters:

httpServletRequest -

remoteProcessGroupEntity - A remoteProcessGroupEntity.

Returns:

A remoteProcessGroupEntity.

removeRemoteProcessGroup

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

Removes the specified remote process group.

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 remote process group to be removed.

Returns:

A remoteProcessGroupEntity.

updateRemoteProcessGroupInputPort

@PreAuthorize(value="hasRole(\'ROLE_DFM\')")
public javax.ws.rs.core.Response updateRemoteProcessGroupInputPort(@Context
                                                                       javax.servlet.http.HttpServletRequest httpServletRequest,
                                                                       LongParameter version,
                                                                       ClientIdParameter clientId,
                                                                       String id,
                                                                       String portId,
                                                                       Boolean isTransmitting,
                                                                       Boolean isCompressed,
                                                                       IntegerParameter concurrentlySchedulableTaskCount)

Updates the specified remote process group input 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 remote process group to update.

portId - The id of the input port to update.

isTransmitting - Whether or not this port is transmitting.

isCompressed - Whether or not this port should compress.

concurrentlySchedulableTaskCount - The number of concurrent tasks that should be supported

Returns:

A remoteProcessGroupPortEntity

updateRemoteProcessGroupInputPort

@PreAuthorize(value="hasRole(\'ROLE_DFM\')")
public javax.ws.rs.core.Response updateRemoteProcessGroupInputPort(@Context
                                                                       javax.servlet.http.HttpServletRequest httpServletRequest,
                                                                       String id,
                                                                       String portId,
                                                                       RemoteProcessGroupPortEntity remoteProcessGroupPortEntity)

Updates the specified remote process group input port.

Parameters:

httpServletRequest -

id - The id of the remote process group to update.

portId - The id of the input port to update.

remoteProcessGroupPortEntity - The remoteProcessGroupPortEntity

Returns:

A remoteProcessGroupPortEntity

updateRemoteProcessGroupOutputPort

@PreAuthorize(value="hasRole(\'ROLE_DFM\')")
public javax.ws.rs.core.Response updateRemoteProcessGroupOutputPort(@Context
                                                                        javax.servlet.http.HttpServletRequest httpServletRequest,
                                                                        LongParameter version,
                                                                        ClientIdParameter clientId,
                                                                        String id,
                                                                        String portId,
                                                                        Boolean isTransmitting,
                                                                        Boolean isCompressed,
                                                                        IntegerParameter concurrentlySchedulableTaskCount)

Updates the specified remote process group 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 remote process group to update.

portId - The id of the output port to update.

isTransmitting - Whether or not this port is transmitting.

isCompressed - Whether or not this port should compress.

concurrentlySchedulableTaskCount - The number of concurrent tasks that should be supported

Returns:

A remoteProcessGroupPortEntity

updateRemoteProcessGroupOutputPort

@PreAuthorize(value="hasRole(\'ROLE_DFM\')")
public javax.ws.rs.core.Response updateRemoteProcessGroupOutputPort(@Context
                                                                        javax.servlet.http.HttpServletRequest httpServletRequest,
                                                                        String id,
                                                                        String portId,
                                                                        RemoteProcessGroupPortEntity remoteProcessGroupPortEntity)

Updates the specified remote process group output port.

Parameters:

httpServletRequest -

id - The id of the remote process group to update.

portId - The id of the output port to update.

remoteProcessGroupPortEntity - The remoteProcessGroupPortEntity

Returns:

A remoteProcessGroupPortEntity

updateRemoteProcessGroup

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

Updates the specified remote process group.

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 remote process group to update.

isTransmitting - Whether this remote process group is transmitting.

x - The x coordinate for this funnels position.

y - The y coordinate for this funnels position.

communicationsTimeout - The timeout to use when communication with this remote process group.

yieldDuration - The yield duration

Returns:

A remoteProcessGroupEntity.

updateRemoteProcessGroup

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

Updates the specified remote process group.

Parameters:

httpServletRequest -

id - The id of the remote process group to update.

remoteProcessGroupEntity - A remoteProcessGroupEntity.

Returns:

A remoteProcessGroupEntity.

setServiceFacade

public void setServiceFacade(NiFiServiceFacade serviceFacade)

setGroupId

public void setGroupId(String groupId)

setClusterManager

public void setClusterManager(WebClusterManager clusterManager)

setProperties

public void setProperties(NiFiProperties properties)