org.apache.nifi.properties

Class ProtectedPropertyContext

java.lang.Object

org.apache.nifi.properties.ProtectedPropertyContext

public class ProtectedPropertyContext
extends Object

A context for protected properties, encapsulating the context name and property name.

Field Summary

Fields

Modifier and Type	Field and Description
private String	contextName
private static String	DEFAULT_CONTEXT
private String	propertyName

Constructor Summary

Constructors

Modifier	Constructor and Description
private	ProtectedPropertyContext(String propertyName, String contextName) Creates a property context with a property name and custom location.

Method Summary

Modifier and Type	Method and Description
static ProtectedPropertyContext	contextFor(String propertyName, String contextName) Creates a ProtectedPropertyContext for the given property name, with a specific context name, acting as a namespace for the property.
static ProtectedPropertyContext	defaultContext(String propertyName) Creates a ProtectedPropertyContext for the given property name, using the default context.
String	getContextKey() Returns the context key, in the format [contextName]/[propertyName]
String	getContextName() Returns the context name
String	getPropertyName() Returns the property name

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONTEXT

private static final String DEFAULT_CONTEXT

See Also:

Constant Field Values

propertyName

private final String propertyName

contextName

private final String contextName

Constructor Detail

ProtectedPropertyContext

private ProtectedPropertyContext(String propertyName,
                                 String contextName)

Creates a property context with a property name and custom location.

Parameters:

propertyName - The property name

contextName - The context name. If null, the default context will be assigned.

Method Detail

contextFor

public static ProtectedPropertyContext contextFor(String propertyName,
                                                  String contextName)

Creates a ProtectedPropertyContext for the given property name, with a specific context name, acting as a namespace for the property.

Parameters:

propertyName - The property name in this location

contextName - A custom context name. If null, the default context will be assigned.

Returns:

A property context representing a property within a specific context

defaultContext

public static ProtectedPropertyContext defaultContext(String propertyName)

Creates a ProtectedPropertyContext for the given property name, using the default context.

Parameters:

propertyName - The property name in this location

Returns:

A property context representing a property with the given name in the default context

getContextKey

public String getContextKey()

Returns the context key, in the format [contextName]/[propertyName]

Returns:

The context key

getPropertyName

public String getPropertyName()

Returns the property name

Returns:

The property name

getContextName

public String getContextName()

Returns the context name

Returns:

The context name