ElasticEmbedded (Kuali Student 2.1.1-FR2-M1-SNAPSHOT API)

java.lang.Object
- org.kuali.student.enrollment.registration.search.elastic.ElasticEmbedded

```
public class ElasticEmbedded
extends Object
```
A simple class that instantiates an elasticsearch Node and obtains a client This is intended for use as a singleton inside a spring context

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`COURSEOFFERING_ELASTIC_TYPE`
`static String`	`KS_ELASTIC_CLUSTER`
`static String`	`KS_ELASTIC_INDEX`
`static Logger`	`LOG`
`static String`	`REGISTRATION_GROUP_ELASTIC_TYPE`

Constructor Summary

Constructors
Constructor and Description

ElasticEmbedded()

Constructors
Constructor and Description
`ElasticEmbedded()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected Collection<RegGroupSearchResult>`	`getAllRegistrationGroups()`
`org.elasticsearch.client.Client`	`getClient()` This method is quick way of keeping the indexed course data up-to-date by refreshing every timeToRefreshMs.
`org.elasticsearch.node.Node`	`getNode()`
`void`	`init()` Starts up a node and gets a handle to the client.
`boolean`	`isIndexOnStartup()`
`void`	`removeRegistrationGroupCache(List<String> registrationGroupToDeleteIds)` pass in a list of rg ids to remove from elastic cache.
`void`	`setIndexOnStartup(boolean indexOnStartup)` when the application starts, this allows you to disable the automatic index.
`void`	`setLrcService(LRCService lrcService)`
`void`	`setNode(org.elasticsearch.node.Node node)`
`void`	`setScheduleOfClassesService(ScheduleOfClassesService scheduleOfClassesService)`
`void`	`setSearchService(SearchService searchService)`
`void`	`setTimeToRefreshMs(long timeToRefreshMs)`
`void`	`shutdown()` Hook to close the node, should be called by spring application context.
`void`	`updateCourseOfferingCache(List<String> courseOfferingIds)` Pass in a list of course offering ids.
`void`	`updateRegistrationGroupCache(List<String> registrationGroupIds)` Pass in a list of registration group ids.

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

Field Detail

LOG
```
public static final Logger LOG
```

KS_ELASTIC_CLUSTER

public static final String KS_ELASTIC_CLUSTER

See Also:: Constant Field Values

KS_ELASTIC_INDEX

public static final String KS_ELASTIC_INDEX

See Also:: Constant Field Values

COURSEOFFERING_ELASTIC_TYPE

public static final String COURSEOFFERING_ELASTIC_TYPE

See Also:: Constant Field Values

REGISTRATION_GROUP_ELASTIC_TYPE

public static final String REGISTRATION_GROUP_ELASTIC_TYPE

See Also:: Constant Field Values

Constructor Detail

ElasticEmbedded

public ElasticEmbedded()
                throws IOException

Throws:: IOException

Method Detail

init

public void init()
          throws MissingParameterException,
                 InvalidParameterException,
                 OperationFailedException,
                 PermissionDeniedException,
                 IOException,
                 DoesNotExistException

Starts up a node and gets a handle to the client. This is a hook for spring application context to start up embedded elastic during application startup.

Throws:: MissingParameterException; InvalidParameterException; OperationFailedException; PermissionDeniedException; IOException; DoesNotExistException

updateCourseOfferingCache

public void updateCourseOfferingCache(List<String> courseOfferingIds)
                               throws DoesNotExistException,
                                      MissingParameterException,
                                      InvalidParameterException,
                                      OperationFailedException,
                                      PermissionDeniedException,
                                      IOException

Pass in a list of course offering ids. We will run a query for those ids and update the cache.

Parameters:: courseOfferingIds -
Throws:: DoesNotExistException; MissingParameterException; InvalidParameterException; OperationFailedException; PermissionDeniedException; IOException

updateRegistrationGroupCache

public void updateRegistrationGroupCache(List<String> registrationGroupIds)
                                  throws DoesNotExistException,
                                         MissingParameterException,
                                         InvalidParameterException,
                                         OperationFailedException,
                                         PermissionDeniedException,
                                         IOException

Pass in a list of registration group ids. We will run a query for those ids and update the cache.

Parameters:: registrationGroupIds -
Throws:: DoesNotExistException; MissingParameterException; InvalidParameterException; OperationFailedException; PermissionDeniedException; IOException

removeRegistrationGroupCache

public void removeRegistrationGroupCache(List<String> registrationGroupToDeleteIds)
                                  throws DoesNotExistException,
                                         MissingParameterException,
                                         InvalidParameterException,
                                         OperationFailedException,
                                         PermissionDeniedException,
                                         IOException

pass in a list of rg ids to remove from elastic cache.

Parameters:: registrationGroupToDeleteIds -
Throws:: DoesNotExistException; MissingParameterException; InvalidParameterException; OperationFailedException; PermissionDeniedException; IOException

getAllRegistrationGroups

protected Collection<RegGroupSearchResult> getAllRegistrationGroups()
                                                             throws DoesNotExistException,
                                                                    InvalidParameterException,
                                                                    MissingParameterException,
                                                                    OperationFailedException,
                                                                    PermissionDeniedException

Throws:: DoesNotExistException; InvalidParameterException; MissingParameterException; OperationFailedException; PermissionDeniedException

shutdown
```
public void shutdown()
```
Hook to close the node, should be called by spring application context.

getNode

public org.elasticsearch.node.Node getNode()

setNode

public void setNode(org.elasticsearch.node.Node node)

getClient
```
public org.elasticsearch.client.Client getClient()
```
This method is quick way of keeping the indexed course data up-to-date by refreshing every timeToRefreshMs.

Returns:
an elastic search client

setSearchService

public void setSearchService(SearchService searchService)

setLrcService

public void setLrcService(LRCService lrcService)

setTimeToRefreshMs

public void setTimeToRefreshMs(long timeToRefreshMs)

setScheduleOfClassesService

public void setScheduleOfClassesService(ScheduleOfClassesService scheduleOfClassesService)

isIndexOnStartup
```
public boolean isIndexOnStartup()
```

setIndexOnStartup
```
public void setIndexOnStartup(boolean indexOnStartup)
```
when the application starts, this allows you to disable the automatic index. By default this is set to true

Parameters:
indexOnStartup -

Class ElasticEmbedded