Class UnisonConfigManagerImpl

java.lang.Object

com.tremolosecurity.config.util.UnisonConfigManagerImpl

All Implemented Interfaces:

ConfigManager, UnisonConfigManager

Direct Known Subclasses:

OpenUnisonConfigManager

public abstract class UnisonConfigManagerImpl
extends Object
implements ConfigManager, UnisonConfigManager

Field Summary

Fields

Modifier and Type	Field	Description
protected MyVDConnection	con
protected String	configXML
protected jakarta.servlet.ServletContext	ctx
protected KeyManagerFactory	kmf
protected KeyStore	ks
protected net.sourceforge.myvd.server.ServerCore	myvd

Constructor Summary

Constructors

Constructor	Description
UnisonConfigManagerImpl(String configXML, jakarta.servlet.ServletContext ctx, String name)

Method Summary

Modifier and Type	Method	Description
List<UrlHolder>	addApplication(ApplicationType app)
void	addAuthenticationMechanism(MechanismType mt)
void	addCustomerAuthorization(CustomAzRuleType azrt)
void	addReloadNotifier(ReloadNotification notifier)	Provide notifications to classes when the configuration is reloaded
void	addResultGroup(ResultGroupType rgt)
void	addThread(StopableThread r)	Adds a thread to the managed list of threads.
void	buildHttpConfig()
void	clearThreads()	Stop all threads and clear them from Unison
void	createAnonUser(jakarta.servlet.http.HttpSession sharedSession)	Resets the session's state to an anonymous user
void	deleteApp(String name)
UrlHolder	findURL(String url)	Finds an application configuration based on a URL
ApplicationType	getApp(String name)	Returns an application configuration based on the application's name
HashMap<String,AuthChainType>	getAuthChains()	Returns a map of Authentication Chain configurations based on the name of the chain
AuthChainType	getAuthFailChain()
MechanismType	getAuthFailMechanism()
String	getAuthFormsPath()	Returns where Unison stores JSP pages for authentication (typically /auth/forms).
String	getAuthIdPPath()	Returns the path where Unison identity providers are configured.
AuthManager	getAuthManager()
AuthMechanism	getAuthMech(String uri)	Retrieves an authentication mechanism implementation based on the URI of a request
HashMap<String,MechanismType>	getAuthMechs()	Returns a map of all configured authentication mechanism configurations
String	getAuthPath()	Returns the path to Unison's "auth" directory.
X509Certificate	getCertificate(String alias)	Retrieves a certificate from Unison's internal certificate store
TremoloType	getCfg()	Returns the un-marshaled XML configuration
String	getConfigXmlPath()	Returns the full path to Unison's XML configuration
jakarta.servlet.ServletContext	getContext()	Returns Unison's servlet context
String	getContextPath()	Returns the context path for Unison
Map<String,CustomAuthorization>	getCustomAuthorizations()	Returns a map of custom authorization implementations and names
Map<Integer,String>	getErrorPages()	Returns the error pages
abstract int	getExternalOpenPort()	Returns the open port, as seen by a client.
abstract int	getExternalSecurePort()	Returns the secure port, as seen by a client.
org.apache.http.client.config.RequestConfig	getGlobalHttpClientConfig()	Returns the global htto client configuration
org.apache.http.config.Registry<org.apache.http.conn.socket.ConnectionSocketFactory>	getHttpClientSocketRegistry()	Returns the protocol registry for the http client
KeyManagerFactory	getKeyManagerFactory()	Returns Unison's Key Management Factory
KeyStore	getKeyStore()	Returns Unison's key store
MyVDConnection	getMyVD()	Return the internal MyVD connection, can be used for searches and authentication
NotificationsManager	getNotificationsMananager()
abstract int	getOpenPort()	Returns the open port this service is listening on
String	getPaasRoleAttribute()	When Unison is embedded, returns the name of the user attribute that will act as the roles identifier.
String	getPaasUserPrinicipalAttribute()	When Unison is embedded, returns the name of the user attribute that will act as the user identifier.
PrivateKey	getPrivateKey(String alias)	Returns a private key from Unison's internal key store
ProvisioningEngine	getProvisioningEngine()	Retrieves the Unison provisioning subsystem
ResultGroupType	getResultGroup(String name)	Returns a Result Group configuration based on its name
SecretKey	getSecretKey(String alias)	Returns a secret key from Unison's key store
abstract int	getSecurePort()	Returns the secure port this service is listening on
SSLContext	getSSLContext()	Returns the SSLContext
HttpUpgradeRequestManager	getUpgradeManager()	Returns an implementation of the upgrade manager
void	initialize(String name)	Initializes a Unison configuration
void	initializeUrls(List<UrlHolder> holders)
abstract boolean	isForceToSSL()	True if all connections in plain text are to be redirected to encrypted text (HTTP/S only)
void	loadAuthMechs()	Loads all authentication mechanisms, DO NOT CALL
void	loadFilters()	Loads all filter configurations, DO NOT CALL
abstract void	loadKeystore(String path, String myVdPath)
abstract void	loadMyVD(String path, String myVdPath)
abstract jakarta.xml.bind.JAXBElement<TremoloType>	loadUnisonConfiguration(jakarta.xml.bind.Unmarshaller unmarshaller)
void	notifyReload()	Notify listeners that the configuration is bring reloaded
abstract void	postInitialize()
void	reloadConfig()	Reloads all configuration items, clears all threads
void	removeAuthenticationMechanism(String name)
void	removeCustomAuthorization(String azName)
void	removeResultGroup(ResultGroupType rgtToRemove)
void	setPaasRoleAttribute(String paasRoleAttribute)	When Unison is embedded, sets the name of the user attribute that will act as the roles identifier.
void	setPaasUserPrinicipalAttribute(String paasUserPrinicipalAttribute)	When Unison is embedded, sets the name of the user attribute that will act as the user identifier.

