services

ElasticsearchPlugin

class ElasticsearchPlugin extends Plugin

Elasticsearch plugin.

Linear Supertypes
Plugin, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ElasticsearchPlugin
  2. Plugin
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ElasticsearchPlugin(application: Application)

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. def _search(queryObj: XContentBuilder, index: String = nameOfIndex, from: Option[Int] = Some(0), size: Option[Int] = Some(maxResults), sort: Option[String], order: Option[String]): (List[ResourceRef], Long)

    * Execute query and return list of results and total result count as tuple

  7. def accumulatePageResult(queryObj: XContentBuilder, user: Option[User], from: Int, size: Int, sort: Option[String], order: Option[String], index: String = nameOfIndex): ElasticsearchResult

    Perform search, check permissions, and keep searching again if page isn't filled with permitted resources

  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. def checkResultPermissions(results: List[ResourceRef], user: Option[User]): List[ResourceRef]

    Return a filtered list of resources that user can actually access

  10. var client: Option[TransportClient]

  11. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. val collections: CollectionService

  13. val comments: CommentService

  14. def connect(force: Boolean = false): Boolean

  15. def convertJsMappingToFields(json: JsObject, parentKey: Option[String] = None, targetObject: Option[String] = None, foundTarget: Boolean = false): List[String]

    Take a JsObject and list all unique fields under targetObject field, except those in ignoredFields

  16. def convertJsObjectToBuilder(builder: XContentBuilder, json: JsObject): XContentBuilder

    Take a JsObject and parse into an XContentBuilder JSON object for indexing into Elasticsearch

  17. def createIndex(index: String = nameOfIndex): Unit

    Create a new index with preconfigured mappgin

  18. val datasets: DatasetService

  19. def delete(id: String, docType: String = "clowder_object", index: String = nameOfIndex): Unit

    Delete an index

  20. def deleteAll(idx: String = nameOfIndex): Unit

    Delete all documents in default index

  21. def enabled: Boolean

    Definition Classes
    Plugin
  22. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  23. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  24. val files: FileService

  25. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  26. val folders: FolderService

  27. def getAutocompleteMetadataFields(query: String, index: String = nameOfIndex): List[String]

    Traverse metadata field mappings to get unique list for autocomplete

  28. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  29. def getElasticsearchObjectMappings(): String

    Return string-encoded JSON object describing field types

  30. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  31. def index(esObj: Option[ElasticsearchObject], index: String = nameOfIndex): Unit

    Index document using an arbitrary map of fields.

  32. def index(section: Section, idx: Option[String]): Unit

  33. def index(file: File, idx: Option[String]): Unit

    Reindex the given file.

  34. def index(dataset: Dataset, recursive: Boolean, idx: Option[String]): Unit

    Reindex the given dataset, if recursive is set to true it will also reindex all files.

  35. def index(collection: Collection, recursive: Boolean, idx: Option[String]): Unit

    Reindex the given collection, if recursive is set to true it will also reindex all datasets and files.

  36. def isEnabled(): Boolean

  37. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  38. def listTags(resourceType: String = "", index: String = nameOfIndex): Map[String, Long]

    Return map of distinct value/count for tags *

  39. val maxResults: Int

  40. val mustNotOperators: List[String]

  41. val mustOperators: List[String]

  42. val nameOfCluster: String

  43. val nameOfIndex: String

  44. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  45. final def notify(): Unit

    Definition Classes
    AnyRef
  46. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  47. def onStart(): Unit

    Definition Classes
    ElasticsearchPlugin → Plugin
  48. def onStop(): Unit

    Definition Classes
    ElasticsearchPlugin → Plugin
  49. def parseDouble(s: String): Option[Double]

    Attempt to cast String into Double, returning None if not possible*

  50. def parseMustNotOperators(builder: XContentBuilder, key: String, value: String, operator: String): XContentBuilder

    Create appropriate search object based on operator

  51. def parseMustOperators(builder: XContentBuilder, key: String, value: String, operator: String): XContentBuilder

    Create appropriate search object based on operator

  52. def prepareElasticJsonQuery(query: String, permitted: List[UUID], user: Option[User]): XContentBuilder

    Convert search string into an Elasticsearch-ready JSON query object *

  53. def prepareElasticJsonQuery(query: List[JsValue], grouping: String, permitted: List[UUID], user: Option[User]): XContentBuilder

    Convert list of search term JsValues into an Elasticsearch-ready JSON query object *

  54. val queue: ElasticsearchQueue

  55. def search(query: String, resource_type: Option[String], datasetid: Option[String], collectionid: Option[String], spaceid: Option[String], folderid: Option[String], field: Option[String], tag: Option[String], from: Option[Int], size: Option[Int], sort: Option[String], order: Option[String], permitted: List[UUID], user: Option[User], index: String = nameOfIndex): ElasticsearchResult

    Search using a simple text string.

    Search using a simple text string. The API endpoint supports several parameters like datasetid that are translated and appended to the query first.

    query
    resource_type

    - Restrict to particular resource_type

    datasetid

    - Restrict to particular dataset ID (only returns files)

    collectionid

    - Restrict to particular collection ID

    spaceid

    - Restrict to particular space ID

    folderid

    - Restrict to particular folder ID

    field

    - Restrict to a specific metadata field (assumes query is the value)

    tag

    - Restrict to a particular tag (exact match)

    from
    size
    permitted
    user
    index

  56. def search(query: List[JsValue], grouping: String, from: Option[Int], size: Option[Int], permitted: List[UUID], user: Option[User]): ElasticsearchResult

    Prepare and execute Elasticsearch query, and return list of matching ResourceRefs

  57. val serverAddress: String

  58. val serverPort: Int

  59. val spaces: SpaceService

  60. def swapIndex(idx: String): Unit

  61. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  62. def toString(): String

    Definition Classes
    AnyRef → Any
  63. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  64. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  65. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  66. def wrapRegex(value: String, query_string: Boolean = false): String

Inherited from Plugin

Inherited from AnyRef

Inherited from Any

Ungrouped