Index (stdlib guice common 7.3.1 API)

A B C D E F G H I J L M N O P R S T U V W

A

AccessRefuser - Interface in com.peterphi.std.guice.common.auth.iface
add(ConfigurationPropertyBindingSite) - Method in class com.peterphi.std.guice.common.serviceprops.ConfigurationProperty
adjustConfigurations(List<Configuration>) - Method in interface com.peterphi.std.guice.apploader.GuiceRole: Provides an opportunity, pre-compositing, to influence the configuration sources and order.
adjustConfigurations(List<Configuration>) - Method in class com.peterphi.std.guice.common.eagersingleton.BindEagerSingletonRole
annotatedWith(Class<? extends Annotation>) - Static method in class com.peterphi.std.guice.common.ClassScanner
as(Class<T>) - Method in class com.peterphi.std.guice.common.serviceprops.ConfigRef
attempt(int) - Method in interface com.peterphi.std.guice.common.retry.retry.Retryable
AUTH_CONSTRAINT_AUTHENTICATED_DENIED_METER - Static variable in class com.peterphi.std.guice.common.metrics.GuiceMetricNames
AUTH_CONSTRAINT_CALL_METER - Static variable in class com.peterphi.std.guice.common.metrics.GuiceMetricNames
AUTH_CONSTRAINT_DENIED_METER - Static variable in class com.peterphi.std.guice.common.metrics.GuiceMetricNames
AUTH_CONSTRAINT_GRANTED_METER - Static variable in class com.peterphi.std.guice.common.metrics.GuiceMetricNames
AuthConstraint - Annotation Type in com.peterphi.std.guice.common.auth.annotations
AuthConstraintInterceptorModule - Class in com.peterphi.std.guice.common.auth: Provides the basic authentication implementation
AuthConstraintInterceptorModule(MetricRegistry) - Constructor for class com.peterphi.std.guice.common.auth.AuthConstraintInterceptorModule

B

BackoffStrategy - Interface in com.peterphi.std.guice.common.retry.retry.backoff
BasicSetup - Class in com.peterphi.std.guice.apploader
BasicSetup(List<Module>) - Constructor for class com.peterphi.std.guice.apploader.BasicSetup
BasicSetup(Module...) - Constructor for class com.peterphi.std.guice.apploader.BasicSetup
BindEagerSingletonRole - Class in com.peterphi.std.guice.common.eagersingleton
BindEagerSingletonRole() - Constructor for class com.peterphi.std.guice.common.eagersingleton.BindEagerSingletonRole
build() - Method in class com.peterphi.std.guice.apploader.impl.GuiceBuilder: Instantiate the guice environment
buildRegistry() - Static method in class com.peterphi.std.guice.common.metrics.CoreMetricsModule

C