Methods inherited from class java.lang.Object

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

Field Details

myvd

protected net.sourceforge.myvd.server.ServerCore myvd

con

protected MyVDConnection con

ks

protected KeyStore ks

kmf

protected KeyManagerFactory kmf

configXML

protected String configXML

ctx

protected jakarta.servlet.ServletContext ctx

Constructor Details

UnisonConfigManagerImpl

public UnisonConfigManagerImpl(String configXML,
 jakarta.servlet.ServletContext ctx,
 String name)
                        throws Exception

Parameters:

configXML -

path -

Throws:

Exception

Method Details

getUpgradeManager

public HttpUpgradeRequestManager getUpgradeManager()

Description copied from interface: ConfigManager

Returns an implementation of the upgrade manager

Specified by:

getUpgradeManager in interface ConfigManager

Returns:

getErrorPages

public Map<Integer,String> getErrorPages()

Description copied from interface: ConfigManager

Returns the error pages

Specified by:

getErrorPages in interface ConfigManager

getConfigXmlPath

public String getConfigXmlPath()

Description copied from interface: ConfigManager

Returns the full path to Unison's XML configuration

Specified by:

getConfigXmlPath in interface ConfigManager

Specified by:

getConfigXmlPath in interface UnisonConfigManager

Returns:

buildHttpConfig

public void buildHttpConfig()
                     throws NoSuchAlgorithmException,
KeyManagementException,
KeyStoreException,
UnrecoverableKeyException

Specified by:

buildHttpConfig in interface ConfigManager

Throws:

NoSuchAlgorithmException

KeyManagementException

KeyStoreException

UnrecoverableKeyException

getAuthMechs

public HashMap<String,MechanismType> getAuthMechs()

Description copied from interface: ConfigManager

Returns a map of all configured authentication mechanism configurations

Specified by:

getAuthMechs in interface ConfigManager

Specified by:

getAuthMechs in interface UnisonConfigManager

Returns:

getCfg

public TremoloType getCfg()

Description copied from interface: ConfigManager

Returns the un-marshaled XML configuration

Specified by:

getCfg in interface ConfigManager

Specified by:

getCfg in interface UnisonConfigManager

Returns:

loadUnisonConfiguration

public abstract jakarta.xml.bind.JAXBElement<TremoloType> loadUnisonConfiguration(jakarta.xml.bind.Unmarshaller unmarshaller)
                                                                           throws Exception

Throws:

Exception

initialize

public void initialize(String name)
                throws jakarta.xml.bind.JAXBException,
Exception,
IOException,
FileNotFoundException,
InstantiationException,
IllegalAccessException,
ClassNotFoundException,
com.novell.ldap.LDAPException,
KeyStoreException,
NoSuchAlgorithmException,
CertificateException,
ProvisioningException

Description copied from interface: ConfigManager

Initializes a Unison configuration

Specified by:

initialize in interface ConfigManager

Specified by:

initialize in interface UnisonConfigManager

Parameters:

name -

Throws:

jakarta.xml.bind.JAXBException

Exception

IOException

FileNotFoundException

InstantiationException

IllegalAccessException

ClassNotFoundException

com.novell.ldap.LDAPException

