org.apache.nifi.web.api

Class TemplateResource

java.lang.Object

org.apache.nifi.web.api.ApplicationResource

org.apache.nifi.web.api.TemplateResource

public class TemplateResource
extends ApplicationResource

RESTful endpoint for managing a Template.

Field Summary

Fields

Modifier and Type	Field and Description
private WebClusterManager	clusterManager
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
TemplateResource()

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createTemplate(javax.servlet.http.HttpServletRequest httpServletRequest, ClientIdParameter clientId, String name, String description, String snippetId) Creates a new template based off of the specified template.
javax.ws.rs.core.Response	exportTemplate(ClientIdParameter clientId, String id) Retrieves the specified template.
javax.ws.rs.core.Response	getTemplates(ClientIdParameter clientId) Retrieves all the of templates in this NiFi.
javax.ws.rs.core.Response	importTemplate(javax.servlet.http.HttpServletRequest httpServletRequest, ClientIdParameter clientId, InputStream in) Imports the specified template.
javax.ws.rs.core.Response	importTemplate(javax.servlet.http.HttpServletRequest httpServletRequest, TemplateEntity templateEntity) Imports the specified template.
private TemplateDTO	populateRemainingTemplateContent(TemplateDTO template) Populates the uri for the specified template.
Set<TemplateDTO>	populateRemainingTemplatesContent(Set<TemplateDTO> templates) Populates the uri for the specified templates.
javax.ws.rs.core.Response	removeTemplate(javax.servlet.http.HttpServletRequest httpServletRequest, ClientIdParameter clientId, String id) Removes the specified template.
void	setClusterManager(WebClusterManager clusterManager)
void	setProperties(NiFiProperties properties)
void	setServiceFacade(NiFiServiceFacade serviceFacade)

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

Constructor Detail

TemplateResource

public TemplateResource()

Method Detail

populateRemainingTemplatesContent

public Set<TemplateDTO> populateRemainingTemplatesContent(Set<TemplateDTO> templates)

Populates the uri for the specified templates.

Parameters:

templates -

Returns:

populateRemainingTemplateContent

private TemplateDTO populateRemainingTemplateContent(TemplateDTO template)

Populates the uri for the specified template.

getTemplates

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

Retrieves all the of templates 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 templatesEntity.

createTemplate

@PreAuthorize(value="hasRole(\'ROLE_DFM\')")
public javax.ws.rs.core.Response createTemplate(@Context
                                                    javax.servlet.http.HttpServletRequest httpServletRequest,
                                                    ClientIdParameter clientId,
                                                    String name,
                                                    String description,
                                                    String snippetId)

Creates a new template based off of the specified template.

Parameters:

httpServletRequest -

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

description - The description of the template.

snippetId - The id of the snippet this template is based on.

Returns:

A templateEntity

importTemplate

@PreAuthorize(value="hasRole(\'ROLE_DFM\')")
public javax.ws.rs.core.Response importTemplate(@Context
                                                    javax.servlet.http.HttpServletRequest httpServletRequest,
                                                    ClientIdParameter clientId,
                                                    InputStream in)

Imports the specified template.

Parameters:

httpServletRequest -

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.

in - The template stream

Returns:

A templateEntity or an errorResponse XML snippet.

importTemplate

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

Imports the specified template.

Parameters:

httpServletRequest -

templateEntity - A templateEntity.

Returns:

A templateEntity.

exportTemplate

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

Retrieves the specified template.

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 template to retrieve

Returns:

A templateEntity.

removeTemplate

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

Removes the specified template.

Parameters:

httpServletRequest -

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 template to remove.

Returns:

A templateEntity.

setServiceFacade

public void setServiceFacade(NiFiServiceFacade serviceFacade)

setClusterManager

public void setClusterManager(WebClusterManager clusterManager)

setProperties

public void setProperties(NiFiProperties properties)