org.apache.nifi.web.api

Class SystemDiagnosticsResource

java.lang.Object

org.apache.nifi.web.api.ApplicationResource

org.apache.nifi.web.api.SystemDiagnosticsResource

public class SystemDiagnosticsResource
extends ApplicationResource

RESTful endpoint for retrieving system diagnostics.

Field Summary

Fields

Modifier and Type	Field and Description
private static org.slf4j.Logger	logger
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
SystemDiagnosticsResource()

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getSystemDiagnostics(ClientIdParameter clientId) Gets the system diagnostics for this NiFi instance.
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

Constructor Detail

SystemDiagnosticsResource

public SystemDiagnosticsResource()

Method Detail

getSystemDiagnostics

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

Gets the system diagnostics for this NiFi instance.

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

setServiceFacade

public void setServiceFacade(NiFiServiceFacade serviceFacade)