RemoteEnvironment (JBoss Metadata Common 12.0.0.Beta1 API)

All Known Subinterfaces:

Environment, MutableEnvironment, MutableRemoteEnvironment

All Known Implementing Classes:

EnvironmentRefsGroupMetaData, JBossEnvironmentRefsGroupMetaData, JBossRemoteEnvironmentRefsGroupMetaData, RemoteEnvironmentRefsGroupMetaData
```
public interface RemoteEnvironment
```
Environment.

Version:

$Revision: 66852 $

Author:

Adrian Brock, Carlo de Wolf

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`AdministeredObjectMetaData`	`getAdministeredObjectByName(java.lang.String name)`	Retrieves by name.
`AdministeredObjectsMetaData`	`getAdministeredObjects()`	Retrieves the administeredObjects.
`AnnotatedEJBReferencesMetaData`	`getAnnotatedEjbReferences()`	Get the ejbReferences.
`ConnectionFactoriesMetaData`	`getConnectionFactories()`	Retrieves the connectionFactories.
`ConnectionFactoryMetaData`	`getConnectionFactoryByName(java.lang.String name)`	Retrieves by name.
`DataSourceMetaData`	`getDataSourceByName(java.lang.String name)`	Get by name
`DataSourcesMetaData`	`getDataSources()`	Get the dataSources.
`EJBReferenceMetaData`	`getEjbReferenceByName(java.lang.String name)`	Get by name
`EJBReferencesMetaData`	`getEjbReferences()`	Get the ejbReferences.
`EnvironmentEntriesMetaData`	`getEnvironmentEntries()`	Get the environmentEntries.
`EnvironmentEntryMetaData`	`getEnvironmentEntryByName(java.lang.String name)`	Get by name
`JMSConnectionFactoriesMetaData`	`getJmsConnectionFactories()`	Retrieves the jmsConnectionFactories.
`JMSConnectionFactoryMetaData`	`getJmsConnectionFactoryByName(java.lang.String name)`	Retrieves by name.
`JMSDestinationMetaData`	`getJmsDestinationByName(java.lang.String name)`	Retrieves by name.
`JMSDestinationsMetaData`	`getJmsDestinations()`	Retrieves the jmsDestinations.
`MailSessionMetaData`	`getMailSessionByName(java.lang.String name)`	Retrieves by name.
`MailSessionsMetaData`	`getMailSessions()`	Retrieves the mailSessions.
`MessageDestinationReferenceMetaData`	`getMessageDestinationReferenceByName(java.lang.String name)`	Get by name
`MessageDestinationReferencesMetaData`	`getMessageDestinationReferences()`	Get the messageDestinationReferences.
`PersistenceUnitReferenceMetaData`	`getPersistenceUnitReferenceByName(java.lang.String name)`	Get by name
`PersistenceUnitReferencesMetaData`	`getPersistenceUnitRefs()`	Get the persistenceUnitRefs.
`LifecycleCallbacksMetaData`	`getPostConstructs()`	Get the postConstructs.
`LifecycleCallbacksMetaData`	`getPreDestroys()`	Get the preDestroys.
`ResourceEnvironmentReferenceMetaData`	`getResourceEnvironmentReferenceByName(java.lang.String name)`	Get by name
`ResourceEnvironmentReferencesMetaData`	`getResourceEnvironmentReferences()`	Get the resourceEnvironmentReferences.
`ResourceReferenceMetaData`	`getResourceReferenceByName(java.lang.String name)`	Get by name
`ResourceReferencesMetaData`	`getResourceReferences()`	Get the resourceReferences.
`ServiceReferenceMetaData`	`getServiceReferenceByName(java.lang.String name)`	Get by name
`ServiceReferencesMetaData`	`getServiceReferences()`	Get the service references

- Method Detail
  - getEnvironmentEntries
```
EnvironmentEntriesMetaData getEnvironmentEntries()
```
    Get the environmentEntries.
    
    Returns:
    
    the environmentEntries.
  - getEnvironmentEntryByName