ClasspathResourceProvider - Class in com.peterphi.std.guice.common.resource.impl
ClassScanner - Class in com.peterphi.std.guice.common
com.peterphi.std.guice.apploader - package com.peterphi.std.guice.apploader
com.peterphi.std.guice.apploader.impl - package com.peterphi.std.guice.apploader.impl
com.peterphi.std.guice.common - package com.peterphi.std.guice.common
com.peterphi.std.guice.common.auth - package com.peterphi.std.guice.common.auth
com.peterphi.std.guice.common.auth.annotations - package com.peterphi.std.guice.common.auth.annotations
com.peterphi.std.guice.common.auth.iface - package com.peterphi.std.guice.common.auth.iface
com.peterphi.std.guice.common.daemon - package com.peterphi.std.guice.common.daemon
com.peterphi.std.guice.common.eagersingleton - package com.peterphi.std.guice.common.eagersingleton
com.peterphi.std.guice.common.eagersingleton.annotations - package com.peterphi.std.guice.common.eagersingleton.annotations
com.peterphi.std.guice.common.lifecycle - package com.peterphi.std.guice.common.lifecycle
com.peterphi.std.guice.common.metrics - package com.peterphi.std.guice.common.metrics
com.peterphi.std.guice.common.resource.iface - package com.peterphi.std.guice.common.resource.iface
com.peterphi.std.guice.common.resource.impl - package com.peterphi.std.guice.common.resource.impl
com.peterphi.std.guice.common.retry.annotation - package com.peterphi.std.guice.common.retry.annotation
com.peterphi.std.guice.common.retry.module - package com.peterphi.std.guice.common.retry.module
com.peterphi.std.guice.common.retry.retry - package com.peterphi.std.guice.common.retry.retry
com.peterphi.std.guice.common.retry.retry.backoff - package com.peterphi.std.guice.common.retry.retry.backoff
com.peterphi.std.guice.common.serviceprops - package com.peterphi.std.guice.common.serviceprops
com.peterphi.std.guice.common.serviceprops.annotations - package com.peterphi.std.guice.common.serviceprops.annotations
com.peterphi.std.guice.common.serviceprops.typed - package com.peterphi.std.guice.common.serviceprops.typed
com.peterphi.std.guice.common.shutdown - package com.peterphi.std.guice.common.shutdown
com.peterphi.std.guice.common.shutdown.iface - package com.peterphi.std.guice.common.shutdown.iface
com.peterphi.std.guice.common.stringparsing - package com.peterphi.std.guice.common.stringparsing
com.peterphi.std.guice.serviceregistry - package com.peterphi.std.guice.serviceregistry
com.peterphi.std.guice.serviceregistry.index - package com.peterphi.std.guice.serviceregistry.index
com.peterphi.std.guice.serviceregistry.rest - package com.peterphi.std.guice.serviceregistry.rest
ConfigRef - Class in com.peterphi.std.guice.common.serviceprops
ConfigRef(Configuration, String) - Constructor for class com.peterphi.std.guice.common.serviceprops.ConfigRef
configuration - Variable in class com.peterphi.std.guice.common.serviceprops.ServicePropertiesModule
ConfigurationConverter - Class in com.peterphi.std.guice.common.serviceprops
ConfigurationConverter() - Constructor for class com.peterphi.std.guice.common.serviceprops.ConfigurationConverter
ConfigurationProperty - Class in com.peterphi.std.guice.common.serviceprops
ConfigurationProperty(ConfigurationPropertyRegistry, Configuration, Configuration, String) - Constructor for class com.peterphi.std.guice.common.serviceprops.ConfigurationProperty
ConfigurationPropertyBindingSite<T,O> - Class in com.peterphi.std.guice.common.serviceprops
ConfigurationPropertyBindingSite(ConfigurationPropertyRegistry, AtomicReference<Injector>, Class<O>, String, Class<T>, AnnotatedElement) - Constructor for class com.peterphi.std.guice.common.serviceprops.ConfigurationPropertyBindingSite
ConfigurationPropertyRegistry - Class in com.peterphi.std.guice.common.serviceprops
ConfigurationPropertyRegistry(Configuration, Configuration) - Constructor for class com.peterphi.std.guice.common.serviceprops.ConfigurationPropertyRegistry
ConfigurationPropertyRegistryModule - Class in com.peterphi.std.guice.common.serviceprops
ConfigurationPropertyRegistryModule(Configuration, Configuration, AtomicReference<Injector>) - Constructor for class com.peterphi.std.guice.common.serviceprops.ConfigurationPropertyRegistryModule
configure() - Method in class com.peterphi.std.guice.common.auth.AuthConstraintInterceptorModule
configure() - Method in class com.peterphi.std.guice.common.JAXBModule
configure() - Method in class com.peterphi.std.guice.common.lifecycle.GuiceLifecycleModule
configure() - Method in class com.peterphi.std.guice.common.Log4JModule
configure() - Method in class com.peterphi.std.guice.common.metrics.CoreMetricsModule
configure() - Method in class com.peterphi.std.guice.common.retry.module.RetryModule
configure() - Method in class com.peterphi.std.guice.common.serviceprops.ConfigurationPropertyRegistryModule
configure() - Method in class com.peterphi.std.guice.common.serviceprops.ServicePropertiesModule
configure() - Method in class com.peterphi.std.guice.common.shutdown.ShutdownModule
configured() - Method in interface com.peterphi.std.guice.apploader.GuiceApplication: Called when a new Injector has been created, after Guice injection has been applied to this instance.
CONTEXT_NAME - Static variable in class com.peterphi.std.guice.apploader.GuiceProperties
convert(Class<?>, String) - Static method in class com.peterphi.std.guice.common.serviceprops.typed.TypedConfigRef: Deprecated.
use StringToTypeConverter directly instead
convert(Class<?>, String) - Static method in class com.peterphi.std.guice.common.stringparsing.StringToTypeConverter
CoreMetricsModule - Class in com.peterphi.std.guice.common.metrics
CoreMetricsModule(MetricRegistry) - Constructor for class com.peterphi.std.guice.common.metrics.CoreMetricsModule
createInjector() - Static method in class com.peterphi.std.guice.apploader.impl.GuiceInjectorBootstrap: Deprecated.
createInjector(PropertyFile) - Static method in class com.peterphi.std.guice.apploader.impl.GuiceInjectorBootstrap: Deprecated.

Create an Injector by loading service.properties and then reading the guice.bootstrap.class from it
This is the entrypoint for the GuiceRegistry
createInjector(GuiceSetup) - Static method in class com.peterphi.std.guice.apploader.impl.GuiceInjectorBootstrap: Deprecated.

Creates an Injector by taking a pre-constructed GuiceSetup
createInjector(PropertyFile, GuiceSetup) - Static method in class com.peterphi.std.guice.apploader.impl.GuiceInjectorBootstrap: Deprecated.

Creates an Injector by taking a preloaded service.properties and a pre-constructed GuiceSetup
createInjector(Configuration, GuiceSetup) - Static method in class com.peterphi.std.guice.apploader.impl.GuiceInjectorBootstrap: Deprecated.

Creates an Injector by taking a preloaded service.properties and a pre-constructed GuiceSetup
CurrentUser - Interface in com.peterphi.std.guice.common.auth.iface

D

DISABLE_CORE_SERVICES - Static variable in class com.peterphi.std.guice.apploader.GuiceProperties
DISABLE_INDEX_SERVICE - Static variable in class com.peterphi.std.guice.apploader.GuiceProperties

E

