org.eurekaclinical.standardapis.props.CasEurekaClinicalProperties Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of eurekaclinical-standard-apis Show documentation

A library of classes shared across the Eureka! Clinical platform.

There is a newer version: 4.1-Alpha-1

Show newest version

package org.eurekaclinical.standardapis.props;

/*-
 * #%L
 * Eureka! Clinical Standard APIs
 * %%
 * Copyright (C) 2016 Emory University
 * %%
 * 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.
 * #L%
 */
import javax.ws.rs.core.UriBuilder;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Base class for implementing properties for Eureka! Clinical microservices.
 * 
 * @author hrathod
 */
public abstract class CasEurekaClinicalProperties extends EurekaClinicalProperties {

    /**
     * The class level logger.
     */
    private static final Logger LOGGER = LoggerFactory.getLogger(CasEurekaClinicalProperties.class);

    /**
     * Loads the application configuration.
     *
     * There are two potential sources of application configuration. The
     * fallback configuration should always be there. The default configuration
     * directory, provided as an argument to this constructor, may optionally
     * have an application.properties file within it that overrides the fallback
     * configuration for each configuration property that is specified. The
     * eureka.config.dir system property allows specifying an
     * alternative configuration directory.
     *
     * @param defaultConfigDir the default location of configuration file, based
     * on the operating system. Cannot be null.
     */
    protected CasEurekaClinicalProperties(String defaultConfigDir) {
        super(defaultConfigDir);
    }

    public abstract String getProxyCallbackServer();

    public String getCasUrl() {
        return this.getValue("cas.url", "https://localhost/cas-server");
    }

    public String getCasLoginUrl() {
        UriBuilder builder = UriBuilder.fromUri(getCasUrl());
        builder.path(this.getValue("cas.url.login", "/login"));
        return builder.build().toString();
    }

    public String getCasLogoutUrl() {
        UriBuilder builder = UriBuilder.fromUri(getCasUrl());
        builder.path(this.getValue("cas.url.logout", "/logout"));
        return builder.build().toString();
    }
    
    /**
     * Whether or not to use CAS renew mode for authentication. Renew mode
     * will always present the authentication screen if the user does not
     * already have an application session. Set to false by
     * default.
     * 
     * @return true to use renew mode, false
     * otherwise.
     */
    public boolean getCasLoginRenew() {
        return Boolean.parseBoolean(getValue("cas.login.renew", "false"));
    }
    
    /**
     * Whether or not to use CAS gateway mode for authentication. Set to
     * false. Subclasses may override this method to return
     * true instead.
     * 
     * @return false.
     */
    public boolean getCasLoginGateway() {
        return false;
    }
    
}