Index

A B C E G H I P R S
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

addAllMetadata(Map<String, Object>) - Method in class com.helixframework.env.HelixEnvironment

Adds a collection of metadata entries.

addMetadata(String, Object) - Method in class com.helixframework.env.HelixEnvironment

Adds a new metadata entry.

ApplicationContextUtil - Class in com.helixframework.env

Utility for checking the current Spring application context.

B

BuildInfo - Class in com.helixframework.env

Gets the build info from build-info.properties file.

C

com.helixframework.env - package com.helixframework.env

Helix environment context that holds environment specific variables for Helix projects.

contains(String) - Static method in class com.helixframework.env.HelixContext

Checks to see if the context contains an attribute with the supplied key.

containsProperty(String) - Method in class com.helixframework.env.HelixEnvironment

Return whether the given property key is available for resolution, i.e.

CTX_ERROR_ID_NAME - Static variable in class com.helixframework.env.HelixContext

Name of the helix context variable that contains the current error id.

CTX_REQUEST_ID_NAME - Static variable in class com.helixframework.env.HelixContext

Name of the helix context variable that contains the current request id.

CTX_SPAN_ID_NAME - Static variable in class com.helixframework.env.HelixContext

Name of the helix context variable that contains the current span id.

CTX_TRACE_ID_NAME - Static variable in class com.helixframework.env.HelixContext

Name of the helix context variable that contains the current trace id.

E

ENV_ACCOUNT - Static variable in class com.helixframework.env.HelixEnvironment

ENV_APPID - Static variable in class com.helixframework.env.HelixEnvironment

ENV_ENVIRONMENT - Static variable in class com.helixframework.env.HelixEnvironment

ENV_ENVIRONMENT - Static variable in class com.helixframework.env.HelixSpringProfileResolver

Represents the name of the environment variable used to specify the Helix-specific environment.

ENV_INSTANCE_ID - Static variable in class com.helixframework.env.HelixEnvironment

ENV_ORG - Static variable in class com.helixframework.env.HelixEnvironment

ENV_REGION - Static variable in class com.helixframework.env.HelixEnvironment

ENV_TEAM - Static variable in class com.helixframework.env.HelixEnvironment

G

get() - Static method in class com.helixframework.env.HelixEnvironmentHolder

Retrieves the current instance of HelixEnvironment held by the HelixEnvironmentHolder.

getAccount() - Method in class com.helixframework.env.HelixEnvironment

Gets the Helix account.

getAppId() - Method in class com.helixframework.env.HelixEnvironment

Gets the Helix application identifier.

getApplicationContext() - Method in class com.helixframework.env.HelixEnvironment

Gets the spring application context.

getAppVersion() - Method in class com.helixframework.env.HelixEnvironment

Gets the version of the application if available.

getArtifact() - Method in class com.helixframework.env.BuildInfo

Gets the build artifact name.

getAttribute(String) - Static method in class com.helixframework.env.HelixContext

Gets an attribute from the thread local context.

getAttribute(String, Class<T>) - Static method in class com.helixframework.env.HelixContext

Gets an attribute from the thread local context.

getAttributeOrDefault(String, T, Class<T>) - Static method in class com.helixframework.env.HelixContext

Gets an attribute from the thread local context.

getAttributes() - Static method in class com.helixframework.env.HelixContext

Gets all attributes on the thread local context.

getAttributes(String) - Static method in class com.helixframework.env.HelixContext

Gets all attributes on the thread local context whose keys start with the supplied prefix.

getDelimitedProperty(String, String) - Method in class com.helixframework.env.HelixEnvironment

Gets the value of a delimited property.

getDelimitedProperty(String, String, List<String>) - Method in class com.helixframework.env.HelixEnvironment

Gets the value of a delimited property.

getEnv(String) - Method in class com.helixframework.env.HelixEnvironment

Gets the value of the environment variable.

getEnv(String, String) - Method in class com.helixframework.env.HelixEnvironment

Gets the value of the environment variable.

getEnvironmentName() - Method in class com.helixframework.env.HelixEnvironment

Gets the Helix environment name.

getGroup() - Method in class com.helixframework.env.BuildInfo

Gets the build group name.

getHelixVersion() - Method in class com.helixframework.env.HelixEnvironment

Gets the Helix version.

getInstance() - Static method in class com.helixframework.env.BuildInfo

Gets the singleton instance of BuildInfo.

getInstanceId() - Method in class com.helixframework.env.HelixEnvironment

Gets the instance identifier.

getMetadata() - Method in class com.helixframework.env.HelixEnvironment

Gets metadata.

getName() - Method in class com.helixframework.env.BuildInfo

Gets the build artifact name.

getOrganization() - Method in class com.helixframework.env.HelixEnvironment

Gets the Helix organization name.

getProperties() - Method in class com.helixframework.env.HelixEnvironment

Gets all system properties.

getProperties(Class<?>) - Method in class com.helixframework.env.HelixEnvironment

Gets all properties whose keys begin with the package name of the supplied class.

getProperties(String) - Method in class com.helixframework.env.HelixEnvironment

Gets all system properties whose keys begin with the supplied string (basename).

getProperties(Pattern) - Method in class com.helixframework.env.HelixEnvironment

Gets all properties whose keys match the regular expression.

getProperty(String) - Method in class com.helixframework.env.HelixEnvironment

Gets the string value of the system property.

