Key (Vitro API 1.12.1 API)

java.lang.Object
- java.lang.Enum<Key>
- - edu.cornell.mannlib.vitro.webapp.utils.developer.Key

All Implemented Interfaces:

Serializable, Comparable<Key>
```
public enum Key
extends Enum<Key>
```
Keys for the DeveloperSettings. Each key holds these values: A property name, which specifies the key in developer.properties, like "this.thatThing" A flag to say whether this key controls a boolean value. If false, then the value is a string. We can derive the element ID for each key by replacing the periods in the property name with underscores.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AUTHORIZATION_LOG_DECISIONS_ACTION_RESTRICTION` Don't log policy decisions unless the requested action meets this restriction.
`AUTHORIZATION_LOG_DECISIONS_ADD_IDENTIFERS` When logging policy decisions, add the identifier bundle.
`AUTHORIZATION_LOG_DECISIONS_ENABLE` Enable the PolicyDecisionLogger.
`AUTHORIZATION_LOG_DECISIONS_POLICY_RESTRICTION` Don't log policy decisions unless the policy meets this restriction.
`AUTHORIZATION_LOG_DECISIONS_SKIP_INCONCLUSIVE` Don't log policy decisions if the decision is INCONCLUSIVE.
`AUTHORIZATION_LOG_DECISIONS_USER_RESTRICTION` Don't log policy decisions unless the identifier bundle meets this restriction.
`DEFEAT_FREEMARKER_CACHE` Load Freemarker templates every time they are requested.
`ENABLED` Developer mode and developer panel is enabled.
`I18N_DEFEAT_CACHE` Load language property files every time they are requested.
`I18N_LOG_STRINGS` Enable the I18nLogger to log each string request.
`INSERT_FREEMARKER_DELIMITERS` Show where each Freemarker template starts and stops.
`LOGGING_RDF_ENABLE` Enable the LoggingRDFService
`LOGGING_RDF_QUERY_RESTRICTION` Don't log with the LoggingRDFService unless the calling stack meets this restriction.
`LOGGING_RDF_STACK_RESTRICTION` Don't log with the LoggingRDFService unless the calling stack meets this restriction.
`LOGGING_RDF_STACK_TRACE` When logging with the LoggingRDFService, include a stack trace
`PAGE_CONTENTS_LOG_CUSTOM_LIST_VIEW` Tell the CustomListViewLogger to note the use of non-default custom list views.
`PAGE_CONTENTS_LOG_CUSTOM_SHORT_VIEW` Tell the ShortViewLogger to note the use of non-default short views.
`PERMIT_ANONYMOUS_CONTROL` If the developer panel is enabled, may an anonymous user change the settings?
`SEARCH_DELETIONS_ENABLE` Tell the SearchEngineLogger to log all index deletions.
`SEARCH_ENGINE_ADD_RESULTS` Add the search results to the log of search operations.
`SEARCH_ENGINE_ADD_STACK_TRACE` Add the stack trace to the log of search operations.
`SEARCH_ENGINE_ENABLE` Tell the SearchEngineLogger to log all search operations.
`SEARCH_ENGINE_QUERY_RESTRICTION` Log search operations only if the query matches this regular expression.
`SEARCH_ENGINE_STACK_RESTRICTION` Log search operations only if the stack trace matches this regular expression.
`SEARCH_INDEX_DOCUMENT_RESTRICTION` Log indexing operations only if the document contents match this regular expression.
`SEARCH_INDEX_ENABLE` Tell the SearchEngineLogger to log all indexing operations.
`SEARCH_INDEX_LOG_INDEXING_BREAKDOWN_TIMINGS` Accumulate breakdown timings for search indexing, and log them at the end of the indexing operation.
`SEARCH_INDEX_SHOW_DOCUMENTS` Add the document contents to the log of indexing operations.
`SEARCH_INDEX_SUPPRESS_MODEL_CHANGE_LISTENER` If set, don't pass model change events to the search indexer.
`SEARCH_INDEX_URI_OR_NAME_RESTRICTION` Log indexing operations only if one of the document identifiers match this regular expression.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`elementId()`
`String`	`propertyName()`
`String`	`toString()`
`static Key`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static Key[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - ENABLED
```
public static final Key ENABLED
```
    Developer mode and developer panel is enabled.
  - PERMIT_ANONYMOUS_CONTROL
```
public static final Key PERMIT_ANONYMOUS_CONTROL
```
    If the developer panel is enabled, may an anonymous user change the settings?
  - DEFEAT_FREEMARKER_CACHE
```
public static final Key DEFEAT_FREEMARKER_CACHE
```
    Load Freemarker templates every time they are requested.
  - INSERT_FREEMARKER_DELIMITERS
```
public static final Key INSERT_FREEMARKER_DELIMITERS
```
    Show where each Freemarker template starts and stops.
  - I18N_DEFEAT_CACHE
```
public static final Key I18N_DEFEAT_CACHE
```
    Load language property files every time they are requested.
  - I18N_LOG_STRINGS
```
public static final Key I18N_LOG_STRINGS
```
    Enable the I18nLogger to log each string request.
  - LOGGING_RDF_ENABLE
```
public static final Key LOGGING_RDF_ENABLE
```
    Enable the LoggingRDFService
  - LOGGING_RDF_STACK_TRACE
```
public static final Key LOGGING_RDF_STACK_TRACE
```
    When logging with the LoggingRDFService, include a stack trace
  - LOGGING_RDF_QUERY_RESTRICTION
```
public static final Key LOGGING_RDF_QUERY_RESTRICTION
```
    Don't log with the LoggingRDFService unless the calling stack meets this restriction.
  - LOGGING_RDF_STACK_RESTRICTION
```
public static final Key LOGGING_RDF_STACK_RESTRICTION
```
    Don't log with the LoggingRDFService unless the calling stack meets this restriction.
  - PAGE_CONTENTS_LOG_CUSTOM_LIST_VIEW
```
public static final Key PAGE_CONTENTS_LOG_CUSTOM_LIST_VIEW
```
    Tell the CustomListViewLogger to note the use of non-default custom list views.
  - PAGE_CONTENTS_LOG_CUSTOM_SHORT_VIEW
```
public static final Key PAGE_CONTENTS_LOG_CUSTOM_SHORT_VIEW
```
    Tell the ShortViewLogger to note the use of non-default short views.
  - SEARCH_INDEX_ENABLE
```
public static final Key SEARCH_INDEX_ENABLE
```
    Tell the SearchEngineLogger to log all indexing operations.
  - SEARCH_INDEX_SHOW_DOCUMENTS
```
public static final Key SEARCH_INDEX_SHOW_DOCUMENTS
```
    Add the document contents to the log of indexing operations.
  - SEARCH_INDEX_URI_OR_NAME_RESTRICTION
```
public static final Key SEARCH_INDEX_URI_OR_NAME_RESTRICTION
```
    Log indexing operations only if one of the document identifiers match this regular expression.
  - SEARCH_INDEX_DOCUMENT_RESTRICTION
```
public static final Key SEARCH_INDEX_DOCUMENT_RESTRICTION
```
    Log indexing operations only if the document contents match this regular expression.
  - SEARCH_INDEX_LOG_INDEXING_BREAKDOWN_TIMINGS
```
public static final Key SEARCH_INDEX_LOG_INDEXING_BREAKDOWN_TIMINGS
```
    Accumulate breakdown timings for search indexing, and log them at the end of the indexing operation.
  - SEARCH_INDEX_SUPPRESS_MODEL_CHANGE_LISTENER
```
public static final Key SEARCH_INDEX_SUPPRESS_MODEL_CHANGE_LISTENER
```
    If set, don't pass model change events to the search indexer.
  - SEARCH_DELETIONS_ENABLE
```
public static final Key SEARCH_DELETIONS_ENABLE
```
    Tell the SearchEngineLogger to log all index deletions.
  - SEARCH_ENGINE_ENABLE
```
public static final Key SEARCH_ENGINE_ENABLE
```
    Tell the SearchEngineLogger to log all search operations.
  - SEARCH_ENGINE_ADD_STACK_TRACE
```
public static final Key SEARCH_ENGINE_ADD_STACK_TRACE
```
    Add the stack trace to the log of search operations.
  - SEARCH_ENGINE_ADD_RESULTS
```
public static final Key SEARCH_ENGINE_ADD_RESULTS
```
    Add the search results to the log of search operations.
  - SEARCH_ENGINE_QUERY_RESTRICTION
```
public static final Key SEARCH_ENGINE_QUERY_RESTRICTION
```
    Log search operations only if the query matches this regular expression.
  - SEARCH_ENGINE_STACK_RESTRICTION
```
public static final Key SEARCH_ENGINE_STACK_RESTRICTION
```
    Log search operations only if the stack trace matches this regular expression.
  - AUTHORIZATION_LOG_DECISIONS_ENABLE
```
public static final Key AUTHORIZATION_LOG_DECISIONS_ENABLE
```
    Enable the PolicyDecisionLogger.
  - AUTHORIZATION_LOG_DECISIONS_ADD_IDENTIFERS
```
public static final Key AUTHORIZATION_LOG_DECISIONS_ADD_IDENTIFERS
```
    When logging policy decisions, add the identifier bundle.
  - AUTHORIZATION_LOG_DECISIONS_SKIP_INCONCLUSIVE
```
public static final Key AUTHORIZATION_LOG_DECISIONS_SKIP_INCONCLUSIVE
```
    Don't log policy decisions if the decision is INCONCLUSIVE.
  - AUTHORIZATION_LOG_DECISIONS_ACTION_RESTRICTION
```
public static final Key AUTHORIZATION_LOG_DECISIONS_ACTION_RESTRICTION
```
    Don't log policy decisions unless the requested action meets this restriction.
  - AUTHORIZATION_LOG_DECISIONS_USER_RESTRICTION
```
public static final Key AUTHORIZATION_LOG_DECISIONS_USER_RESTRICTION
```
    Don't log policy decisions unless the identifier bundle meets this restriction.
  - AUTHORIZATION_LOG_DECISIONS_POLICY_RESTRICTION
```
public static final Key AUTHORIZATION_LOG_DECISIONS_POLICY_RESTRICTION
```
    Don't log policy decisions unless the policy meets this restriction.
- Method Detail
  - values
```
public static Key[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (Key c : Key.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Key valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - propertyName
```
public String propertyName()
```
  - elementId
```
public String elementId()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Enum<Key>

Enum Key

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

ENABLED

PERMIT_ANONYMOUS_CONTROL

DEFEAT_FREEMARKER_CACHE

INSERT_FREEMARKER_DELIMITERS

I18N_DEFEAT_CACHE

I18N_LOG_STRINGS

LOGGING_RDF_ENABLE

LOGGING_RDF_STACK_TRACE

LOGGING_RDF_QUERY_RESTRICTION

LOGGING_RDF_STACK_RESTRICTION

PAGE_CONTENTS_LOG_CUSTOM_LIST_VIEW

PAGE_CONTENTS_LOG_CUSTOM_SHORT_VIEW

SEARCH_INDEX_ENABLE

SEARCH_INDEX_SHOW_DOCUMENTS

SEARCH_INDEX_URI_OR_NAME_RESTRICTION

SEARCH_INDEX_DOCUMENT_RESTRICTION

SEARCH_INDEX_LOG_INDEXING_BREAKDOWN_TIMINGS

SEARCH_INDEX_SUPPRESS_MODEL_CHANGE_LISTENER

SEARCH_DELETIONS_ENABLE

SEARCH_ENGINE_ENABLE

SEARCH_ENGINE_ADD_STACK_TRACE

SEARCH_ENGINE_ADD_RESULTS

SEARCH_ENGINE_QUERY_RESTRICTION

SEARCH_ENGINE_STACK_RESTRICTION

AUTHORIZATION_LOG_DECISIONS_ENABLE

AUTHORIZATION_LOG_DECISIONS_ADD_IDENTIFERS

AUTHORIZATION_LOG_DECISIONS_SKIP_INCONCLUSIVE

AUTHORIZATION_LOG_DECISIONS_ACTION_RESTRICTION

AUTHORIZATION_LOG_DECISIONS_USER_RESTRICTION

AUTHORIZATION_LOG_DECISIONS_POLICY_RESTRICTION

Method Detail

values

valueOf

propertyName

elementId

toString