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.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.nifi.web.api.ApplicationResource

ApplicationResource.ReplicationTarget, ApplicationResource.ResponseCreator

Field Summary

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

CLIENT_ID, FORWARDED_CONTEXT_HTTP_HEADER, FORWARDED_HOST_HTTP_HEADER, FORWARDED_PORT_HTTP_HEADER, FORWARDED_PROTO_HTTP_HEADER, NODEWISE, NON_GUARANTEED_ENDPOINT, properties, 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

Modifier and Type	Method and Description
javax.ws.rs.core.Response	exportTemplate(java.lang.String id) Retrieves the specified template.
TemplateDTO	populateRemainingTemplateContent(TemplateDTO template) Populates the uri for the specified template.
java.util.Set<TemplateEntity>	populateRemainingTemplateEntitiesContent(java.util.Set<TemplateEntity> templateEntities) Populate the uri's for the specified templates.
javax.ws.rs.core.Response	removeTemplate(javax.servlet.http.HttpServletRequest httpServletRequest, java.lang.String id) Removes the specified template.
void	setAuthorizer(Authorizer authorizer)
void	setServiceFacade(NiFiServiceFacade serviceFacade)

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

authorizeProcessGroup, authorizeSnippet, generateContinueResponse, generateCreatedResponse, generateNotAuthorizedResponse, generateOkResponse, generateOkResponse, generateResourceUri, generateUuid, getAbsolutePath, getClusterCoordinator, getClusterCoordinatorNode, getHeaders, getHeaders, getIdGenerationSeed, getProperties, getReplicationTarget, getRequestParameters, getRequestReplicator, getRequestUri, getRevision, getRevision, isCancellationPhase, isExecutionPhase, isTwoPhaseRequest, isValidationPhase, negotiateTransportProtocolVersion, noCache, replicate, replicate, replicate, replicate, replicate, replicate, replicate, replicate, replicate, replicateNodeResponse, replicateNodeResponse, replicateNodeResponse, replicateToCoordinator, setClusterCoordinator, setCommonHeaders, setFlowController, setProperties, setRequestReplicator, withWriteLock, withWriteLock, withWriteLock

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateResource

public TemplateResource()

Method Detail

populateRemainingTemplateEntitiesContent

public java.util.Set<TemplateEntity> populateRemainingTemplateEntitiesContent(java.util.Set<TemplateEntity> templateEntities)

Populate the uri's for the specified templates.

Parameters:

templateEntities - templates

Returns:

templates

populateRemainingTemplateContent

public TemplateDTO populateRemainingTemplateContent(TemplateDTO template)

Populates the uri for the specified template.

exportTemplate

public javax.ws.rs.core.Response exportTemplate(java.lang.String id)

Retrieves the specified template.

Parameters:

id - The id of the template to retrieve

Returns:

A templateEntity.

removeTemplate

public javax.ws.rs.core.Response removeTemplate(@Context
                                                javax.servlet.http.HttpServletRequest httpServletRequest,
                                                java.lang.String id)

Removes the specified template.

Parameters:

httpServletRequest - request

id - The id of the template to remove.

Returns:

A templateEntity.

setServiceFacade

public void setServiceFacade(NiFiServiceFacade serviceFacade)

setAuthorizer

public void setAuthorizer(Authorizer authorizer)