All Classes and Interfaces
Class
Description
Abstract parent class for Gauges.
Abstract parent class for Health Checks.
Deprecated.
no longer required, extend GuiceSetup directly instead.
Provides the basic authentication implementation
Extension point to allow for the abstraction of
AuthConstraint role
requirement strings from the actual user roles from CurrentUser.Thrown to indicate that an operation was refused because the user did not have the necessary role
If present on a member of a unit test class, a module will be dynamically added to bind a mock for this member
A basic process tracker that does not touch stdout/stderr streams
A wrapper for BCrypt
Service that returns Breakers that depend on one or more of a group of underlying named breakers.
Current implementation is designed for manual (and therefore low volume) tripping
Current implementation is designed for manual (and therefore low volume) tripping
When annotated on a zero argument public/protected/package-private method in a Guice-constructed object this annotation will
automatically
cache the result of the method
Holds weak references to a number of caches, allowing a UI to list all cached data or to invalidate all cached data
ModuleData or a carbon MultiSource Module containing a single non-Multisource source
Implements the Carbon socket API
A case-insensitive case-preserving String Set
Retrieve the MANIFEST.MF properties for the jar/war containing a particular class
A Factory for
ClassScanner instances that maintains a WeakReference
to the produced scanner (allowing the GC to collect the produced scanner and associated jar file refs when it's no longer in
use)Makes the use of Java's ugly compareTo operation a little more readable
A RestFailureRenderer that uses the configured templating engine to render exceptions destined for humans.
Simplifies the creation of long-running daemon threads
An abstraction over the store/retrieve semantics of hibernate to allow a higher-level pattern of access
Encodes a date as a BIGINT in the database.
NOTE: Dates being processed MUST NOT be modified in ANY way - they MUST be treated as immutable datatypes
NOTE: Dates being processed MUST NOT be modified in ANY way - they MUST be treated as immutable datatypes
Represents a deadline (some point in the future - generally, a time by which some operation should be completed)
A special implementation of FreemarkerURLHelper that builds webapp/rest relative URLs by inspecting the requested path.
Should only be used when debugging!
Should only be used when debugging!
Extension to liquibase MSSQLDatabase that bypasses the prohibition on changing the default schema name
Allows a Criteria to be wrapped as a DetachedCriteria, allowing the use of Criteria objects in subqueries without having to
follow an entirely separate codepath.
Where possible implementations should use DigestUtils from commons-codec
Documentation that can be read at runtime
A dummy cache which can be used to hook into a cache clear operation
XMLStreamWriter that recognises when a duplicate call of
DuplicateNSFilteringXMLStreamWriter.setDefaultNamespace(String) is called, and suppresses itAnnotation to be placed on a member within a
Entity-annotated class to indicate that this should be
eager-fetched when querying.A class with this annotation will automatically be eagerly bound in the guice environment.
Unless
Unless
EagerSingleton.inTests() is set to true, this will be ignored within environments built for unit tests.An abstraction over ProcessBuilder to simplify the creation of processes
A process tracker that reads stdout and stderr into Strings
When present on a JAX-RS interface, indicates that clients constructed by the framework for that service will use a fast fail
mode (low timeouts)
A self-registering client filter that (if the fast infoset plugin is available) always prefers fastinfoset responses over
requests application/xml
Title: File Helper
A FileFilter which matches files by their extensions
An implementation of ResourceProvider that loads resources from a folder on the local filesystem
A health determine if a given folder can be read/written
A service that is registered with a
GuiceRegistry for configuration and lifecycle
event injection.Build the specifications for a new guice framework environment
Annotation that describes how to customise the test environment for a test run with
GuiceUnitActs as a ThymeleafTemplater for core guice services
A recurring daemon that runs once a day (although it can be triggered to run early)
Deprecated.
use GuiceBuilder directly instead.
Hooks into guice so that when objects implementing
GuiceLifecycleListener are
provisioned the GuiceLifecycleListener.postConstruct() method is calledHelper class for modules
The properties used directly (that is, not pulled in with a
Inject and Named annotations) by the framework.Registry that holds the Injector and the applications currently registered to be injected with the latest Guice
objects.
Uses
Uses
GuiceBuilder to acquire a GuiceSetup which defines the Guice Modules to use to build this
environment.A jax-rs REST
This allows for a vanilla jax rs implementation, albeit at a small runtime performance penalty.
Application implementation that returns singletons whih are dynamic proxies bound to objects built by
GuiceThis allows for a vanilla jax rs implementation, albeit at a small runtime performance penalty.
A helper REST service that allows basic services; superseded by other core services
A recurring daemon that runs at particular scheduled times (although it can be triggered to run early)
Basic Guice-aware servlet that is configured at invocation time and restarted using
Feeds Servlet lifecycle events back to
Overrides
GuiceRegistryFeeds Servlet lifecycle events back to
GuiceRegistry to perform orderly shutdown of servicesOverrides
HttpServlet.service(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse) to perform lazy configuration.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
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
A JUnit runner for the guice framework; test classes are generally annotated with
GuiceConfig to indicate the desired guice
environment customisation.Thread worker responsible for periodically running health checks and logging failures
Indicates the severity of some state, metric or condition
A helper class which handles encoding and decoding hexidecimal
Service interface for plugins wishing to validate a Hibernate configuration before it is permitted to access the database
The default implementation of a Dao for Hibernate; often it is necessary to extend this to produce richer queries
This DAO can be used in two main ways: With singleton instances of this class created for each entity (where only simple CRUD methods are required) With subclasses of this HibernateDao implementing additional queries (often with corresponding extensions to the Dao type)
This DAO can be used in two main ways: With singleton instances of this class created for each entity (where only simple CRUD methods are required) With subclasses of this HibernateDao implementing additional queries (often with corresponding extensions to the Dao type)
Uses hibernate's
Interceptor class behind the scenes to allow observers to hook into events (N.B.Uses a Hibernate
Interceptor to intercept SQL Statement preparations as they happen on the local threadA HTML renderer that will only emit HTML when the caller lists text/html as their primary Accept header value
Represents the current Http Call being processed by this Thread
An Iterator and Enumeration class
An abstract base type for a case-sensitive identifier
All implementations must directly extend this type (ie.
All implementations must directly extend this type (ie.
A registry of indexable services exposed through this application
Role responsible for making it possible to read all Guice Properties that are defined globally (e.g.
Provides JAX-RS with JAXBContext instances acquired through JAXBSerialiserFactory
Exposes JAXBSerialiserFactory as a Singleton, optionally forcing the use of MOXy with the guice.jaxb.moxy config value
A RuntimeException version of a JAXBException
A thread-safe, caching JAXB helper type.
A factory for JAXBSerialiser instances that can optionally be forced to use EclipseLink MOXy (or use the default JAXBContext
implementation acquisition rules).
Caches JAXBSerialiser instances created using either
Caches JAXBSerialiser instances created using either
SoftReferences or direct hard references (based on config - defaults to soft references)Takes an Exception thrown by a JAX-RS provider and renders it prettily
Registers JAX-RS converters for commonly-used types (e.g.
A factory that builds dynamic proxy clients (using JAX-RS RESTful client interfaces) for services at a known location
Encodes Joda DateTime values into a BIGINT column where the date is expressed in milliseconds since 1970.
Annotation to be placed on an
Entity-annotated class to indicate that special measures should be
taken when querying against this entity because the backing table will be large.Thrown to indicate that there are liquibase changesets pending
Hibernate Configuration Validator that makes sure database has all appropriate liquibase migrations applied before hibernate
is
permitted to access the database.
An exception that contains the exact Response that should be sent back to the client
An interface to a service which is able to provide the local endpoint
Automates the configuration of
Reads the
If the log4j.properties property is not specified then the default behaviour is observed (log4j configures itself automatically)
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)
Indicates a malformed API response from Carbon
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)
When annotated on a public/protected/package-private method in a Guice-constructed object this annotation will automatically
create a metric with the provided name (prefixed with "method-timing.")
Handles the logic of creating a MultiXSD
Encodes one or more XSDs in a single XML
Utility class that loosens any xsd:any constraint where namespace="##other" to namespace="##any" (because JAXB cannot
represent namespace="##any" with
XmlAnyElement, so the generated schemas are often
over-constrained as a result)Describes some configuration to load (and keep up-to-date) over the network.
If constructed by Guice this will automatically keep the main service configuration up-to-date
If constructed by Guice this will automatically keep the main service configuration up-to-date
A simple retry backoff that permits a single attempt and then no more
If specified on a JAX-RS Interface type, clients will not be registered with the Breaker REST Client Pausing system
This is intended for services that cannot safely or sensibly be paused -- a prime example is services that are directly involved in the authentication pipeline to reset breakers
This is intended for services that cannot safely or sensibly be paused -- a prime example is services that are directly involved in the authentication pipeline to reset breakers
Description: An Error thrown when some functionality is not yet implemented.
An OutputStream which immediately discards all writes
Holds the OAuth2 callback information for this session; will start unpopulated (see
OAuth2SessionRef.isValid()) and then be populated
once the OAuth2 callback completes.Thrown when the remote OAuth Server sends a callback containing an error code
Indicates a user has used a Service with a given Scope (and allows a user to revoke access to a Service at any time)
Bearer Token Generator that automatically generates User Manager Delegation Tokens for outgoing service calls it is assigned to
help with.
Automatically switches the Resteasy HTTP Client from Apache to OkHttp (which supports H2C) if OkHttp3 is on the classpath
Implementation of
ClientHttpEngine based on OkHttp.A special ParamRunnable which runs synchronously once prepare() is called
A class encapsulating the Runnable idea, mixed with Callable - instead of having a return type, this takes an argument to be
passed to the
run methodThe Runnable shell in which a ParamRunnable is wrapped once its
prepare() method is calledThe default interrogator interface, used if
ServiceLoader finds no custom implementationsPEM handling utilities
A custom PostgreSQL Dialect for Hibernate that uses bytea instead of oid for byte[] Lobs
A special type of property that refers to the size of a collection
Thrown when an action requiring a read/write session is attempted within a read-only session
Marks a field as able to be reconfigured on the fly (with the whole class having its members reinjected at the point of
reconfiguration).
Filters results from remote JAX-RS calls if they are thrown by remote services that can provide rich exception information
Apply this to implementation classes when you want one instance per HTTP request.
Thrown to indicate that it is not possible to represent a timecode or sample count in a precise way
Interface to a provider of resources.
Paths are specified in the style of a UNIX filepath, using "/" as a separator character.
Paths are specified in the style of a UNIX filepath, using "/" as a separator character.
A factory that builds dynamic proxy clients (using JAX-RS RESTful client interfaces) for services, abstracting away the method
through which client endpoints, credentials, etc.
Builds ResteasyClient objects
A dispatcher capable of operating as either a Filter or a Servlet
Holds information about the REST classes this webapp uses
A factory that reflectively builds instances of RestException
This factory is used to gain access to the package-private setter methods in RestException
This factory is used to gain access to the package-private setter methods in RestException
Wire type for the common REST exception representation
Takes a Throwable and marshalls it as a
N.B.
RestFailureN.B.
Holds information about the REST resources this webapp exposes
A simple REST resource that lists the services registered with the
RestResourceRegistry
N.B.Helper type to provide
Deprecated.
use
WebQuery insteadDeprecated.
use
WebQuery and the associated builder methods, particularly WebQuery.decode(UriInfo)Deprecated.
use
WebQuery and the associated builder methods, particularly WebQuery.decode(UriInfo)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
A wrapper type which takes a Callable and turns it into a RunnableFuture
A number of samples at a given sample rate
Encodes a SampleCount as a String in the form
hh:mm:ss:ff@Timebase - See Timecode.getInstance(String) for
information on the formatIndicates that a precondition for creating a scope against an OAuth Service has failed
A friendly alias for a service (or group of services)
Module that binds properties from
The properties found in the PropertyFile object(s) are all exposed a String Named properties.
PropertyFiles in the classpath (called service.properties by
default)The properties found in the PropertyFile object(s) are all exposed a String Named properties.
Adds the
RequestScoped and SessionScoped scope annotations, also exposes HttpCallContext, HttpServletRequest,
HttpServletResponse and HttpSession based on the current HTTP callApply this to implementation classes when you want one instance per HTTP session.
A simple Future whose value will be set at some later date
Allows services to register to take action as part of an orderly shutdown procedure
A Guice module that adds a Singleton
This module also exposes a shutdown method that triggers the shutdown of the associated ShutdownManager
ShutdownManager bindingThis module also exposes a shutdown method that triggers the shutdown of the associated ShutdownManager
A simple, untyped Id field; this is one step above having a String id
It is recommended that users extend Id themselves rather than using this type (as a SimpleId adds no discernable information about what the id is for)
It is recommended that users extend Id themselves rather than using this type (as a SimpleId adds no discernable information about what the id is for)
Wrapper around a single item guava cache as a workaround for google not implementing the request for a single item cache made in 2012.
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
Implementors of this interface must also register with a
ShutdownManager to receive shutdown notifications.
Note: this class has a natural ordering that is inconsistent with equals.
Represents Storage unit conversions in a similar fashion to how TimeUnit represents time unit conversions
This enumeration reflects the confused landscape of storage units: it contains computer science units (binary), storage industry units (decimal) and network industry units (decimal, bit-based)
This enumeration reflects the confused landscape of storage units: it contains computer science units (binary), storage industry units (decimal) and network industry units (decimal, bit-based)
Title: Stream Utility Class
Encodes Joda DateTime values into a VARCHAR column where the date format is:
yyyyMMdd'T'HHmmss.SSSZ.Implements a String Templater that processes strings containing
${...} expressions, and replaces them using a StrLookup instance.Renders exceptions using a template
Annotation for static no-argument method to provide a configuration source.
Annotation for a test method; indicates that the test method should be repeated for each value in a guice (or, in the event
that
TestEach.value() is provided, annotation) backed collection.Annotation for static no-argument method to provide a guice module.
A text/plain WebApplicationException
N.B.
N.B.
Created by bmcleod on 06/09/2016.
Represents a ThymeLeaf Template that can be called.
Module to configure the ThymeLeaf templating engine
Light abstraction over a ThymeLeaf TemplateEngine allowing cleaner construction of the current web context (when the template
engine is being used inside an http call).
Exposes the following special variables:
Exposes the following special variables:
currentUser - of type ThymeleafCurrentUserUtils
config - of type GuiceConfig
Keeps track of how long it has been since a given timestamp (by default, when the instance was created)
This is mainly designed for testing timing
This is mainly designed for testing timing
Describes a timebase, expressed as a rational number.
Represents a timecode, dd:hh:mm:ss:ff - where ff may be an arbitrary length
Timecodes containing days are not well supported.
Timecodes containing days are not well supported.
Constructs Timecode instances
Compares Timecodes in order of how much time they represent
This means that 00:00:00:02@25 is greater than 00:00:00:1920@48kHz
This means that 00:00:00:02@25 is greater than 00:00:00:1920@48kHz
Represents a range between two non-null timecodes
Encodes a Timecode as a String in the form
SMPTE Timecode@Timebase - See Timecode.getInstance(String)
for
information on the formatRepresents an immutable Timeout (ie.
Interprets a number of milliseconds as a Timeout
Supports the following string representations:
Supports the following string representations:
ISO-8601 Duration
### - treated as milliseconds
###(d|h|m|s|ms) (days, hours, minutes, seconds, milliseconds)
Provides transaction helper methods
Represents a server-side exception that could not be bound to a local client-side RestException implementation (for example, an
IllegalArgumentException thrown server-side)
Handles creating the (session scoped) UserLogin object
Turns a User Manager Bearer Token to an OAuth2SessionRef, populating the Session scope with that OAuth2SessionRef.
Matches:
Methods declared in classes annotated with
AuthConstraint
Method implementations directly annotated with AuthConstraint
Methods of classes implementing one of a passed list of interface classes
Describes a database query to be executed
Defines a plugin that extends the functionality of the WebQuery Query String Decode functionality
Simple WebQuery Decode Plugin that allows named presets for queries.
Defines an individual field constraint to apply
Base class for components of a Constraint Group
Helper class to allow date maths to be encoded and resolved
Defines the functions that an be applied to fields (data-type permitting)
Defines a group of constraints to be ANDed or ORred together
Defines a group constraint combining approach
Defines a sort instruction
Special WebQuery fields and their wire representation in the Query String API
A simple renderer that renders an XML form of the RestFailure object by letting the JAX-RS implementation serialise it
Sets the X-Rich-Exception flag so that our code can understand and intelligently reconstruct an exception client-side
Sets the X-Rich-Exception flag so that our code can understand and intelligently reconstruct an exception client-side
Generic wrapper around some Carbon XML element
Wrapper class that performs XSD Validation