org.ow2.util.ee.metadata.common.api.xml.struct
Interface IEnvironment

All Superinterfaces:
Serializable

public interface IEnvironment
extends Serializable

Environment used by beans.

Author:
Florent Benoit

Method Summary
 void addAroundInvoke(IAroundInvoke aroundInvoke)
          Adds a new <around-invoke> element to assembly descriptor.
 void addDataSource(IDataSource dataSource)
           
 void addEJBLocalRef(IEJBLocalRef ejLocalRef)
          Adds a new <ejb-local-ref> element.
 void addEJBRef(IEJBRef ejbRef)
          Adds a new <ejb-ref> element.
 void addEnvEntry(IEnvEntry envEntry)
          Add a new env-entry element to this object.
 void addMessageDestinationRef(IMessageDestinationRef messageDestinationRef)
          Adds a new <message-destination-ref> element.
 void addPersistenceContextRef(IPersistenceContextRef persistenceContextRef)
          Adds a new <persistence-context-ref> element.
 void addPersistenceUnitRef(IPersistenceUnitRef persistenceUnitRef)
          Adds a new <persistence-unit-ref> element.
 void addPostActivateCallback(ILifeCycleCallback postActivateCallback)
          Adds a new <post-activate> element to assembly descriptor.
 void addPostConstructCallback(ILifeCycleCallback postConstructCallback)
          Adds a new <post-construct> element to assembly descriptor.
 void addPreDestroyCallback(ILifeCycleCallback preDestroyCallback)
          Adds a new <pre-destroy> element to assembly descriptor.
 void addPrePassivateCallback(ILifeCycleCallback prePassivateCallback)
          Adds a new <pre-passivate> element to assembly descriptor.
 void addResourceEnvRef(IResourceEnvRef resourceEnvRef)
          Adds a new <resource-ref> element.
 void addResourceRef(IResourceRef resourceRef)
          Adds a new <resource-ref> element.
 void addSecurityRoleRef(ISecurityRoleRef securityRoleRef)
          Adds a new <security-role-ref> element.
 void addServiceRef(IServiceRef serviceRef)
          Adds a new <service-ref> element.
 List<IAroundInvoke> getAroundInvokeList()
          Gets the list of <around-invoke> elements.
 List<IDataSource> getDataSourceList()
           
 List<IEJBLocalRef> getEJBLocalRefList()
          Gets the list of <ejb-local-ref> elements.
 List<IEJBRef> getEJBRefList()
          Gets the list of <ejb-ref> elements.
 List<IEnvEntry> getEnvEntryList()
           
 List<IMessageDestinationRef> getMessageDestinationRefList()
          Gets the list of <message-destination-ref> elements.
 List<IPersistenceContextRef> getPersistenceContextRefList()
          Gets the list of <persistence-context-ref> elements.
 List<IPersistenceUnitRef> getPersistenceUnitRefList()
          Gets the list of <persistence-unit-ref> elements.
 List<ILifeCycleCallback> getPostActivateCallbackList()
          Gets the list of <post-activate> elements.
 List<ILifeCycleCallback> getPostConstructCallbackList()
          Gets the list of <post-construct> elements.
 List<ILifeCycleCallback> getPreDestroyCallbackList()
          Gets the list of <pre-destroy> elements.
 List<ILifeCycleCallback> getPrePassivateCallbackList()
          Gets the list of <pre-passivate> elements.
 List<IResourceEnvRef> getResourceEnvRefList()
          Gets the list of <resource-env-ref> elements.
 List<IResourceRef> getResourceRefList()
          Gets the list of <resource-ref> elements.
 List<ISecurityRoleRef> getSecurityRoleRefList()
          Gets the list of <security-role-ref> elements.
 List<IServiceRef> getServiceRefList()
          Gets the list of <service-ref> elements.
 

Method Detail

addEnvEntry

void addEnvEntry(IEnvEntry envEntry)
Add a new env-entry element to this object.

Parameters:
envEntry - the ejb-ref object

getEnvEntryList

List<IEnvEntry> getEnvEntryList()
Returns:
the list of all env-entry elements

getAroundInvokeList

List<IAroundInvoke> getAroundInvokeList()
Gets the list of <around-invoke> elements.

Returns:
list of <around-invoke> elements.

addAroundInvoke

void addAroundInvoke(IAroundInvoke aroundInvoke)
Adds a new <around-invoke> element to assembly descriptor.

Parameters:
aroundInvoke - the <around-invoke> element

getPostConstructCallbackList

List<ILifeCycleCallback> getPostConstructCallbackList()
Gets the list of <post-construct> elements.

Returns:
list of <post-construct> elements.

addPostConstructCallback

void addPostConstructCallback(ILifeCycleCallback postConstructCallback)
Adds a new <post-construct> element to assembly descriptor.

Parameters:
postConstructCallback - the <post-construct> element

