/usr/share/perl5/XML/RPC/Enc.pm is in libxml-rpc-fast-perl 0.8-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 | package XML::RPC::Enc;
=head1 NAME
XML::RPC::Enc - Base class for XML::RPC encoders
=head1 SYNOPSIS
Generic usage
use XML::RPC::Fast;
my $server = XML::RPC::Fast->new( undef, encoder => XML::RPC::Enc::LibXML->new );
my $client = XML::RPC::Fast->new( $uri, encoder => XML::RPC::Enc::LibXML->new );
=cut
use strict;
use warnings;
use Carp;
# Base class for encoders
use XML::RPC::Fast ();
our $VERSION = $XML::RPC::Fast::VERSION;
=head1 METHODS
The following methods should be implemented
=cut
=head2 new (%args)
Should support arguments:
=over 4
=item internal_encoding [ = undef ]
Internal encoding. C<undef> means wide perl characters (perl-5.8.1+)
=item external_encoding [ = utf-8 ]
External encoding. Which encoding to use in composed XML
=back
=cut
sub new {
my ( $pkg, %args ) = @_;
}
# Encoder part
=head2 request ($method, @args) : xml byte-stream, [ new call url ]
Encode request into XML
=cut
sub request {
my ( $self, $method, @args ) = @_;
croak "request not implemented by $self";
#return $xml;
}
=head2 response (@args) : xml byte-stream
Encode response into XML
=cut
sub response {
my ( $self, $method, @args ) = @_;
croak "response not implemented by $self";
#return $xml;
}
=head2 fault ($faultcode, $faultstring) : xml byte-stream
Encode fault into XML
=cut
sub fault {
my ( $self, $faultcode, $faultstring ) = @_;
croak "fault not implemented by $self";
#return $xml;
}
=head2 registerClass ($class_name,$encoder_cb)
Register encoders for custom Perl types
Encoders description:
# Generic:
$simple_encoder_cb = sub {
my $object = shift;
# ...
return type => $string;
};
# Encoder-dependent (XML::RPC::Enc::LibXML)
$complex_encoder_cb = sub {
my $object = shift;
# ...
return XML::LibXML::Node;
};
Samples:
$enc->registerClass( DateTime => sub {
return ( 'dateTime.iso8601' => $_[0]->strftime('%Y%m%dT%H%M%S.%3N%z') );
});
# Encoder-dependent (XML::RPC::Enc::LibXML)
$enc->registerClass( DateTime => sub {
my $node = XML::LibXML::Element->new('dateTime.iso8601');
$node->appendText($_[0]->strftime('%Y%m%dT%H%M%S.%3N%z'));
return $node;
});
=cut
sub registerClass {
my ( $self,$class,$encoder ) = @_;
croak "registerClass not implemented by $self";
}
# Decoder part
=head2 decode ($xml) : $methodname, @args
Decode request xml
=head2 decode ($xml) : @args
Decode response xml
=head2 decode ($xml) : { fault => { faultCode => ..., faultString => ... } }
Decode fault xml
=cut
sub decode {
my ( $self, $xml ) = @_;
croak "decode not implemented by $self";
# return $methodname, @args if request
# return @args if response
# return { fault => { faultCode => ..., faultString => ... } } if fault
}
=head2 registerType ($xmlrpc_type,$decoder_cb)
Register decoders for XML-RPC types
$decoder_cb is depends on encoder implementation.
Samples for XML::RPC::Enc::LibXML
$enc->registerType( base64 => sub {
my $node = shift;
return MIME::Base64::decode($node->textContent);
});
$enc->registerType( 'dateTime.iso8601' => sub {
my $node = shift;
return DateTime::Format::ISO8601->parse_datetime($node->textContent);
});
=cut
sub registerType {
my ( $self,$type,$decoder ) = @_;
croak "registerType not implemented by $self";
}
=head1 COPYRIGHT & LICENSE
Copyright (c) 2008-2009 Mons Anderson.
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
=head1 AUTHOR
Mons Anderson, C<< <mons@cpan.org> >>
=cut
1;
|