DeploymentConfiguration

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS (src) NEXT CLASS (src)

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.enterprise.deploy.spi
Interface DeploymentConfiguration

All Known Implementing Classes:: DeploymentConfigurationImpl (src)

public interface DeploymentConfiguration

A container for server specific configuration for a top level deployment.

Method Summary
`DConfigBeanRoot (src)`	`getDConfigBeanRoot(DDBeanRoot (src) bean)` Return the top level configuration for a deployment descriptor
`DeployableObject (src)`	`getDeployableObject()` Return an object that provides access to the deployment descriptor
`void`	`removeDConfigBean(DConfigBeanRoot (src) bean)` Remove a root configuration and all its children
`void`	`restore(java.io.InputStream input)` Restores a full set of configuration beans
`DConfigBeanRoot (src)`	`restoreDConfigBean(java.io.InputStream input, DDBeanRoot (src) bean)` Restore a configuration from an input stream
`void`	`save(java.io.OutputStream output)` Saves the fulls set of configuration beans
`void`	`saveDConfigBean(java.io.OutputStream output, DConfigBeanRoot (src) bean)` Save a configuration to an output stream

Method Detail

getDeployableObject

public DeployableObject (src)  getDeployableObject()

Return an object that provides access to the deployment descriptor

Returns:: the deployable object

getDConfigBeanRoot

public DConfigBeanRoot (src)  getDConfigBeanRoot(DDBeanRoot (src)  bean)
                                   throws ConfigurationException (src)

Return the top level configuration for a deployment descriptor

Parameters:: bean - the root of the deployment descriptor
Returns:: the configuration
Throws:: ConfigurationException (src) - for an error in the deployment descriptor

removeDConfigBean

public void removeDConfigBean(DConfigBeanRoot (src)  bean)
                       throws BeanNotFoundException (src)

Remove a root configuration and all its children

Parameters:: bean - the configuration
Throws:: BeanNotFoundException (src) - when the bean is not found

restoreDConfigBean

public DConfigBeanRoot (src)  restoreDConfigBean(java.io.InputStream input,
                                          DDBeanRoot (src)  bean)
                                   throws ConfigurationException (src)

Restore a configuration from an input stream

Parameters:: input - the input stream; bean - the deployment descriptor
Returns:: the configuration
Throws:: ConfigurationException (src) - when there is an error in the configuration

saveDConfigBean

public void saveDConfigBean(java.io.OutputStream output,
                            DConfigBeanRoot (src)  bean)
                     throws ConfigurationException (src)

Save a configuration to an output stream

Parameters:: output - the output stream; bean - the configuration
Throws:: ConfigurationException (src) - when there is an error in the configuration

restore

public void restore(java.io.InputStream input)
             throws ConfigurationException (src)

Restores a full set of configuration beans

Parameters:: input - the input stream
Throws:: ConfigurationException (src) - for an error in the configuration

save

public void save(java.io.OutputStream output)
          throws ConfigurationException (src)

Saves the fulls set of configuration beans

Parameters:: output - the output stream
Throws:: ConfigurationException (src) - for an error in the configuration