Keel 2.1RC2

org.keel.core.container
Class AbstractKeelServiceable

java.lang.Object
  extended byorg.keel.core.container.AbstractKeelServiceable
All Implemented Interfaces:
Serviceable
Direct Known Subclasses:
AbstractAuthenticationManager, AbstractPersistentFactory, AbstractPersistentMetaData, BSFScript, ConfigAuthorizationManager, DBAuthorizationManager, DefaultQuery, DefaultReader, JellyScript, KeelServiceableDelegate, LoginHelper, LoginHelper, PersistGroup, PersistGroupManager, PersistUser, PersistUserManager

public abstract class AbstractKeelServiceable
extends java.lang.Object
implements Serviceable

Author:
Michael Nash, Shash Chatterjee A helper class to consolidate obtaining services in the Keel environment. All Keel classes that would normally implement Avalon's Serviceable interface should extend this class instead. For classes that already extend other classes, there is the KeelServiceableDelegate class that can be used to delegate service lookup. *

Field Summary
private  java.util.List components
          The list of components looked up via this class
private  KeelServiceManager serviceManager
          The parent service manager
 
Constructor Summary
AbstractKeelServiceable()
           
 
Method Summary
private  void addService(java.lang.Object o)
          Add a service to the list of retrieved services
private  void deleteService(java.lang.Object o)
          Delete a service from the list of retrieved services
 java.lang.Object getService(java.lang.String role)
          Lookup default service
 java.lang.Object getService(java.lang.String role, Context c)
          Lookup default service and set security context
 java.lang.Object getService(java.lang.String role, java.lang.String hint)
          Lookup a service
 java.lang.Object getService(java.lang.String role, java.lang.String hint, Context c)
          Lookup service and set security context
 ServiceManager getServiceManager()
          Return the parent service manager
 java.lang.Object getServiceSelector(java.lang.String role)
          Lookup service selector
 void releaseService(java.lang.Object o)
          Release a particular service
 void releaseServices()
          Release all services retrieved so far
 void service(ServiceManager parent)
          Sets the parent service manager to lookup services from
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

serviceManager

private KeelServiceManager serviceManager
The parent service manager


components

private java.util.List components
The list of components looked up via this class

Constructor Detail

AbstractKeelServiceable

public AbstractKeelServiceable()
Method Detail

service

public void service(ServiceManager parent)
             throws ServiceException
Sets the parent service manager to lookup services from

Specified by:
service in interface Serviceable
Parameters:
parent - The ServiceManager which this Serviceable uses. Must not be null.
Throws:
ServiceException - if an error occurs
See Also:
Serviceable.service(org.apache.avalon.framework.service.ServiceManager)

getServiceManager

public ServiceManager getServiceManager()
Return the parent service manager

Returns:
ServiceManager

getService

public java.lang.Object getService(java.lang.String role,
                                   java.lang.String hint)
                            throws ServiceException
Lookup a service

Parameters:
role - - The role for the service
hint - - Service shorthand, for a particular impl.
Returns:
Object - Cast to the correct service interface
Throws:
ServiceException

getService

public java.lang.Object getService(java.lang.String role,
                                   java.lang.String hint,
                                   Context c)
                            throws ServiceException
Lookup service and set security context

Parameters:
role - - The role for the service
hint - - Service shorthand, for a particular impl.
c - - Security context
Returns:
Object - Cast to the correct service interface
Throws:
ServiceException

getService

public java.lang.Object getService(java.lang.String role)
                            throws ServiceException
Lookup default service

Parameters:
role - - The role for the service
Returns:
Object - Cast to the correct service interface
Throws:
ServiceException

getService

public java.lang.Object getService(java.lang.String role,
                                   Context c)
                            throws ServiceException
Lookup default service and set security context

Parameters:
role - - The role for the service
c - - Security context
Returns:
Object - Cast to the correct service interface
Throws:
ServiceException

getServiceSelector

public java.lang.Object getServiceSelector(java.lang.String role)
                                    throws ServiceException
Lookup service selector

Parameters:
role - - The role for the service
Returns:
Object - Cast to the correct service interface
Throws:
ServiceException

addService

private void addService(java.lang.Object o)
Add a service to the list of retrieved services


deleteService

private void deleteService(java.lang.Object o)
Delete a service from the list of retrieved services


releaseServices

public void releaseServices()
Release all services retrieved so far


releaseService

public void releaseService(java.lang.Object o)
Release a particular service

Parameters:
o - Service to release

Keel 2.1RC2

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