Uses of Interface
org.jgrapes.core.Eligible

Packages that use Eligible

Package	Description
org.jgrapes.core	Defines the interfaces and classes that provide the core functionality of the JGrapes event driven component framework.
org.jgrapes.core.annotation	Annotations used by the library.
org.jgrapes.core.events	Core events.
org.jgrapes.core.internal	Classes implementing the public API of the library.
org.jgrapes.http	Provides components for building a HTTP server based on the core and IO components.
org.jgrapes.http.annotation	Adds a special annotation for methods that handle HTTP request events.
org.jgrapes.http.events	Provides the events handled by the server components.
org.jgrapes.http.freemarker	Provides a base component for generating template based responses to HTTP requests.
org.jgrapes.io	I/O related components built on top of the core package.
org.jgrapes.io.events	Provides the events used by the I/O related components.
org.jgrapes.io.process	Classes for managing processes.
org.jgrapes.io.util	Utility classes, mainly for adapted buffers to specific needs.
org.jgrapes.io.util.events	Events associated with classes from org.jgrapes.io.util.
org.jgrapes.mail	Components for handling mail.
org.jgrapes.mail.events	Mail related events.
org.jgrapes.net	Networking related I/O classes.
org.jgrapes.net.events
org.jgrapes.util	Utility components that are too small to deserve individual libraries/projects.
org.jgrapes.util.events

Uses of Eligible in org.jgrapes.core

Subinterfaces of Eligible in org.jgrapes.core

Modifier and Type	Interface	Description
interface	Channel	Instances of this interface can be used as a communication bus for sending events between components.
static interface	Channel.Default	This interface’s class can be used to specify the component’s channel (see Component.channel()) as criterion in handler annotations.
interface	Self	This interface type can be used to specify the object itself as channel in handler annotations.
interface	Subchannel	Represents a subchannel.

Classes in org.jgrapes.core that implement Eligible

Modifier and Type	Class	Description
class	ClassChannel	This class is the root base class for channels that use their class (type) as value for matching (see Eligible).
class	CompletionEvent<T extends Event<?>>	A base class for events that signal the completion of some other (monitored) event and provide this other event as their result.
class	Component	This class can be used as base class for implementing a component.
class	ComponentCollector<F extends ComponentFactory>	Deprecated. This class has been moved to ComponentCollector.
class	Event<T>	This class is the base class for all events.
final class	NamedChannel	This class provides channels that are identified by a name (string).
final class	NamedEvent<T>	A class for events using a simple name as the event’s kind.
static class	Subchannel.DefaultSubchannel	A simple implementation of Subchannel.

Methods in org.jgrapes.core with parameters of type Eligible

Modifier and Type	Method	Description
boolean	HandlerScope.includes(Eligible event, Eligible[] channels)	Matches the given event and channels against the criteria for events and channels of this handler scope.

Uses of Eligible in org.jgrapes.core.annotation

Classes in org.jgrapes.core.annotation that implement Eligible

Modifier and Type	Class	Description
static final class	Handler.NoChannel	The default value for the channels parameter of the annotation.
static final class	Handler.NoEvent	The default value for the events parameter of the annotation.

Uses of Eligible in org.jgrapes.core.events

Classes in org.jgrapes.core.events that implement Eligible

Modifier and Type	Class	Description
class	Attached	Signals the addition of a component (or subtree) to the component tree.
class	Detached	Signals the removal of a component from the component tree.
class	Error	This event signals that an error occurred while processing an event.
class	HandlingError	This event signals that a throwable occurred while executing a handler.
class	Start	An event that signals the start of the application.
class	Started	The event that signals the completion of the Start event.
class	Stop	An event that causes an application to shut down.

Uses of Eligible in org.jgrapes.core.internal

Classes in org.jgrapes.core.internal that implement Eligible

