Keel 2.1RC2

org.keel.services.domain.config
Class ConfigDomain

java.lang.Object
  extended byorg.keel.services.domain.config.ConfigDomain
All Implemented Interfaces:
Configurable, Domain

public class ConfigDomain
extends java.lang.Object
implements Domain, Configurable

An implementation of org.keel.core.services.domain.Domain service. This domain handles domain definitins defined in XML in system.xconf files. The format of the configuration is as follows:

      
          
          
          ...
      
      where, type=one of DB, AUTHENTICATION_MANAGER, AUTHORIZATION_MANAGER
             name=the hint configured for the service to be used 
 

Version:
$Revision: 1.1 $ $Date: 2004/03/09 20:19:55 $
Author:
Shash Chatterjee

Nested Class Summary
 
Nested classes inherited from class org.keel.services.domain.Domain
Domain.DomainKey
 
Field Summary
protected  Configuration configuration
           
private static java.lang.String DEFAULT
           
protected  java.lang.String description
           
protected  java.lang.String name
           
protected  java.lang.String unconfigured
           
protected  java.util.Map values
           
 
Fields inherited from interface org.keel.services.domain.Domain
ROLE
 
Constructor Summary
ConfigDomain()
           
 
Method Summary
 void configure(Configuration configuration)
          Pass the Configuration to the Configurable class.
 java.lang.String getDescription()
          Return the description configured for this domain
 java.lang.String getName()
          Return the name of this component (same as the "id" attribute in configuration
private  java.lang.String getUnconfigured()
          This the value returned, if a key is not configured
 java.lang.String getValue(Domain.DomainKey key)
          Get the hint configured for a particular domain type (key)
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT

private static final java.lang.String DEFAULT
See Also:
Constant Field Values

configuration

protected Configuration configuration

name

protected java.lang.String name

description

protected java.lang.String description

values

protected java.util.Map values

unconfigured

protected java.lang.String unconfigured
Constructor Detail

ConfigDomain

public ConfigDomain()
Method Detail

getName

public java.lang.String getName()
Return the name of this component (same as the "id" attribute in configuration

Specified by:
getName in interface Domain
Returns:
name of the domain
See Also:
Domain.getName()

getDescription

public java.lang.String getDescription()
Return the description configured for this domain

Specified by:
getDescription in interface Domain
Returns:
description of domain
See Also:
Domain.getDescription()

getValue

public java.lang.String getValue(Domain.DomainKey key)
                          throws DomainException
Get the hint configured for a particular domain type (key)

Specified by:
getValue in interface Domain
Parameters:
key - The service whose hint is to be looked up
Returns:
The value of the hint
Throws:
DomainException - If configuration or other internal errors happen
See Also:
Domain.getValue(org.keel.services.domain.Domain.DomainKey)

getUnconfigured

private java.lang.String getUnconfigured()
This the value returned, if a key is not configured

Returns:

configure

public void configure(Configuration configuration)
               throws ConfigurationException
Description copied from interface: Configurable
Pass the Configuration to the Configurable class.

Specified by:
configure in interface Configurable
Parameters:
configuration - the class configurations. Must not be null.
Throws:
ConfigurationException - if an error occurs
See Also:
Configurable.configure(org.apache.avalon.framework.configuration.Configuration)

Keel 2.1RC2

Please see keelframework.org for information about new Keel releases.