KeyStoreException

NoSuchAlgorithmException

CertificateException

ProvisioningException

getNotificationsMananager

public NotificationsManager getNotificationsMananager()

Specified by:

getNotificationsMananager in interface ConfigManager

postInitialize

public abstract void postInitialize()

loadKeystore

public abstract void loadKeystore(String path,
 String myVdPath)
                           throws Exception

Throws:

Exception

getAuthChains

public HashMap<String,AuthChainType> getAuthChains()

Description copied from interface: ConfigManager

Returns a map of Authentication Chain configurations based on the name of the chain

Specified by:

getAuthChains in interface ConfigManager

Specified by:

getAuthChains in interface UnisonConfigManager

Returns:

addApplication

public List<UrlHolder> addApplication(ApplicationType app)
                               throws Exception

Specified by:

addApplication in interface ConfigManager

Throws:

Exception

deleteApp

public void deleteApp(String name)

Specified by:

deleteApp in interface ConfigManager

initializeUrls

public void initializeUrls(List<UrlHolder> holders)
                    throws Exception

Specified by:

initializeUrls in interface ConfigManager

Throws:

Exception

findURL

public UrlHolder findURL(String url)
                  throws Exception

Description copied from interface: ConfigManager

Finds an application configuration based on a URL

Specified by:

findURL in interface ConfigManager

Specified by:

findURL in interface UnisonConfigManager

Parameters:

url -

Returns:

Throws:

Exception

getResultGroup

public ResultGroupType getResultGroup(String name)

Description copied from interface: ConfigManager

Returns a Result Group configuration based on its name

Specified by:

getResultGroup in interface ConfigManager

Specified by:

getResultGroup in interface UnisonConfigManager

Parameters:

name -

Returns:

getMyVD

public MyVDConnection getMyVD()

Description copied from interface: ConfigManager

Return the internal MyVD connection, can be used for searches and authentication

Specified by:

getMyVD in interface ConfigManager

Specified by:

getMyVD in interface UnisonConfigManager

Returns:

getSecretKey

public SecretKey getSecretKey(String alias)

Description copied from interface: ConfigManager

Returns a secret key from Unison's key store

Specified by:

getSecretKey in interface ConfigManager

Specified by:

getSecretKey in interface UnisonConfigManager

Parameters:

alias -

Returns:

getApp

public ApplicationType getApp(String name)

Description copied from interface: ConfigManager

Returns an application configuration based on the application's name

Specified by:

getApp in interface ConfigManager

Specified by:

getApp in interface UnisonConfigManager

Parameters:

name -

Returns:

loadFilters

public void loadFilters()

Description copied from interface: ConfigManager

Loads all filter configurations, DO NOT CALL

Specified by:

loadFilters in interface ConfigManager

Specified by:

loadFilters in interface UnisonConfigManager

loadAuthMechs

public void loadAuthMechs()
                   throws jakarta.servlet.ServletException

Description copied from interface: ConfigManager

Loads all authentication mechanisms, DO NOT CALL

Specified by:

loadAuthMechs in interface ConfigManager

Specified by:

loadAuthMechs in interface UnisonConfigManager

Throws:

jakarta.servlet.ServletException

getAuthMech

public AuthMechanism getAuthMech(String uri)

Description copied from interface: ConfigManager

Retrieves an authentication mechanism implementation based on the URI of a request

Specified by:

getAuthMech in interface ConfigManager

Specified by:

getAuthMech in interface UnisonConfigManager

Parameters:

uri -

Returns:

getCertificate

public X509Certificate getCertificate(String alias)

Description copied from interface: ConfigManager

Retrieves a certificate from Unison's internal certificate store

Specified by:

getCertificate in interface ConfigManager

Specified by:

getCertificate in interface UnisonConfigManager

Parameters:

alias -

Returns:

getProvisioningEngine

public ProvisioningEngine getProvisioningEngine()

Description copied from interface: ConfigManager

Retrieves the Unison provisioning subsystem

Specified by:

getProvisioningEngine in interface ConfigManager

Specified by:

getProvisioningEngine in interface UnisonConfigManager

Returns:

reloadConfig

public void reloadConfig()
                  throws Exception

Description copied from interface: ConfigManager

Reloads all configuration items, clears all threads

Specified by:

reloadConfig in interface ConfigManager

Specified by:

reloadConfig in interface UnisonConfigManager

Throws:

Exception

getPrivateKey

public PrivateKey getPrivateKey(String alias)

Description copied from interface: ConfigManager

Returns a private key from Unison's internal key store