EagerSingleton - Annotation Type in com.peterphi.std.guice.common.eagersingleton.annotations: A class with this annotation will automatically be eagerly bound in the guice environment.
Unless EagerSingleton.inTests() is set to true, this will be ignored within environments built for unit tests.
endpoint - Variable in class com.peterphi.std.guice.serviceregistry.index.ManualIndexableService
equals(Object) - Method in class com.peterphi.std.guice.serviceregistry.index.ManualIndexableService
execute() - Method in class com.peterphi.std.guice.common.daemon.GuiceRecurringDaemon: Run one iteration of the daemon
executeException(Throwable) - Method in class com.peterphi.std.guice.common.daemon.GuiceRecurringDaemon: Called when the GuiceRecurringDaemon.execute() method throws an exception.
ExponentialBackoff - Class in com.peterphi.std.guice.common.retry.retry.backoff
ExponentialBackoff(Timeout, double) - Constructor for class com.peterphi.std.guice.common.retry.retry.backoff.ExponentialBackoff
ExponentialBackoff(Timeout, double, Timeout) - Constructor for class com.peterphi.std.guice.common.retry.retry.backoff.ExponentialBackoff

F

FilesystemResourceProviderImpl - Class in com.peterphi.std.guice.common.resource.impl: An implementation of ResourceProvider that loads resources from a folder on the local filesystem
FilesystemResourceProviderImpl(File) - Constructor for class com.peterphi.std.guice.common.resource.impl.FilesystemResourceProviderImpl
finalAttemptFailed(Retryable<T>, int, Throwable) - Method in class com.peterphi.std.guice.common.retry.retry.RetryManager: Called when the final attempt at a retryable operation failed
Allows extending classes to customise behaviour or throw custom exceptions
forPackages(String...) - Static method in class com.peterphi.std.guice.common.ClassScanner
forPackages(Class<?>...) - Static method in class com.peterphi.std.guice.common.ClassScanner
forPackages(ClassLoader, String...) - Static method in class com.peterphi.std.guice.common.ClassScanner
forTesting() - Static method in class com.peterphi.std.guice.apploader.impl.GuiceBuilder: Construct a GuiceBuilder with sensible defaults for testing
forTesting(Module...) - Static method in class com.peterphi.std.guice.apploader.impl.GuiceBuilder: Construct a GuiceBuilder with sensible defaults for testing.

G

