org.objectweb.jonas_ws.wsgen
Interface ConfigGenerator

All Known Implementing Classes:
AbsConfigGenerator

public interface ConfigGenerator

This interface provides methods used to generate configuration files for a Web services Engine.


Field Summary
static java.lang.String DEBUG
           
static java.lang.Boolean DEBUG_DEFAULT
           
static java.lang.String KEEP_GEN
           
static java.lang.String NO_CONFIG
           
static java.lang.Boolean NO_CONFIG_DEFAULT
           
static java.lang.String VERBOSE
           
static java.lang.Boolean VERBOSE_DEFAULT
           
 
Method Summary
 void genClientConfig(java.util.Iterator bdIt, java.lang.String filename)
          Generate client configuration files for each ServiceRef of bean descs.
 void genClientConfig(ServiceRef[] servRefs, java.lang.String filename)
          Generate client configuration files for the list of ServiceRef.
 void genEndpointConfig(WSDeploymentDesc dd, java.lang.String filename)
          Generate endpoint configuration files for the set of ServiceDesc included in WSDeploymentDesc.
 java.lang.String getDefaultMapping()
           
 java.lang.String getEngineWebApp()
          Return the webservices engine class name.
 java.lang.Object getOption(java.lang.String name)
          Get an option, return the option value or null if the option isn't set.
 java.lang.Object getOption(java.lang.String name, java.lang.Object defolt)
          Get an option, return the option value or default if the option isn't set.
 void setOption(java.lang.String name, java.lang.Object value)
          Set an option for generation.
 

Field Detail

VERBOSE

public static final java.lang.String VERBOSE
See Also:
Constant Field Values

DEBUG

public static final java.lang.String DEBUG
See Also:
Constant Field Values

NO_CONFIG

public static final java.lang.String NO_CONFIG
See Also:
Constant Field Values

KEEP_GEN

public static final java.lang.String KEEP_GEN
See Also:
Constant Field Values

VERBOSE_DEFAULT

public static final java.lang.Boolean VERBOSE_DEFAULT

DEBUG_DEFAULT

public static final java.lang.Boolean DEBUG_DEFAULT

NO_CONFIG_DEFAULT

public static final java.lang.Boolean NO_CONFIG_DEFAULT
Method Detail

getEngineWebApp

public java.lang.String getEngineWebApp()
                                 throws WsGenException
Return the webservices engine class name.

Returns:
the webservices engine class name.
Throws:
WsGenException - if the method isn't implemented

getDefaultMapping

public java.lang.String getDefaultMapping()

genEndpointConfig

public void genEndpointConfig(WSDeploymentDesc dd,
                              java.lang.String filename)
                       throws WsGenException
Generate endpoint configuration files for the set of ServiceDesc included in WSDeploymentDesc. Common method for all Web Services implementation (Glue/Axis).

Parameters:
dd - The DeploymentDesc to process (image of a webservices.xml)
filename - The war or jar being processed
Throws:
WsGenException - if generation fails

genClientConfig

public void genClientConfig(ServiceRef[] servRefs,
                            java.lang.String filename)
                     throws WsGenException
Generate client configuration files for the list of ServiceRef. Common method for all Web Services implementation (Glue/Axis).

Parameters:
servRefs - The list of ServiceRef to process.
filename - The war or jar being processed
Throws:
WsGenException - if generation fails

genClientConfig

public void genClientConfig(java.util.Iterator bdIt,
                            java.lang.String filename)
                     throws WsGenException
Generate client configuration files for each ServiceRef of bean descs. Common method for all Web Services implementation (Glue/Axis).

Parameters:
bdIt - an iterator on a bean desc list
filename - The war or jar being processed
Throws:
WsGenException - if generation fails

setOption

public void setOption(java.lang.String name,
                      java.lang.Object value)
Set an option for generation.

Parameters:
name - option name
value - option value

getOption

public java.lang.Object getOption(java.lang.String name,
                                  java.lang.Object defolt)
Get an option, return the option value or default if the option isn't set.

Parameters:
name - option name
defolt - option value
Returns:
the option value or default if the option isn't set.

getOption

public java.lang.Object getOption(java.lang.String name)
Get an option, return the option value or null if the option isn't set.

Parameters:
name - option name
Returns:
the option value or null if the option isn't set.