Specified by:

getPrivateKey in interface ConfigManager

Specified by:

getPrivateKey in interface UnisonConfigManager

Parameters:

alias -

Returns:

getKeyStore

public KeyStore getKeyStore()

Description copied from interface: ConfigManager

Returns Unison's key store

Specified by:

getKeyStore in interface ConfigManager

Specified by:

getKeyStore in interface UnisonConfigManager

Returns:

getKeyManagerFactory

public KeyManagerFactory getKeyManagerFactory()

Description copied from interface: ConfigManager

Returns Unison's Key Management Factory

Specified by:

getKeyManagerFactory in interface ConfigManager

Specified by:

getKeyManagerFactory in interface UnisonConfigManager

Returns:

addThread

public void addThread(StopableThread r)

Description copied from interface: ConfigManager

Adds a thread to the managed list of threads. Useful for "clean up" processes

Specified by:

addThread in interface ConfigManager

Specified by:

addThread in interface UnisonConfigManager

Parameters:

r -

clearThreads

public void clearThreads()

Description copied from interface: ConfigManager

Stop all threads and clear them from Unison

Specified by:

clearThreads in interface ConfigManager

Specified by:

clearThreads in interface UnisonConfigManager

addReloadNotifier

public void addReloadNotifier(ReloadNotification notifier)

Description copied from interface: ConfigManager

Provide notifications to classes when the configuration is reloaded

Specified by:

addReloadNotifier in interface ConfigManager

Specified by:

addReloadNotifier in interface UnisonConfigManager

Parameters:

notifier -

notifyReload

public void notifyReload()

Description copied from interface: ConfigManager

Notify listeners that the configuration is bring reloaded

Specified by:

notifyReload in interface ConfigManager

Specified by:

notifyReload in interface UnisonConfigManager

isForceToSSL

public abstract boolean isForceToSSL()

Description copied from interface: ConfigManager

True if all connections in plain text are to be redirected to encrypted text (HTTP/S only)

Specified by:

isForceToSSL in interface ConfigManager

Specified by:

isForceToSSL in interface UnisonConfigManager

Returns:

getOpenPort

public abstract int getOpenPort()

Description copied from interface: ConfigManager

Returns the open port this service is listening on

Specified by:

getOpenPort in interface ConfigManager

Specified by:

getOpenPort in interface UnisonConfigManager

Returns:

getSecurePort

public abstract int getSecurePort()

Description copied from interface: ConfigManager

Returns the secure port this service is listening on

Specified by:

getSecurePort in interface ConfigManager

Specified by:

getSecurePort in interface UnisonConfigManager

Returns:

getExternalOpenPort

public abstract int getExternalOpenPort()

Description copied from interface: ConfigManager

Returns the open port, as seen by a client. For instance if Unison is running on port 8080 but there is a firewall port forwarding from port 80 this would return 80

Specified by:

getExternalOpenPort in interface ConfigManager

Specified by:

getExternalOpenPort in interface UnisonConfigManager

Returns:

getExternalSecurePort

public abstract int getExternalSecurePort()

Description copied from interface: ConfigManager

Returns the secure port, as seen by a client. For instance if Unison is running on port 8443 but there is a firewall port forwarding from port 443 this would return 443

Specified by:

getExternalSecurePort in interface ConfigManager

Specified by:

getExternalSecurePort in interface UnisonConfigManager

Returns:

createAnonUser

public void createAnonUser(jakarta.servlet.http.HttpSession sharedSession)

Description copied from interface: ConfigManager

Resets the session's state to an anonymous user

Specified by:

createAnonUser in interface ConfigManager

Specified by:

createAnonUser in interface UnisonConfigManager

Parameters:

sharedSession -

getAuthPath

public String getAuthPath()

Description copied from interface: ConfigManager

Returns the path to Unison's "auth" directory. If Unison is embedded this directory can be at different levels

Specified by:

getAuthPath in interface ConfigManager

Specified by:

getAuthPath in interface UnisonConfigManager

Returns:

getAuthFormsPath

public String getAuthFormsPath()

Description copied from interface: ConfigManager

Returns where Unison stores JSP pages for authentication (typically /auth/forms). If Unison is embedded this path may change.

Specified by:

getAuthFormsPath in interface ConfigManager

Specified by:

getAuthFormsPath in interface UnisonConfigManager

Returns:

getAuthIdPPath

public String getAuthIdPPath()

Description copied from interface: ConfigManager

Returns the path where Unison identity providers are configured. Typicaly /auth/idp however this may change if Unison is embedded.

