/**
* Constructs a new instance of the DefaultRuntimeInjector, for test use.
*
* @param config The instance of the FilterConfig.
* @param filterConfiguration An instance of the FilterConfiguration.
* @throws ServletException If there is an error reading the Filter Config.
* @throws AuthException If there is an error getting the ServerAuthContext instance.
*/
DefaultRuntimeInjector(final FilterConfig config, final FilterConfiguration filterConfiguration)
throws ServletException, AuthException {
this.filterConfiguration = filterConfiguration;
/*
* Must set the loggers before initialising anything else otherwise classes with static loggers will get the
* NOP implementations
*/
LoggingConfigurator<MessageInfo> loggingConfigurator = getLoggingConfigurator(config);
LogFactory.setAuditLogger(loggingConfigurator.getAuditLogger());
LogFactory.setDebugLogger(loggingConfigurator.getDebugLogger());
LOGGER.setDebugLogger(LogFactory.getDebug());
ServerContextFactory serverContextFactory = getServerContextFactory(config);
MessageInfoUtils messageInfoUtils = new MessageInfoUtils();
HttpServletCallbackHandler callbackHandler = new HttpServletCallbackHandler();
ContextHandler contextHandler = new ContextHandler(messageInfoUtils);
ServerAuthContext serverAuthContext =
serverContextFactory.getServerAuthContext(
messageInfoUtils, callbackHandler, contextHandler);
RuntimeResultHandler runtimeResultHandler = new RuntimeResultHandler();
this.jaspiRuntime = new JaspiRuntime(serverAuthContext, runtimeResultHandler);
LOGGER.debug("Finished initialising the DefaultRuntimeInjector");
}
/**
* Gets the instance of the configured {@link LoggingConfigurator}, configured in the Filter
* Config init params. <br>
* If no LoggingConfigurator is configured in the Filter Config, then a NoOp LoggingConfigurator
* will be returned.
*
* @param config The Filter Config.
* @return An instance of the LoggingConfigurator.
* @throws ServletException If there is an error reading the Filter Config.
*/
private LoggingConfigurator<MessageInfo> getLoggingConfigurator(final FilterConfig config)
throws ServletException {
LoggingConfigurator<MessageInfo> loggingConfigurator =
filterConfiguration.get(
config,
INIT_PARAM_LOGGING_CONFIGURATOR_CLASS,
INIT_PARAM_LOGGING_CONFIGURATOR_METHOD,
INIT_PARAM_LOGGING_CONFIGURATOR_METHOD_DEFAULT);
if (loggingConfigurator == null) {
LOGGER.debug(
"Filter init param, "
+ INIT_PARAM_LOGGING_CONFIGURATOR_CLASS
+ ", not set. Falling back "
+ "to the NoOp Logging Configurator.");
loggingConfigurator =
new LoggingConfigurator<MessageInfo>() {
@Override
public DebugLogger getDebugLogger() {
return null;
}
@Override
public AuditLogger<MessageInfo> getAuditLogger() {
return null;
}
};
}
return loggingConfigurator;
}
/**
* Returns a new instance of the DefaultRuntimeInjector. <br>
* This does and should return a new instance of a RuntimeInjector, as it is only ever called once
* per configured filter. This means that a web application can create multiple instances of the
* JaspiRuntimeFilter and each instance will have its own self contained injector which uses that
* instances filter configuration.
*
* @param config The instance of the FilterConfig.
* @return A RuntimeInjector.
* @throws ServletException If there is an error creating the RuntimeInjector.
*/
public static RuntimeInjector getRuntimeInjector(final FilterConfig config)
throws ServletException {
try {
return new DefaultRuntimeInjector(config);
} catch (AuthException e) {
LOGGER.error("Failed to construct RuntimeInjector", e);
throw new ServletException("Failed to construct RuntimeInjector", e);
}
}
/**
* {@inheritDoc} <br>
* Will only ever return the singleton instance (for this instance of the JaspiRuntimeFilter) and
* if asked for an instance of a different type will throw a {@link RuntimeException}.
*
* @param type {@inheritDoc}
* @param <T> {@inheritDoc}
* @return {@inheritDoc}
*/
@SuppressWarnings("unchecked")
@Override
public <T> T getInstance(final Class<T> type) {
if (!JaspiRuntime.class.equals(type)) {
LOGGER.error("Type not registered! " + type.getName());
throw new RuntimeException("Type not registered! " + type.getName());
}
return (T) jaspiRuntime;
}
/**
* Gets the instance of the configured {@link ServerContextFactory}, configured in the Filter
* Config init params. <br>
* If no ServerContextFactory is configured in the Filter Config, then the {@link
* DefaultServerContextFactory} will be returned.
*
* @param config The Filter Config.
* @return An instance of the ServerContextFactory.
* @throws ServletException If there is an error reading the Filter Config.
*/
private ServerContextFactory getServerContextFactory(final FilterConfig config)
throws ServletException {
ServerContextFactory serverContextFactory =
filterConfiguration.get(
config,
INIT_PARAM_CONTEXT_CLASS,
INIT_PARAM_CONTEXT_METHOD,
INIT_PARAM_CONTEXT_METHOD_DEFAULT);
if (serverContextFactory == null) {
LOGGER.debug(
"Filter init param, "
+ INIT_PARAM_CONTEXT_CLASS
+ ", not set. Falling back to the "
+ DefaultServerContextFactory.class.getSimpleName()
+ ".");
return DefaultServerContextFactory.getServerContextFactory(config);
}
return serverContextFactory;
}