Package com.illumon.iris.controller.utils

Class ControllerScriptPathLoader

java.lang.Object

com.illumon.iris.controller.utils.ControllerScriptPathLoader

All Implemented Interfaces:

ScriptPathLoader, StateOverrideScriptPathLoader

public class ControllerScriptPathLoader
extends Object
implements StateOverrideScriptPathLoader

A ScriptPathLoader slaved to the PersistentQueryController.

ImplNote:

The lock/unlock operations are no-ops - we don't offer consistency for this implementation.

Method Summary

Modifier and Type	Method	Description
void	clearOverride()	Instead of using the previously set override, use the state the loader was created with.
void	close()	Free resources associated with this loader.
Set<String>	getAvailableScriptDisplayPaths()
Set<String>	getAvailableScriptRelativePaths()
String	getScriptBodyByDisplayPath(String displayPath)
String	getScriptBodyByRelativePath(String relativePath)
String	getUseStateJson()	Get the currently active state as a JSON string created by ScriptPathLoaderState.encodeJSON()
void	lock()	Acquire a read lock.
void	refresh()	Refresh the loader internally.
void	setOverrideState(ScriptPathLoaderState state)	Sets a state that should be used for loading operations instead of the state the loader was created with.
void	unlock()	Release a previously acquired read lock.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.illumon.iris.db.util.scripts.ScriptPathLoader

getAvailableScriptDisplayPaths, getAvailableScriptRelativePaths, getScriptBodyByDisplayPath, getScriptBodyByRelativePath, getState, makeState

Method Details

lock

public void lock()

Description copied from interface: ScriptPathLoader

Acquire a read lock. Use before invoking any of the get* methods, and hold for as long as consistency is required for this loader.

Specified by:

lock in interface ScriptPathLoader

unlock

public void unlock()

Description copied from interface: ScriptPathLoader

Release a previously acquired read lock.

Specified by:

unlock in interface ScriptPathLoader

getAvailableScriptDisplayPaths

public Set<String> getAvailableScriptDisplayPaths()

Specified by:

getAvailableScriptDisplayPaths in interface ScriptPathLoader

Returns:

The display paths currently available from this loader.

getAvailableScriptRelativePaths

public Set<String> getAvailableScriptRelativePaths()

Specified by:

getAvailableScriptRelativePaths in interface ScriptPathLoader

Returns:

The relative paths currently available from this loader.

getScriptBodyByDisplayPath

public String getScriptBodyByDisplayPath(String displayPath)

Specified by:

getScriptBodyByDisplayPath in interface ScriptPathLoader

Parameters:

displayPath - The display path to load a script for.

Returns:

The body of the requested script.

getScriptBodyByRelativePath

public String getScriptBodyByRelativePath(String relativePath)

Specified by:

getScriptBodyByRelativePath in interface ScriptPathLoader

Parameters:

relativePath - The relative path to load a script for.

Returns:

The body of the requested script.

refresh

public void refresh()

Description copied from interface: ScriptPathLoader

Refresh the loader internally. Will respect existing read locks.

Specified by:

refresh in interface ScriptPathLoader

close

public void close()

Description copied from interface: ScriptPathLoader

Free resources associated with this loader.

Specified by:

close in interface ScriptPathLoader

clearOverride

public void clearOverride()

Description copied from interface: StateOverrideScriptPathLoader

Instead of using the previously set override, use the state the loader was created with.

Specified by:

clearOverride in interface StateOverrideScriptPathLoader

setOverrideState

public void setOverrideState(ScriptPathLoaderState state)

Description copied from interface: StateOverrideScriptPathLoader

Sets a state that should be used for loading operations instead of the state the loader was created with.

Specified by:

setOverrideState in interface StateOverrideScriptPathLoader

Parameters:

state - the state to use for loading operations.

getUseStateJson

public String getUseStateJson()

Description copied from interface: StateOverrideScriptPathLoader

Get the currently active state as a JSON string created by ScriptPathLoaderState.encodeJSON()

Specified by:

getUseStateJson in interface StateOverrideScriptPathLoader

Returns:

the currently active state as a JSON string