java.lang.Object
- org.nuxeo.elasticsearch.config.ElasticSearchIndexConfig

public class ElasticSearchIndexConfig
extends Object

XMap descriptor for configuring an index

Author:: Tiry

Field Summary

Fields
Modifier and Type	Field	Description
`protected boolean`	`create`
`static String`	`DEFAULT_MAPPING_FILE`
`protected static String`	`DEFAULT_REPOSITORY_NAME`
`static String`	`DEFAULT_SETTING_FILE`
`protected String[]`	`excludes`
`protected List<String>`	`extraMappings`
`protected String[]`	`includes`
`protected boolean`	`isEnabled`
`protected boolean`	`manageAlias`
`protected String`	`mapping`
`protected Boolean`	`mappingAppend`
`protected String`	`mappingFile`
`protected String`	`name`
`protected String`	`repositoryName`
`protected String`	`settings`
`protected String`	`settingsFile`
`protected String`	`type`
`protected static String`	`WRITE_SUFFIX`
`protected String`	`writeAlias`

Constructor Summary

Constructors
Constructor Description

ElasticSearchIndexConfig()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected String`	`contentOfFile(String filename)`
`String[]`	`getExcludes()`
`List<String>`	`getExtraMappings()`
`String[]`	`getIncludes()`
`String`	`getMapping()`
`String`	`getName()`
`String`	`getRepositoryName()`
`protected InputStream`	`getResourceStream(String filename)`
`String`	`getSettings()`
`String`	`getType()`
`boolean`	`hasExplicitWriteIndex()`
`boolean`	`isDocumentIndex()`	Return true if the index/mapping is associated with a Nuxeo document repository
`boolean`	`isEnabled()`
`boolean`	`manageAlias()`
`void`	`merge(ElasticSearchIndexConfig other)`	Use `other` mapping and settings if not defined.
`boolean`	`mustCreate()`
`String`	`newWriteIndexForAlias(String aliasName, String oldIndexName)`
`void`	`setEnabled(boolean isEnabled)`
`String`	`toString()`
`String`	`writeIndexOrAlias()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_SETTING_FILE

public static final String DEFAULT_SETTING_FILE

See Also:: Constant Field Values

DEFAULT_MAPPING_FILE

public static final String DEFAULT_MAPPING_FILE

See Also:: Constant Field Values

DEFAULT_REPOSITORY_NAME

protected static final String DEFAULT_REPOSITORY_NAME

See Also:: Constant Field Values

WRITE_SUFFIX

protected static final String WRITE_SUFFIX

See Also:: Constant Field Values

isEnabled
```
protected boolean isEnabled
```

name
```
protected String name
```

manageAlias
```
protected boolean manageAlias
```

writeAlias
```
protected String writeAlias
```

repositoryName
```
protected String repositoryName
```

type
```
protected String type
```

create
```
protected boolean create
```

settings
```
protected String settings
```

settingsFile
```
protected String settingsFile
```

mapping
```
protected String mapping
```

mappingFile
```
protected String mappingFile
```

extraMappings
```
protected List<String> extraMappings
```

mappingAppend
```
protected Boolean mappingAppend
```

excludes
```
protected String[] excludes
```

includes
```
protected String[] includes
```

Constructor Detail
- ElasticSearchIndexConfig
```
public ElasticSearchIndexConfig()
```

Method Detail

toString
```
public String toString()
```
Overrides:

toString in class Object

getExcludes
```
public String[] getExcludes()
```

getIncludes
```
public String[] getIncludes()
```

getName
```
public String getName()
```

getType
```
public String getType()
```

getSettings
```
public String getSettings()
```

contentOfFile

protected String contentOfFile(String filename)

getResourceStream

protected InputStream getResourceStream(String filename)

getMapping
```
public String getMapping()
```

getExtraMappings

public List<String> getExtraMappings()

mustCreate
```
public boolean mustCreate()
```

getRepositoryName
```
public String getRepositoryName()
```

isEnabled
```
public boolean isEnabled()
```

setEnabled

public void setEnabled(boolean isEnabled)

isDocumentIndex
```
public boolean isDocumentIndex()
```
Return true if the index/mapping is associated with a Nuxeo document repository

Since:

7.4

merge

public void merge(ElasticSearchIndexConfig other)

Use other mapping and settings if not defined.

hasExplicitWriteIndex

public boolean hasExplicitWriteIndex()

writeIndexOrAlias
```
public String writeIndexOrAlias()
```

manageAlias
```
public boolean manageAlias()
```

newWriteIndexForAlias

public String newWriteIndexForAlias(String aliasName,
                                    String oldIndexName)

Class ElasticSearchIndexConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_SETTING_FILE

DEFAULT_MAPPING_FILE

DEFAULT_REPOSITORY_NAME

WRITE_SUFFIX

isEnabled

name

manageAlias

writeAlias

repositoryName

type

create

settings

settingsFile

mapping

mappingFile

extraMappings

mappingAppend

excludes

includes

Constructor Detail

ElasticSearchIndexConfig

Method Detail

toString

getExcludes

getIncludes

getName

getType

getSettings

contentOfFile

getResourceStream

getMapping

getExtraMappings

mustCreate

getRepositoryName

isEnabled

setEnabled

isDocumentIndex

merge

hasExplicitWriteIndex

writeIndexOrAlias

manageAlias

newWriteIndexForAlias