getProperty(String, Class<T>) - Method in class com.helixframework.env.HelixEnvironment

Gets the value of the system property.

getProperty(String, Class<T>, T) - Method in class com.helixframework.env.HelixEnvironment

Gets the value of the system property.

getProperty(String, String) - Method in class com.helixframework.env.HelixEnvironment

Gets the string value of the system property.

getRegion() - Method in class com.helixframework.env.HelixEnvironment

Gets the current region.

getRequiredProperty(String) - Method in class com.helixframework.env.HelixEnvironment

Gets the string value of the system property; throwing a RuntimeException if the property is not defined.

getRequiredProperty(String, Class<T>) - Method in class com.helixframework.env.HelixEnvironment

Gets the value of the system property; throwing a RuntimeException if the property is not defined.

getTeam() - Method in class com.helixframework.env.HelixEnvironment

Gets the Helix team name.

getTimestamp() - Method in class com.helixframework.env.BuildInfo

Gets the build timestamp.

getVersion() - Method in class com.helixframework.env.BuildInfo

Gets the build version.

H

HelixContext - Class in com.helixframework.env

Thread local context holder for values.

HelixEnvironment - Class in com.helixframework.env

Holds context about the currently executing helix environment.

HelixEnvironment(Environment) - Constructor for class com.helixframework.env.HelixEnvironment

Creates an instance of the HelixEnvironment based on the supplied Spring Environment.

HelixEnvironmentAware - Interface in com.helixframework.env

Interface that can be implemented when not using dependency injection to mark a class as requiring HelixEnvironment.

HelixEnvironmentHolder - Class in com.helixframework.env

HelixEnvironmentHolder is a component that holds a static reference to a HelixEnvironment instance.

HelixEnvironmentHolder(HelixEnvironment) - Constructor for class com.helixframework.env.HelixEnvironmentHolder

Constructs a HelixEnvironmentHolder with the specified HelixEnvironment.

HelixSpringProfileResolver - Class in com.helixframework.env

Utility class responsible for resolving the current application environment/profile based on Spring Boot configuration properties, Helix-specific environment configurations, and corresponding environment variables.

HelixSpringProfileResolver() - Constructor for class com.helixframework.env.HelixSpringProfileResolver

I

isDebug() - Method in class com.helixframework.env.HelixEnvironment

Gets the current debug state of the application.

isDefault() - Static method in class com.helixframework.env.HelixSpringProfileResolver

Checks if the current environment is set to the default environment.

isLocal() - Method in class com.helixframework.env.HelixEnvironment

Checks to see if the application is running in the "local" environment.

isLocal() - Static method in class com.helixframework.env.HelixSpringProfileResolver

Determines whether the current environment is set to "local".

isMainApplicationContext(ApplicationContext) - Static method in class com.helixframework.env.ApplicationContextUtil

Checks if the supplied application context is the main context.

isManagementContext(ApplicationContext) - Static method in class com.helixframework.env.ApplicationContextUtil

Checks if the supplied application context is the actuator context.

P

PROP_ACCOUNT - Static variable in class com.helixframework.env.HelixEnvironment

PROP_APPID - Static variable in class com.helixframework.env.HelixEnvironment

PROP_DEBUG - Static variable in class com.helixframework.env.HelixEnvironment

PROP_ENVIRONMENT - Static variable in class com.helixframework.env.HelixEnvironment

PROP_ENVIRONMENT - Static variable in class com.helixframework.env.HelixSpringProfileResolver

A constant property name used to specify the environment in Helix configurations.

PROP_HELIX_VERSION - Static variable in class com.helixframework.env.HelixEnvironment

PROP_INSTANCE_ID - Static variable in class com.helixframework.env.HelixEnvironment

PROP_ORG - Static variable in class com.helixframework.env.HelixEnvironment

PROP_REGION - Static variable in class com.helixframework.env.HelixEnvironment

PROP_TEAM - Static variable in class com.helixframework.env.HelixEnvironment

R

reset() - Static method in class com.helixframework.env.HelixContext

Resets the thread local context holder; removing all attributes from the context.

resolve() - Static method in class com.helixframework.env.HelixSpringProfileResolver

Resolves the current environment/profile based on Spring Boot and Helix specific configuration properties and environment variables.

resolveValue(String, String) - Method in class com.helixframework.env.HelixEnvironment

Gets the string value of a property or environment variable with the supplied names.

resolveValue(String, String, String) - Method in class com.helixframework.env.HelixEnvironment

Gets the string value of a property or environment variable with the supplied names.

S

setApplicationContext(ApplicationContext) - Method in class com.helixframework.env.HelixEnvironment

setAttribute(String, Object) - Static method in class com.helixframework.env.HelixContext

Sets an attribute in the thread local context.

setAttribute(String, Object, boolean) - Static method in class com.helixframework.env.HelixContext

Sets an attribute in the thread local context and optionally adds it to the mapped diagnostic context.

setAttributes(Map<String, Object>) - Static method in class com.helixframework.env.HelixContext

Sets attributes on the thread local context.

setAttributes(Map<String, Object>, boolean) - Static method in class com.helixframework.env.HelixContext

Sets all attributes in the thread local context and optionally adds them to the mapped diagnostic context.

setHelixEnvironment(HelixEnvironment) - Method in interface com.helixframework.env.HelixEnvironmentAware

Sets the helix environment.

A B C E G H I P R S
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form