RemoteEnvironmentRefsGroupMetaData (JBoss Metadata Common 10.0.2.Final API)

java.lang.Object
- org.jboss.metadata.javaee.spec.RemoteEnvironmentRefsGroupMetaData

All Implemented Interfaces:

Serializable, MutableRemoteEnvironment, RemoteEnvironment

Direct Known Subclasses:

EnvironmentRefsGroupMetaData, JBossEnvironmentRefsGroupMetaData, JBossRemoteEnvironmentRefsGroupMetaData
```
public class RemoteEnvironmentRefsGroupMetaData
extends Object
implements Serializable, RemoteEnvironment, MutableRemoteEnvironment
```
References which are only available remote (for application clients).

Version:

$Revision: 76290 $

Author:

Adrian Brock, Carlo de Wolf

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

RemoteEnvironmentRefsGroupMetaData()
Create a new EnvironmentRefsGroupMetaData.

Constructors
Constructor and Description
`RemoteEnvironmentRefsGroupMetaData()` Create a new EnvironmentRefsGroupMetaData.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`LifecycleCallbacksMetaData`	`addAll(LifecycleCallbacksMetaData current, LifecycleCallbacksMetaData additions)`
`AdministeredObjectMetaData`	`getAdministeredObjectByName(String name)` Retrieves by name.
`AdministeredObjectsMetaData`	`getAdministeredObjects()` Retrieves the administeredObjects.
`AnnotatedEJBReferencesMetaData`	`getAnnotatedEjbReferences()` Get the ejbReferences.
`ConnectionFactoriesMetaData`	`getConnectionFactories()` Retrieves the connectionFactories.
`ConnectionFactoryMetaData`	`getConnectionFactoryByName(String name)` Retrieves by name.
`DataSourceMetaData`	`getDataSourceByName(String name)` Get by name
`DataSourcesMetaData`	`getDataSources()` Get the dataSources.
`static DataSourcesMetaData`	`getDataSources(Environment env)`
`EJBReferenceMetaData`	`getEjbReferenceByName(String name)` Get by name
`EJBReferencesMetaData`	`getEjbReferences()` Get the ejbReferences.
`EnvironmentEntriesMetaData`	`getEnvironmentEntries()` Get the environmentEntries.
`EnvironmentEntryMetaData`	`getEnvironmentEntryByName(String name)` Get by name
`JMSConnectionFactoriesMetaData`	`getJmsConnectionFactories()` Retrieves the jmsConnectionFactories.
`JMSConnectionFactoryMetaData`	`getJmsConnectionFactoryByName(String name)` Retrieves by name.
`JMSDestinationMetaData`	`getJmsDestinationByName(String name)` Retrieves by name.
`JMSDestinationsMetaData`	`getJmsDestinations()` Retrieves the jmsDestinations.
`MailSessionMetaData`	`getMailSessionByName(String name)` Retrieves by name.
`MailSessionsMetaData`	`getMailSessions()` Retrieves the mailSessions.
`MessageDestinationReferenceMetaData`	`getMessageDestinationReferenceByName(String name)` Get by name
`MessageDestinationReferencesMetaData`	`getMessageDestinationReferences()` Get the messageDestinationReferences.
`PersistenceUnitReferenceMetaData`	`getPersistenceUnitReferenceByName(String name)` Get by name
`PersistenceUnitReferencesMetaData`	`getPersistenceUnitRefs()` Get the persistenceUnitRefs.
`LifecycleCallbacksMetaData`	`getPostConstructs()` Get the postConstructs.
`LifecycleCallbacksMetaData`	`getPreDestroys()` Get the preDestroys.
`ResourceEnvironmentReferenceMetaData`	`getResourceEnvironmentReferenceByName(String name)` Get by name
`ResourceEnvironmentReferencesMetaData`	`getResourceEnvironmentReferences()` Get the resourceEnvironmentReferences.
`ResourceReferenceMetaData`	`getResourceReferenceByName(String name)` Get by name
`ResourceReferencesMetaData`	`getResourceReferences()` Get the resourceReferences.
`ServiceReferenceMetaData`	`getServiceReferenceByName(String name)` Get by name
`ServiceReferencesMetaData`	`getServiceReferences()` Get the serviceReferences.
`void`	`setAdministeredObjects(AdministeredObjectsMetaData administeredObjects)` Sets administeredObjects.
`void`	`setAnnotatedEjbReferences(AnnotatedEJBReferencesMetaData annotatedEjbReferences)` Set the annotatedEjbReferences.
`void`	`setConnectionFactories(ConnectionFactoriesMetaData connectionFactories)` Sets connectionFactories.
`void`	`setDataSources(DataSourcesMetaData dataSources)` Set the dataSources.
`void`	`setEjbReferences(EJBReferencesMetaData ejbReferences)` Set the ejbReferences.
`void`	`setEnvironmentEntries(EnvironmentEntriesMetaData environmentEntries)` Set the environmentEntries.
`void`	`setJmsConnectionFactories(JMSConnectionFactoriesMetaData jmsConnectionFactories)` Sets jmsConnectionFactories.
`void`	`setJmsDestinations(JMSDestinationsMetaData jmsDestinations)` Sets jmsDestinations.
`void`	`setMailSessions(MailSessionsMetaData mailSessions)` Sets mailSessions.
`void`	`setMessageDestinationReferences(MessageDestinationReferencesMetaData messageDestinationReferences)` Set the messageDestinationReferences.
`void`	`setPersistenceUnitRefs(PersistenceUnitReferencesMetaData persistenceUnitRefs)` Set the persistenceUnitRefs.
`void`	`setPostConstructs(LifecycleCallbacksMetaData postConstructs)` Set the postConstructs.
`void`	`setPreDestroys(LifecycleCallbacksMetaData preDestroys)` Set the preDestroys.
`void`	`setResourceEnvironmentReferences(ResourceEnvironmentReferencesMetaData resourceEnvironmentReferences)` Set the resourceEnvironmentReferences.
`void`	`setResourceReferences(ResourceReferencesMetaData resourceReferences)` Set the resourceReferences.
`void`	`setServiceReferences(ServiceReferencesMetaData serviceReferences)` Set the serviceReferences.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - RemoteEnvironmentRefsGroupMetaData
```
public RemoteEnvironmentRefsGroupMetaData()
```
    Create a new EnvironmentRefsGroupMetaData.
