xdoclet.modules.ejb.intf

Class ServiceEndpointSubTask

public class ServiceEndpointSubTask extends AbstractEjbCodeGeneratorSubTask

Generates service endpoint interfaces for JAXPRC beans.

Since: 22.12.03

Version: $Revision: 1.2 $

Author: Christoph G. Jung (christoph.jung@infor.de)

UNKNOWN: 24. Februar 2004 display-name = "Service-Endpoint Interface" name = "service-endpoint" parent = "xdoclet.modules.ejb.EjbDocletTask" file = "service-endpoint-custom.xdt" relates-to = "{0}.java" description = "A text file containing * custom template and/or java code to include in the service-endpoint interface."

Field Summary
static String	DEFAULT_SERVICE_ENDPOINT_CLASS_PATTERN
protected static String	DEFAULT_TEMPLATE_FILE
protected String	serviceEndpointClassPattern A configuration parameter for specifying the service-endpoint interface name pattern.

Constructor Summary
	ServiceEndpointSubTask() Describe what the ServiceEndpointSubTask constructor does

Method Summary
protected void	engineStarted() Describe what the method does
protected String	getGeneratedFileName(XClass clazz) Gets the GeneratedFileName attribute of the ServiceEndpointInterfaceSubTask object
String	getServiceEndpointClassPattern() Returns the configuration parameter for specifying the service-endpoint interface name pattern.
protected boolean	matchesGenerationRules(XClass clazz) Describe what the method does
void	setPattern(String newPattern) The pattern by which the interfaces are named.
void	validateOptions() Called to validate configuration parameters.

Field Detail

DEFAULT_SERVICE_ENDPOINT_CLASS_PATTERN

public static final String DEFAULT_SERVICE_ENDPOINT_CLASS_PATTERN

DEFAULT_TEMPLATE_FILE

protected static final String DEFAULT_TEMPLATE_FILE

serviceEndpointClassPattern

protected String serviceEndpointClassPattern

A configuration parameter for specifying the service-endpoint interface name pattern. By default the value is used for deciding the service-endpoint interface name. {0} in the value mean current class's symbolic name which for an EJBean is the EJB name.

Constructor Detail

ServiceEndpointSubTask

public ServiceEndpointSubTask()

Describe what the ServiceEndpointSubTask constructor does

Method Detail

engineStarted

protected void engineStarted()

Describe what the method does

Throws: XDocletException

getGeneratedFileName

protected String getGeneratedFileName(XClass clazz)

Gets the GeneratedFileName attribute of the ServiceEndpointInterfaceSubTask object

Parameters: clazz Describe what the parameter does

Returns: The GeneratedFileName value

Throws: XDocletException

getServiceEndpointClassPattern

public String getServiceEndpointClassPattern()

Returns the configuration parameter for specifying the service-endpoint interface name pattern. By default the value is used for deciding the service-endpoint interface name. {0} in the value mean current class's symbolic name which for an EJBean is the EJB name. If nothing explicitly specified by user then "{0}" is used by default.

Returns: The ServiceEndpointClassPattern value

matchesGenerationRules

protected boolean matchesGenerationRules(XClass clazz)

Describe what the method does

Parameters: clazz Describe what the parameter does

Returns: Describe the return value

Throws: XDocletException

setPattern

public void setPattern(String newPattern)

The pattern by which the interfaces are named. {0} designates the EJB name.

Parameters: newPattern The new Pattern value

UNKNOWN: No,defaultsto {0}

validateOptions

public void validateOptions()

Called to validate configuration parameters.

Throws: XDocletException