getPostActivateCallbackList

List<ILifeCycleCallback> getPostActivateCallbackList()
Gets the list of <post-activate> elements.

Returns:
list of <post-activate> elements.

addPostActivateCallback

void addPostActivateCallback(ILifeCycleCallback postActivateCallback)
Adds a new <post-activate> element to assembly descriptor.

Parameters:
postActivateCallback - the <post-activate> element

getPreDestroyCallbackList

List<ILifeCycleCallback> getPreDestroyCallbackList()
Gets the list of <pre-destroy> elements.

Returns:
list of <pre-destroy> elements.

addPreDestroyCallback

void addPreDestroyCallback(ILifeCycleCallback preDestroyCallback)
Adds a new <pre-destroy> element to assembly descriptor.

Parameters:
preDestroyCallback - the <pre-destroy> element

getPrePassivateCallbackList

List<ILifeCycleCallback> getPrePassivateCallbackList()
Gets the list of <pre-passivate> elements.

Returns:
list of <pre-passivate> elements.

addPrePassivateCallback

void addPrePassivateCallback(ILifeCycleCallback prePassivateCallback)
Adds a new <pre-passivate> element to assembly descriptor.

Parameters:
prePassivateCallback - the <pre-passivate> element

getEJBRefList

List<IEJBRef> getEJBRefList()
Gets the list of <ejb-ref> elements.

Returns:
list of <ejb-ref> elements.

addEJBRef

void addEJBRef(IEJBRef ejbRef)
Adds a new <ejb-ref> element.

Parameters:
ejbRef - the <ejb-ref> element

getResourceRefList

List<IResourceRef> getResourceRefList()
Gets the list of <resource-ref> elements.

Returns:
list of <resource-ref> elements.

addResourceRef

void addResourceRef(IResourceRef resourceRef)
Adds a new <resource-ref> element.

Parameters:
resourceRef - the <resource-ref> element

getMessageDestinationRefList

List<IMessageDestinationRef> getMessageDestinationRefList()
Gets the list of <message-destination-ref> elements.

Returns:
list of <message-destination-ref> elements.

addMessageDestinationRef

void addMessageDestinationRef(IMessageDestinationRef messageDestinationRef)
Adds a new <message-destination-ref> element.

Parameters:
messageDestinationRef - the <message-destination-ref> element

getServiceRefList

List<IServiceRef> getServiceRefList()
Gets the list of <service-ref> elements.

Returns:
list of <service-ref> elements.

addServiceRef

void addServiceRef(IServiceRef serviceRef)
Adds a new <service-ref> element.

Parameters:
serviceRef - the <service-ref> element

getResourceEnvRefList

List<IResourceEnvRef> getResourceEnvRefList()
Gets the list of <resource-env-ref> elements.

Returns:
list of <resource-env-ref> elements.

addResourceEnvRef

void addResourceEnvRef(IResourceEnvRef resourceEnvRef)
Adds a new <resource-ref> element.

Parameters:
resourceEnvRef - the <resource-ref> element

getEJBLocalRefList

List<IEJBLocalRef> getEJBLocalRefList()
Gets the list of <ejb-local-ref> elements.

Returns:
list of <ejb-local-ref> elements.

addEJBLocalRef

void addEJBLocalRef(IEJBLocalRef ejLocalRef)
Adds a new <ejb-local-ref> element.

Parameters:
ejLocalRef - the <ejb-local-ref> element

getPersistenceUnitRefList

List<IPersistenceUnitRef> getPersistenceUnitRefList()
Gets the list of <persistence-unit-ref> elements.

Returns:
list of <persistence-unit-ref> elements.

addPersistenceUnitRef

void addPersistenceUnitRef(IPersistenceUnitRef persistenceUnitRef)
Adds a new <persistence-unit-ref> element.

Parameters:
persistenceUnitRef - the <persistence-unit-ref> element

getPersistenceContextRefList

List<IPersistenceContextRef> getPersistenceContextRefList()
Gets the list of <persistence-context-ref> elements.

Returns:
list of <persistence-context-ref> elements.

addPersistenceContextRef

void addPersistenceContextRef(IPersistenceContextRef persistenceContextRef)
Adds a new <persistence-context-ref> element.

Parameters:
persistenceContextRef - the <persistence-context-ref> element

getSecurityRoleRefList

List<ISecurityRoleRef> getSecurityRoleRefList()
Gets the list of <security-role-ref> elements.

Returns:
list of <security-role-ref> elements.

addSecurityRoleRef

void addSecurityRoleRef(ISecurityRoleRef securityRoleRef)
Adds a new <security-role-ref> element.

Parameters:
ejLocalRef - the <security-role-ref> element

getDataSourceList

List<IDataSource> getDataSourceList()

addDataSource

void addDataSource(IDataSource dataSource)


Copyright © 2007-2012 OW2 Consortium. All Rights Reserved.