- Method Detail
  - addAll
```
public LifecycleCallbacksMetaData addAll(LifecycleCallbacksMetaData current,
                                         LifecycleCallbacksMetaData additions)
```
  - getEnvironmentEntries
```
public EnvironmentEntriesMetaData getEnvironmentEntries()
```
    Get the environmentEntries.
    
    Specified by:
    
    getEnvironmentEntries in interface RemoteEnvironment
    
    Returns:
    
    the environmentEntries.
  - setEnvironmentEntries
```
public void setEnvironmentEntries(EnvironmentEntriesMetaData environmentEntries)
```
    Set the environmentEntries.
    
    Specified by:
    
    setEnvironmentEntries in interface MutableRemoteEnvironment
    
    Parameters:
    
    environmentEntries - the environmentEntries.
    
    Throws:
    
    IllegalArgumentException - for a null environmentEntries
  - getEjbReferences
```
public EJBReferencesMetaData getEjbReferences()
```
    Get the ejbReferences.
    
    Specified by:
    
    getEjbReferences in interface RemoteEnvironment
    
    Returns:
    
    the ejbReferences.
  - setEjbReferences
```
public void setEjbReferences(EJBReferencesMetaData ejbReferences)
```
    Set the ejbReferences.
    
    Specified by:
    
    setEjbReferences in interface MutableRemoteEnvironment
    
    Parameters:
    
    ejbReferences - the ejbReferences.
    
    Throws:
    
    IllegalArgumentException - for a null ejbReferences
  - getAnnotatedEjbReferences
