A B C D F H I L M N O P R S T U

A

AbstractHandler<T extends ServiceHandler<T>> - Class in org.gcube.common.ghn.service.handlers

Partial implementation of ServiceHandler.

AbstractHandler() - Constructor for class org.gcube.common.ghn.service.handlers.AbstractHandler

B

bind(InputStream) - Method in class org.gcube.common.ghn.service.configuration.ConfigurationBinder

Returns a ServiceConfiguration from its XML serialisation.

C

client_services - Static variable in class org.gcube.common.ghn.service.Constants

The configuration name of ClientContainerHandlers.

ClientContainerHandler - Class in org.gcube.common.ghn.service.handlers.lifetime

A LifetimeHandler that starts and stops a ClientContainer

ClientContainerHandler() - Constructor for class org.gcube.common.ghn.service.handlers.lifetime.ClientContainerHandler

configuration_file - Static variable in class org.gcube.common.ghn.service.Constants

The default name of configuration files for ClientContainers.

ConfigurationBinder - Class in org.gcube.common.ghn.service.configuration

Binds ServiceConfigurations from XML serialisations, using ServiceHandler bindings found in classpath archives that include a #service_marker_file.

ConfigurationBinder() - Constructor for class org.gcube.common.ghn.service.configuration.ConfigurationBinder

Constants - Class in org.gcube.common.ghn.service

Library-wide constants.

Constants() - Constructor for class org.gcube.common.ghn.service.Constants

contextDestroyed(ServletContextEvent) - Method in class org.gcube.common.ghn.service.LifetimeListener

contextInitialized(ServletContextEvent) - Method in class org.gcube.common.ghn.service.LifetimeListener

D

DefaultPipeline<T extends ServiceHandler<T>> - Class in org.gcube.common.ghn.service.handlers

Default implementation of Pipeline.

DefaultPipeline(List<T>) - Constructor for class org.gcube.common.ghn.service.handlers.DefaultPipeline

Creates an instance with a given set of handlers.

destroy() - Method in class org.gcube.common.ghn.service.RequestFilter

doFilter(ServletRequest, ServletResponse, FilterChain) - Method in class org.gcube.common.ghn.service.RequestFilter

doGet(HttpServletRequest, HttpServletResponse) - Method in class org.gcube.common.ghn.service.extensions.ServiceLifetime

F

forward(ServiceEvent<T>) - Method in class org.gcube.common.ghn.service.handlers.DefaultPipeline

forward(ServiceEvent<T>) - Method in interface org.gcube.common.ghn.service.handlers.Pipeline

Forwards an event a step further through the pipeline.

H

handleRequest(Pipeline<RequestHandler>, RequestEvent) - Method in class org.gcube.common.ghn.service.handlers.request.ScopeHandler

handleRequest(Pipeline<RequestHandler>, RequestEvent) - Method in class org.gcube.common.ghn.service.handlers.RequestHandler

Invoked when the container receives a request for a servlet of a managed service.

handleResponse(Pipeline<RequestHandler>, ResponseEvent) - Method in class org.gcube.common.ghn.service.handlers.RequestHandler

Invoked when a servlet of a managed service has produced a response to a request.

handlers() - Method in class org.gcube.common.ghn.service.handlers.DefaultPipeline

handlers() - Method in interface org.gcube.common.ghn.service.handlers.Pipeline

Returns the handlers currently in the pipeline.

I

init(FilterConfig) - Method in class org.gcube.common.ghn.service.RequestFilter

L

LifetimeEvent - Class in org.gcube.common.ghn.service.events

A ServiceEvent that relates to the lifetime of a managed service.

LifetimeEvent(ServletContext) - Constructor for class org.gcube.common.ghn.service.events.LifetimeEvent

Creates an instance with the ServletContext of the managed service.

LifetimeHandler - Class in org.gcube.common.ghn.service.handlers

A Handler of LifetimeEvents.

LifetimeHandler() - Constructor for class org.gcube.common.ghn.service.handlers.LifetimeHandler

LifetimeHandlerAdapter - Class in org.gcube.common.ghn.service.configuration

Adapts ClientService bindings found in a ContainerConfiguration.

LifetimeHandlerAdapter() - Constructor for class org.gcube.common.ghn.service.configuration.LifetimeHandlerAdapter

LifetimeHandlerAdapter.UnavailableHandler - Class in org.gcube.common.ghn.service.configuration

A LifetimeHandler included in a ServiceConfiguration but not available at runtime.

LifetimeHandlerAdapter.UnavailableHandler() - Constructor for class org.gcube.common.ghn.service.configuration.LifetimeHandlerAdapter.UnavailableHandler