Modifier and Type	Class	Description
class	ActionEvent<T>	A base class for events that perform an action instead of being handled.
final class	ComponentProxy	The ComponentProxy is a special ComponentVertex that references the object implementing the Component interface (instead of being its base class).
class	ComponentVertex	ComponentVertex is the base class for all nodes in the component tree.
class	EventBase<T>	Provides the implementations of methods to class Event that need access to classes or methods that are visible in the implementation package only.

Uses of Eligible in org.jgrapes.http

Classes in org.jgrapes.http that implement Eligible

Modifier and Type	Class	Description
class	HttpConnector	A converter component that receives and sends web application layer messages and byte buffers on associated network channels.
class	HttpServer	A converter component that receives and sends byte buffers on a network channel and web application layer messages on IOSubchannels of its channel.
class	InMemorySessionManager	A in memory session manager.
class	LanguageSelector	A component that attempts to derive information about language preferences from requests in the specified scope (usually “/”) and make them available as a LanguageSelector.Selection object associated with the request event using Selection.class as association identifier.
class	SessionManager	A base class for session managers.
class	StaticContentDispatcher	A dispatcher for requests for static content, usually files.

Uses of Eligible in org.jgrapes.http.annotation

Methods in org.jgrapes.http.annotation with parameters of type Eligible

Modifier and Type	Method	Description
boolean	RequestHandler.Evaluator.Scope.includes(Eligible event, Eligible[] channels)

Uses of Eligible in org.jgrapes.http.events

Classes in org.jgrapes.http.events that implement Eligible

Modifier and Type	Class	Description
class	DiscardSession	Causes a session manager to discard the given session.
class	HostUnresolved	Indicates that a host name could not be resolved.
class	HttpConnected	Signals that a HTTP connection for a HttpRequest has been established.
class	MessageReceived<T>	Base class for events that signal the reception of a message.
class	ProtocolSwitchAccepted	Indicates that a component has accepted a Request.In.Get with a header that requested an upgrade to another protocol.
class	Request<R>	The base class for all HTTP requests such as Request.In.Get, Request.In.Post etc.
static class	Request.In	The base class for all incoming HTTP requests.
static class	Request.In.Completed	The associated completion event.
static class	Request.In.Connect	Represents a HTTP CONNECT request.
static class	Request.In.Delete	The Class Delete.
static class	Request.In.Get	Represents a HTTP GET request.
static class	Request.In.Head	Represents a HTTP HEAD request.
static class	Request.In.Options	Represents a HTTP OPTIONS request.
static class	Request.In.Post	Represents a HTTP POST request.
static class	Request.In.Put	Represents a HTTP PUT request.
static class	Request.In.Trace	Represents a HTTP TRACE request.
static class	Request.Out	The base class for all outgoing HTTP requests.
static class	Request.Out.Connect	Represents a HTTP CONNECT request.
static class	Request.Out.Delete	Represents a HTTP DELETE request.
static class	Request.Out.Get	Represents a HTTP GET request.
static class	Request.Out.Head	Represents a HTTP HEAD request.
static class	Request.Out.Options	Represents a HTTP OPTIONS request.
static class	Request.Out.Post	Represents a HTTP POST request.
static class	Request.Out.Put	Represents a HTTP PUT request.
static class	Request.Out.Trace	Represents a HTTP TRACE request.
class	Response	Represents the response (header).
class	Upgraded	Fired when a protocol upgrade was successful.
class	WebSocketClose	An event that provides the close information when a WebSockt is closed.

Uses of Eligible in org.jgrapes.http.freemarker

Classes in org.jgrapes.http.freemarker that implement Eligible

Modifier and Type	Class	Description
class	FreeMarkerRequestHandler	A base class for components that generate responses to HTTP requests which are based on a FreeMarker template.

Uses of Eligible in org.jgrapes.io

Subinterfaces of Eligible in org.jgrapes.io

Modifier and Type	Interface	Description
interface	IOSubchannel	Represents a subchannel for grouping input and output events related to an I/O resource such as an opened file or a network connection.

Classes in org.jgrapes.io that implement Eligible