```
public AnnotatedEJBReferencesMetaData getAnnotatedEjbReferences()
```
    Description copied from interface: RemoteEnvironment
    
    Get the ejbReferences.
    
    Specified by:
    
    getAnnotatedEjbReferences in interface RemoteEnvironment
    
    Returns:
    
    the ejbReferences.
  - setAnnotatedEjbReferences
```
public void setAnnotatedEjbReferences(AnnotatedEJBReferencesMetaData annotatedEjbReferences)
```
    Description copied from interface: MutableRemoteEnvironment
    
    Set the annotatedEjbReferences.
    
    Specified by:
    
    setAnnotatedEjbReferences in interface MutableRemoteEnvironment
  - getServiceReferences
```
public ServiceReferencesMetaData getServiceReferences()
```
    Get the serviceReferences.
    
    Specified by:
    
    getServiceReferences in interface RemoteEnvironment
    
    Returns:
    
    the serviceReferences.
  - setServiceReferences
```
public void setServiceReferences(ServiceReferencesMetaData serviceReferences)
```
    Set the serviceReferences.
    
    Specified by:
    
    setServiceReferences in interface MutableRemoteEnvironment
    
    Parameters:
    
    serviceReferences - the serviceReferences.
    
    Throws:
    
    IllegalArgumentException - for a null serviceReferences
  - getResourceReferences
```
public ResourceReferencesMetaData getResourceReferences()
```
    Get the resourceReferences.
    
    Specified by:
    
    getResourceReferences in interface RemoteEnvironment
    
    Returns:
    
    the resourceReferences.
  - setResourceReferences
```
public void setResourceReferences(ResourceReferencesMetaData resourceReferences)
```
    Set the resourceReferences.
    
    Specified by:
    
    setResourceReferences in interface MutableRemoteEnvironment
    
    Parameters:
    
    resourceReferences - the resourceReferences.
    
    Throws:
    
    IllegalArgumentException - for a null resourceReferences
  - getResourceEnvironmentReferences
```
public ResourceEnvironmentReferencesMetaData getResourceEnvironmentReferences()
```
    Get the resourceEnvironmentReferences.
    
    Specified by:
    
    getResourceEnvironmentReferences in interface RemoteEnvironment
    
    Returns:
    
    the resourceEnvironmentReferences.
  - setResourceEnvironmentReferences
```
public void setResourceEnvironmentReferences(ResourceEnvironmentReferencesMetaData resourceEnvironmentReferences)
```
    Set the resourceEnvironmentReferences.
    
    Specified by:
    
    setResourceEnvironmentReferences in interface MutableRemoteEnvironment
    
    Parameters:
    
    resourceEnvironmentReferences - the resourceEnvironmentReferences.
    
    Throws:
    
    IllegalArgumentException - for a null resourceEnvironmentReferences
  - getMessageDestinationReferences
```
public MessageDestinationReferencesMetaData getMessageDestinationReferences()
```
    Get the messageDestinationReferences.
    
    Specified by:
    
    getMessageDestinationReferences in interface RemoteEnvironment
    
    Returns:
    
    the messageDestinationReferences.
  - setMessageDestinationReferences
```
public void setMessageDestinationReferences(MessageDestinationReferencesMetaData messageDestinationReferences)
```
    Set the messageDestinationReferences.
    
    Specified by:
    
    setMessageDestinationReferences in interface MutableRemoteEnvironment
    
    Parameters:
    
    messageDestinationReferences - the messageDestinationReferences.
    
    Throws:
    
    IllegalArgumentException - for a null messageDestinationReferences
  - getPostConstructs
```
public LifecycleCallbacksMetaData getPostConstructs()
```
    Get the postConstructs.
    
    Specified by:
    
    getPostConstructs in interface RemoteEnvironment
    
    Returns:
    
    the postConstructs.
  - setPostConstructs
```
public void setPostConstructs(LifecycleCallbacksMetaData postConstructs)
```
    Set the postConstructs.
    
    Specified by:
    
    setPostConstructs in interface MutableRemoteEnvironment
    
    Parameters:
    
    postConstructs - the postConstructs.
    
    Throws:
    
    IllegalArgumentException - for a null postConstructs
  - getPreDestroys