get() - Method in class com.peterphi.std.guice.common.serviceprops.ConfigRef
get(Class<T>) - Method in class com.peterphi.std.guice.common.serviceprops.ConfigRef
get(String) - Method in class com.peterphi.std.guice.common.serviceprops.ConfigurationPropertyRegistry
get() - Method in class com.peterphi.std.guice.common.serviceprops.typed.TypedConfigRef
getAll() - Method in class com.peterphi.std.guice.common.serviceprops.ConfigurationPropertyRegistry
getAnnotatedClasses(Class<? extends Annotation>, Predicate<Class<?>>) - Method in class com.peterphi.std.guice.common.ClassScanner
getAnnotatedClasses(Class<? extends Annotation>) - Method in class com.peterphi.std.guice.common.ClassScanner
getBackoff(int) - Method in interface com.peterphi.std.guice.common.retry.retry.backoff.BackoffStrategy: Get the time to wait after the attempt^th failure
getBackoff(int) - Method in class com.peterphi.std.guice.common.retry.retry.backoff.ExponentialBackoff
getBackoff(int) - Method in class com.peterphi.std.guice.common.retry.retry.backoff.NoBackoffStrategy
getBinaryResource(String) - Method in interface com.peterphi.std.guice.common.resource.iface.ResourceProvider: Loads a binary resource
getBinaryResource(String) - Method in class com.peterphi.std.guice.common.resource.impl.ClasspathResourceProvider
getBinaryResource(String) - Method in class com.peterphi.std.guice.common.resource.impl.FilesystemResourceProviderImpl
getBindings() - Method in class com.peterphi.std.guice.common.serviceprops.ConfigurationProperty
getBuilder() - Method in class com.peterphi.std.guice.apploader.impl.GuiceRegistry
getClasses(String, boolean, Predicate<Class<?>>) - Method in class com.peterphi.std.guice.common.ClassScanner: Find all the classes in a package
getClasses(String, boolean) - Method in class com.peterphi.std.guice.common.ClassScanner: Find all the classes in a package
getConfiguration() - Method in class com.peterphi.std.guice.common.serviceprops.ServicePropertiesModule
getConstructionTime() - Method in class com.peterphi.std.guice.common.ClassScanner
getDescription() - Method in class com.peterphi.std.guice.common.serviceprops.ConfigurationPropertyBindingSite: Get a description (from a @Doc annotation, if one is present)
getDocumentation() - Method in class com.peterphi.std.guice.common.serviceprops.ConfigurationProperty
getExtendingClasses(Class<T>) - Method in class com.peterphi.std.guice.common.ClassScanner
getExtendingClasses(Class<T>, Predicate<Class<? extends T>>) - Method in class com.peterphi.std.guice.common.ClassScanner
getHealthCheckRegistry() - Method in class com.peterphi.std.guice.common.metrics.CoreMetricsModule
getHrefs() - Method in class com.peterphi.std.guice.common.serviceprops.ConfigurationProperty
getHrefs() - Method in class com.peterphi.std.guice.common.serviceprops.ConfigurationPropertyBindingSite
getInheritedAnnotatedClasses(Class<? extends Annotation>, Predicate<Class<?>>) - Method in class com.peterphi.std.guice.common.ClassScanner
getInheritedAnnotatedClasses(Class<? extends Annotation>) - Method in class com.peterphi.std.guice.common.ClassScanner
getInjector() - Method in class com.peterphi.std.guice.apploader.impl.GuiceRegistry
getList() - Method in class com.peterphi.std.guice.common.serviceprops.ConfigRef
getLocalEndpoint() - Method in interface com.peterphi.std.guice.serviceregistry.LocalEndpointDiscovery: Get the endpoint of the local webapp
getLocalServices() - Static method in class com.peterphi.std.guice.serviceregistry.index.IndexableServiceRegistry
getMetricRegistry() - Method in class com.peterphi.std.guice.common.metrics.CoreMetricsModule
getName() - Method in interface com.peterphi.std.guice.common.auth.iface.CurrentUser: Get the name of the current user
getName() - Method in class com.peterphi.std.guice.common.serviceprops.ConfigurationProperty
getName() - Method in class com.peterphi.std.guice.common.serviceprops.ConfigurationPropertyBindingSite
getObject() - Method in class com.peterphi.std.guice.common.serviceprops.ConfigRef
getOverrideConfiguration() - Method in class com.peterphi.std.guice.common.serviceprops.ServicePropertiesModule
getOwner() - Method in class com.peterphi.std.guice.common.serviceprops.ConfigurationPropertyBindingSite
getPropertyResource(String) - Method in interface com.peterphi.std.guice.common.resource.iface.ResourceProvider: Loads a resource containing a property file
getPropertyResource(String) - Method in class com.peterphi.std.guice.common.resource.impl.ClasspathResourceProvider
getPropertyResource(String) - Method in class com.peterphi.std.guice.common.resource.impl.FilesystemResourceProviderImpl
getRemoteServices() - Static method in class com.peterphi.std.guice.serviceregistry.index.IndexableServiceRegistry
getResourceClass() - Method in class com.peterphi.std.guice.serviceregistry.rest.RestResource
getResources() - Static method in class com.peterphi.std.guice.serviceregistry.rest.RestResourceRegistry
getRevision() - Static method in class com.peterphi.std.guice.serviceregistry.index.IndexableServiceRegistry
getRevision() - Static method in class com.peterphi.std.guice.serviceregistry.rest.RestResourceRegistry
getSearchTime() - Method in class com.peterphi.std.guice.common.ClassScanner
getShutdownManager() - Method in class com.peterphi.std.guice.common.shutdown.ShutdownModule
getSiblingClasses(Class<?>, boolean, Predicate<Class<?>>) - Method in class com.peterphi.std.guice.common.ClassScanner: Find all the classes that are siblings of the provided class
getStringArray() - Method in class com.peterphi.std.guice.common.serviceprops.ConfigRef
getTextResource(String) - Method in interface com.peterphi.std.guice.common.resource.iface.ResourceProvider: Loads a text resource.
getTextResource(String) - Method in class com.peterphi.std.guice.common.resource.impl.ClasspathResourceProvider
getTextResource(String) - Method in class com.peterphi.std.guice.common.resource.impl.FilesystemResourceProviderImpl
getType() - Method in class com.peterphi.std.guice.common.serviceprops.ConfigurationProperty
getType() - Method in class com.peterphi.std.guice.common.serviceprops.ConfigurationPropertyBindingSite
getUsername() - Method in interface com.peterphi.std.guice.common.auth.iface.CurrentUser: Get the username of the current user
GuiceApplication - Interface in com.peterphi.std.guice.apploader: A service that is registered with a GuiceRegistry for configuration and lifecycle event injection.
GuiceBuilder - Class in com.peterphi.std.guice.apploader.impl: Build the specifications for a new guice framework environment
GuiceBuilder() - Constructor for class com.peterphi.std.guice.apploader.impl.GuiceBuilder
GuiceDaemon - Class in com.peterphi.std.guice.common.daemon
GuiceDaemon() - Constructor for class com.peterphi.std.guice.common.daemon.GuiceDaemon
GuiceDaemon(boolean) - Constructor for class com.peterphi.std.guice.common.daemon.GuiceDaemon
GuiceInjectorBootstrap - Class in com.peterphi.std.guice.apploader.impl: Deprecated.
use GuiceBuilder directly instead. This class will be removed in a future release.
GuiceInjectorBootstrap() - Constructor for class com.peterphi.std.guice.apploader.impl.GuiceInjectorBootstrap: Deprecated.
GuiceLifecycleListener - Interface in com.peterphi.std.guice.common.lifecycle
GuiceLifecycleModule - Class in com.peterphi.std.guice.common.lifecycle: Hooks into guice so that when objects implementing GuiceLifecycleListener are provisioned the GuiceLifecycleListener.postConstruct() method is called
GuiceLifecycleModule() - Constructor for class com.peterphi.std.guice.common.lifecycle.GuiceLifecycleModule
GuiceMetricNames - Class in com.peterphi.std.guice.common.metrics
GuiceProperties - Class in com.peterphi.std.guice.apploader: The properties used directly (that is, not pulled in with a Inject and Named annotations) by the framework.
GuiceProperties() - Constructor for class com.peterphi.std.guice.apploader.GuiceProperties
GuiceRecurringDaemon - Class in com.peterphi.std.guice.common.daemon
GuiceRecurringDaemon(Timeout) - Constructor for class com.peterphi.std.guice.common.daemon.GuiceRecurringDaemon: Creates a new Daemon; the Daemon will start once the guice object is fully constructed
GuiceRecurringDaemon(boolean, Timeout) - Constructor for class com.peterphi.std.guice.common.daemon.GuiceRecurringDaemon: Creates a new Daemon; the Daemon will start once the guice object is fully constructed
GuiceRegistry - Class in com.peterphi.std.guice.apploader.impl: Registry that holds the Injector and the applications currently registered to be injected with the latest Guice objects.
Uses GuiceBuilder to acquire a GuiceSetup which defines the Guice Modules to use to build this environment.
GuiceRegistry() - Constructor for class com.peterphi.std.guice.apploader.impl.GuiceRegistry
GuiceRegistry(GuiceBuilder) - Constructor for class com.peterphi.std.guice.apploader.impl.GuiceRegistry
GuiceRole - Interface in com.peterphi.std.guice.apploader
GuiceSetup - Interface in com.peterphi.std.guice.apploader: Bootstrap interface, replaces static *Loader types
Implementors MUST expose a public default constructor.
Instances of this interface are short-lived and created every time the GuiceBuilder needs to construct a new Injector

