A B C E F G H I J L M P R S T

A

AccessRefuser - Interface in com.peterphi.std.guice.common.auth.iface

ApplicationContextNameRegistry - Class in com.peterphi.std.guice.serviceregistry

Records a global context name for the local application

ApplicationContextNameRegistry() - Constructor for class com.peterphi.std.guice.serviceregistry.ApplicationContextNameRegistry

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() - Constructor for class com.peterphi.std.guice.common.auth.AuthConstraintInterceptorModule

B

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

C

ClasspathResourceProvider - Class in com.peterphi.std.guice.common.resource.impl

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.converter - package com.peterphi.std.guice.common.converter

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.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.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

configure() - Method in class com.peterphi.std.guice.common.auth.AuthConstraintInterceptorModule

configure() - Method in class com.peterphi.std.guice.common.converter.PropertiesTypeConversionModule

configure() - Method in class com.peterphi.std.guice.common.JAXBModule

configure() - Method in class com.peterphi.std.guice.common.Log4JModule

configure() - Method in class com.peterphi.std.guice.common.retry.module.RetryModule

configure() - Method in class com.peterphi.std.guice.common.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.

createInjector() - Static method in class com.peterphi.std.guice.apploader.impl.GuiceInjectorBootstrap

createInjector(PropertyFile) - Static method in class com.peterphi.std.guice.apploader.impl.GuiceInjectorBootstrap

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

Creates an Injector by taking a preloaded service.properties and a pre-constructed GuiceSetup

createInjector(PropertyFile, GuiceSetup) - Static method in class com.peterphi.std.guice.apploader.impl.GuiceInjectorBootstrap

Creates an Injector by taking a preloaded service.properties and a pre-constructed GuiceSetup

CurrentUser - Interface in com.peterphi.std.guice.common.auth.iface

E

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

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

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

G

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

getContextName() - Static method in class com.peterphi.std.guice.serviceregistry.ApplicationContextNameRegistry

getInjector() - Static method in class com.peterphi.std.guice.apploader.impl.GuiceRegistry

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

getName() - Method in interface com.peterphi.std.guice.common.auth.iface.CurrentUser

Get the name of the current user

getProperties() - Method in class com.peterphi.std.guice.common.ServicePropertiesModule

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

getRegistry() - Method in class com.peterphi.std.guice.common.metrics.StatsRegistry

Returns the underlying registry instance

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

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

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

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.

GuiceInjectorBootstrap - Class in com.peterphi.std.guice.apploader.impl

Responsible for creating fresh Injector instances.

GuiceInjectorBootstrap() - Constructor for class com.peterphi.std.guice.apploader.impl.GuiceInjectorBootstrap

GuiceRegistry - Class in com.peterphi.std.guice.apploader.impl

Static registry that holds the Injector and the applications currently registered to be injected with the latest Guice objects.
Uses GuiceInjectorBootstrap 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

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 GuiceInjectorBootstrap 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

I

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(Injector) - Method in interface com.peterphi.std.guice.apploader.GuiceSetup

Allows any post-creation actions to be taken

isAnonymous() - Method in interface com.peterphi.std.guice.common.auth.iface.CurrentUser

Return true if the user is not authenticated

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(PropertyFile) - Constructor for class com.peterphi.std.guice.common.JAXBModule

L

LocalEndpointDiscovery - Interface in com.peterphi.std.guice.serviceregistry

An interface to a service which is able to provide the local endpoint

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(PropertyFile) - 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

P

properties - Variable in class com.peterphi.std.guice.common.ServicePropertiesModule

PropertiesTypeConversionModule - Class in com.peterphi.std.guice.common.converter

PropertiesTypeConversionModule() - Constructor for class com.peterphi.std.guice.common.converter.PropertiesTypeConversionModule

R

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(GuiceApplication, boolean) - Static method in class com.peterphi.std.guice.apploader.impl.GuiceRegistry

Request that an application be registered with this GuiceRegistry

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>, PropertyFile) - Method in class com.peterphi.std.guice.apploader.BasicSetup

registerModules(List<Module>, PropertyFile) - 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.

restart() - Static 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

RetryModule - Class in com.peterphi.std.guice.common.retry.module

RetryModule() - Constructor for class com.peterphi.std.guice.common.retry.module.RetryModule

S

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

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

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(PropertyFile...) - Constructor for class com.peterphi.std.guice.common.ServicePropertiesModule

Load the properties from the provided PropertyFiles, with later PropertyFile values overriding those specified in previous PropertyFile objects

setContextName(String) - Static method in class com.peterphi.std.guice.serviceregistry.ApplicationContextNameRegistry

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

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

STATIC_CONTAINER_PREFIX_CONFIG_NAME - Static variable in interface com.peterphi.std.guice.serviceregistry.LocalEndpointDiscovery

STATIC_CONTEXTPATH_CONFIG_NAME - Static variable in interface com.peterphi.std.guice.serviceregistry.LocalEndpointDiscovery

STATIC_ENDPOINT_CONFIG_NAME - Static variable in interface com.peterphi.std.guice.serviceregistry.LocalEndpointDiscovery

StatsRegistry - Class in com.peterphi.std.guice.common.metrics

Fronts the Coda Hale Metrics MetricRegistry instance to allow more

StatsRegistry(ShutdownManager) - Constructor for class com.peterphi.std.guice.common.metrics.StatsRegistry

stop() - Static 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.

T

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

A B C E F G H I J L M P R S T