```
public LifecycleCallbacksMetaData getPreDestroys()
```
    Get the preDestroys.
    
    Specified by:
    
    getPreDestroys in interface RemoteEnvironment
    
    Returns:
    
    the preDestroys.
  - setPreDestroys
```
public void setPreDestroys(LifecycleCallbacksMetaData preDestroys)
```
    Set the preDestroys.
    
    Specified by:
    
    setPreDestroys in interface MutableRemoteEnvironment
    
    Parameters:
    
    preDestroys - the preDestroys.
    
    Throws:
    
    IllegalArgumentException - for a null preDestroys
  - getPersistenceUnitRefs
```
public PersistenceUnitReferencesMetaData getPersistenceUnitRefs()
```
    Get the persistenceUnitRefs.
    
    Specified by:
    
    getPersistenceUnitRefs in interface RemoteEnvironment
    
    Returns:
    
    the persistenceUnitRefs.
  - setPersistenceUnitRefs
```
public void setPersistenceUnitRefs(PersistenceUnitReferencesMetaData persistenceUnitRefs)
```
    Set the persistenceUnitRefs.
    
    Specified by:
    
    setPersistenceUnitRefs in interface MutableRemoteEnvironment
    
    Parameters:
    
    persistenceUnitRefs - the persistenceUnitRefs.
    
    Throws:
    
    IllegalArgumentException - for a null persistenceUnitRefs
  - getEjbReferenceByName
```
public EJBReferenceMetaData getEjbReferenceByName(String name)
```
    Description copied from interface: RemoteEnvironment
    
    Get by name
    
    Specified by:
    
    getEjbReferenceByName in interface RemoteEnvironment
    
    Parameters:
    
    name - the name
    
    Returns:
    
    the result or null if not found
  - getEnvironmentEntryByName
```
public EnvironmentEntryMetaData getEnvironmentEntryByName(String name)
```
    Description copied from interface: RemoteEnvironment
    
    Get by name
    
    Specified by:
    
    getEnvironmentEntryByName in interface RemoteEnvironment
    
    Parameters:
    
    name - the name
    
    Returns:
    
    the result or null if not found
  - getMessageDestinationReferenceByName
```
public MessageDestinationReferenceMetaData getMessageDestinationReferenceByName(String name)
```
    Description copied from interface: RemoteEnvironment
    
    Get by name
    
    Specified by:
    
    getMessageDestinationReferenceByName in interface RemoteEnvironment
    
    Parameters:
    
    name - the name
    
    Returns:
    
    the result or null if not found
  - getPersistenceUnitReferenceByName
```
public PersistenceUnitReferenceMetaData getPersistenceUnitReferenceByName(String name)
```
    Description copied from interface: RemoteEnvironment
    
    Get by name
    
    Specified by:
    
    getPersistenceUnitReferenceByName in interface RemoteEnvironment
    
    Parameters:
    
    name - the name
    
    Returns:
    
    the result or null if not found
  - getResourceEnvironmentReferenceByName
```
public ResourceEnvironmentReferenceMetaData getResourceEnvironmentReferenceByName(String name)
```
    Description copied from interface: RemoteEnvironment
    
    Get by name
    
    Specified by:
    
    getResourceEnvironmentReferenceByName in interface RemoteEnvironment
    
    Parameters:
    
    name - the name
    
    Returns:
    
    the result or null if not found
  - getResourceReferenceByName
```
public ResourceReferenceMetaData getResourceReferenceByName(String name)
```
    Description copied from interface: RemoteEnvironment
    
    Get by name
    
    Specified by:
    
    getResourceReferenceByName in interface RemoteEnvironment
    
    Parameters:
    
    name - the name
    
    Returns:
    
    the result or null if not found
  - getServiceReferenceByName
