Net::Soma - Perl client interface to SOMA iWireless platform


Net-Soma documentation  | view source Contained in the Net-Soma distribution.

Index


NAME

Top

Net::Soma - Perl client interface to SOMA iWireless platform

SYNOPSIS

Top

use Net::Soma; use Net::Soma qw( AttributeInstance FeatureInstance ApplicationInstance ChoiceItem AttributeDef FeatureDef ApplicationDef ApplicationDefV2 FeatureDefV2 AttributeDefV2 CPEInfoDefV2 CPESearchStruct CPESearchResult CPEInfo CPEInfoDef HardwarePort NoSuchCPEException DataAccessException InternalFault BadAppParameterException BadAppParameterExceptionV2 NoSuchAppException NoSuchFeatureException NoSuchAttributeException BadCPEParameterException ActiveApplicationsException );

$soma = new Net::Soma { url => 'https://soma.example.net:8088/ossapi/services', namespace => 'AppCatalog', }

$err_or_som = $soma->getApplicationDefinitions();

if (ref($err_or_som)){ my $result = $err_or_som->result; foreach my $definition (@$result) { print $definition->name, "\n"; } }else{ print "$err_or_som\n"; }

DESCRIPTION

Top

Net::Soma is a module implementing a Perl interface to SOMA's iWireless SOAP interface (ossapi). It is compatible with release 1.5 of that software and requires the WSDLs from SOMA.

Net::Soma enables you to simply access the SOAP interface of your SOMA networks softair platform server.

BASIC USAGE

Top

Import the Net::Soma module with

use Net::Soma (@list_of_classes);

Net::Soma will create any of the following classes for you

AttributeInstance FeatureInstance ApplicationInstance ChoiceItem AttributeDef FeatureDef ApplicationDef ApplicationDefV2 FeatureDefV2 AttributeDefV2 CPEInfoDefV2 CPESearchStruct CPESearchResult CPEInfo CPEInfoDef HardwarePort NoSuchCPEException DataAccessException InternalFault BadAppParameterException BadAppParameterExceptionV2 NoSuchAppException NoSuchFeatureException NoSuchAttributeException BadCPEParameterException ActiveApplicationsException

CONSTRUCTOR

Top

new HASHREF

Creates a new Soma object. HASHREF should contain the keys url and namespace for the URL of the Soma SOAP proxy and the namespace of the methods you would like to call. You may optionally define the key die_on_fault to cause that behavior for methods.

METHODS

Top

All Soma methods may be invoked as methods of the Net::Soma object. The return value is either the fault string in the event of an error or a SOAP::SOM object.

If the option die_on_fault was set for the Net::Soma object, then instead the method dies on error and returns the result component of the SOAP::SOM object on success.

SEE ALSO

Top

  SOAP::Lite, SOAP::SOM

  http://www.somanetworks.com/ for information about SOMA and iWireless.

  http://www.sisd.com/freeside/ for the ISP billing and provisioning system
  which provoked the need for this module.

BUGS

Top

Namespace promiscuous. Lax handling of arguments and return values. In fact, calling a bogus method with arguments causes complaints about accessing methods on undefined values (at line 233, paramdata->name)

Quite probably others. Use at your own risk.

AUTHOR AND COPYRIGHT

Top


Net-Soma documentation  | view source Contained in the Net-Soma distribution.