Modifier and Type	Class	Description
class	FileStorage	A component that reads from or writes to a file.
class	InputStreamMonitor	A component that watches for new input on an InputStream.
static class	IOSubchannel.DefaultIOSubchannel	A simple implementation of IOSubchannel.
class	NioDispatcher	A helper component that provides the central hub for non blocking I/O components.
class	PurgeTerminator	A component that handles Purge events by unconditionally firing a Close events as response.

Uses of Eligible in org.jgrapes.io.events

Classes in org.jgrapes.io.events that implement Eligible

Modifier and Type	Class	Description
class	Close	This event causes the initiator of an I/O channel to shutdown the channel.
class	Closed<T>	This event signals that an I/O subchannel will no longer be used.
class	ConnectError	Indicates a problem while opening a network connection.
class	FileOpened
class	HalfClosed	This event signals that an I/O subchannel has been closed on the other end.
final class	Input<T extends Buffer>	This event signals that a new chunk of data has successfully been obtained from some source.
class	IOError	A special kind of Error that signals I/O related problems.
class	IOEvent<T extends Buffer>	Events of this type signal that a new chunk of data is available for processing.
class	NioRegistration	Signal a registration request to a registry.
static class	NioRegistration.Completed	The completion event for a NioRegistration event.
class	Opened<T>	This event signals that an I/O resource has successfully been opened (usually in response to some …Open event).
class	OpenFile	A base class for events that cause a file to be opened.
class	Opening<T>	This event is fired on IOSubchannels that are created by provider components before their first usage for Input or Output events.
class	OpenSocketConnection
class	Output<T extends Buffer>	This event signals that a new chunk of internally generated data is to be forwarded to some destination.
class	ProcessExited	Fired when a process has exited.
class	ProcessStarted	Fired when a process has been started.
class	Purge	Fired by an initiator of connections that maintains a pool of such connections if no more connections are available.
class	SaveInput	Causes the FileStorage component to write the data from all Input events on the channel that this event is fired on to a file until an event with the end of record flag set is sent on the channel.
class	SaveOutput	Causes the FileStorage component to write the data from all Output events on the channel that this event is fired on to a file until an event with the end of record flag set is sent on the channel.
class	StartProcess	Starts a new process managed by the ProcessManager component that handles the event.
class	StartProcessError	Indicates a problem while starting a process.
class	StreamFile	Causes the content of a file to be streamed as a sequence of Output events (terminated by an event with the end of record flag set) on the channel that this event is fired on.

Uses of Eligible in org.jgrapes.io.process

Classes in org.jgrapes.io.process that implement Eligible

Modifier and Type	Class	Description
class	ProcessManager	Provides a component that executes processes.
final class	ProcessManager.ProcessChannel	The Class ProcessChannel.

Uses of Eligible in org.jgrapes.io.util

Classes in org.jgrapes.io.util that implement Eligible

Modifier and Type	Class	Description
class	ConnectionManager<C extends ConnectionManager<C>.Connection>	A base class for components that manage Subchannels representing some kind of connection to a server or service.
class	ConnectionManager.Connection	The base class for the connections managed by this component.
class	LinkedIOSubchannel	Provides an I/O subchannel that is linked to another I/O subchannel.

Uses of Eligible in org.jgrapes.io.util.events

Classes in org.jgrapes.io.util.events that implement Eligible

Modifier and Type	Class	Description
class	DataInput<T>	Signals that some data is available for handling.
class	JsonParsingError	Signals an error that occurred while parsing JSON.

Uses of Eligible in org.jgrapes.mail

Subinterfaces of Eligible in org.jgrapes.mail

Modifier and Type	Interface	Description
interface	MailChannel	A special sub channel used for sending and receiving mail.

Classes in org.jgrapes.mail that implement Eligible