```
public ServiceReferenceMetaData getServiceReferenceByName(String name)
```
    Description copied from interface: RemoteEnvironment
    
    Get by name
    
    Specified by:
    
    getServiceReferenceByName in interface RemoteEnvironment
    
    Parameters:
    
    name - the name
    
    Returns:
    
    the result or null if not found
  - getDataSources
```
public DataSourcesMetaData getDataSources()
```
    Description copied from interface: RemoteEnvironment
    
    Get the dataSources.
    
    Specified by:
    
    getDataSources in interface RemoteEnvironment
    
    Returns:
    
    the dataSources
  - setDataSources
```
public void setDataSources(DataSourcesMetaData dataSources)
```
    Description copied from interface: MutableRemoteEnvironment
    
    Set the dataSources.
    
    Specified by:
    
    setDataSources in interface MutableRemoteEnvironment
  - getDataSourceByName
```
public DataSourceMetaData getDataSourceByName(String name)
```
    Description copied from interface: RemoteEnvironment
    
    Get by name
    
    Specified by:
    
    getDataSourceByName in interface RemoteEnvironment
    
    Parameters:
    
    name - the name
    
    Returns:
    
    the result or null if not found
  - getDataSources
```
public static DataSourcesMetaData getDataSources(Environment env)
```
  - getAdministeredObjects
```
public AdministeredObjectsMetaData getAdministeredObjects()
```
    Description copied from interface: RemoteEnvironment
    
    Retrieves the administeredObjects.
    
    Specified by:
    
    getAdministeredObjects in interface RemoteEnvironment
    
    Returns:
  - setAdministeredObjects
```
public void setAdministeredObjects(AdministeredObjectsMetaData administeredObjects)
                            throws IllegalArgumentException
```
    Sets administeredObjects.
    
    Parameters:
    
    administeredObjects -
    
    Throws:
    
    IllegalArgumentException - for a null arg
  - getAdministeredObjectByName
```
public AdministeredObjectMetaData getAdministeredObjectByName(String name)
                                                       throws IllegalArgumentException
```
    Description copied from interface: RemoteEnvironment
    
    Retrieves by name.
    
    Specified by:
    
    getAdministeredObjectByName in interface RemoteEnvironment
    
    Parameters:
    
    name - the name
    
    Returns:
    
    the result or null if not found
    
    Throws:
    
    IllegalArgumentException - for a null name
  - getConnectionFactories
```
public ConnectionFactoriesMetaData getConnectionFactories()
```
    Description copied from interface: RemoteEnvironment
    
    Retrieves the connectionFactories.
    
    Specified by:
    
    getConnectionFactories in interface RemoteEnvironment
    
    Returns:
  - setConnectionFactories
```
public void setConnectionFactories(ConnectionFactoriesMetaData connectionFactories)
                            throws IllegalArgumentException
```
    Sets connectionFactories.
    
    Parameters:
    
    connectionFactories -
    
    Throws:
    
    IllegalArgumentException - for a null arg
  - getConnectionFactoryByName
```
public ConnectionFactoryMetaData getConnectionFactoryByName(String name)
                                                     throws IllegalArgumentException
```
    Description copied from interface: RemoteEnvironment
    
    Retrieves by name.
    
    Specified by:
    
    getConnectionFactoryByName in interface RemoteEnvironment
    
    Parameters:
    
    name - the name
    
    Returns:
    
    the result or null if not found
    
    Throws:
    
    IllegalArgumentException - for a null name
  - getJmsConnectionFactories
```
public JMSConnectionFactoriesMetaData getJmsConnectionFactories()
```
    Description copied from interface: RemoteEnvironment
    
    Retrieves the jmsConnectionFactories.
    
    Specified by:
    
    getJmsConnectionFactories in interface RemoteEnvironment
    
    Returns:
  - setJmsConnectionFactories
```
public void setJmsConnectionFactories(JMSConnectionFactoriesMetaData jmsConnectionFactories)
                               throws IllegalArgumentException
```
    Sets jmsConnectionFactories.
    
    Parameters:
    
    jmsConnectionFactories -
    
    Throws:
    
    IllegalArgumentException - for a null arg
  - getJmsConnectionFactoryByName