H

hashCode() - Method in class com.peterphi.std.guice.serviceregistry.index.ManualIndexableService
hasRole(String) - Method in interface com.peterphi.std.guice.common.auth.iface.CurrentUser: Return whether the user has the named role
HIBERNATE_PROPERTIES - Static variable in class com.peterphi.std.guice.apploader.GuiceProperties
HTTP_404_EXCEPTIONS_METER - Static variable in class com.peterphi.std.guice.common.metrics.GuiceMetricNames
HTTP_CALLS_TIMER - Static variable in class com.peterphi.std.guice.common.metrics.GuiceMetricNames
HTTP_EXCEPTIONS_METER - Static variable in class com.peterphi.std.guice.common.metrics.GuiceMetricNames

I

INDEX_SERVICE_ENDPOINT - Static variable in class com.peterphi.std.guice.apploader.GuiceProperties
IndexableServiceRegistry - Class in com.peterphi.std.guice.serviceregistry.index: A registry of indexable services exposed through this application
IndexableServiceRegistry() - Constructor for class com.peterphi.std.guice.serviceregistry.index.IndexableServiceRegistry
injectorCreated(Injector) - Method in class com.peterphi.std.guice.apploader.BasicSetup
injectorCreated(Stage, ClassScanner, CompositeConfiguration, PropertiesConfiguration, GuiceSetup, List<Module>, AtomicReference<Injector>, MetricRegistry) - Method in interface com.peterphi.std.guice.apploader.GuiceRole: Called once the Injector has been created
injectorCreated(Injector) - Method in interface com.peterphi.std.guice.apploader.GuiceSetup: Allows any post-creation actions to be taken
injectorCreated(Stage, ClassScanner, CompositeConfiguration, PropertiesConfiguration, GuiceSetup, List<Module>, AtomicReference<Injector>, MetricRegistry) - Method in class com.peterphi.std.guice.common.eagersingleton.BindEagerSingletonRole
interfaceClass() - Static method in class com.peterphi.std.guice.common.ClassScanner
isAnonymous() - Method in interface com.peterphi.std.guice.common.auth.iface.CurrentUser: Return true if the user is not authenticated
isAutoLoadProperties() - Method in class com.peterphi.std.guice.apploader.impl.GuiceBuilder
isDeprecated() - Method in class com.peterphi.std.guice.common.serviceprops.ConfigurationProperty
isDeprecated() - Method in class com.peterphi.std.guice.common.serviceprops.ConfigurationPropertyBindingSite
isReconfigurable() - Method in class com.peterphi.std.guice.common.serviceprops.ConfigurationProperty
isReconfigurable() - Method in class com.peterphi.std.guice.common.serviceprops.ConfigurationPropertyBindingSite

J

JAXBModule - Class in com.peterphi.std.guice.common: Exposes JAXBSerialiserFactory as a Singleton, optionally forcing the use of MOXy with the guice.jaxb.moxy config value
JAXBModule(Configuration) - Constructor for class com.peterphi.std.guice.common.JAXBModule

L

LOCAL_REST_SERVICES_ENDPOINT - Static variable in class com.peterphi.std.guice.apploader.GuiceProperties
LocalEndpointDiscovery - Interface in com.peterphi.std.guice.serviceregistry: An interface to a service which is able to provide the local endpoint
LOG4J_PROPERTIES_FILE - Static variable in class com.peterphi.std.guice.apploader.GuiceProperties
Log4JModule - Class in com.peterphi.std.guice.common: Reads the log4j.properties value from the service config; if a value is supplied it searches the classpath for this and loads it into log4j.
If the log4j.properties property is not specified then the default behaviour is observed (log4j configures itself automatically)
Log4JModule(Configuration, MetricRegistry) - Constructor for class com.peterphi.std.guice.common.Log4JModule

M

