org.n52.security.authentication.config
Class BeanConfiguration

java.lang.Object
  extended by javax.security.auth.login.Configuration
      extended by org.n52.security.authentication.config.ConfigurationDecorator
          extended by org.n52.security.authentication.config.BeanConfiguration

public class BeanConfiguration
extends ConfigurationDecorator

Class BeanConfiguration represents a JAAS-Configuration, which is written in a Pojo-Style.

It provides methods for simple setting/getting the AppConfigurationEntry[] instances. It does not implement any kind of external configuration. It extends ConfigurationDecorator, therewith it is possible to generate a chain of Configuration-instances.

Version:
$Revision: $
Author:
Marko Reiprecht Created on 10.09.2007

Constructor Summary
BeanConfiguration()
          Constructor creates a empty BeanConfiguration instance.
BeanConfiguration(javax.security.auth.login.Configuration configuration)
          Constructor creates a empty BeanConfiguration instance, which delegates to the given Configuration instance.
BeanConfiguration(javax.security.auth.login.Configuration configuration, boolean weak)
          Constructor creates a empty BeanConfiguration instance, which delegates to the given Configuration instance.
BeanConfiguration(javax.security.auth.login.Configuration configuration, boolean weak, java.util.Map appConfigurationEntries)
          Constructor creates a BeanConfiguration instance, which only delegates to the given Configuration instance if no application entry is found in the given map.
 
Method Summary
 java.util.Map getAppConfigurationEntries()
          Method returns the appConfigurationEntries managed by this BeanConfiguration object.
 javax.security.auth.login.AppConfigurationEntry[] getAppConfigurationEntry(java.lang.String applicationName)
          Returns the AppConfiguraionEntries for a special applicationName.
 void removeAppConfigurationEntry(java.lang.String applicationName)
          Method removes all AppConfigurationEntries of a special application name.
 void setAppConfigurationEntries(java.util.Map configurationEntries)
          Method sets the appConfigurationEntries of this BeanConfiguration object.
 void setAppConfigurationEntry(java.lang.String applicationName, javax.security.auth.login.AppConfigurationEntry[] applicationEntry)
          Method sets the AppConfigurationEntries of a special application name.
 
Methods inherited from class org.n52.security.authentication.config.ConfigurationDecorator
getDelegationConfiguration, refresh, setDelegationConfiguration, setDelegationConfiguration
 
Methods inherited from class javax.security.auth.login.Configuration
getConfiguration, setConfiguration
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BeanConfiguration

public BeanConfiguration()
Constructor creates a empty BeanConfiguration instance.


BeanConfiguration

public BeanConfiguration(javax.security.auth.login.Configuration configuration)
Constructor creates a empty BeanConfiguration instance, which delegates to the given Configuration instance.

Parameters:
configuration - the configuration to delegate to.
See Also:
ConfigurationDecorator.ConfigurationDecorator(Configuration)

BeanConfiguration

public BeanConfiguration(javax.security.auth.login.Configuration configuration,
                         boolean weak)
Constructor creates a empty BeanConfiguration instance, which delegates to the given Configuration instance.

Parameters:
configuration - of type Configuration, can be null.
weak - of type boolean, if true only a WeakReference is stored to the given Configuration.
See Also:
ConfigurationDecorator.ConfigurationDecorator(Configuration,boolean)

BeanConfiguration

public BeanConfiguration(javax.security.auth.login.Configuration configuration,
                         boolean weak,
                         java.util.Map appConfigurationEntries)
Constructor creates a BeanConfiguration instance, which only delegates to the given Configuration instance if no application entry is found in the given map.

Parameters:
configuration - of type Configuration, can be null.
weak - of type boolean, if true only a WeakReference is stored to the given Configuration.
appConfigurationEntries - a Map of type Map<String,AppConfigurationEntry[]>
See Also:
ConfigurationDecorator.ConfigurationDecorator(Configuration,boolean)
Method Detail

getAppConfigurationEntries

public java.util.Map getAppConfigurationEntries()
Method returns the appConfigurationEntries managed by this BeanConfiguration object. The returned map is unmodifiable and only the entries directly visible to this instance are returned. Entries managed elsewere in the configuration chain are not returned.

Returns:
the appConfigurationEntries (type Map<String,AppConfigurationEntry[]>).

setAppConfigurationEntries

public void setAppConfigurationEntries(java.util.Map configurationEntries)
Method sets the appConfigurationEntries of this BeanConfiguration object. The entries of the given map are copied to the internal map.

Parameters:
configurationEntries - the appConfigurationEntries managed by this BeanConfiguration object.

setAppConfigurationEntry

public void setAppConfigurationEntry(java.lang.String applicationName,
                                     javax.security.auth.login.AppConfigurationEntry[] applicationEntry)
Method sets the AppConfigurationEntries of a special application name. The given entry is copied to the internal map. A entry with the same name will be overwritten.

Parameters:
applicationName - of type String must not null.
applicationEntry - of type AppConfigurationEntry[] must not null.

removeAppConfigurationEntry

public void removeAppConfigurationEntry(java.lang.String applicationName)
Method removes all AppConfigurationEntries of a special application name. Only entries managed(visible) by this Configuration instance are removed.

Parameters:
applicationName - of type String must not null.

getAppConfigurationEntry

public javax.security.auth.login.AppConfigurationEntry[] getAppConfigurationEntry(java.lang.String applicationName)
Returns the AppConfiguraionEntries for a special applicationName. First it looks in the entries managed by this object, if no entries for the applicationName are found the wrapped Configuration object is asked.

Overrides:
getAppConfigurationEntry in class ConfigurationDecorator
Parameters:
applicationName - of type String must not null.
Returns:
AppConfigurationEntry[] indexed by applicationName.
See Also:
ConfigurationDecorator.getAppConfigurationEntry(String)


Copyright © 2004-2009 52north.org. All Rights Reserved.