Specified by:

getAuthIdPPath in interface ConfigManager

Specified by:

getAuthIdPPath in interface UnisonConfigManager

Returns:

getPaasUserPrinicipalAttribute

public String getPaasUserPrinicipalAttribute()

Description copied from interface: ConfigManager

When Unison is embedded, returns the name of the user attribute that will act as the user identifier.

Specified by:

getPaasUserPrinicipalAttribute in interface ConfigManager

Specified by:

getPaasUserPrinicipalAttribute in interface UnisonConfigManager

Returns:

setPaasUserPrinicipalAttribute

public void setPaasUserPrinicipalAttribute(String paasUserPrinicipalAttribute)

Description copied from interface: ConfigManager

When Unison is embedded, sets the name of the user attribute that will act as the user identifier.

Specified by:

setPaasUserPrinicipalAttribute in interface ConfigManager

Specified by:

setPaasUserPrinicipalAttribute in interface UnisonConfigManager

getPaasRoleAttribute

public String getPaasRoleAttribute()

Description copied from interface: ConfigManager

When Unison is embedded, returns the name of the user attribute that will act as the roles identifier.

Specified by:

getPaasRoleAttribute in interface ConfigManager

Specified by:

getPaasRoleAttribute in interface UnisonConfigManager

Returns:

setPaasRoleAttribute

public void setPaasRoleAttribute(String paasRoleAttribute)

Description copied from interface: ConfigManager

When Unison is embedded, sets the name of the user attribute that will act as the roles identifier.

Specified by:

setPaasRoleAttribute in interface ConfigManager

Specified by:

setPaasRoleAttribute in interface UnisonConfigManager

getContextPath

public String getContextPath()

Description copied from interface: ConfigManager

Returns the context path for Unison

Specified by:

getContextPath in interface ConfigManager

Specified by:

getContextPath in interface UnisonConfigManager

Returns:

getContext

public jakarta.servlet.ServletContext getContext()

Description copied from interface: ConfigManager

Returns Unison's servlet context

Specified by:

getContext in interface ConfigManager

Specified by:

getContext in interface UnisonConfigManager

Returns:

getAuthManager

public AuthManager getAuthManager()

Specified by:

getAuthManager in interface ConfigManager

getGlobalHttpClientConfig

public org.apache.http.client.config.RequestConfig getGlobalHttpClientConfig()

Description copied from interface: ConfigManager

Returns the global htto client configuration

Specified by:

getGlobalHttpClientConfig in interface ConfigManager

Returns:

getHttpClientSocketRegistry

public org.apache.http.config.Registry<org.apache.http.conn.socket.ConnectionSocketFactory> getHttpClientSocketRegistry()

Description copied from interface: ConfigManager

Returns the protocol registry for the http client

Specified by:

getHttpClientSocketRegistry in interface ConfigManager

Returns:

loadMyVD

public abstract void loadMyVD(String path,
 String myVdPath)
                       throws Exception

Throws:

Exception

getCustomAuthorizations

public Map<String,CustomAuthorization> getCustomAuthorizations()

Description copied from interface: ConfigManager

Returns a map of custom authorization implementations and names

Specified by:

getCustomAuthorizations in interface ConfigManager

Returns:

getSSLContext

public SSLContext getSSLContext()

Description copied from interface: ConfigManager

Returns the SSLContext

Specified by:

getSSLContext in interface ConfigManager

Returns:

addResultGroup

public void addResultGroup(ResultGroupType rgt)

Specified by:

addResultGroup in interface ConfigManager

removeResultGroup

public void removeResultGroup(ResultGroupType rgtToRemove)

Specified by:

removeResultGroup in interface ConfigManager

addCustomerAuthorization

public void addCustomerAuthorization(CustomAzRuleType azrt)

Specified by:

addCustomerAuthorization in interface ConfigManager

removeCustomAuthorization

public void removeCustomAuthorization(String azName)

Specified by:

removeCustomAuthorization in interface ConfigManager

getAuthFailMechanism

public MechanismType getAuthFailMechanism()

Specified by:

getAuthFailMechanism in interface ConfigManager

addAuthenticationMechanism

public void addAuthenticationMechanism(MechanismType mt)

Specified by:

addAuthenticationMechanism in interface ConfigManager

removeAuthenticationMechanism

public void removeAuthenticationMechanism(String name)

Specified by:

removeAuthenticationMechanism in interface ConfigManager

getAuthFailChain

public AuthChainType getAuthFailChain()

Specified by:

getAuthFailChain in interface ConfigManager