Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- abort(String) - Method in class com.tccc.kos.commons.util.concurrent.future.FutureWork
-
Aborts the work with the specified reason.
- abort(String, ReasonData) - Method in class com.tccc.kos.commons.util.concurrent.future.FutureWork
-
Aborts the work with the specified reason and optional reason data.
- abort(String, Object, Class<?>) - Method in class com.tccc.kos.commons.util.concurrent.future.FutureWork
-
Aborts the work with the specified reason and optional data and view.
- ABORT - Enum constant in enum class com.tccc.kos.commons.util.concurrent.future.FutureEvent
- ABORT - Enum constant in enum class com.tccc.kos.commons.util.concurrent.future.FutureState
- AbstractConfigurable<T extends ConfigBean> - Class in com.tccc.kos.commons.core.service.config
-
Abstract base class that can be used for objects that need to be configurable.
- AbstractConfigurable(String) - Constructor for class com.tccc.kos.commons.core.service.config.AbstractConfigurable
- AbstractConfigurableService<T extends ConfigBean> - Class in com.tccc.kos.commons.core.service
-
Abstract base class for all services that are configurable.
- AbstractConfigurableService() - Constructor for class com.tccc.kos.commons.core.service.AbstractConfigurableService
- AbstractService - Class in com.tccc.kos.commons.core.service
-
Abstract base class for all services.
- AbstractVFSSource - Class in com.tccc.kos.commons.core.vfs
-
Abstract base class for all concrete VFSSource classes.
- AbstractVFSSource() - Constructor for class com.tccc.kos.commons.core.vfs.AbstractVFSSource
- Adapter - Class in com.tccc.kos.core.service.spawn
-
Specialized
SpawnProcess
designed around starting adapters. - Adapter(String) - Constructor for class com.tccc.kos.core.service.spawn.Adapter
-
Create a new adapter that is backed by the specified program name.
- add(int, FutureWork) - Method in class com.tccc.kos.commons.util.concurrent.future.SequencedFuture
-
Adds a future to the specified location in the sequence following
List
semantics for insertion. - add(Handle) - Method in class com.tccc.kos.commons.core.service.handle.Handle
-
Adds the specified handle as a child of this handle without a name prefix.
- add(Trouble) - Method in class com.tccc.kos.commons.core.service.trouble.TroubleService
-
Adds the specified trouble to the service.
- add(FutureWork) - Method in class com.tccc.kos.commons.util.concurrent.future.ParallelFuture
-
Adds a future to the collection.
- add(FutureWork) - Method in class com.tccc.kos.commons.util.concurrent.future.SequencedFuture
-
Adds a future to the sequence.
- add(Unit) - Method in class com.tccc.kos.commons.util.units.UnitSystem
-
Adds a new unit to the system.
- add(Object) - Method in class com.tccc.kos.commons.core.context.BeanContext
-
Adds a bean to the context.
- add(String, Handle) - Method in class com.tccc.kos.commons.core.service.handle.Handle
-
Adds the specified handle as a child of this handle using the specified name prefix.
- add(String, HandleAware) - Method in class com.tccc.kos.commons.core.service.handle.Handle
-
Adds the specified
HandleAware
as a child of this handle using the specified name prefix. - add(String, Object) - Method in class com.tccc.kos.commons.core.context.BeanContext
-
Adds a bean to the context with a name.
- add(String, Object) - Method in class com.tccc.kos.commons.core.service.config.BeanUpdate
-
Add an updated value to the update.
- add(K, V) - Method in class com.tccc.kos.commons.util.MultiValueMap
-
Adds the given value to the list of items associated with the given key.
- add(T) - Method in class com.tccc.kos.commons.util.AutowiredList
- addAlias(WebsocketConnection, String) - Method in class com.tccc.kos.commons.web.websocket.router.RouterEngine
-
Add an alias to the specified connection.
- addAll(Map<K, V>) - Method in class com.tccc.kos.commons.util.MultiValueMap
-
Adds the contents of the given map into this object's internal map.
- addAll(K, Collection<V>) - Method in class com.tccc.kos.commons.util.MultiValueMap
-
Adds the contents of the given list to the list associated with the specified key.
- addArg(Object) - Method in class com.tccc.kos.core.service.spawn.SpawnProcess
-
Add a command line argument.
- addBoard(Board) - Method in class com.tccc.kos.core.service.assembly.Assembly
-
Add a board to the assembly
- addCallback(String, StreamingJsonReaderCallback) - Method in class com.tccc.kos.commons.util.json.StreamingJsonReader
-
Add a new callback to the specified json path.
- addClient(WebsocketConnection) - Method in class com.tccc.kos.commons.web.websocket.router.RouterEngine
-
Add a client to the router.
- addDateFormat(DateFormat) - Method in class com.tccc.kos.core.service.region.RegionService
-
Adds a date format to the service.
- addDeviceClass(int) - Method in class com.tccc.kos.core.service.udev.UdevNode
-
Query the device class and add the results
- addDir(String) - Method in class com.tccc.kos.commons.kab.KabOutputStream
-
Create a new dir entry.
- addFile(String) - Method in class com.tccc.kos.commons.kab.KabOutputStream
-
Create a new file entry.
- addHandleChild(String, HandleAware) - Method in interface com.tccc.kos.commons.core.service.handle.HandleAware
-
Adds a child
HandleAware
bean to this bean. - addHandler(int, BinaryMsgClientHandler) - Method in class com.tccc.kos.commons.core.client.binarymsg.BinaryMsgClientIface
-
Register a handler with the specified api num.
- addHeader(String, Object) - Method in class com.tccc.kos.commons.web.api.ApiRequest
-
Adds the specified header to the message.
- addHeader(String, Object) - Method in class com.tccc.kos.commons.web.websocket.router.msg.RoutedMessage
-
Adds the specified header to the message.
If the value isnull
, then the header is removed. - addHeader(String, String) - Method in class com.tccc.kos.commons.web.client.WebsocketEndpoint
-
Adds a header to this endpoint.
- addHeaders(Map<String, ?>) - Method in class com.tccc.kos.commons.web.websocket.router.msg.RoutedMessage
-
Adds all the headers from the specified map.
- addHeaders(Map<String, Object>) - Method in class com.tccc.kos.commons.web.api.ApiRequest
-
Adds all the
headers
from the specified map. - addIface(BinaryMsgClientIface) - Method in class com.tccc.kos.commons.core.client.binarymsg.BinaryMsgClient
-
Add a new iface to the client.
- addIface(Trouble) - Static method in interface com.tccc.kos.commons.core.service.trouble.HandleTroubleIface
-
Adds the iface to the specified
Trouble
. - addIface(Trouble) - Static method in interface com.tccc.kos.core.service.hardware.BoardTroubleIface
-
Adds the iface to the specified
Trouble
. - addIface(String) - Method in class com.tccc.kos.commons.core.service.trouble.Trouble
-
Add a symbolic interface name to the trouble.
- addImpacted(Object) - Method in class com.tccc.kos.commons.core.service.trouble.Trouble
-
Add an object to the impact list.
- addInterface(BinaryMsgIface) - Method in class com.tccc.kos.commons.core.service.blink.binarymsg.BinaryMsgSession
-
Add an interface to the session.
- addKey(K) - Method in class com.tccc.kos.commons.util.MultiValueMap
-
Add the specified key to the map with an empty list if the key doesn't already exist.
- addLink(Object) - Method in class com.tccc.kos.commons.core.service.trouble.Trouble
-
Link an object to the trouble
- addListener(ConfigBeanListener) - Method in class com.tccc.kos.commons.core.service.config.ConfigBean
-
Add a listener to the list.
- addListener(StateBeanListener) - Method in class com.tccc.kos.commons.core.service.state.StateBean
-
Add a listener to the list.
- addListener(WebsocketConnectionListener) - Method in class com.tccc.kos.commons.web.client.WebsocketClient
-
Add a connection listener to the client.
- addListener(BoardLinkListener) - Method in class com.tccc.kos.core.service.hardware.Board
-
Add a listener to the board.
- addListener(UdevDeviceListener) - Method in class com.tccc.kos.core.service.udev.UdevService
-
Add a device listener.
- addListener(String, RouterListener) - Method in class com.tccc.kos.commons.web.websocket.router.WebsocketRouter
-
Add a listener for when the specified routerId is added/removed from the forwarding table.
- addLoader(ResourceLoader) - Method in class com.tccc.kos.core.service.region.XmlRegionFactory
-
Adds a
ResourceLoader
used to search for referenced XML files. - addMessageHandler(String, RouterMessageHandler) - Method in class com.tccc.kos.commons.web.websocket.router.WebsocketRouter
-
Add a message handler to the router.
- addOptionsType(String, Class<? extends ConfigOptions>) - Method in class com.tccc.kos.commons.core.service.config.ConfigService
-
Register an options type for converting options json to options beans.
- addParam(UriParam) - Method in class com.tccc.kos.commons.util.net.UriBuilder
-
Adds the specified parameter to the URI.
- addParam(String, String) - Method in class com.tccc.kos.commons.util.net.UriBuilder
-
Adds the specified parameter to the URI.
- addParams(List<UriParam>) - Method in class com.tccc.kos.commons.util.net.UriBuilder
-
Adds the specified parameters to the URI.
- addPath(Enum<?>, NamedPath, String) - Method in class com.tccc.kos.commons.path.PathMgr
-
Same as above except that it accepts an Enum value.
- addPath(Enum<?>, Enum<?>, String) - Method in class com.tccc.kos.commons.path.PathMgr
-
Same as above, excepts accepts an Enum value and Enum baseName.
- addPath(Enum<?>, String, String) - Method in class com.tccc.kos.commons.path.PathMgr
-
Same as above, excepts accepts an Enum value.
- addPath(String) - Method in class com.tccc.kos.commons.util.net.UriBuilder
-
Adds a path to the URI.
- addPath(String, NamedPath, String) - Method in class com.tccc.kos.commons.path.PathMgr
-
Adds a named path to the
PathMgr
. - addPath(String, String, String) - Method in class com.tccc.kos.commons.path.PathMgr
-
Adds a named path.
- addPaths(String...) - Method in class com.tccc.kos.commons.util.net.UriBuilder
-
Adds paths to the URI.
- addPaths(List<String>) - Method in class com.tccc.kos.commons.util.net.UriBuilder
-
Adds paths to the URI.
- addPermFileContents(String, String) - Method in class com.tccc.kos.commons.kab.PermAccessProvider
-
Adds
permFileContents
to ourrulesMap
. - addProcess(SpawnProcess) - Method in class com.tccc.kos.core.service.spawn.SpawnService
-
Add a process to the spawn list.
- addProcess(SpawnProcess, NodeId) - Method in class com.tccc.kos.core.service.spawn.SpawnService
-
Add a process to the spawn list.
- addRequestHandler(int, BinaryMsgListener) - Method in class com.tccc.kos.commons.core.service.blink.binarymsg.BinaryMsgIface
-
Add a listener for a given request message identified by apiNum.
- addRouter(WebsocketConnection) - Method in class com.tccc.kos.commons.web.websocket.router.RouterEngine
-
Add the connection as a router.
- addSource(KabSource) - Method in class com.tccc.kos.core.primary.service.nodemgr.install.InstallBuilder
-
Add a kab source to the builder.
- addState(Object) - Method in class com.tccc.kos.commons.util.ready.ReadyIndicator
-
Add a state object that must be marked ready before the indicator is ready.
- addTag(String) - Method in class com.tccc.kos.commons.core.service.trouble.Trouble
-
Add a tag to the trouble
- addTag(Element, String) - Static method in class com.tccc.kos.commons.xml.XmlUtil
-
Sets a string tag value in the specified element.
- addTag(Element, String, Namespace) - Static method in class com.tccc.kos.commons.xml.XmlUtil
-
Sets a string tag value in the specified element.
- addTimeFormat(TimeFormat) - Method in class com.tccc.kos.core.service.region.RegionService
-
Adds a time format to the service.
- addToCtx(Object) - Method in class com.tccc.kos.core.service.app.Application
-
Add a bean to the application context.
- addToCtx(Object) - Method in class com.tccc.kos.core.service.assembly.Assembly
-
Adds the given bean to the assembly context.
- addToEnd(ResourceLoader) - Method in class com.tccc.kos.commons.util.resource.ResourceLoaderList
-
Add a loader to the end of the search list.
- addToFront(ResourceLoader) - Method in class com.tccc.kos.commons.util.resource.ResourceLoaderList
-
Add a loader to the front of the search list.
- addUnitSystem(UnitSystem) - Method in class com.tccc.kos.core.service.region.RegionService
-
Adds a unit system to the service.
- addValueCallback(String, StreamingJsonReaderCallback) - Method in class com.tccc.kos.commons.util.json.StreamingJsonReader
-
Add a new callback to the specified json path.
- addViewClass(String, Class<?>) - Method in class com.tccc.kos.commons.core.service.handle.HandleService
-
Add a custom view class.
- AdjustableCallback - Class in com.tccc.kos.commons.util.concurrent
-
Class that supports single (one-shot) or recurring callbacks, allows the delay to be adjusted while the timer is running, and has variance support to add a degree of randomness to the timer.
- AdjustableCallback(boolean, int, Runnable) - Constructor for class com.tccc.kos.commons.util.concurrent.AdjustableCallback
-
Creates a timer with the specified
callback
method,delay
, andrecurring
flag. - AdjustableCallback(boolean, Runnable) - Constructor for class com.tccc.kos.commons.util.concurrent.AdjustableCallback
-
Creates a timer with the specified
callback
method andrecurring
flag. - AndTroubleMatcher - Class in com.tccc.kos.commons.core.service.trouble.matcher
-
Matcher that returns true if the logical AND of all child matchers are true.
- AndTroubleMatcher(TroubleMatcher...) - Constructor for class com.tccc.kos.commons.core.service.trouble.matcher.AndTroubleMatcher
-
Create a matcher that returns true if the logical AND of all specified matchers is true.
- AnyRouterListener - Interface in com.tccc.kos.commons.web.websocket.router
-
This interface provides callback methods for when routers are added or removed from the forwarding table.
- api(ApiRequest<T>) - Method in class com.tccc.kos.commons.web.api.ApiClient
-
Performs an API call using the settings in the
request
object. - ApiClient - Class in com.tccc.kos.commons.web.api
-
System component used to interact with applications running on nodes within a kOS cluster.
- ApiController - Annotation Interface in com.tccc.kos.commons.core.dispatcher.annotations
-
Class annotation that indicates that the class contains endpoints.
- ApiEndpoint - Annotation Interface in com.tccc.kos.commons.core.dispatcher.annotations
-
The
ApiEndpoint
annotation is used to declare and document an HTTP (RESTful) endpoint. - ApiEndpoint.Param - Annotation Interface in com.tccc.kos.commons.core.dispatcher.annotations
- ApiRequest<T> - Class in com.tccc.kos.commons.web.api
-
Data class used by ApiClient to make API calls to local and remote nodes.
- ApiRequest() - Constructor for class com.tccc.kos.commons.web.api.ApiRequest
-
Constructs a new
ApiRequest
in which all data fields arenull
except the requestmethod
field, which is initialized to GET. - append(String, FutureEvent, FutureRunnable) - Method in class com.tccc.kos.commons.util.concurrent.future.FutureWork
-
Appends an event callback.
- appendIfMissing(String, String) - Static method in class com.tccc.kos.commons.util.misc.Str
-
Appends the suffix to the end of the string if the string does not already end with it.
- Application<T extends BaseAppConfig> - Class in com.tccc.kos.core.service.app
-
Base class for all kOS applications.
- Application() - Constructor for class com.tccc.kos.core.service.app.Application
- AppListener - Interface in com.tccc.kos.core.service.app
-
Listener for Application-related events.
- AppLoader - Class in com.tccc.kos.core.service.app
-
Class responsible for loading an application from the filesystem.
- AppLoader() - Constructor for class com.tccc.kos.core.service.app.AppLoader
- applyDefaultUpdates(BeanUpdate) - Method in class com.tccc.kos.core.service.region.BaseRegion
-
Applies the default units, time format, and date format from the specified region to the settings bean via the specified updates object.
- AppMessageBroker - Class in com.tccc.kos.core.service.app
-
Wrapper for the system message broker that prefixes the topics with the application id.
- AppMessageBroker() - Constructor for class com.tccc.kos.core.service.app.AppMessageBroker
- AppService - Class in com.tccc.kos.core.service.app
-
Service that manages applications within kOS.
- areHeadersModified() - Method in class com.tccc.kos.commons.web.websocket.router.msg.RoutedMessage
-
Indicates if the headers in this routed message have been modified or not.
- Assembly - Class in com.tccc.kos.core.service.assembly
-
An assembly is used to describe a collection of hardware that can be added or removed as an atomic unit within kOS.
- Assembly(String, JsonDescriptor) - Constructor for class com.tccc.kos.core.service.assembly.Assembly
-
Create a new assembly with the specified name.
- AssemblyAware - Interface in com.tccc.kos.core.service.assembly
-
Interface for objects that are directly linked to an Assembly object.
- AssemblyListener - Interface in com.tccc.kos.core.service.assembly
-
Listener for Assembly-related events.
- AssemblyService - Class in com.tccc.kos.core.service.assembly
-
Manages assemblies in kOS.
- ATTR_ALIAS - Static variable in class com.tccc.kos.commons.web.websocket.router.RouterEngine
- AttributeAware - Interface in com.tccc.kos.commons.util
-
Interface that is implemented by any bean that has attributes.
- AUTHORIZE_FILE - Static variable in class com.tccc.kos.commons.kab.KabFile
- Autowired - Annotation Interface in com.tccc.kos.commons.core.context.annotations
-
Annotation that informs the BeanContext that a dependent field needs its object reference injected, which is also known as autowired.
- AutowiredList<T> - Class in com.tccc.kos.commons.util
-
Specialized list class supports autowiring.
- AutowiredList() - Constructor for class com.tccc.kos.commons.util.AutowiredList
- AutowiredList.ChangeListener - Interface in com.tccc.kos.commons.util
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form