ManualIndexableService - Class in com.peterphi.std.guice.serviceregistry.index: Describes a service which is not automatically exposed by this application (for example, it may be a remote service that this application is responsible for registering with the index service)
ManualIndexableService(String, String) - Constructor for class com.peterphi.std.guice.serviceregistry.index.ManualIndexableService
maxAttemptsReached(int) - Method in class com.peterphi.std.guice.common.retry.retry.RetryManager: Returns true if the given attempt number is greater than or equal to the maximum number of attempts this retry manager should run
METRICS_JAXRS_SHOW_SAMPLES - Static variable in class com.peterphi.std.guice.apploader.GuiceProperties
MOXY_ENABLED - Static variable in class com.peterphi.std.guice.apploader.GuiceProperties

N

name(Class<?>, String...) - Static method in class com.peterphi.std.guice.common.metrics.GuiceMetricNames: Produces a sensible name for a path beneath a class, taking into account that the class provided might be enhanced by guice AOP (if it is then the class from the code will be used, rather than the generated AOP class name)
NoBackoffStrategy - Class in com.peterphi.std.guice.common.retry.retry.backoff: A simple retry backoff that permits a single attempt and then no more
NoBackoffStrategy() - Constructor for class com.peterphi.std.guice.common.retry.retry.backoff.NoBackoffStrategy

O

OVERRIDE_FILE_PROPERTY - Static variable in class com.peterphi.std.guice.apploader.GuiceProperties
overrides - Variable in class com.peterphi.std.guice.common.serviceprops.ServicePropertiesModule

P

packagePredicate(Predicate<String>) - Static method in class com.peterphi.std.guice.common.ClassScanner
postConstruct() - Method in class com.peterphi.std.guice.common.daemon.GuiceDaemon
postConstruct() - Method in class com.peterphi.std.guice.common.daemon.GuiceRecurringDaemon
postConstruct() - Method in interface com.peterphi.std.guice.common.lifecycle.GuiceLifecycleListener: Called after Guice has fully and successfully constructed this object
processMethod(Class<?>, Method) - Method in class com.peterphi.std.guice.common.serviceprops.ConfigurationPropertyRegistryModule
processMethod(Class<?>, Constructor<?>) - Method in class com.peterphi.std.guice.common.serviceprops.ConfigurationPropertyRegistryModule: TODO delete me when it's possible to use Java 1.8 java.reflect.Executable for Method+Constructor

R

