org.jibx.ws.wsdl.model

Class WsdlBase

java.lang.Object

org.jibx.ws.wsdl.model.WsdlBase

Direct Known Subclasses:

Definitions, OpenAttrBase

public abstract class WsdlBase
extends Object

Base class which provides validation hooks and support for extra namespaces. This base class for WSDL element representations is based on the schema data model code.

Author:

Dennis M. Sosnoski

Field Summary

Fields

Modifier and Type	Field and Description
static String	SOAP_NAMESPACE_URI Fixed URI for SOAP namespace.
static String	WSDL_NAMESPACE_URI Fixed URI for WSDL namespace.

Constructor Summary

Constructors

Constructor and Description
WsdlBase()

Method Summary

Methods

Modifier and Type	Method and Description
void	addNamespaceDeclaration(String prefix, String uri) Add namespace declaration.
void	clearNamespaceDeclarations() Clear namespace declarations list.
List	getDocumentation() Get documentation.
Object	getExtension() Get extension data.
List	getNamespaceDeclarations() Get namespace declarations list.
protected void	preget(IMarshallingContext ictx) Pre-get method to be called by data binding while writing element start tag.
protected void	preset(IUnmarshallingContext ictx) Pre-set method to be called by data binding while parsing element start tag.
void	prevalidate(ValidationContext vctx) Prevalidate component information.
protected void	readNamespaces(IUnmarshallingContext ictx) Collect namespace declarations from element.
void	setDocumentation(List documentation) Set documentation.
void	setExtension(Object extension) Set extension data.
void	validate(ValidationContext vctx) Validate component information.
protected void	validateAttributes(IUnmarshallingContext ictx, boolean other, StringArray attrs) Validate attributes of element.
protected void	writeNamespaces(IMarshallingContext ictx) Write namespace declarations to element.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

WSDL_NAMESPACE_URI

public static final String WSDL_NAMESPACE_URI

Fixed URI for WSDL namespace.

See Also:

Constant Field Values

SOAP_NAMESPACE_URI

public static final String SOAP_NAMESPACE_URI

Fixed URI for SOAP namespace.

See Also:

Constant Field Values

Constructor Detail

WsdlBase

public WsdlBase()

Method Detail

getExtension

public Object getExtension()

Get extension data. The actual type of object used for extension data (if any) is defined by the application.

Returns:

extension

setExtension

public void setExtension(Object extension)

Set extension data. The actual type of object used for extension data (if any) is defined by the application.

Parameters:

extension -

getNamespaceDeclarations

public final List getNamespaceDeclarations()

Get namespace declarations list. Entries in this list consist of pairs, consisting of namespace prefix followed by namespace URI. The empty string is used as the prefix for the default namespace.

Returns:

extra attribute list

clearNamespaceDeclarations

public final void clearNamespaceDeclarations()

Clear namespace declarations list.

addNamespaceDeclaration

public final void addNamespaceDeclaration(String prefix,
                           String uri)

Add namespace declaration.

Parameters:

prefix - namespace prefix

uri - namespace URI

getDocumentation

public List getDocumentation()

Get documentation. This is the content of the optional <documentation> child element, which consists of DOM Nodes.

Returns:

documentation (null if no documentation present)

setDocumentation

public void setDocumentation(List documentation)

Set documentation. This is the content of the optional <documentation> child element, which consists of DOM Nodes.

Parameters:

documentation -

preget

protected void preget(IMarshallingContext ictx)
               throws JiBXException

Pre-get method to be called by data binding while writing element start tag. The base class implementation just writes out any extra namespaces defined on the element. Subclasses which override this implementation must call the base implementation during their processing.

Parameters:

ictx - marshalling context

Throws:

JiBXException - on marshalling error

preset

protected void preset(IUnmarshallingContext ictx)
               throws JiBXException

Pre-set method to be called by data binding while parsing element start tag. The base class implementation just reads in any extra namespaces defined on the element. Subclasses which override this implementation must call the base implementation during their processing.

Parameters:

ictx - unmarshalling context

Throws:

JiBXException - on error

validateAttributes

protected void validateAttributes(IUnmarshallingContext ictx,
                      boolean other,
                      StringArray attrs)

Validate attributes of element. This is designed to be called during unmarshalling as part of the pre-set method processing when a subclass instance is being created. An error is reported if an element in the default namespace is not in the declared list,

Parameters:

ictx - unmarshalling context

other - attributes from other namespaces allowed flag

attrs - attributes array

See Also:

preset(IUnmarshallingContext)

readNamespaces

protected void readNamespaces(IUnmarshallingContext ictx)

Collect namespace declarations from element. This is designed to be called during unmarshalling as part of the pre-set method processing when a subclass instance is being created.

Parameters:

ictx - unmarshalling context

writeNamespaces

protected void writeNamespaces(IMarshallingContext ictx)
                        throws JiBXException

Write namespace declarations to element. This is designed to be called during marshalling as part of the pre-get method processing when a subclass instance is being marshalled.

Parameters:

ictx - marshalling context

Throws:

JiBXException - on error writing

prevalidate

public void prevalidate(ValidationContext vctx)

Prevalidate component information. The prevalidation step is used to check isolated aspects of a component, such as the settings for enumerated values. This empty base class implementation should be overridden by each subclass that requires prevalidation handling.

Parameters:

vctx - validation context

validate

public void validate(ValidationContext vctx)

Validate component information. The validation step is used for checking the interactions between components, such as name references to other components. The prevalidate(org.jibx.schema.validation.ValidationContext) method will always be called for every component in the schema definition before this method is called for any component. This empty base class implementation should be overridden by each subclass that requires validation handling.

Parameters:

vctx - validation context