LifetimeHandlerAdapter.UnavailableHandler(String) - Constructor for class org.gcube.common.ghn.service.configuration.LifetimeHandlerAdapter.UnavailableHandler

Creates an instance with a given name

lifetimeHandlers() - Method in class org.gcube.common.ghn.service.configuration.ServiceConfiguration

Returns the LifetimeHandlers configured on the service.

LifetimeListener - Class in org.gcube.common.ghn.service

A ServletContextListener for managed services which notifies a ServiceManager of service lifetime events.

LifetimeListener() - Constructor for class org.gcube.common.ghn.service.LifetimeListener

M

marshal(LifetimeHandler) - Method in class org.gcube.common.ghn.service.configuration.LifetimeHandlerAdapter

marshal(RequestHandler) - Method in class org.gcube.common.ghn.service.configuration.RequestHandlerAdapter

N

name() - Method in class org.gcube.common.ghn.service.configuration.LifetimeHandlerAdapter.UnavailableHandler

name() - Method in class org.gcube.common.ghn.service.configuration.RequestHandlerAdapter.UnavailableHandler

name() - Method in class org.gcube.common.ghn.service.handlers.lifetime.ClientContainerHandler

name() - Method in class org.gcube.common.ghn.service.handlers.request.ScopeHandler

name() - Method in interface org.gcube.common.ghn.service.handlers.ServiceHandler

Returns the name of the handler.

O

onEvent(Pipeline<LifetimeHandler>, ServiceEvent<LifetimeHandler>) - Method in class org.gcube.common.ghn.service.handlers.LifetimeHandler

onEvent(Pipeline<RequestHandler>, ServiceEvent<RequestHandler>) - Method in class org.gcube.common.ghn.service.handlers.RequestHandler

onEvent(Pipeline<T>, ServiceEvent<T>) - Method in interface org.gcube.common.ghn.service.handlers.ServiceHandler

Processes a given event.

onStart(Pipeline<LifetimeHandler>, StartServiceEvent) - Method in class org.gcube.common.ghn.service.handlers.lifetime.ClientContainerHandler

onStart(Pipeline<LifetimeHandler>, StartServiceEvent) - Method in class org.gcube.common.ghn.service.handlers.LifetimeHandler

Invoked when the container starts a managed service.

onStartup(Set<Class<?>>, ServletContext) - Method in class org.gcube.common.ghn.service.ServiceInitializer

onStop(Pipeline<LifetimeHandler>, StopServiceEvent) - Method in class org.gcube.common.ghn.service.handlers.lifetime.ClientContainerHandler

onStop(Pipeline<LifetimeHandler>, StopServiceEvent) - Method in class org.gcube.common.ghn.service.handlers.LifetimeHandler

Invoked when the container stops a managed service.

org.gcube.common.ghn.service - package org.gcube.common.ghn.service

org.gcube.common.ghn.service.configuration - package org.gcube.common.ghn.service.configuration

org.gcube.common.ghn.service.events - package org.gcube.common.ghn.service.events

org.gcube.common.ghn.service.extensions - package org.gcube.common.ghn.service.extensions

org.gcube.common.ghn.service.handlers - package org.gcube.common.ghn.service.handlers

org.gcube.common.ghn.service.handlers.lifetime - package org.gcube.common.ghn.service.handlers.lifetime

org.gcube.common.ghn.service.handlers.request - package org.gcube.common.ghn.service.handlers.request

P

Pipeline<T extends ServiceHandler<T>> - Interface in org.gcube.common.ghn.service.handlers

An ordered list ServiceHandlers registered to handle ServiceEvents of the same type.

R

request() - Method in class org.gcube.common.ghn.service.events.RequestEvent

Returns the request.

RequestEvent - Class in org.gcube.common.ghn.service.events

A ServiceEvent that occurs when the a request reaches a servlet of the managed service.

RequestEvent(String, ServletRequest) - Constructor for class org.gcube.common.ghn.service.events.RequestEvent

Creates an instance with the request and the name of the target servlet.

RequestFilter - Class in org.gcube.common.ghn.service

A Filter that executes a Pipeline of RequestHandlers when RequestEvents and ResponseEvents are generated for a given servlet of a managed service.

RequestFilter(String, Pipeline<RequestHandler>) - Constructor for class org.gcube.common.ghn.service.RequestFilter

Creates an instance with the name of the target servlet and a pipeline.

RequestHandler - Class in org.gcube.common.ghn.service.handlers

A Handler of RequestEvents and ResponseEvents.

RequestHandler() - Constructor for class org.gcube.common.ghn.service.handlers.RequestHandler

RequestHandlerAdapter - Class in org.gcube.common.ghn.service.configuration

Adapts ClientService bindings found in a ContainerConfiguration.

