strolch/web-rest/src/main/java/li/strolch/rest/RestfulStrolchComponent.java

/*
 * Copyright 2013 Robert von Burg <eitch@eitchnet.ch>
 *
 * Licensed 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 li.strolch.rest;

import li.strolch.agent.api.ComponentContainer;
import li.strolch.agent.api.StrolchAgent;
import li.strolch.agent.api.StrolchComponent;
import li.strolch.persistence.api.StrolchTransaction;
import li.strolch.privilege.model.Certificate;
import li.strolch.privilege.model.PrivilegeContext;
import li.strolch.rest.filters.AccessControlResponseFilter;
import li.strolch.rest.filters.HttpCacheResponseFilter;
import li.strolch.runtime.configuration.ComponentConfiguration;
import li.strolch.runtime.privilege.PrivilegeHandler;
import li.strolch.runtime.sessions.StrolchSessionHandler;
import li.strolch.service.api.ServiceHandler;
import li.strolch.utils.dbc.DBC;

import java.text.MessageFormat;
import java.util.concurrent.TimeUnit;

/**
 * @author Robert von Burg <eitch@eitchnet.ch>
 */
public class RestfulStrolchComponent extends StrolchComponent {

	private static final String PARAM_CORS_ENABLED = "corsEnabled";
	private static final String PARAM_CORS_ORIGIN = "corsOrigin";
	private static final String PARAM_REST_LOGGING = "restLogging";
	private static final String PARAM_REST_LOGGING_ENTITY = "restLoggingEntity";
	private static final String PARAM_HTTP_CACHE_MODE = "httpCacheMode";
	private static final String PARAM_SECURE_COOKIE = "secureCookie";
	private static final String PARAM_COOKIE_MAX_AGE = "cookieMaxAge";
	private static final String PARAM_DOMAIN = "domain";
	private static final String PARAM_PATH = "path";
	private static final String PARAM_BASIC_AUTH_ENABLED = "basicAuthEnabled";
	private static final String PARAM_HIDE_VERSION_FROM_UNAUTHORIZED_CLIENTS = "hideVersionFromUnauthorizedClients";

	/**
	 * Allowed values:
	 * <ul>
	 * <li>{@code OFF} - tracing support is disabled.</li>
	 * <li>{@code ON_DEMAND} - tracing support is in 'stand by' mode, it is enabled on demand by existence of request
	 * HTTP header</li>
	 * <li>{@code ALL} - tracing support is enabled for every request.</li>
	 * </ul>
	 *
	 * @see org.glassfish.jersey.server.ServerProperties#TRACING
	 */
	private static final String PARAM_REST_TRACING = "restTracing";

	/**
	 * Allowed values:
	 * <ul>
	 * <li>{@code SUMMARY}</li>
	 * <li>{@code TRACE}</li>
	 * <li>{@code VERBOSE}</li>
	 * </ul>
	 *
	 * @see org.glassfish.jersey.server.ServerProperties#TRACING_THRESHOLD
	 */
	private static final String PARAM_REST_TRACING_THRESHOLD = "restTracingThreshold";

	private static RestfulStrolchComponent instance;

	private String restTracing;
	private String restTracingThreshold;
	private boolean corsEnabled;
	private String corsOrigin;
	private boolean restLogging;
	private boolean restLoggingEntity;
	private boolean secureCookie;
	private String domain;
	private String path;
	private int cookieMaxAge;
	private boolean basicAuthEnabled;
	private boolean hideVersionFromUnauthorizedClients;

	private String webPath;

	public RestfulStrolchComponent(ComponentContainer container, String componentName) {
		super(container, componentName);
	}

	public String getWebPath() {
		return this.webPath;
	}

	public void setWebPath(String webPath) {
		this.webPath = webPath;
	}

	public boolean isCorsEnabled() {
		return this.corsEnabled;
	}

	public String getCorsOrigin() {
		return this.corsOrigin;
	}

	public String getRestTracing() {
		return this.restTracing;
	}

	public String getRestTracingThreshold() {
		return this.restTracingThreshold;
	}

	public boolean isRestLogging() {
		return this.restLogging;
	}

	public boolean isRestLoggingEntity() {
		return this.restLoggingEntity;
	}

	public boolean isSecureCookie() {
		return this.secureCookie;
	}

	public int getCookieMaxAge() {
		return this.cookieMaxAge;
	}

	public String getDomain() {
		return domain;
	}

	public boolean isDomainSet() {
		return this.domain != null;
	}

	public boolean isPathSet() {
		return this.path != null;
	}

	public String getPath() {
		return this.path;
	}