```
EnvironmentEntryMetaData getEnvironmentEntryByName(java.lang.String name)
```
    Get by name
    
    Parameters:
    
    name - the name
    
    Returns:
    
    the result or null if not found
    
    Throws:
    
    java.lang.IllegalArgumentException - for a null name
  - getEjbReferences
```
EJBReferencesMetaData getEjbReferences()
```
    Get the ejbReferences.
    
    Returns:
    
    the ejbReferences.
  - getAnnotatedEjbReferences
```
AnnotatedEJBReferencesMetaData getAnnotatedEjbReferences()
```
    Get the ejbReferences.
    
    Returns:
    
    the ejbReferences.
  - getEjbReferenceByName
```
EJBReferenceMetaData getEjbReferenceByName(java.lang.String name)
```
    Get by name
    
    Parameters:
    
    name - the name
    
    Returns:
    
    the result or null if not found
    
    Throws:
    
    java.lang.IllegalArgumentException - for a null name
  - getServiceReferences
```
ServiceReferencesMetaData getServiceReferences()
```
    Get the service references
    
    Returns:
  - getServiceReferenceByName
```
ServiceReferenceMetaData getServiceReferenceByName(java.lang.String name)
```
    Get by name
    
    Parameters:
    
    name - the name
    
    Returns:
    
    the result or null if not found
    
    Throws:
    
    java.lang.IllegalArgumentException - for a null name
  - getResourceReferences
```
ResourceReferencesMetaData getResourceReferences()
```
    Get the resourceReferences.
    
    Returns:
    
    the resourceReferences.
  - getResourceReferenceByName
```
ResourceReferenceMetaData getResourceReferenceByName(java.lang.String name)
```
    Get by name
    
    Parameters:
    
    name - the name
    
    Returns:
    
    the result or null if not found
    
    Throws:
    
    java.lang.IllegalArgumentException - for a null name
  - getResourceEnvironmentReferences
```
ResourceEnvironmentReferencesMetaData getResourceEnvironmentReferences()
```
    Get the resourceEnvironmentReferences.
    
    Returns:
    
    the resourceEnvironmentReferences.
  - getResourceEnvironmentReferenceByName
```
ResourceEnvironmentReferenceMetaData getResourceEnvironmentReferenceByName(java.lang.String name)
```
    Get by name
    
    Parameters:
    
    name - the name
    
    Returns:
    
    the result or null if not found
    
    Throws:
    
    java.lang.IllegalArgumentException - for a null name
  - getMessageDestinationReferences
```
MessageDestinationReferencesMetaData getMessageDestinationReferences()
```
    Get the messageDestinationReferences.
    
    Returns:
    
    the messageDestinationReferences.
  - getMessageDestinationReferenceByName
```
MessageDestinationReferenceMetaData getMessageDestinationReferenceByName(java.lang.String name)
```
    Get by name
    
    Parameters:
    
    name - the name
    
    Returns:
    
    the result or null if not found
    
    Throws:
    
    java.lang.IllegalArgumentException - for a null name
  - getPostConstructs
```
LifecycleCallbacksMetaData getPostConstructs()
```
    Get the postConstructs.
    
    Returns:
    
    the postConstructs.
  - getPreDestroys
```
LifecycleCallbacksMetaData getPreDestroys()
```
    Get the preDestroys.
    
    Returns:
    
    the preDestroys.
  - getPersistenceUnitRefs
```
PersistenceUnitReferencesMetaData getPersistenceUnitRefs()
```
    Get the persistenceUnitRefs.
    
    Returns:
    
    the persistenceUnitRefs.
  - getPersistenceUnitReferenceByName
```
PersistenceUnitReferenceMetaData getPersistenceUnitReferenceByName(java.lang.String name)
```
    Get by name
    
    Parameters:
    
    name - the name
    
    Returns:
    
    the result or null if not found
    
    Throws:
    
    java.lang.IllegalArgumentException - for a null name
  - getDataSources
