import SOAP-WSDL 2.00_29 from CPAN
git-cpan-module: SOAP-WSDL git-cpan-version: 2.00_29 git-cpan-authorid: MKUTTER git-cpan-file: authors/id/M/MK/MKUTTER/SOAP-WSDL-2.00_29.tar.gz
This commit is contained in:
Martin Kutter
committed by
Michael G. Schwern
Michael G. Schwern
parent
2bad767211
commit
874251225f
@@ -0,0 +1,49 @@
|
||||
=pod
|
||||
|
||||
=head1 NAME
|
||||
|
||||
SOAP::WSDL::Manual::Deserializer
|
||||
|
||||
=head1 DESERIALIZER CLASSES
|
||||
|
||||
Deserializer classes convert SOAP messages to perl data structures.
|
||||
|
||||
SOAP::WSDL comes with several builtin serializer classes:
|
||||
|
||||
=over
|
||||
|
||||
=item * L<SOAP::WSDL::Deserializer::XSD|SOAP::WSDL::Deserializer::XSD>
|
||||
|
||||
Creates SOAP::WSDL::XSD objects from SOAP messages. Default deserializer for
|
||||
generated interfaces and SOAP::WSDL::Client.
|
||||
|
||||
=item * L<SOAP::WSDL::Deserializer::Hash|SOAP::WSDL::Deserializer::Hash>
|
||||
|
||||
Creates perl hash structures from SOAP messages.
|
||||
|
||||
=item * L<SOAP::WSDL::Deserializer::SOM|SOAP::WSDL::Deserializer::SOM>
|
||||
|
||||
Creates SOAP::SOM objects from SOAP messages. Default deserializer for
|
||||
SOAP::WSDL.
|
||||
|
||||
See L<SOAP::Lite> for more information on SOAP::SOM objects.
|
||||
|
||||
=back
|
||||
|
||||
=head1 WRITING YOUR OWN DESERIALIZER
|
||||
|
||||
See L<SOAP::WSDL::Factory::Deserializer>.
|
||||
|
||||
=head1 LICENSE AND COPYRIGHT
|
||||
|
||||
Copyright 2007 Martin Kutter.
|
||||
|
||||
This file is part of SOAP-WSDL. You may distribute/modify it under the same
|
||||
terms as perl itself
|
||||
|
||||
=head1 AUTHOR
|
||||
|
||||
Martin Kutter E<lt>martin.kutter fen-net.deE<gt>
|
||||
|
||||
=cut
|
||||
|
||||
@@ -0,0 +1,99 @@
|
||||
=head1 NAME
|
||||
|
||||
SOAP::WSDL::Manual::Glossary - Those acronyms and stuff
|
||||
|
||||
=head1 Glossary
|
||||
|
||||
=head2 web service
|
||||
|
||||
Web services are RPC (Remote Procedure Call) interfaces accessible via
|
||||
some internet protocol, typically via HTTP(S).
|
||||
|
||||
=head2 SOAP
|
||||
|
||||
SOAP is (was - since 1.2 the name "SOAP" has no meaning any more) an acronym
|
||||
for Simple Object Access Protocol.
|
||||
SOAP is a W3C recommendation. The latest version of the SOAP specification
|
||||
may be found at L<http://www.w3.org/TR/soap/>.
|
||||
|
||||
SOAP defines a protocoll for message exchange between applications.
|
||||
The most popular usage is to use SOAP for remote procedure calls (RPC).
|
||||
|
||||
While one of the constituting aspects of a web service is its
|
||||
reachability via some internet protocol, you might as well define
|
||||
SOAP services accessible via postcards.
|
||||
|
||||
Despite it's former name, SOAP has nothing more to do with objects than
|
||||
cars have with pets - SOAP messages may, but not necessarily do
|
||||
carry objects, very much like your car may, but does not need to
|
||||
carry your pet.
|
||||
|
||||
=head2 WSDL
|
||||
|
||||
WSDL is an acronym for Web Services Description Language.
|
||||
WSDL is a W3C recommendation. The latest version of the WSDL specification
|
||||
may be found at L<http://www.w3.org/TR/wsdl20/>.
|
||||
|
||||
WSDL defines a XML-based language for describing web service interfaces,
|
||||
including SOAP interfaces.
|
||||
|
||||
=head2 WS-I
|
||||
|
||||
WS-I (Web Services Interoperability Organization) is an open industry
|
||||
organisation chartered to promote Web service interoperability across
|
||||
platforms, operating systems, and programming languages.
|
||||
|
||||
WS-I publishes profiles, which provide implementation guidelines for
|
||||
how related Web services specifications should be used together for
|
||||
best interoperability. To date, WS-I has finalized the Basic Profile,
|
||||
Attachments Profile and Simple SOAP Binding Profile.
|
||||
|
||||
SOAP::WSDL aims at complying to the WS-I Basic Profile (but does not
|
||||
implement full support yet).
|
||||
|
||||
=head2 SOAP message styles
|
||||
|
||||
=head3 rpc
|
||||
|
||||
Meant for transporting a RPC message. All contents of the SOAP body are
|
||||
put into a top-level node named equal to the SOAP operation.
|
||||
|
||||
WS-I Basic Profile allows the use of rpc message style.
|
||||
|
||||
SOAP::WSDL does not support rpc message style yet.
|
||||
|
||||
SOAP::Lite supports rpc message style only.
|
||||
|
||||
=head3 document
|
||||
|
||||
Meant for transporting arbitrary content. No additional nodes are inserted
|
||||
between the SOAP body and the actual content.
|
||||
|
||||
WS-I Basic Profile allows the use of document message style.
|
||||
|
||||
=head2 SOAP encoding styles
|
||||
|
||||
=head3 encoded
|
||||
|
||||
=head3 literal
|
||||
|
||||
=head1 LICENSE AND COPYRIGHT
|
||||
|
||||
Copyright 2007 Martin Kutter.
|
||||
|
||||
This file is part of SOAP-WSDL. You may distribute/modify it under the same
|
||||
terms as perl itself.
|
||||
|
||||
=head1 AUTHOR
|
||||
|
||||
Martin Kutter E<lt>martin.kutter fen-net.deE<gt>
|
||||
|
||||
=head1 REPOSITORY INFORMATION
|
||||
|
||||
$Rev: 391 $
|
||||
$LastChangedBy: kutterma $
|
||||
$Id: Glossary.pod 391 2007-11-17 21:56:13Z kutterma $
|
||||
$HeadURL: http://soap-wsdl.svn.sourceforge.net/svnroot/soap-wsdl/SOAP-WSDL/trunk/lib/SOAP/WSDL/Manual/Glossary.pod $
|
||||
|
||||
=cut
|
||||
|
||||
@@ -0,0 +1,247 @@
|
||||
=pod
|
||||
|
||||
=head1 NAME
|
||||
|
||||
SOAP::WSDL::Manual::Parser - How SOAP::WSDL parses XML messages
|
||||
|
||||
=head1 Which XML message does SOAP::WSDL parse ?
|
||||
|
||||
Naturally, there are two kinds of XML documents (or messages) SOAP::WSDL has
|
||||
to parse:
|
||||
|
||||
=over
|
||||
|
||||
=item * WSDL definitions
|
||||
|
||||
=item * SOAP messages
|
||||
|
||||
=back
|
||||
|
||||
There are different parser implementations available for SOAP messages and
|
||||
WSDL definitions.
|
||||
|
||||
=head1 WSDL definitions parser
|
||||
|
||||
=head2 SOAP::WSDL::Expat::WSDLParser
|
||||
|
||||
A parser for WSDL definitions based on L<XML::Parser::Expat|XML::Parser::Expat>.
|
||||
|
||||
my $parser = SOAP::WSDL::Expat::WSDLParser->new();
|
||||
my $wsdl = $parser->parse_file( $filename );
|
||||
|
||||
The WSDL parser creates a tree of perl objects, whose root is a
|
||||
L<SOAP::WSDL::Definitions|SOAP::WSDL::Definitions> element.
|
||||
|
||||
=head1 SOAP messages parser
|
||||
|
||||
=head2 SOAP::WSDL::Expat::MessageParser
|
||||
|
||||
L<SOAP::WSDL::Expat::MessageParser|SOAP::WSDL::Expat::MessageParser> converts
|
||||
SOAP messages to SOAP::WSDL::XSD object trees.
|
||||
|
||||
It uses a class resolvers for finding out which class
|
||||
a particular XML element should be of, and type libs containing these classes.
|
||||
|
||||
=head3 Creating a class resolver
|
||||
|
||||
The easiest way for creating a class resolver is to run SOAP::WSDL's generator.
|
||||
|
||||
See L<wsdl2perl.pl>.
|
||||
|
||||
The class resolver must implement a class method "get_class", which is passed
|
||||
a list ref of the current element's XPath (relative to Body), split by /.
|
||||
|
||||
This method must return a class name appropriate for a XML element.
|
||||
|
||||
A class resolver package might look like this:
|
||||
|
||||
package ClassResolver;
|
||||
|
||||
my %class_list = (
|
||||
'EnqueueMessage' => 'Typelib::TEnqueueMessage',
|
||||
'EnqueueMessage/MMessage' => 'Typelib::TMessage',
|
||||
'EnqueueMessage/MMessage/MRecipientURI' => 'SOAP::WSDL::XSD::Builtin::anyURI',
|
||||
'EnqueueMessage/MMessage/MMessageContent' => 'SOAP::WSDL::XSD::Builtin::string',
|
||||
);
|
||||
|
||||
sub new { return bless {}, 'ClassResolver' };
|
||||
|
||||
sub get_class {
|
||||
my $name = join('/', @{ $_[1] });
|
||||
return ($class_list{ $name }) ? $class_list{ $name }
|
||||
: warn "no class found for $name";
|
||||
};
|
||||
1;
|
||||
|
||||
=head3 Skipping unwanted items
|
||||
|
||||
Sometimes there's unneccessary information transported in SOAP messages.
|
||||
|
||||
To skip XML nodes (including all child nodes), just edit the type map for
|
||||
the message and set the type map entry to '__SKIP__'.
|
||||
|
||||
In the example above, EnqueueMessage/StuffIDontNeed and all child elements
|
||||
are skipped.
|
||||
|
||||
my %class_list = (
|
||||
'EnqueueMessage' => 'Typelib::TEnqueueMessage',
|
||||
'EnqueueMessage/MMessage' => 'Typelib::TMessage',
|
||||
'EnqueueMessage/MMessage/MRecipientURI' => 'SOAP::WSDL::XSD::Builtin::anyURI',
|
||||
'EnqueueMessage/MMessage/MMessageContent' => 'SOAP::WSDL::XSD::Builtin::string',
|
||||
'EnqueueMessage/StuffIDontNeed' => '__SKIP__',
|
||||
'EnqueueMessage/StuffIDontNeed/Foo' => 'SOAP::WSDL::XSD::Builtin::string',
|
||||
'EnqueueMessage/StuffIDontNeed/Bar' => 'SOAP::WSDL::XSD::Builtin::string',
|
||||
);
|
||||
|
||||
Note that only SOAP::WSDL::Expat::MessageParser implements skipping elements
|
||||
at the time of writing.
|
||||
|
||||
=head3 Creating type lib classes
|
||||
|
||||
Every element must have a correspondent one in the type library.
|
||||
|
||||
Builtin types should be resolved as SOAP::WSDL::XSD::Builtin::* classes
|
||||
|
||||
Creating a type lib is easy: Just run SOAP::WSDL's generator - it will
|
||||
create both a typemap and the type lib classes for a WSDL file.
|
||||
|
||||
Sometimes it is nessecary to create type lib classes by hand - not all
|
||||
WSDL definitions are complete.
|
||||
|
||||
For writing your own lib classes, see L<SOAP::WSDL::XSD::Typelib::Element>,
|
||||
L<SOAP::WSDL::XSD::Typelib::ComplexType> and L<SOAP::WSDL::XSD::Typelib::SimpleType>.
|
||||
|
||||
=head2 SOAP::WSDL::Expat::Message2Hash
|
||||
|
||||
Transforms a SOAP message into a perl hash refs. Using this parser is usually
|
||||
triggered by calling the C<outputhash> method of SOAP::WSDL, or by using
|
||||
L<SOAP::WSDL::Deserializer::Hash|SOAP::WSDL::Deserializer::Hash>.
|
||||
|
||||
Acts somewhat like XML::Simple, but faster.
|
||||
|
||||
The following restrictions apply:
|
||||
|
||||
=over
|
||||
|
||||
=item * Ignores all namespaces
|
||||
|
||||
=item * Ignores all attributes
|
||||
|
||||
=item * Does not handle mixed content
|
||||
|
||||
=item * The SOAP header is ignored
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
=head1 OLD SAX HANDLER
|
||||
|
||||
Historically, SOAP::WSDL used SAX for parsing XML. The SAX handlers were
|
||||
implemented as L<XML::LibXML|XML::LibXML> handlers, which also worked with
|
||||
L<XML::SAX::ParserFactory|XML::SAX::ParserFactory>.
|
||||
|
||||
Support for SAX and L<XML::LibXML|XML::LibXML> in SOAP::WSDL is discontinued
|
||||
for the following reasons:
|
||||
|
||||
=over
|
||||
|
||||
=item * Speed
|
||||
|
||||
L<XML::Parser::Expat|XML::Parser::Expat> is faster than
|
||||
L<XML::LibXML|XML::LibXML> - at least when optimized for speed.
|
||||
|
||||
High parsing speed is one of the key requirements for a SOAP toolkit - if XML
|
||||
serializing and (more important) deserializing are not fast enough, the whole
|
||||
toolkit is unusable.
|
||||
|
||||
=item * Availability
|
||||
|
||||
L<XML::Parser|XML::Parser> is more popular than L<XML::LibXML|XML::LibXML>.
|
||||
|
||||
=item * Stability
|
||||
|
||||
XML::LibXML is based on the libxml2 library. Several versions of
|
||||
libxml2 are known to have specific bugs. As a workaround, there are
|
||||
often several versions of libxml2 installed on one system. This may
|
||||
lead to problems on operating systems which cannot load more than
|
||||
one version of a shared library simultaneously.
|
||||
|
||||
XML::LibXML is also still under development, while XML::Parser has had time
|
||||
to stabilize.
|
||||
|
||||
=item * SOAP::Lite uses XML::Parser
|
||||
|
||||
L<SOAP::Lite|SOAP::Lite> uses L<XML::Parser|XML::Parser> if available.
|
||||
SOAP::WSDL should not require users to install both L<XML::Parser|XML::Parser>
|
||||
and L<XML::LibXML|XML::LibXML>.
|
||||
|
||||
=back
|
||||
|
||||
The old SAX handler historically used in SOAP::WSDL are not included in
|
||||
the SOAP::WSDL package any more.
|
||||
|
||||
However, they may be obtained from the "attic" directory in
|
||||
SOAP::WSDL's SVN repository at
|
||||
|
||||
https://soap-wsdl.svn.sourceforge.net/svnroot/soap-wsdl/SOAP-WSDL/trunk/attic
|
||||
|
||||
=over
|
||||
|
||||
=item * SOAP::WSDL::SAX::WSDLHandler
|
||||
|
||||
This is a SAX handler for parsing WSDL files into object trees SOAP::WSDL
|
||||
works with.
|
||||
|
||||
It's built as a native handler for XML::LibXML, but will also work with
|
||||
XML::SAX::ParserFactory.
|
||||
|
||||
To parse a WSDL file, use one of the following variants:
|
||||
|
||||
my $parser = XML::LibXML->new();
|
||||
my $handler = SOAP::WSDL::SAX::WSDLHandler->new();
|
||||
$parser->set_handler( $handler );
|
||||
$parser->parse( $xml );
|
||||
my $data = $handler->get_data();
|
||||
|
||||
my $handler = SOAP::WSDL::SAX::WSDLHandler->new({
|
||||
base => 'XML::SAX::Base'
|
||||
});
|
||||
my $parser = XML::SAX::ParserFactor->parser(
|
||||
Handler => $handler
|
||||
);
|
||||
$parser->parse( $xml );
|
||||
my $data = $handler->get_data();
|
||||
|
||||
=item * SOAP::WSDL::SAX::MessageHandler
|
||||
|
||||
This is a SAX handler for parsing WSDL files into object trees SOAP::WSDL
|
||||
works with.
|
||||
|
||||
It's built as a native handler for XML::LibXML, but will also work with
|
||||
XML::SAX::ParserFactory.
|
||||
|
||||
Can be used for parsing both streams (chunks) and documents.
|
||||
|
||||
=back
|
||||
|
||||
=head1 LICENSE AND COPYRIGHT
|
||||
|
||||
Copyright 2007 Martin Kutter.
|
||||
|
||||
This file is part of SOAP-WSDL. You may distribute/modify it under
|
||||
the same terms as perl itself.
|
||||
|
||||
=head1 AUTHOR
|
||||
|
||||
Martin Kutter E<lt>martin.kutter fen-net.deE<gt>
|
||||
|
||||
=head1 REPOSITORY INFORMATION
|
||||
|
||||
$Rev: 391 $
|
||||
$LastChangedBy: kutterma $
|
||||
$Id: Parser.pod 391 2007-11-17 21:56:13Z kutterma $
|
||||
$HeadURL: http://soap-wsdl.svn.sourceforge.net/svnroot/soap-wsdl/SOAP-WSDL/trunk/lib/SOAP/WSDL/Manual/Parser.pod $
|
||||
|
||||
=cut
|
||||
|
||||
@@ -0,0 +1,30 @@
|
||||
=pod
|
||||
|
||||
=head1 NAME
|
||||
|
||||
SOAP::WSDL::Manual::Serializer
|
||||
|
||||
=head1 SERIALIZER CLASSES
|
||||
|
||||
Serializer classes convert perl data structures to XML.
|
||||
|
||||
SOAP::WSDL comes with one builtin serializer class:
|
||||
L<SOAP::WSDL::Serializer::XSD|SOAP::WSDL::Serializer::XSD>.
|
||||
|
||||
=head1 WRITING YOUR OWN SERIALIZER
|
||||
|
||||
See L<SOAP::WSDL::Factory::Serializer>.
|
||||
|
||||
=head1 LICENSE
|
||||
|
||||
Copyright 2007 Martin Kutter.
|
||||
|
||||
This file is part of SOAP-WSDL. You may distribute/modify it under
|
||||
the same terms as perl itself
|
||||
|
||||
=head1 AUTHOR
|
||||
|
||||
Martin Kutter E<lt>martin.kutter fen-net.deE<gt>
|
||||
|
||||
=cut
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,447 @@
|
||||
=pod
|
||||
|
||||
=head1 NAME
|
||||
|
||||
SOAP::WSDL::Manual::XSD - SOAP::WSDL's XML Schema implementation
|
||||
|
||||
=head1 DESCRIPTION
|
||||
|
||||
SOAP::WSDL's XML Schema implementation translates XML Schema definitions into
|
||||
perl classes.
|
||||
|
||||
Every top-level type or element in a XML schema is translated into a perl
|
||||
class (usually in it's own file).
|
||||
|
||||
Atomic types are either directly included in the class of their parent's
|
||||
node, or as sub-package in their parent class' file.
|
||||
|
||||
While the implementation is still incomplete, it covers the XML schema
|
||||
definitions used by most object mappers.
|
||||
|
||||
=head1 USAGE
|
||||
|
||||
You can use SOAP::WSDL::XSD based classes just like any perl class - you may
|
||||
instantiate it, inherit from it etc.
|
||||
|
||||
You should be aware, that SOAP::WSDL::XSD based classes are inside-out
|
||||
classes using Class::Std::Fast, though - things you would expect from
|
||||
hash-based classes like using the blessed hash ref as data storage won't work.
|
||||
|
||||
Moreover, most all SOAP::WSDL::XSD::Typelib based classes override
|
||||
Class::Std::Fast's default constructor for speed - you should not expect
|
||||
BUILD or START methods to work, unless you call them yourself (or define a new
|
||||
constructor).
|
||||
|
||||
All SOAP::WSDL::XSD based complexType classes allow a hash ref matching their
|
||||
data structure as only parameter to new(). You may mix hash and list refs and
|
||||
objects in the structure passed to new - as long as the structure matches, it
|
||||
will work fine.
|
||||
|
||||
All SOAP::WSDL::XSD based simpleType (and builtin) classes accept a single
|
||||
hash ref with the only key "value" and the value to be set as value.
|
||||
|
||||
=head2 Conversions
|
||||
|
||||
=head3 Array dereference
|
||||
|
||||
All SOAP::WSDL::XSD based classes overload arrayification - that is being
|
||||
accessed as a list ref - with a method returning [ $self ].
|
||||
|
||||
This means that you can safely use the results of get_ELEMENT calls on
|
||||
complexTypes as list refs (you'll have to check for definedness, though -
|
||||
see L<SOAP::WSDL::XSD::Typelib::Builtin|SOAP::WSDL::XSD::Typelib::Builtin>
|
||||
for details.
|
||||
|
||||
To iterate over a (potential) list of child elements just do the following:
|
||||
|
||||
if (defined $obj->get_ELEMENT()) {
|
||||
for (@{ $obj->get_ELEMENT() }) {
|
||||
...
|
||||
}
|
||||
}
|
||||
|
||||
This is especially useful in mini-languages like
|
||||
L<HTML::Template::Compiled|HTML::Template::Compiled>, where you could say
|
||||
|
||||
<%IF_DEFINED obj.get_ELEMENT %>
|
||||
<%LOOP obj.get_ELEMENT %>
|
||||
...
|
||||
<%/LOOP>
|
||||
<%IF%>
|
||||
|
||||
Note that this does not work in HTML::Template::Compiled yet - the code
|
||||
generated for the template checks UNIVERSAL::isa instead of dereferencing.
|
||||
There's a ticket open in HTC to solve the issue.
|
||||
|
||||
=head3 as_hash_ref
|
||||
|
||||
SOAP::WSDL::XSD::Typelib::ComplexType based objects have a method as_hash_ref,
|
||||
which returns the object's content as a hash reference.
|
||||
|
||||
This can be convenient for cloning:
|
||||
|
||||
my $class = ref $old;
|
||||
my $clone = $class->new( $old->as_hash_ref() );
|
||||
|
||||
To convert from one type to another, you
|
||||
can just say
|
||||
|
||||
my $new = MyTypes::NewType->new( $old->as_hash_ref() );
|
||||
|
||||
Of course this will only work if MyTypes::NewType has a superset of the old
|
||||
object class' elements.
|
||||
.
|
||||
|
||||
Future versions will restrict the data returned to the child element's data -
|
||||
you should not expect XML attributes to be returned through hash refs.
|
||||
|
||||
=head1 HOW IT WORKS
|
||||
|
||||
=head2 Base classes
|
||||
|
||||
SOAP::WSDL::XSD provides a set of base classes for the construction of XML
|
||||
schema defined type classes.
|
||||
|
||||
=head3 Builtin types
|
||||
|
||||
SOAP::WSDL::XSD provides classes for all builtin XML Schema datatypes.
|
||||
|
||||
For a list and reference on these classes, see
|
||||
SOAP::WSDL::XSD::Typelib::Builtin.
|
||||
|
||||
=head3 Derivation classes
|
||||
|
||||
For derivation by list, the list derivation class
|
||||
SOAP::WSDL::XSD::Typelib::Builtin::list exists.
|
||||
|
||||
Derivation by restriction is handled without the help of additional classes.
|
||||
|
||||
=head3 Element construction class
|
||||
|
||||
For the construction of element classes, the element superclass
|
||||
SOAP::WSDL::XSD::Typelib::Element exists. All elements are ultimately derived
|
||||
from this class. Elements may inherit from type classes, too - see
|
||||
L</TRANSLATION RULES> for details.
|
||||
|
||||
=head3 complexType construction class
|
||||
|
||||
For the construction of complexType classes, the construction class
|
||||
SOAP::WSDL::XSD::Typelib::ComplexType is provided. It provides a __factory
|
||||
method for placing attributes in generated classes, and generating
|
||||
appropriate setter/getter accessors.
|
||||
|
||||
The setters are special: They handle complex data structures of any type
|
||||
(meaning hash refs, list refs and objects, and any combination of them), as
|
||||
long as their structure matches the expected structure.
|
||||
|
||||
=head1 TRANSLATION RULES
|
||||
|
||||
=head2 element
|
||||
|
||||
TODO add more elaborate description
|
||||
|
||||
=head3 element with type attribute
|
||||
|
||||
Elements defined by referencing a builtin or user defined type inherit
|
||||
from SOAP::WSDL::XSD::Typelib::Element and from the corresponding type class.
|
||||
|
||||
Element Type
|
||||
base class class
|
||||
^ ^
|
||||
| |
|
||||
------------
|
||||
|
|
||||
Element type="" class
|
||||
|
||||
=head3 element with ref attribute
|
||||
|
||||
Elements defined by referencing another element inherit from the
|
||||
corresponding element class.
|
||||
|
||||
referenced Element class
|
||||
^
|
||||
|
|
||||
Element ref="" class
|
||||
|
||||
=head3 element with atomic simpleType
|
||||
|
||||
Elements defined by a atomic simpleType from
|
||||
SOAP::WSDL::XSD::Typelib::Element and from the base type of the atomic type.
|
||||
|
||||
Element atomic Type
|
||||
base class base class
|
||||
^ ^
|
||||
| |
|
||||
--------------
|
||||
|
|
||||
element simpleType class
|
||||
|
||||
=head3 element with atomic complexType
|
||||
|
||||
Elements defined with a atomic complexType inherit from
|
||||
SOAP::WSDL::XSD::Typelib::Element and from
|
||||
SOAP::WSDL::XSD::Typelib::ComplexType.
|
||||
|
||||
Element complexType
|
||||
base class base class
|
||||
^ ^
|
||||
| |
|
||||
--------------
|
||||
|
|
||||
element complexType class
|
||||
|
||||
=head2 complexType
|
||||
|
||||
TODO add more elaborate description
|
||||
|
||||
Some content models are not implemented yet. The content models
|
||||
implemented are described below.
|
||||
|
||||
=head3 complexType with "all" variety
|
||||
|
||||
Complex types with "all" variety inherit from
|
||||
SOAP::WSDL::XSD::Typelib::ComplexType, and call it's factory method for
|
||||
creating fields and accessors/mutators for the complexType's elements.
|
||||
|
||||
All element's type classes are loaded. Complex type classes have a "has a"
|
||||
relationship to their element fields.
|
||||
|
||||
Element fields may either be element classes (for element ref="") or type
|
||||
classes (for element type=""). No extra element classes are created for
|
||||
a complexType's elements.
|
||||
|
||||
complexType
|
||||
base class
|
||||
^
|
||||
|
|
||||
complexType all
|
||||
---------------- has a
|
||||
element name="a" ------------> Element or type class object
|
||||
element name="b" ------------> Element or type class object
|
||||
|
||||
The implementation for all does enforce the order of elements as described
|
||||
in the WSDL, even though this is not required by the XML Schema
|
||||
specification.
|
||||
|
||||
=head3 complexType with "sequence" variety
|
||||
|
||||
The implementation of the "sequence" variety is the same as for all.
|
||||
|
||||
=head3 complexType with "choice" variety
|
||||
|
||||
The implementation for choice currently is the same as for all - which means,
|
||||
no check for occurrence are made.
|
||||
|
||||
=head3 complexType with complexContent content model
|
||||
|
||||
Note that complexType classes with complexContent content model don't exhibit
|
||||
their type via the xsi:type attribute yet, so they currently cannot be used
|
||||
as a replacement for their base type.
|
||||
|
||||
SOAP::WSDL's XSD deserializer backend does not recognize the xsi:type=""
|
||||
attribute either yet.
|
||||
|
||||
=over
|
||||
|
||||
=item * restriction variety
|
||||
|
||||
ComplexType classes with restriction variety inherit from their base type.
|
||||
No additional processing or content checking is performed yet.
|
||||
|
||||
complexType
|
||||
base type class
|
||||
^
|
||||
|
|
||||
complexType
|
||||
restriction
|
||||
|
||||
=item * extension variety
|
||||
|
||||
ComplexType classes with extension variety inherit from the XSD base
|
||||
complexType class and from their base type.
|
||||
|
||||
Extension classes are checked for (re-)defining all elements of their parent
|
||||
class.
|
||||
|
||||
Note that a derived type's elements (=properties) overrides the getter /
|
||||
setter methods for all inherited elements. All object data is stored in the
|
||||
derived type's class, not in the defining class (See L<Class::Std> for a
|
||||
discussion on inside out object data storage).
|
||||
|
||||
No additional processing or content checking is performed yet.
|
||||
|
||||
complexType complexType
|
||||
base class base type class
|
||||
^ ^
|
||||
| |
|
||||
-----------------
|
||||
|
|
||||
complexType
|
||||
extension
|
||||
|
||||
=back
|
||||
|
||||
=head2 SimpleType
|
||||
|
||||
TODO add more elaborate description
|
||||
|
||||
Some derivation methods are not implemented yet. The derivation methods
|
||||
implemented are described below.
|
||||
|
||||
=head3 Derivation by list
|
||||
|
||||
Derivation by list is implemented by inheriting from both the base type and
|
||||
SOAP::WSDL::XSD::Typelib::XSD::list.
|
||||
|
||||
=head3 Derivation by restriction
|
||||
|
||||
Derivation by restriction is implemented by inheriting from a base type and
|
||||
applying the required restrictions.
|
||||
|
||||
=head1 FACETS
|
||||
|
||||
XML Schema facets are not implemented yet.
|
||||
|
||||
They will probably implemented some day by putting constant methods into
|
||||
the correspondent classes.
|
||||
|
||||
=head1 ATTRIBUTES
|
||||
|
||||
XML attributes are not implemented yet. The documentation below sketches
|
||||
how XML attributes will be implemented in the future.
|
||||
|
||||
All XML attributes are derived from SOAP::WSDL::XSD::Typelib::Attribute.
|
||||
|
||||
The attribute set for a XML element (derived from anySimpleType or
|
||||
complexType) is implemented as a sub-package of the element derived from
|
||||
SOAP::WSDL::XSD::Typelib::AttributeSet.
|
||||
|
||||
The sub-package is named as the top package, suffixed with C<_ATTR>.
|
||||
|
||||
All XML attributes for a XML element are set- and retrievable via the method
|
||||
C<attr>. The name is chosen to allow mimicing SOAP::Lite's behaviour, which
|
||||
allows setting a SOAP::Data object's attributes via C<attr>.
|
||||
|
||||
my $attrSet = $obj->attr();
|
||||
$obj->attr({
|
||||
whitespace => 'preserve',
|
||||
nillable => 1,
|
||||
});
|
||||
|
||||
SOAP::WSDL::XSD::Typelib::AttributeSet is derived from
|
||||
SOAP::WSDL::XSD::Typelib::ComplexType with content model C<all>. The
|
||||
individual attributes can be set and retrieved via the respective set_FOO /
|
||||
get_FOO methods.
|
||||
|
||||
The C<attr> method provides auto-vivification: An xml object's attribute set
|
||||
is instantiated when accessed.
|
||||
|
||||
=head1 CAVEATS
|
||||
|
||||
=over
|
||||
|
||||
=item * START and BUILD are not being called
|
||||
|
||||
In contrast to "normal" Class::Std::Fast based objects, the classes of the
|
||||
SOAP::WSDL::XSD::Typelib:: hierarchy (and all type and element classes
|
||||
generated by SOAP::WSDL) override Class::Std's constructor for performance
|
||||
reasons.
|
||||
|
||||
If you inherit from such a class and place a START or BUILD method in it,
|
||||
it will not get called - at least not unless you place something like this
|
||||
at the top of you code:
|
||||
|
||||
use Class::Std::Fast::Storable;
|
||||
|
||||
In this case, Class::Std::Fast::Storable will export a new() method into your
|
||||
class, which in turn calls START and BUILD.
|
||||
|
||||
The constructors of all SOAP::WSDL::XSD::Typelib:: classes don't !
|
||||
|
||||
=back
|
||||
|
||||
=head1 BUGS AND LIMITATIONS
|
||||
|
||||
The following XML Schema declaration elements are not supported yet:
|
||||
|
||||
=over
|
||||
|
||||
=item * Declaration elements
|
||||
|
||||
attribute
|
||||
notation
|
||||
|
||||
=item * Type definition elements
|
||||
|
||||
simpleContent
|
||||
union
|
||||
|
||||
=item * Content model definition elements
|
||||
|
||||
any
|
||||
anyAttribute
|
||||
attributeGroup
|
||||
group
|
||||
|
||||
=item * Identity definition elements
|
||||
|
||||
field
|
||||
key
|
||||
keyref
|
||||
selector
|
||||
unique
|
||||
|
||||
=item * Inclusion elements
|
||||
|
||||
import
|
||||
include
|
||||
redefine
|
||||
|
||||
=back
|
||||
|
||||
The following XML Schema declaration elements are supported, but have no
|
||||
effect yet:
|
||||
|
||||
=over
|
||||
|
||||
=item * Factes
|
||||
|
||||
enumeration
|
||||
fractionDigits
|
||||
lenght
|
||||
maxExclusive
|
||||
maxInclusiove
|
||||
maxLength
|
||||
minExclusive
|
||||
minInclusive
|
||||
minLength
|
||||
pattern
|
||||
totalDigits
|
||||
whitespace
|
||||
|
||||
=item * Documentation elements
|
||||
|
||||
appinfo
|
||||
|
||||
=back
|
||||
|
||||
=head1 LICENSE
|
||||
|
||||
Copyright 2007 Martin Kutter.
|
||||
|
||||
This file is part of SOAP-WSDL. You may distribute/modify it under
|
||||
the same terms as perl itself
|
||||
|
||||
=head1 AUTHOR
|
||||
|
||||
Martin Kutter E<lt>martin.kutter fen-net.deE<gt>
|
||||
|
||||
=head1 REPOSITORY INFORMATION
|
||||
|
||||
$Rev: 390 $
|
||||
$LastChangedBy: kutterma $
|
||||
$Id: Client.pm 390 2007-11-16 22:18:32Z kutterma $
|
||||
$HeadURL: http://soap-wsdl.svn.sourceforge.net/svnroot/soap-wsdl/SOAP-WSDL/trunk/lib/SOAP/WSDL/Client.pm $
|
||||
|
||||
=cut
|
||||
|
||||
Reference in New Issue
Block a user