Reconfigurable - Annotation Type in com.peterphi.std.guice.common.serviceprops.annotations: Marks a field as able to be reconfigured on the fly (with the whole class having its members reinjected at the point of reconfiguration).
refuse(AuthConstraint, CurrentUser) - Method in interface com.peterphi.std.guice.common.auth.iface.AccessRefuser: Return a Throwable (should either be an Error or a RuntimeException) to be raised when the provided user fails the authentication constraint
register(Stage, ClassScanner, CompositeConfiguration, PropertiesConfiguration, GuiceSetup, List<Module>, AtomicReference<Injector>, MetricRegistry) - Method in interface com.peterphi.std.guice.apploader.GuiceRole: Provides an opportunity to influence modules (adding, removing, reordering) being loaded.
register(GuiceApplication, boolean) - Method in class com.peterphi.std.guice.apploader.impl.GuiceRegistry: Request that an application be registered with this GuiceRegistry
register(Stage, ClassScanner, CompositeConfiguration, PropertiesConfiguration, GuiceSetup, List<Module>, AtomicReference<Injector>, MetricRegistry) - Method in class com.peterphi.std.guice.common.eagersingleton.BindEagerSingletonRole
register(StoppableService) - Method in interface com.peterphi.std.guice.common.shutdown.iface.ShutdownManager: Registers a service to be notified when the system shuts down
The ShutdownManager will hold a strong reference to this object, preventing it from being garbage collected until shutdown.
register(Class<?>) - Static method in class com.peterphi.std.guice.serviceregistry.index.IndexableServiceRegistry
register(String, String) - Static method in class com.peterphi.std.guice.serviceregistry.index.IndexableServiceRegistry
register(ManualIndexableService) - Static method in class com.peterphi.std.guice.serviceregistry.index.IndexableServiceRegistry
register(Class<?>) - Static method in class com.peterphi.std.guice.serviceregistry.rest.RestResourceRegistry: Register a new resource - N.B.
register(Class<?>, boolean) - Static method in class com.peterphi.std.guice.serviceregistry.rest.RestResourceRegistry: Register a new resource - N.B.
registerModules(List<Module>, Configuration) - Method in class com.peterphi.std.guice.apploader.BasicSetup
registerModules(List<Module>, Configuration) - Method in interface com.peterphi.std.guice.apploader.GuiceSetup: Request for the Setup implementation to add its required modules
ResourceNotFoundException - Exception in com.peterphi.std.guice.common.resource.iface
ResourceNotFoundException() - Constructor for exception com.peterphi.std.guice.common.resource.iface.ResourceNotFoundException
ResourceNotFoundException(Throwable) - Constructor for exception com.peterphi.std.guice.common.resource.iface.ResourceNotFoundException
ResourceNotFoundException(String) - Constructor for exception com.peterphi.std.guice.common.resource.iface.ResourceNotFoundException
ResourceNotFoundException(String, Throwable) - Constructor for exception com.peterphi.std.guice.common.resource.iface.ResourceNotFoundException
ResourceProvider - Interface in com.peterphi.std.guice.common.resource.iface: Interface to a provider of resources.
Paths are specified in the style of a UNIX filepath, using "/" as a separator character.
REST_SERVICES_PREFIX - Static variable in class com.peterphi.std.guice.apploader.GuiceProperties
restart() - Method in class com.peterphi.std.guice.apploader.impl.GuiceRegistry: Restart Guice services
RestResource - Class in com.peterphi.std.guice.serviceregistry.rest
RestResource(Class<?>) - Constructor for class com.peterphi.std.guice.serviceregistry.rest.RestResource
RestResourceRegistry - Class in com.peterphi.std.guice.serviceregistry.rest: Holds information about the REST resources this webapp exposes
RestResourceRegistry() - Constructor for class com.peterphi.std.guice.serviceregistry.rest.RestResourceRegistry
Retry - Annotation Type in com.peterphi.std.guice.common.retry.annotation: When annotated on a public/protected/package-private method in a Guice-constructed object this annotation will automatically retry if that method throws an exception
RETRY_ATTEMPT_FAILURES - Static variable in class com.peterphi.std.guice.common.metrics.GuiceMetricNames
RETRY_ATTEMPTS - Static variable in class com.peterphi.std.guice.common.metrics.GuiceMetricNames
RETRY_CALLS - Static variable in class com.peterphi.std.guice.common.metrics.GuiceMetricNames
RETRY_TOTAL_FAILURES - Static variable in class com.peterphi.std.guice.common.metrics.GuiceMetricNames
Retryable<T> - Interface in com.peterphi.std.guice.common.retry.retry
RetryManager - Class in com.peterphi.std.guice.common.retry.retry
RetryManager(BackoffStrategy, int, Timer, Meter) - Constructor for class com.peterphi.std.guice.common.retry.retry.RetryManager
RetryModule - Class in com.peterphi.std.guice.common.retry.module
RetryModule(MetricRegistry) - Constructor for class com.peterphi.std.guice.common.retry.module.RetryModule
ROLE_HIBERNATE_AUTO - Static variable in class com.peterphi.std.guice.apploader.GuiceProperties
ROLE_JAXRS_SERVER_AUTO - Static variable in class com.peterphi.std.guice.apploader.GuiceProperties
ROLE_METRICS_JAXRS_AUTO - Static variable in class com.peterphi.std.guice.apploader.GuiceProperties
ROLE_THYMELEAF_AUTO - Static variable in class com.peterphi.std.guice.apploader.GuiceProperties
run() - Method in class com.peterphi.std.guice.common.daemon.GuiceRecurringDaemon
run(Retryable<T>) - Method in class com.peterphi.std.guice.common.retry.retry.RetryManager
runUnchecked(Retryable<T>) - Method in class com.peterphi.std.guice.common.retry.retry.RetryManager: Run the operation, only throwing an unchecked exception on failure

S

SCAN_PACKAGES - Static variable in class com.peterphi.std.guice.apploader.GuiceProperties

serviceInterface - Variable in class com.peterphi.std.guice.serviceregistry.index.ManualIndexableService

ServicePropertiesModule - Class in com.peterphi.std.guice.common.serviceprops

Module that binds properties from PropertyFiles in the classpath (called service.properties by default)
The properties found in the PropertyFile object(s) are all exposed a String Named properties.

ServicePropertiesModule(CompositeConfiguration, PropertiesConfiguration) - Constructor for class com.peterphi.std.guice.common.serviceprops.ServicePropertiesModule

SERVLET_CONTEXT_NAME - Static variable in class com.peterphi.std.guice.apploader.GuiceProperties

set(String) - Method in class com.peterphi.std.guice.common.serviceprops.ConfigurationProperty

SETUP_PROPERTY - Static variable in class com.peterphi.std.guice.apploader.GuiceProperties

shouldRetry(int, Throwable) - Method in interface com.peterphi.std.guice.common.retry.retry.Retryable

Decides whether a retry should be attempted after the provided exception occurs

shouldStartAsDaemon() - Method in class com.peterphi.std.guice.common.daemon.GuiceDaemon

shutdown() - Method in class com.peterphi.std.guice.common.daemon.GuiceDaemon

shutdown() - Method in interface com.peterphi.std.guice.common.shutdown.iface.ShutdownManager

Request that all registered services perform an orderly shutdown.

shutdown() - Method in interface com.peterphi.std.guice.common.shutdown.iface.StoppableService

Called to request this service clean up any ongoing work and terminate.

shutdown() - Method in class com.peterphi.std.guice.common.shutdown.ShutdownModule

Triggers the shutdown action

ShutdownManager - Interface in com.peterphi.std.guice.common.shutdown.iface

Allows services to register to take action as part of an orderly shutdown procedure

ShutdownModule - Class in com.peterphi.std.guice.common.shutdown

A Guice module that adds a Singleton ShutdownManager binding
This module also exposes a shutdown method that triggers the shutdown of the associated ShutdownManager

ShutdownModule() - Constructor for class com.peterphi.std.guice.common.shutdown.ShutdownModule