```
DataSourcesMetaData getDataSources()
```
    Get the dataSources.
    
    Returns:
    
    the dataSources
  - getDataSourceByName
```
DataSourceMetaData getDataSourceByName(java.lang.String name)
```
    Get by name
    
    Parameters:
    
    name - the name
    
    Returns:
    
    the result or null if not found
    
    Throws:
    
    java.lang.IllegalArgumentException - for a null name
  - getAdministeredObjects
```
AdministeredObjectsMetaData getAdministeredObjects()
```
    Retrieves the administeredObjects.
    
    Returns:
  - getAdministeredObjectByName
```
AdministeredObjectMetaData getAdministeredObjectByName(java.lang.String name)
                                                throws java.lang.IllegalArgumentException
```
    Retrieves by name.
    
    Parameters:
    
    name - the name
    
    Returns:
    
    the result or null if not found
    
    Throws:
    
    java.lang.IllegalArgumentException - for a null name
  - getConnectionFactories
```
ConnectionFactoriesMetaData getConnectionFactories()
```
    Retrieves the connectionFactories.
    
    Returns:
  - getConnectionFactoryByName
```
ConnectionFactoryMetaData getConnectionFactoryByName(java.lang.String name)
                                              throws java.lang.IllegalArgumentException
```
    Retrieves by name.
    
    Parameters:
    
    name - the name
    
    Returns:
    
    the result or null if not found
    
    Throws:
    
    java.lang.IllegalArgumentException - for a null name
  - getJmsConnectionFactories
```
JMSConnectionFactoriesMetaData getJmsConnectionFactories()
```
    Retrieves the jmsConnectionFactories.
    
    Returns:
  - getJmsConnectionFactoryByName
```
JMSConnectionFactoryMetaData getJmsConnectionFactoryByName(java.lang.String name)
                                                    throws java.lang.IllegalArgumentException
```
    Retrieves by name.
    
    Parameters:
    
    name - the name
    
    Returns:
    
    the result or null if not found
    
    Throws:
    
    java.lang.IllegalArgumentException - for a null name
  - getJmsDestinations
```
JMSDestinationsMetaData getJmsDestinations()
```
    Retrieves the jmsDestinations.
    
    Returns:
  - getJmsDestinationByName
```
JMSDestinationMetaData getJmsDestinationByName(java.lang.String name)
                                        throws java.lang.IllegalArgumentException
```
    Retrieves by name.
    
    Parameters:
    
    name - the name
    
    Returns:
    
    the result or null if not found
    
    Throws:
    
    java.lang.IllegalArgumentException - for a null name
  - getMailSessions
```
MailSessionsMetaData getMailSessions()
```
    Retrieves the mailSessions.
    
    Returns:
  - getMailSessionByName
```
MailSessionMetaData getMailSessionByName(java.lang.String name)
                                  throws java.lang.IllegalArgumentException
```
    Retrieves by name.
    
    Parameters:
    
    name - the name
    
    Returns:
    
    the result or null if not found
    
    Throws:
    
    java.lang.IllegalArgumentException - for a null name

Interface RemoteEnvironment

Method Summary

Method Detail

getEnvironmentEntries

getEnvironmentEntryByName

getEjbReferences

getAnnotatedEjbReferences

getEjbReferenceByName

getServiceReferences

getServiceReferenceByName

getResourceReferences

getResourceReferenceByName

getResourceEnvironmentReferences

getResourceEnvironmentReferenceByName

getMessageDestinationReferences

getMessageDestinationReferenceByName

getPostConstructs

getPreDestroys

getPersistenceUnitRefs

getPersistenceUnitReferenceByName

getDataSources

getDataSourceByName

getAdministeredObjects

getAdministeredObjectByName

getConnectionFactories

getConnectionFactoryByName

getJmsConnectionFactories

getJmsConnectionFactoryByName

getJmsDestinations

getJmsDestinationByName

getMailSessions

getMailSessionByName