RequestHandlerAdapter() - Constructor for class org.gcube.common.ghn.service.configuration.RequestHandlerAdapter

RequestHandlerAdapter.UnavailableHandler - Class in org.gcube.common.ghn.service.configuration

A RequestHandler included in a ServiceConfiguration but not available at runtime.

RequestHandlerAdapter.UnavailableHandler() - Constructor for class org.gcube.common.ghn.service.configuration.RequestHandlerAdapter.UnavailableHandler

RequestHandlerAdapter.UnavailableHandler(String) - Constructor for class org.gcube.common.ghn.service.configuration.RequestHandlerAdapter.UnavailableHandler

Creates an instance with a given name

requestHandlers() - Method in class org.gcube.common.ghn.service.configuration.ServiceConfiguration

Returns the RequestHandlers configured on the service.

response() - Method in class org.gcube.common.ghn.service.events.ResponseEvent

Returns the response.

ResponseEvent - Class in org.gcube.common.ghn.service.events

A ServiceEvent that occurs when the a servlet returns a response to a given request.

ResponseEvent(String, ServletRequest, ServletResponse) - Constructor for class org.gcube.common.ghn.service.events.ResponseEvent

Creates an instance with the response, the corresponding request, and the name of the target servlet

S

scope_management - Static variable in class org.gcube.common.ghn.service.Constants

The configuration name of ScopeHandlers.

ScopeHandler - Class in org.gcube.common.ghn.service.handlers.request

ScopeHandler() - Constructor for class org.gcube.common.ghn.service.handlers.request.ScopeHandler

ServiceConfiguration - Class in org.gcube.common.ghn.service.configuration

The configuration of a managed service.

ServiceConfiguration(List<LifetimeHandler>, List<RequestHandler>) - Constructor for class org.gcube.common.ghn.service.configuration.ServiceConfiguration

Creates an instance with the LifetimeHandlers and RequestHandlers.

ServiceEvent<T extends ServiceHandler<T>> - Interface in org.gcube.common.ghn.service.events

A tagging interface for events that relate to a managed service.

ServiceHandler<T extends ServiceHandler<T>> - Interface in org.gcube.common.ghn.service.handlers

Registers in Pipelines to handle ServiceEvents about a managed service.

ServiceInitializer - Class in org.gcube.common.ghn.service

Adds a LifetimeListener to managed services.

ServiceInitializer() - Constructor for class org.gcube.common.ghn.service.ServiceInitializer

ServiceLifetime - Class in org.gcube.common.ghn.service.extensions

ServiceLifetime() - Constructor for class org.gcube.common.ghn.service.extensions.ServiceLifetime

ServiceManager - Class in org.gcube.common.ghn.service

Starts and stops management functions for a given service.

ServiceManager() - Constructor for class org.gcube.common.ghn.service.ServiceManager

servletContext() - Method in class org.gcube.common.ghn.service.events.LifetimeEvent

Returns the ServletContext of the managed service.

servletName() - Method in class org.gcube.common.ghn.service.events.RequestEvent

Returns the name of the target servlet.

start(ServletContext) - Method in class org.gcube.common.ghn.service.handlers.RequestHandler

Initialises the handler.

start(ServletContext) - Method in class org.gcube.common.ghn.service.ServiceManager

Starts service management functions.

StartServiceEvent - Class in org.gcube.common.ghn.service.events

A ServiceEvent that occurs when the service is started by the container.

StartServiceEvent(ServletContext) - Constructor for class org.gcube.common.ghn.service.events.StartServiceEvent

Creates an instance with the ServletContext of the managed service.

stop() - Method in class org.gcube.common.ghn.service.handlers.RequestHandler

Terminates the handler.

stop(ServletContext) - Method in class org.gcube.common.ghn.service.ServiceManager

Stops management functions.

StopServiceEvent - Class in org.gcube.common.ghn.service.events

A ServiceEvent that occurs when the service is stopped by the container.

StopServiceEvent(ServletContext) - Constructor for class org.gcube.common.ghn.service.events.StopServiceEvent

Creates an instance with the ServletContext of the managed service.

T

toString() - Method in class org.gcube.common.ghn.service.events.LifetimeEvent

toString() - Method in class org.gcube.common.ghn.service.events.RequestEvent

toString() - Method in class org.gcube.common.ghn.service.events.ResponseEvent

toString() - Method in class org.gcube.common.ghn.service.handlers.AbstractHandler

U

unmarshal(Object) - Method in class org.gcube.common.ghn.service.configuration.LifetimeHandlerAdapter

unmarshal(Object) - Method in class org.gcube.common.ghn.service.configuration.RequestHandlerAdapter

A B C D F H I L M N O P R S T U