sleep(long) - Method in class com.peterphi.std.guice.common.daemon.GuiceDaemon

Sleep for the specified amount of time (unless the daemon is stopping, in which case do not sleep at all).

sleep(Timeout) - Method in class com.peterphi.std.guice.common.daemon.GuiceDaemon

Sleep for the specified amount of time (unless the daemon is stopping, in which case do not sleep at all).

sleepTime - Variable in class com.peterphi.std.guice.common.daemon.GuiceRecurringDaemon

STAGE_PROPERTY - Static variable in class com.peterphi.std.guice.apploader.GuiceProperties

STATIC_CONTAINER_PREFIX_CONFIG_NAME - Static variable in class com.peterphi.std.guice.apploader.GuiceProperties

STATIC_CONTEXTPATH_CONFIG_NAME - Static variable in class com.peterphi.std.guice.apploader.GuiceProperties

STATIC_ENDPOINT_CONFIG_NAME - Static variable in class com.peterphi.std.guice.apploader.GuiceProperties

stop() - Method in class com.peterphi.std.guice.apploader.impl.GuiceRegistry

Shutdown all services

StoppableService - Interface in com.peterphi.std.guice.common.shutdown.iface

Interface for a service that is interested in receiving callback actions when a Guice environment is shutdown
Implementors of this interface must also register with a ShutdownManager to receive shutdown notifications.

stopping() - Method in interface com.peterphi.std.guice.apploader.GuiceApplication

Called when an Injector is stopping and before the ShutdownManager for the GuiceRegistry is signalled
The GuiceRegistry will wait for this method to return before proceeding.

StringToTypeConverter - Class in com.peterphi.std.guice.common.stringparsing

StringToTypeConverter() - Constructor for class com.peterphi.std.guice.common.stringparsing.StringToTypeConverter

T

THYMELEAF_CALL_TIMER - Static variable in class com.peterphi.std.guice.common.metrics.GuiceMetricNames

THYMELEAF_RENDER_EXCEPTION_METER - Static variable in class com.peterphi.std.guice.common.metrics.GuiceMetricNames

toProperties(Configuration) - Static method in class com.peterphi.std.guice.common.serviceprops.ConfigurationConverter

toString() - Method in class com.peterphi.std.guice.common.serviceprops.ConfigurationPropertyBindingSite

toString() - Method in class com.peterphi.std.guice.serviceregistry.index.ManualIndexableService

TRANSACTION_CALLS_TIMER - Static variable in class com.peterphi.std.guice.common.metrics.GuiceMetricNames

TRANSACTION_COMMIT_FAILURE_METER - Static variable in class com.peterphi.std.guice.common.metrics.GuiceMetricNames

TRANSACTION_ERROR_ROLLBACK_METER - Static variable in class com.peterphi.std.guice.common.metrics.GuiceMetricNames

TRANSACTION_OWNER_CALLS_TIMER - Static variable in class com.peterphi.std.guice.common.metrics.GuiceMetricNames

TypedConfigRef<T> - Class in com.peterphi.std.guice.common.serviceprops.typed

TypedConfigRef(ConfigRef, Class<T>) - Constructor for class com.peterphi.std.guice.common.serviceprops.typed.TypedConfigRef

U

union(PropertyFile...) - Static method in class com.peterphi.std.guice.common.serviceprops.ConfigurationConverter

Combine a number of PropertyFile instances together to form a single Configuration; the first PropertyFile will be overridden by configuration in each subsequent PropertyFile

UNIT_TEST - Static variable in class com.peterphi.std.guice.apploader.GuiceProperties

USE_REQUEST_URL_FOR_FREEMARKER_URL_BUILDER - Static variable in class com.peterphi.std.guice.apploader.GuiceProperties

V

validate(String) - Method in class com.peterphi.std.guice.common.serviceprops.ConfigurationProperty

validate(String) - Method in class com.peterphi.std.guice.common.serviceprops.ConfigurationPropertyBindingSite

W

withAutoLoadProperties(boolean) - Method in class com.peterphi.std.guice.apploader.impl.GuiceBuilder

withAutoLoadRoles(boolean) - Method in class com.peterphi.std.guice.apploader.impl.GuiceBuilder

withClassloader(ClassLoader) - Method in class com.peterphi.std.guice.apploader.impl.GuiceBuilder

withConfig(PropertyFile...) - Method in class com.peterphi.std.guice.apploader.impl.GuiceBuilder

withConfig(String...) - Method in class com.peterphi.std.guice.apploader.impl.GuiceBuilder

withConfig(Configuration...) - Method in class com.peterphi.std.guice.apploader.impl.GuiceBuilder

withRegistry(GuiceRegistry) - Method in class com.peterphi.std.guice.apploader.impl.GuiceBuilder

withRole(GuiceRole...) - Method in class com.peterphi.std.guice.apploader.impl.GuiceBuilder

withScanner(ClassScanner) - Method in class com.peterphi.std.guice.apploader.impl.GuiceBuilder

withSetup(Class<? extends GuiceSetup>) - Method in class com.peterphi.std.guice.apploader.impl.GuiceBuilder

withSetup(GuiceSetup) - Method in class com.peterphi.std.guice.apploader.impl.GuiceBuilder

A B C D E F G H I J L M N O P R S T U V W