edu.internet2.middleware.shibboleth.common.service
Interface Service

All Known Subinterfaces:
ReloadableService
All Known Implementing Classes:
BaseReloadableService, BaseService, SAMLMDRelyingPartyConfigurationManager, ServletContextAttributeExporter, ShibbolethAttributeFilteringEngine, ShibbolethAttributeResolver, ShibbolethSAML1AttributeAuthority, ShibbolethSAML2AttributeAuthority

public interface Service

A simple interface that represents coarse grained services, or components, within the software.


Method Summary
 void destroy()
          Destroys a service, freeing any resources it may currently be using.
 String getId()
          Gets the ID of this service.
 void initialize()
          Initializes this service.
 boolean isDestroyed()
          Gets whether the service has been destroyed.
 boolean isInitialized()
          Gets whether the service is initialized and ready for use.
 

Method Detail

getId

String getId()
Gets the ID of this service.

Returns:
ID of this service

isInitialized

boolean isInitialized()
Gets whether the service is initialized and ready for use.

Returns:
true if the service is ready for use, false it not

initialize

void initialize()
                throws ServiceException
Initializes this service. Calling this on an initialized service should return immediately without affecting any service state.

Throws:
ServiceException - thrown if there is a problem initializing the service

isDestroyed

boolean isDestroyed()
Gets whether the service has been destroyed.

Returns:
true if the service has been destroyed

destroy

void destroy()
             throws ServiceException
Destroys a service, freeing any resources it may currently be using. Whether a service can be re-initialized after being destroyed is implementation dependent.

Throws:
ServiceException - thrown if there is a problem destroying the service


Copyright © 1999-2012. All Rights Reserved.