/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.isis.runtimes.dflt.runtime.systemusinginstallers;
import org.apache.log4j.Logger;
import org.apache.isis.applib.fixtures.LogonFixture;
import org.apache.isis.core.commons.components.Installer;
import org.apache.isis.core.commons.components.Noop;
import org.apache.isis.core.commons.debug.DebugBuilder;
import org.apache.isis.runtimes.dflt.runtime.authentication.exploration.ExplorationSession;
import org.apache.isis.runtimes.dflt.runtime.fixtures.FixturesInstaller;
import org.apache.isis.runtimes.dflt.runtime.installerregistry.InstallerLookup;
import org.apache.isis.runtimes.dflt.runtime.system.DeploymentType;
import org.apache.isis.runtimes.dflt.runtime.system.IsisSystemException;
import org.apache.isis.runtimes.dflt.runtime.system.IsisSystemFixturesHookAbstract;
import org.apache.isis.runtimes.dflt.runtime.system.context.IsisContext;
import org.apache.isis.runtimes.dflt.runtime.system.internal.InitialisationSession;
import org.apache.isis.runtimes.dflt.runtime.system.internal.IsisLocaleInitializer;
import org.apache.isis.runtimes.dflt.runtime.system.internal.IsisTimeZoneInitializer;
/**
*
*/
public abstract class IsisSystemAbstract extends IsisSystemFixturesHookAbstract {
public static final Logger LOG = Logger.getLogger(IsisSystemAbstract.class);
private FixturesInstaller fixtureInstaller;
private LogonFixture logonFixture;
// ///////////////////////////////////////////
// Constructors
// ///////////////////////////////////////////
public IsisSystemAbstract(final DeploymentType deploymentType) {
super(deploymentType, new IsisLocaleInitializer(), new IsisTimeZoneInitializer());
}
public IsisSystemAbstract(final DeploymentType deploymentType, final IsisLocaleInitializer localeInitializer, final IsisTimeZoneInitializer timeZoneInitializer) {
super(deploymentType, localeInitializer, timeZoneInitializer);
}
@Override
protected void installFixturesIfRequired() throws IsisSystemException {
// some deployment types (eg CLIENT) do not support installing fixtures
// instead, any fixtures should be installed when server boots up.
if (!getDeploymentType().canInstallFixtures()) {
return;
}
fixtureInstaller = obtainFixturesInstaller();
if (isNoop(fixtureInstaller)) {
return;
}
IsisContext.openSession(new InitialisationSession());
fixtureInstaller.installFixtures();
try {
// only allow logon fixtures if not in production mode.
if (!getDeploymentType().isProduction()) {
logonFixture = fixtureInstaller.getLogonFixture();
}
} finally {
IsisContext.closeSession();
}
}
private boolean isNoop(final FixturesInstaller candidate) {
return candidate == null || (fixtureInstaller instanceof Noop);
}
// ///////////////////////////////////////////
// Fixtures
// ///////////////////////////////////////////
/**
* This is the only {@link Installer} that is used by any (all) subclass
* implementations, because it effectively <i>is</i> the component we need
* (as opposed to a builder/factory of the component we need).
*
* <p>
* The fact that the component <i>is</i> an installer (and therefore can be
* {@link InstallerLookup} looked up} is at this level really just an
* incidental implementation detail useful for the subclass that uses
* {@link InstallerLookup} to create the other components.
*/
protected abstract FixturesInstaller obtainFixturesInstaller() throws IsisSystemException;
// ///////////////////////////////////////////
// Fixtures Installer
// ///////////////////////////////////////////
public FixturesInstaller getFixturesInstaller() {
return fixtureInstaller;
}
/**
* The {@link LogonFixture}, if any, obtained by running fixtures.
*
* <p>
* Intended to be used when for {@link DeploymentType#EXPLORATION
* exploration} (instead of an {@link ExplorationSession}) or
* {@link DeploymentType#PROTOTYPE prototype} deployments (saves logging
* in). Should be <i>ignored</i> in other {@link DeploymentType}s.
*/
@Override
public LogonFixture getLogonFixture() {
return logonFixture;
}
@Override
protected void appendFixturesInstallerDebug(final DebugBuilder debug) {
debug.appendln("Fixture Installer", fixtureInstaller == null ? "none" : fixtureInstaller.getClass().getName());
}
}