```
public JMSConnectionFactoryMetaData getJmsConnectionFactoryByName(String name)
                                                           throws IllegalArgumentException
```
    Description copied from interface: RemoteEnvironment
    
    Retrieves by name.
    
    Specified by:
    
    getJmsConnectionFactoryByName in interface RemoteEnvironment
    
    Parameters:
    
    name - the name
    
    Returns:
    
    the result or null if not found
    
    Throws:
    
    IllegalArgumentException - for a null name
  - getJmsDestinations
```
public JMSDestinationsMetaData getJmsDestinations()
```
    Description copied from interface: RemoteEnvironment
    
    Retrieves the jmsDestinations.
    
    Specified by:
    
    getJmsDestinations in interface RemoteEnvironment
    
    Returns:
  - setJmsDestinations
```
public void setJmsDestinations(JMSDestinationsMetaData jmsDestinations)
                        throws IllegalArgumentException
```
    Sets jmsDestinations.
    
    Parameters:
    
    jmsDestinations -
    
    Throws:
    
    IllegalArgumentException - for a null arg
  - getJmsDestinationByName
```
public JMSDestinationMetaData getJmsDestinationByName(String name)
                                               throws IllegalArgumentException
```
    Description copied from interface: RemoteEnvironment
    
    Retrieves by name.
    
    Specified by:
    
    getJmsDestinationByName in interface RemoteEnvironment
    
    Parameters:
    
    name - the name
    
    Returns:
    
    the result or null if not found
    
    Throws:
    
    IllegalArgumentException - for a null name
  - getMailSessions
```
public MailSessionsMetaData getMailSessions()
```
    Description copied from interface: RemoteEnvironment
    
    Retrieves the mailSessions.
    
    Specified by:
    
    getMailSessions in interface RemoteEnvironment
    
    Returns:
  - setMailSessions
```
public void setMailSessions(MailSessionsMetaData mailSessions)
                     throws IllegalArgumentException
```
    Sets mailSessions.
    
    Parameters:
    
    mailSessions -
    
    Throws:
    
    IllegalArgumentException - for a null arg
  - getMailSessionByName
```
public MailSessionMetaData getMailSessionByName(String name)
                                         throws IllegalArgumentException
```
    Description copied from interface: RemoteEnvironment
    
    Retrieves by name.
    
    Specified by:
    
    getMailSessionByName in interface RemoteEnvironment
    
    Parameters:
    
    name - the name
    
    Returns:
    
    the result or null if not found
    
    Throws:
    
    IllegalArgumentException - for a null name

Class RemoteEnvironmentRefsGroupMetaData

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RemoteEnvironmentRefsGroupMetaData

Method Detail

addAll

getEnvironmentEntries

setEnvironmentEntries

getEjbReferences

setEjbReferences

getAnnotatedEjbReferences

setAnnotatedEjbReferences

getServiceReferences

setServiceReferences

getResourceReferences

setResourceReferences

getResourceEnvironmentReferences

setResourceEnvironmentReferences

getMessageDestinationReferences

setMessageDestinationReferences

getPostConstructs

setPostConstructs

getPreDestroys

setPreDestroys

getPersistenceUnitRefs

setPersistenceUnitRefs

getEjbReferenceByName

getEnvironmentEntryByName

getMessageDestinationReferenceByName

getPersistenceUnitReferenceByName

getResourceEnvironmentReferenceByName

getResourceReferenceByName

getServiceReferenceByName

getDataSources

setDataSources

getDataSourceByName

getDataSources

getAdministeredObjects

setAdministeredObjects

getAdministeredObjectByName

getConnectionFactories

setConnectionFactories

getConnectionFactoryByName

getJmsConnectionFactories

setJmsConnectionFactories

getJmsConnectionFactoryByName

getJmsDestinations

setJmsDestinations

getJmsDestinationByName

getMailSessions

setMailSessions

getMailSessionByName