	public boolean isBasicAuthEnabled() {
		return this.basicAuthEnabled;
	}

	public boolean isHideVersionFromUnauthorizedClients() {
		return hideVersionFromUnauthorizedClients;
	}

	@Override
	public void initialize(ComponentConfiguration configuration) throws Exception {

		this.corsEnabled = configuration.getBoolean(PARAM_CORS_ENABLED, Boolean.FALSE);
		if (this.corsEnabled) {
			this.corsOrigin = configuration.getString(PARAM_CORS_ORIGIN, null);
			logger.info("Enabling CORS for origin: " + this.corsOrigin);
			AccessControlResponseFilter.setCorsEnabled(true);
			AccessControlResponseFilter.setOrigin(this.corsOrigin);
		}

		// restful logging and tracing
		this.restLogging = configuration.getBoolean(PARAM_REST_LOGGING, Boolean.FALSE);
		this.restLoggingEntity = configuration.getBoolean(PARAM_REST_LOGGING_ENTITY, Boolean.FALSE);
		this.restTracing = configuration.getString(PARAM_REST_TRACING, "OFF");
		this.restTracingThreshold = configuration.getString(PARAM_REST_TRACING_THRESHOLD, "TRACE");

		String msg = "Set restLogging={0} with logEntities={1} restTracing={2} with threshold={3}";
		logger.info(MessageFormat.format(msg, this.restLogging, this.restLoggingEntity, this.restTracing,
				this.restTracingThreshold));

		// set http cache mode
		String cacheMode = configuration.getString(PARAM_HTTP_CACHE_MODE, HttpCacheResponseFilter.NO_CACHE);
		logger.info("HTTP header cache mode is set to {}", cacheMode);

		this.secureCookie = configuration.getBoolean(PARAM_SECURE_COOKIE, true);
		this.cookieMaxAge = configuration.getInt(PARAM_COOKIE_MAX_AGE, (int) TimeUnit.DAYS.toSeconds(1));
		this.domain = configuration.getString(PARAM_DOMAIN, "");
		if (this.domain.isEmpty())
			this.domain = null;
		this.path = configuration.getString(PARAM_PATH, "");
		if (this.path.isEmpty())
			this.path = null;
		this.basicAuthEnabled = configuration.getBoolean(PARAM_BASIC_AUTH_ENABLED, true);
		this.hideVersionFromUnauthorizedClients = configuration.getBoolean(PARAM_HIDE_VERSION_FROM_UNAUTHORIZED_CLIENTS,
				false);

		logger.info(
				"Cookie max age is " + this.cookieMaxAge + "s and is " + (this.secureCookie ? "secure" : "not secure"));

		super.initialize(configuration);
	}

	@Override
	public void start() throws Exception {
		instance = this;
		super.start();
	}

	@Override
	public void stop() throws Exception {
		super.stop();
	}

	/**
	 * @return the RestfulStrolchComponent
	 */
	public static RestfulStrolchComponent getInstance() {
		DBC.PRE.assertNotNull("Not yet initialized!", instance);
		return instance;
	}

	public StrolchAgent getAgent() {
		return super.getAgent();
	}

	public PrivilegeHandler getPrivilegeHandler() {
		return getAgent().getPrivilegeHandler();
	}

	@Override
	public <T> T getComponent(Class<T> clazz) {
		return getAgent().getComponent(clazz);
	}

	public <T extends StrolchComponent> T getComponentByName(String name) {
		return getAgent().getComponentByName(name);
	}

	public StrolchSessionHandler getSessionHandler() {
		return getContainer().getComponent(StrolchSessionHandler.class);
	}

	public ServiceHandler getServiceHandler() {
		return getContainer().getComponent(ServiceHandler.class);
	}

	public PrivilegeContext validate(Certificate certificate) {
		return getPrivilegeHandler().validate(certificate);
	}

	public StrolchTransaction openTx(Certificate certificate, Class<?> clazz) {
		return getContainer().getRealm(certificate).openTx(certificate, clazz, true);
	}

	public StrolchTransaction openTx(Certificate certificate, String name) {
		return getContainer().getRealm(certificate).openTx(certificate, name, true);
	}

	public StrolchTransaction openTx(Certificate certificate, String name, boolean readOnly) {
		return getContainer().getRealm(certificate).openTx(certificate, name, readOnly);
	}

	public StrolchTransaction openTx(Certificate certificate, String realm, Class<?> clazz) {
		return getContainer().getRealm(realm).openTx(certificate, clazz, true);
	}

	public StrolchTransaction openTx(Certificate certificate, String realm, String name) {
		return getContainer().getRealm(realm).openTx(certificate, name, true);
	}
}