soap::wsdl::manual::codefirst(3pm) [debian man page]

SOAP::WSDL::Manual::CodeFirst(3pm)			User Contributed Perl Documentation			SOAP::WSDL::Manual::CodeFirst(3pm)

NAME

       CodeFirst - Writing Code-First Web Services with SOAP::WSDL

       Note: This document is just a collection of thought. There's no implementation yet.

   How Data Class definitions could look like
       Moose

       Of course SOAP::WSDL could (and probably should) just use Moose - it provides the full Metaclass Framework needed for generating Schemas
       from class definitions.

       However, Moose is way too powerful for building (just) simple Data Transfer Objects which can be expressed in XML.

       With Moose, a class could look like this:

	package MyElements::GenerateBarCode;
	use Moose;

	has 'xmlns' =>
	    is => 'ro',
	    default => 'http://webservicex.net';

	has 'xmlname' =>
	    is => 'ro',
	    default => 'GenerateBarCode';

	has 'BarCodeParam' =>
	     is => 'rw',
	     type => 'MyTypes::BarCodeData';

	has 'BarCodeText' =>
	     is => 'rw',
	     type => 'String';
	1;

       This is - despite the condensed syntax - a lot of line noise.

       Native SOAP::WSDL

       SOAP::WSDL::XSD::Typelib::ComplexType (should) provide a simple setup method allowing a even shorter description (and offering the
       additional performance boost SOAP::WSDL has over Moose):

	package MyElements::GenerateBarCode;
	use strice; use warnings;
	use SOAP::WSDL::XSD::Typelib::Element;
	use SOAP::WSDL::XSD::Typelib::ComplexType;

	_namespace 'http://webservicex.net';	# might be better in the SOAP server interface
	_name 'GenerateBarCode';
	_elements
		BarCodeParam => 'MyTypes::BarCodeData',
		BarCodeText => 'string';

       This would result in the following XML Schema (inside a schema with the namespace "http://webservicex.net" - the namespaces could even be
       declared outside the DTO classes.

	<complexType name="GenerateBarCode">
	     <sequence>
		  <element name="BarCodeParam" type="tns:BarCodeData"/>
		  <element name="BarCodeText" type="xsd:string"/>
	     </sequence>
	</complexType>

   Interface definitions
       Perl does not have the concept of interfaces. However, Moose provides Roles, which can be used for defining interfaces.

       However, it's not really necessary to define a interface Interface (in the sense of a Java interface) - a interface class is sufficient.

       Subroutine attributes could be used for providing additional information - attributes in perl are much like annotations in Java

       A interface could look like this:

	package MyServer::BarCode;
	use strict; use warnings;
	use SOAP::WSDL::Server::CodeFirst;

	sub generateBarCode :WebMethod(name=<GenerateBarCode>
	    return=<MyElements::GenerateBarcodeResponse>
	    body=<MyElements::GenerateBarcode>) {
	    my ($self, $body, $header) = @_;
	    my $result = MyElements::GenerateBarcodeResponse->new();
	    return $result;
	};
	1;

perl v5.10.1							    2010-12-21					SOAP::WSDL::Manual::CodeFirst(3pm)

SOAP::WSDL::XSD::Typelib::SimpleType(3pm)		User Contributed Perl Documentation		 SOAP::WSDL::XSD::Typelib::SimpleType(3pm)

NAME

       SOAP::WSDL::XSD::Typelib::SimpleType - simpleType base class

DESCRIPTION

       This module implements a base class for designing simple type classes modelling XML Schema simpleType definitions.

SYNOPSIS

	   # example simpleType derived by restriction
	   # XSD would be:
	   # <simpleType name="MySimpleType">
	   #	<restriction base="xsd:string" />
	   # </simpleType>
	   package MySimpleType;
	   use Class::Std::Fast::Storable constructor => 'none';
	   # restriction base implemented via inheritance
	   use SOAP::WSDL::XSD::Typelib::Builtin;
	   use SOAP::WSDL::XSD::Typelib::SimpleType;
	   use base qw(
	       # derive by restriction
	       'SOAP::WSDL::XSD::Typelib::SimpleType::restriction',
	       # restriction base
	       'SOAP::WSDL::XSD::Typelib::Builtin::string'
	   );

	   # example simpleType derived by list.
	   # XSD would be:
	   # <simpleType name="MySimpleListType">
	   #	<list itemTipe="xsd:string" />
	   # </simpleType>
	   package MySimpleListType;
	   use Class::Std::Fast::Storable constructor => 'none';
	   # restriction base implemented via inheritance
	   use SOAP::WSDL::XSD::Typelib::Builtin;
	   use base ('SOAP::WSDL::XSD::Typelib::SimpleType',
	       'SOAP::WSDL::XSD::Typelib::Builtin::list',	 # derive by list
	       'SOAP::WSDL::XSD::Typelib::Builtin::string'	 # list itemType
	   );

How to write your own simple type
       Writing a simple type class is easy - all you have to do is setting up the base classes correctly.

       The following rules apply:

       o   simpleType derived via list

	   simpleType classes derived via list must inherit from these classes in exactly this order:

	    SOAP::WSDL::XSD::Typelib::SimpleType
	    SOAP::WSDL::XSD::Typelib::Builtin::list	    # derive by list
	    The::List::ItemType::Class			    # list itemType

	   The::List::ItemType::Class can either be a builtin class (see SOAP::WSDL::XSD::Builtin) or another simpleType class (any other class
	   implementing the right methods is supported too, but not for the faint of heart).

       o   simpleType derived via restriction

	   simpleType classes derived via restriction must inherit from these classes in exactly this order:

	    SOAP::WSDL::XSD::Typelib::SimpleType	       # you may leave this out
	    SOAP::WSDL::XSD::Typelib::SimpleType::restriction  # derive by restriction
	    The::Restriction::Base::Class		       # restriction base

	   The::Restriction::Base::Class can either be a builtin class (see SOAP::WSDL::XSD::Builtin) or another simpleType class.

	   The slight inconsistency between the these variants is caused by the restriction element, which has different meanings for simpleType
	   and complexType definitions.

BUGS AND LIMITATIONS

       o   Thread safety

	   SOAP::WSDL::XSD::Typelib::SimpleType uses Class::Std::Fast::Storable which uses Class::Std. Class::Std is not thread safe, so
	   SOAP::WSDL::XSD::Typelib::SimpleType is neither.

       o   union

	   union simple types are not supported yet.

       o   XML Schema facets

	   No facets are implemented yet.

LICENSE AND COPYRIGHT

       Copyright 2004-2007 Martin Kutter.

       This file is part of SOAP-WSDL. You may distribute/modify it under the same terms as perl itself

AUTHOR

       Martin Kutter <martin.kutter fen-net.de>

REPOSITORY INFORMATION

	$Rev: 851 $
	$LastChangedBy: kutterma $
	$Id: SimpleType.pm 851 2009-05-15 22:45:18Z kutterma $
	$HeadURL: https://soap-wsdl.svn.sourceforge.net/svnroot/soap-wsdl/SOAP-WSDL/trunk/lib/SOAP/WSDL/XSD/Typelib/SimpleType.pm $

perl v5.10.1							    2010-12-21				 SOAP::WSDL::XSD::Typelib::SimpleType(3pm)