org.eurekaclinical.standardapis.props

Class CasEurekaClinicalProperties

java.lang.Object

org.eurekaclinical.standardapis.props.EurekaClinicalProperties

org.eurekaclinical.standardapis.props.CasEurekaClinicalProperties

Direct Known Subclasses:

CasJerseyEurekaClinicalProperties

public abstract class CasEurekaClinicalProperties
extends EurekaClinicalProperties

Base class for implementing properties for Eureka! Clinical microservices.

Author:

hrathod

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CasEurekaClinicalProperties(String defaultConfigDir) Loads the application configuration.

Method Summary

Modifier and Type	Method and Description
List<String>	getAllowedWebClientUrls() For API gateways, specifies the URLs of the web clients that may attempt to login to the gateway.
boolean	getCasLoginGateway() Whether or not to use CAS gateway mode for authentication.
boolean	getCasLoginRenew() Whether or not to use CAS renew mode for authentication.
String	getCasLoginUrl()
String	getCasLogoutUrl()
String	getCasUrl()
abstract String	getProxyCallbackServer()

Methods inherited from class org.eurekaclinical.standardapis.props.EurekaClinicalProperties

getConfigDir, getDomainUrl, getIntValue, getStage, getStringListValue, getStringListValue, getUrl, getValue, getValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CasEurekaClinicalProperties

protected CasEurekaClinicalProperties(String defaultConfigDir)

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.

Parameters:

defaultConfigDir - the default location of configuration file, based on the operating system. Cannot be null.

Method Detail

getProxyCallbackServer

public abstract String getProxyCallbackServer()

getCasUrl

public String getCasUrl()

getCasLoginUrl

public String getCasLoginUrl()

getCasLogoutUrl

public String getCasLogoutUrl()

getCasLoginRenew

public boolean getCasLoginRenew()

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.

Returns:

true to use renew mode, false otherwise.

getCasLoginGateway

public boolean getCasLoginGateway()

Whether or not to use CAS gateway mode for authentication. Set to false. Subclasses may override this method to return true instead.

Returns:

false.

getAllowedWebClientUrls

public List<String> getAllowedWebClientUrls()

For API gateways, specifies the URLs of the web clients that may attempt to login to the gateway. This default implementation always returns null. Subclasses for an API gateway should override this implementation to get the list of allowed webclients from an application property that is specific to the gateway.

Returns:

a list of URL strings, or an empty list or null if none are specified.