Modifier and Type	Class	Description
class	MailConnectionManager<C extends MailConnectionManager<C,O>.AbstractMailChannel,O extends Event<?>>	Provides a base class for mail components using connections.
protected class	MailConnectionManager.AbstractMailChannel	A sub-channel for mail connections.
class	MailMonitor	A component that opens mail stores and monitors mail folders for mails.
protected class	MailMonitor.MonitorChannel	The specific implementation of the MailChannel.
class	MailSender	A component that sends mail using a system wide or user specific connection.
protected class	MailSender.SenderChannel	The specific implementation of the MailChannel.

Uses of Eligible in org.jgrapes.mail.events

Classes in org.jgrapes.mail.events that implement Eligible

Modifier and Type	Class	Description
class	MailFoldersUpdated	Signals the retrieval of mails (update) by a MailMonitor.
class	MailMonitorOpened	Fired when the requested connection has been established.
class	OpenMailConnection	Common base class for events that open a mail connection for sending or receiving mail.
class	OpenMailMonitor	An event that opens folders on the store defined by the base class for monitoring.
class	OpenMailSender	Fired to open a connection for sending mails.
class	SendMailMessage	Indicates the arrival of a new message.
class	UpdateMailFolders	Triggers the retrieval of mails (update) by a MailMonitor.

Uses of Eligible in org.jgrapes.net

Subinterfaces of Eligible in org.jgrapes.net

Modifier and Type	Interface	Description
interface	SocketIOChannel	A special sub channel used for socket connections.

Classes in org.jgrapes.net that implement Eligible

Modifier and Type	Class	Description
class	SocketConnectionManager	Provides a base class for the SocketServer and the SocketConnector.
protected class	SocketConnectionManager.SocketChannelImpl
class	SocketConnector	A component that reads from or write to a socket connection.
class	SocketServer	Provides a socket server.
class	SslCodec	A component that receives and sends byte buffers on an encrypted channel and sends and receives the corresponding decrypted data on a plain channel.

Uses of Eligible in org.jgrapes.net.events

Classes in org.jgrapes.net.events that implement Eligible

Modifier and Type	Class	Description
class	Accepted	This event signals that a new connection has been made by a client.
class	ClientConnected	This event signals that a new connection has been made by a client.
class	Connected<T>	This event signals that a new connection has been established.
class	Ready	Signals that a server has bound to a socket address and is ready to accept connections.

Uses of Eligible in org.jgrapes.util

Classes in org.jgrapes.util that implement Eligible

Modifier and Type	Class	Description
class	ComponentCollector<F extends ComponentFactory>	A component that collects all component factory services of a given type and uses each to create one or more components that are then attached to the component collector instance.
class	ComponentProvider	Provides child components dynamically using ComponentFactorys.
class	ConfigurationStore	A base class for configuration stores.
class	FileSystemWatcher	A component that watches paths in the file system for changes and sends events if such changes occur.
class	JsonConfigurationStore	This component provides a store for an application’s configuration backed by a JSON file.
class	NightConfigStore	A base class for configuration stored based on the night config library.
class	PreferencesStore	This component provides a store for an application’s configuration backed by the Java Preferences.
class	TomlConfigurationStore	This component provides a store for an application’s configuration backed by a TOML file.
class	YamlConfigurationStore	This component provides a store for an application’s configuration backed by a YAML file.

Uses of Eligible in org.jgrapes.util.events

Classes in org.jgrapes.util.events that implement Eligible

Modifier and Type	Class	Description
class	ConfigurationUpdate	An event to indicate that configuration information has been updated.
class	FileChanged	Informs about changes of a watched file.
class	InitialConfiguration	A special ConfigurationUpdate event that is used for reporting the configuration on startup.
class	InitialPreferences	A special ConfigurationUpdate event that is used by the PreferencesStore for reporting the configuration on startup.
class	KeyValueStoreData	Defines an optional completion event for a KeyValueStoreQuery.
class	KeyValueStoreQuery	A query event for a key/value store.
class	KeyValueStoreUpdate	An event that triggers updates or deletions in a key/value store.
class	WatchFile	Registers a path to be watched with a FileSystemWatcher.