OpenSRF/src/perlmods/OpenSRF/Application.pm

   1 package OpenSRF::Application;
   2 use vars qw/$_app $log @_METHODS $thunk $server_class/;
   3
   4 use base qw/OpenSRF/;
   5 use OpenSRF::AppSession;
   6 use OpenSRF::DomainObject::oilsMethod;
   7 use OpenSRF::DomainObject::oilsResponse qw/:status/;
   8 use OpenSRF::Utils::Logger qw/:level/;
   9 use Data::Dumper;
  10 use Time::HiRes qw/time/;
  11 use OpenSRF::EX qw/:try/;
  12 use Carp;
  13 #use OpenSRF::UnixServer;  # to get the server class from UnixServer::App
  14
  15 sub DESTROY{};
  16
  17 use strict;
  18 use warnings;
  19
  20 $log = 'OpenSRF::Utils::Logger';
  21
  22 our $in_request = 0;
  23 our @pending_requests;
  24
  25 sub package {
  26         my $self = shift;
  27         return 1 unless ref($self);
  28         return $self->{package};
  29 }
  30
  31 sub signature {
  32         my $self = shift;
  33         return 0 unless ref($self);
  34         return $self->{signature};
  35 }
  36
  37 sub argc {
  38         my $self = shift;
  39         return 0 unless ref($self);
  40         return $self->{argc};
  41 }
  42
  43 sub api_name {
  44         my $self = shift;
  45         return 1 unless ref($self);
  46         return $self->{api_name};
  47 }
  48
  49 sub api_level {
  50         my $self = shift;
  51         return 1 unless ref($self);
  52         return $self->{api_level};
  53 }
  54
  55 sub server_class {
  56         my $class = shift;
  57         if($class) {
  58                 $server_class = $class;
  59         }
  60         return $server_class;
  61 }
  62
  63 sub thunk {
  64         my $self = shift;
  65         my $flag = shift;
  66         $thunk = $flag if (defined $flag);
  67         return $thunk;
  68 }
  69
  70 sub application_implementation {
  71         my $self = shift;
  72         my $app = shift;
  73
  74         if (defined $app) {
  75                 $_app = $app;
  76                 $_app->use;
  77                 if( $@ ) {
  78                         $log->error( "Error loading application_implementation: $app -> $@", ERROR);
  79                 }
  80
  81         }
  82
  83         return $_app;
  84 }
  85
  86 sub handler {
  87         my ($self, $session, $app_msg) = @_;
  88
  89         if( ! $app_msg ) {
  90                 return 1;  # error?
  91         }
  92
  93         $log->debug( "In Application::handler()", DEBUG );
  94
  95         my $app = $self->application_implementation;
  96
  97         if( $app ) {
  98                 $log->debug( "Application is $app", DEBUG);
  99         }
 100
 101         if ($session->last_message_type eq 'REQUEST') {
 102                 $log->debug( "We got a REQUEST: ". $app_msg->method);
 103
 104                 my $method_name = $app_msg->method;
 105                 $log->debug( " * Looking up $method_name inside $app", DEBUG);
 106
 107                 my $method_proto = $session->last_message_api_level;
 108                 $log->debug( " * Method API Level [$method_proto]", DEBUG);
 109
 110                 my $coderef = $app->method_lookup( $method_name, $method_proto, 1, 1 );
 111
 112                 unless ($coderef) {
 113                         $session->status( OpenSRF::DomainObject::oilsMethodException->new(
 114                                                 statusCode => STATUS_NOTFOUND(),
 115                                                 status => "Method [$method_name] not found for $app"));
 116                         return 1;
 117                 }
 118
 119                 $log->debug( " (we got coderef $coderef", DEBUG);
 120
 121                 unless ($session->continue_request) {
 122                         $session->status(
 123                                 OpenSRF::DomainObject::oilsConnectStatus->new(
 124                                                 statusCode => STATUS_REDIRECTED(),
 125                                                 status => 'Disconnect on max requests' ) );
 126                         $session->kill_me;
 127                         return 1;
 128                 }
 129
 130                 if (ref $coderef) {
 131                         my @args = $app_msg->params;
 132                         my $appreq = OpenSRF::AppRequest->new( $session );
 133
 134                         $log->debug( "in_request = $in_request : [" . $appreq->threadTrace."]", DEBUG );
 135                         if( $in_request ) {
 136                                 $log->debug( "Pushing onto pending requests: " . $appreq->threadTrace, DEBUG );
 137                                 push @pending_requests, [ $appreq, \@args, $coderef ];
 138                                 return 1;
 139                         }
 140
 141
 142                         $in_request++;
 143
 144                         $log->debug( "Executing coderef for {$method_name}", INTERNAL );
 145
 146                         my $resp;
 147                         try {
 148                                 # un-if(0) this block to enable param checking based on signature and argc
 149                                 if (0) {
 150                                         if (@args < $coderef->argc) {
 151                                                 die     "Not enough params passed to ".
 152                                                         $coderef->api_name." : requires ". $coderef->argc
 153                                         }
 154                                         if (@args) {
 155                                                 my $sig = $coderef->signature;
 156                                                 if ($sig && exists $sig->{params}) {
 157                                                         for my $p (0 .. scalar(@{ $sig->{params} }) - 1 ) {
 158                                                                 my $s = $sig->{params}->[$p];
 159                                                                 my $a = $args[$p];
 160                                                                 if ($s->{class} && JSON->lookup_hint(ref $a) ne $s->{class}) {
 161                                                                         die "Incorrect param class at position $p : should be a '$$s{class}'";
 162                                                                 } elsif ($s->{type}) {
 163                                                                         if (lc($s->{type}) eq 'object' && $a !~ /HASH/o) {
 164                                                                                 die "Incorrect param type at position $p : should be an 'object'";
 165                                                                         } elsif (lc($s->{type}) eq 'array' && $a !~ /ARRAY/o) {
 166                                                                                 die "Incorrect param type at position $p : should be an 'array'";
 167                                                                         } elsif (lc($s->{type}) eq 'number' && (ref($a) || $a !~ /^-?\d+(?:\.\d+)?$/o)) {
 168                                                                                 die "Incorrect param type at position $p : should be a 'number'";
 169                                                                         } elsif (lc($s->{type}) eq 'string' && ref($a)) {
 170                                                                                 die "Incorrect param type at position $p : should be a 'string'";
 171                                                                         }
 172                                                                 }
 173                                                         }
 174                                                 }
 175                                         }
 176                                 }
 177
 178                                 my $start = time();
 179                                 warn "About to run...\n";
 180                                 $resp = $coderef->run( $appreq, @args);
 181                                 warn "Done running...\n";
 182                                 my $time = sprintf '%.3f', time() - $start;
 183
 184                                 $log->debug( "Method duration for {$method_name}:  ". $time, INFO );
 185                                 if( defined( $resp ) ) {
 186                                         $appreq->respond_complete( $resp );
 187                                 } else {
 188                                         $appreq->status( OpenSRF::DomainObject::oilsConnectStatus->new(
 189                                                                 statusCode => STATUS_COMPLETE(),
 190                                                                 status => 'Request Complete' ) );
 191                                 }
 192                         } catch Error with {
 193                                 my $e = shift;
 194                                 warn "Caught error from 'run' method: $e\n";
 195
 196                                 if(UNIVERSAL::isa($e,"Error")) {
 197                                         $e = $e->stringify();
 198                                 }
 199                                 my $sess_id = $session->session_id;
 200                                 $session->status(
 201                                         OpenSRF::DomainObject::oilsMethodException->new(
 202                                                         statusCode      => STATUS_INTERNALSERVERERROR(),
 203                                                         status          => " *** Call to [$method_name] failed for session ".
 204                                                                            "[$sess_id], thread trace ".
 205                                                                            "[".$appreq->threadTrace."]:\n$e\n"
 206                                         )
 207                                 );
 208                         };
 209
 210
 211
 212                         # ----------------------------------------------
 213
 214
 215                         # XXX may need this later
 216                         # $_->[1] = 1 for (@OpenSRF::AppSession::_CLIENT_CACHE);
 217
 218                         $in_request--;
 219
 220                         $log->debug( "Pending Requests: " . scalar(@pending_requests), INTERNAL );
 221
 222                         # cycle through queued requests
 223                         while( my $aref = shift @pending_requests ) {
 224                                 $in_request++;
 225                                 my $resp;
 226                                 try {
 227                                         # un-if(0) this block to enable param checking based on signature and argc
 228                                         if (0) {
 229                                                 if (@args < $aref->[2]->argc) {
 230                                                         die     "Not enough params passed to ".
 231                                                                 $aref->[2]->api_name." : requires ". $aref->[2]->argc
 232                                                 }
 233                                                 if (@args) {
 234                                                         my $sig = $aref->[2]->signature;
 235                                                         if ($sig && exists $sig->{params}) {
 236                                                                 for my $p (0 .. scalar(@{ $sig->{params} }) - 1 ) {
 237                                                                         my $s = $sig->{params}->[$p];
 238                                                                         my $a = $args[$p];
 239                                                                         if ($s->{class} && JSON->lookup_hint(ref $a) ne $s->{class}) {
 240                                                                                 die "Incorrect param class at position $p : should be a '$$s{class}'";
 241                                                                         } elsif ($s->{type}) {
 242                                                                                 if (lc($s->{type}) eq 'object' && $a !~ /HASH/o) {
 243                                                                                         die "Incorrect param type at position $p : should be an 'object'";
 244                                                                                 } elsif (lc($s->{type}) eq 'array' && $a !~ /ARRAY/o) {
 245                                                                                         die "Incorrect param type at position $p : should be an 'array'";
 246                                                                                 } elsif (lc($s->{type}) eq 'number' && (ref($a) || $a !~ /^-?\d+(?:\.\d+)?$/o)) {
 247                                                                                         die "Incorrect param type at position $p : should be a 'number'";
 248                                                                                 } elsif (lc($s->{type}) eq 'string' && ref($a)) {
 249                                                                                         die "Incorrect param type at position $p : should be a 'string'";
 250                                                                                 }
 251                                                                         }
 252                                                                 }
 253                                                         }
 254                                                 }
 255                                         }
 256
 257                                         my $start = time;
 258                                         my $response = $aref->[2]->run( $aref->[0], @{$aref->[1]} );
 259                                         my $time = sprintf '%.3f', time - $start;
 260                                         $log->debug( "Method duration for {[".$aref->[2]->api_name." -> ".join(', ',@{$aref->[1]}).'}:  '.$time, DEBUG );
 261
 262                                         $appreq = $aref->[0];
 263                                         if( ref( $response ) ) {
 264                                                 $appreq->respond_complete( $response );
 265                                         } else {
 266                                                 $appreq->status( OpenSRF::DomainObject::oilsConnectStatus->new(
 267                                                                         statusCode => STATUS_COMPLETE(),
 268                                                                         status => 'Request Complete' ) );
 269                                         }
 270                                         $log->debug( "Executed: " . $appreq->threadTrace, DEBUG );
 271                                 } catch Error with {
 272                                         my $e = shift;
 273                                         if(UNIVERSAL::isa($e,"Error")) {
 274                                                 $e = $e->stringify();
 275                                         }
 276                                         $session->status(
 277                                                 OpenSRF::DomainObject::oilsMethodException->new(
 278                                                                 statusCode => STATUS_INTERNALSERVERERROR(),
 279                                                                 status => "Call to [".$aref->[2]->api_name."] faild:  $e"
 280                                                 )
 281                                         );
 282                                 };
 283                                 $in_request--;
 284                         }
 285
 286                         return 1;
 287                 }
 288
 289                 my $res = OpenSRF::DomainObject::oilsMethodException->new(
 290                                 status => "Received non-REQUEST message in Application handler");
 291                 $session->send('ERROR', $res);
 292                 $session->kill_me;
 293                 return 1;
 294
 295         } else {
 296                 $session->push_queue([ $app_msg, $session->last_threadTrace ]);
 297         }
 298
 299         $session->last_message_type('');
 300         $session->last_message_api_level('');
 301
 302         return 1;
 303 }
 304
 305 sub is_registered {
 306         my $self = shift;
 307         my $api_name = shift;
 308         my $api_level = shift || 1;
 309         return exists($_METHODS[$api_level]{$api_name});
 310 }
 311
 312
 313 sub normalize_whitespace {
 314         my $txt = shift;
 315
 316         $txt =~ s/^\s+//gso;
 317         $txt =~ s/\s+$//gso;
 318         $txt =~ s/\s+/ /gso;
 319         $txt =~ s/\n//gso;
 320         $txt =~ s/\. /\.  /gso;
 321
 322         return $txt;
 323 }
 324
 325 sub parse_string_signature {
 326         my $string = shift;
 327         return [] unless $string;
 328         my @chunks = split(/\@/so, $string);
 329
 330         my @params;
 331         my $ret;
 332         my $desc = '';
 333         for (@chunks) {
 334                 if (/^return (.+)$/so) {
 335                         $ret = [normalize_whitespace($1)];
 336                 } elsif (/^param (\w+) \b(.+)$/so) {
 337                         push @params, [ $1, normalize_whitespace($2) ];
 338                 } else {
 339                         $desc .= '@' if $desc;
 340                         $desc .= $_;
 341                 }
 342         }
 343
 344         return [normalize_whitespace($desc),\@params, $ret];
 345 }
 346
 347 sub parse_array_signature {
 348         my $array = shift;
 349         my ($d,$p,$r) = @$array;
 350         return {} unless ($d or $p or $r);
 351
 352         return {
 353                 desc    => $d,
 354                 params  => [
 355                         map {
 356                                 { name  => $$_[0],
 357                                   desc  => $$_[1],
 358                                   type  => $$_[2],
 359                                   class => $$_[3],
 360                                 }
 361                         } @$p
 362                 ],
 363                 'return'=>
 364                         { desc  => $$r[0],
 365                           type  => $$r[1],
 366                           class => $$r[2],
 367                         }
 368         };
 369 }
 370
 371 sub register_method {
 372         my $self = shift;
 373         my $app = ref($self) || $self;
 374         my %args = @_;
 375
 376
 377         throw OpenSRF::DomainObject::oilsMethodException unless ($args{method});
 378
 379         $args{api_level} = 1 unless(defined($args{api_level}));
 380         $args{stream} ||= 0;
 381         $args{remote} ||= 0;
 382         $args{argc} ||= 0;
 383         $args{package} ||= $app;
 384         $args{server_class} = server_class();
 385         $args{api_name} ||= $args{server_class} . '.' . $args{method};
 386
 387         # un-if(0) this block to enable signature parsing
 388         if (!$args{signature}) {
 389                 if ($args{notes} && !ref($args{notes})) {
 390                         $args{signature} =
 391                                 parse_array_signature( parse_string_signature( $args{notes} ) );
 392                 }
 393         } elsif( !ref($args{signature}) ) {
 394                 $args{signature} =
 395                         parse_array_signature( parse_string_signature( $args{notes} ) );
 396         } elsif( ref($args{signature}) eq 'ARRAY') {
 397                 $args{signature} =
 398                         parse_array_signature( $args{signature} );
 399         }
 400
 401         unless ($args{object_hint}) {
 402                 ($args{object_hint} = $args{package}) =~ s/::/_/go;
 403         }
 404
 405         JSON->register_class_hint( name => $args{package}, hint => $args{object_hint}, type => "hash" );
 406
 407         $_METHODS[$args{api_level}]{$args{api_name}} = bless \%args => $app;
 408
 409         __PACKAGE__->register_method(
 410                 stream => 0,
 411                 argc => $args{argc},
 412                 api_name => $args{api_name}.'.atomic',
 413                 method => 'make_stream_atomic',
 414                 notes => "This is a system generated method.  Please see the definition for $args{api_name}",
 415         ) if ($args{stream});
 416 }
 417
 418 sub retrieve_remote_apis {
 419         my $method = shift;
 420         my $session = OpenSRF::AppSession->create('router');
 421         try {
 422                 $session->connect or OpenSRF::EX::WARN->throw("Connection to router timed out");
 423         } catch Error with {
 424                 my $e = shift;
 425                 $log->debug( "Remote subrequest returned an error:\n". $e );
 426                 return undef;
 427         } finally {
 428                 return undef unless ($session->state == $session->CONNECTED);
 429         };
 430
 431         my $req = $session->request( 'opensrf.router.info.class.list' );
 432         my $list = $req->recv;
 433
 434         if( UNIVERSAL::isa($list,"Error") ) {
 435                 throw $list;
 436         }
 437
 438         my $content = $list->content;
 439
 440         $req->finish;
 441         $session->finish;
 442         $session->disconnect;
 443
 444         my %u_list = map { ($_ => 1) } @$content;
 445
 446         for my $class ( keys %u_list ) {
 447                 next if($class eq $server_class);
 448                 populate_remote_method_cache($class, $method);
 449         }
 450 }
 451
 452 sub populate_remote_method_cache {
 453         my $class = shift;
 454         my $meth = shift;
 455
 456         my $session = OpenSRF::AppSession->create($class);
 457         try {
 458                 $session->connect or OpenSRF::EX::WARN->throw("Connection to $class timed out");
 459
 460                 my $call = 'opensrf.system.method.all' unless (defined $meth);
 461                 $call = 'opensrf.system.method' if (defined $meth);
 462
 463                 my $req = $session->request( $call, $meth );
 464
 465                 while (my $method = $req->recv) {
 466                         next if (UNIVERSAL::isa($method, 'Error'));
 467
 468                         $method = $method->content;
 469                         next if ( exists($_METHODS[$$method{api_level}]) &&
 470                                 exists($_METHODS[$$method{api_level}]{$$method{api_name}}) );
 471                         $method->{remote} = 1;
 472                         bless($method, __PACKAGE__ );
 473                         $_METHODS[$$method{api_level}]{$$method{api_name}} = $method;
 474                 }
 475
 476                 $req->finish;
 477                 $session->finish;
 478                 $session->disconnect;
 479
 480         } catch Error with {
 481                 my $e = shift;
 482                 $log->debug( "Remote subrequest returned an error:\n". $e );
 483                 return undef;
 484         };
 485 }
 486
 487 sub method_lookup {
 488         my $self = shift;
 489         my $method = shift;
 490         my $proto = shift;
 491         my $no_recurse = shift || 0;
 492         my $no_remote = shift || 0;
 493
 494         # this instead of " || 1;" above to allow api_level 0
 495         $proto = $self->api_level unless (defined $proto);
 496
 497         my $class = ref($self) || $self;
 498
 499         $log->debug("Lookup of [$method] by [$class] in api_level [$proto]", DEBUG);
 500         $log->debug("Available methods\n\t".join("\n\t", keys %{ $_METHODS[$proto] }), INTERNAL);
 501
 502         my $meth;
 503         if (__PACKAGE__->thunk) {
 504                 for my $p ( reverse(1 .. $proto) ) {
 505                         if (exists $_METHODS[$p]{$method}) {
 506                                 $meth = $_METHODS[$p]{$method};
 507                         }
 508                 }
 509         } else {
 510                 if (exists $_METHODS[$proto]{$method}) {
 511                         $meth = $_METHODS[$proto]{$method};
 512                 }
 513         }
 514
 515         if (defined $meth) {
 516                 $log->debug("Looks like we found [$method]!", DEBUG);
 517                 $log->debug("Method object is ".Dumper($meth), INTERNAL);
 518                 if($no_remote and $meth->{remote}) {
 519                         $log->debug("OH CRAP We're not supposed to return remote methods", WARN);
 520                         return undef;
 521                 }
 522
 523         } elsif (!$no_recurse) {
 524                 $log->debug("We didn't find [$method], asking everyone else.", DEBUG);
 525                 retrieve_remote_apis($method);
 526                 $meth = $self->method_lookup($method,$proto,1);
 527         }
 528
 529         return $meth;
 530 }
 531
 532 sub run {
 533         my $self = shift;
 534         my $req = shift;
 535
 536         my $resp;
 537         my @params = @_;
 538
 539         if ( !UNIVERSAL::isa($req, 'OpenSRF::AppRequest') ) {
 540                 $log->debug("Creating a SubRequest object", DEBUG);
 541                 unshift @params, $req;
 542                 $req = OpenSRF::AppSubrequest->new;
 543         } else {
 544                 $log->debug("This is a top level request", DEBUG);
 545         }
 546
 547         if (!$self->{remote}) {
 548                 my $code ||= \&{$self->{package} . '::' . $self->{method}};
 549                 $log->debug("Created coderef [$code] for $$self{package}::$$self{method}",DEBUG);
 550                 my $err = undef;
 551
 552                 try {
 553                         $resp = $code->($self, $req, @params);
 554
 555                 } catch Error with {
 556                         my $e = shift;
 557                         $err = $e;
 558                         warn "Method 'run' catching error: $e\n";
 559
 560                         if( ref($self) eq 'HASH') {
 561                                 $log->error("Sub $$self{package}::$$self{method} DIED!!!\n\t$e\n", ERROR);
 562                         }
 563                 };
 564
 565                 if($err) {
 566                         if(UNIVERSAL::isa($err,"Error")) {
 567                                 warn "Throwing from method run:\n$err\n------------------\n";
 568                                 throw $err;
 569                         } else {
 570                                 die $err->stringify;
 571                         }
 572                 }
 573
 574
 575                 $log->debug("Coderef for [$$self{package}::$$self{method}] has been run", DEBUG);
 576
 577                 if ( ref($req) and UNIVERSAL::isa($req, 'OpenSRF::AppSubrequest') ) {
 578                         $log->debug("A SubRequest object is responding", DEBUG);
 579                         $req->respond($resp) if (defined $resp);
 580                         $log->debug("... Responding with : " . join(" ",$req->responses), DEBUG);
 581                         return $req->responses;
 582                 } else {
 583                         $log->debug("A top level Request object is responding $resp", DEBUG) if (defined $resp);
 584                         return $resp;
 585                 }
 586         } else {
 587                 my $session = OpenSRF::AppSession->create($self->{server_class});
 588                 try {
 589                         #$session->connect or OpenSRF::EX::WARN->throw("Connection to [$$self{server_class}] timed out");
 590                         my $remote_req = $session->request( $self->{api_name}, @params );
 591                         while (my $remote_resp = $remote_req->recv) {
 592                                 OpenSRF::Utils::Logger->debug("Remote Subrequest Received " . $remote_resp, INTERNAL );
 593                                 if( UNIVERSAL::isa($remote_resp,"Error") ) {
 594                                         throw $remote_resp;
 595                                 }
 596                                 $req->respond( $remote_resp->content );
 597                         }
 598                         $remote_req->finish();
 599
 600                 } catch Error with {
 601                         my $e = shift;
 602                         $log->debug( "Remote subrequest returned an error:\n". $e );
 603                         return undef;
 604                 };
 605
 606                 if ($session) {
 607                         $session->disconnect();
 608                         $session->finish();
 609                 }
 610
 611                 $log->debug( "Remote Subrequest Responses " . join(" ", $req->responses), INTERNAL );
 612
 613                 return $req->responses;
 614         }
 615         # huh? how'd we get here...
 616         return undef;
 617 }
 618
 619 sub introspect {
 620         my $self = shift;
 621         my $client = shift;
 622         my $method = shift;
 623
 624         $method = undef if ($self->api_name =~ /all$/o);
 625
 626         for my $api_level ( reverse(1 .. $#_METHODS) ) {
 627                 for my $api_name ( sort keys %{$_METHODS[$api_level]} ) {
 628                         if (!$_METHODS[$api_level]{$api_name}{remote}) {
 629                                 if (defined($method)) {
 630                                         if ($api_name =~ $method) {
 631                                                 $client->respond( $_METHODS[$api_level]{$api_name} );
 632                                         }
 633                                 } else {
 634                                         $log->debug( "Returning definition for method [$api_name]", INTERNAL );
 635                                         $client->respond( $_METHODS[$api_level]{$api_name} );
 636                                         $log->debug( "responed with definition for method [$api_name]", INTERNAL );
 637                                 }
 638                         }
 639                 }
 640         }
 641
 642         return undef;
 643 }
 644 __PACKAGE__->register_method(
 645         stream => 1,
 646         method => 'introspect',
 647         api_name => 'opensrf.system.method.all',
 648         argc => 0,
 649         signature => {
 650                 desc => q/This method is used to introspect an entire OpenSRF Application/,
 651                 return => {
 652                         desc => q/A stream of objects describing the methods available via this OpenSRF Application/,
 653                         type => 'object'
 654                 }
 655         },
 656 );
 657 __PACKAGE__->register_method(
 658         stream => 1,
 659         method => 'introspect',
 660         argc => 1,
 661         api_name => 'opensrf.system.method',
 662         argc => 1,
 663         signature => {
 664                 desc => q/Use this method to get the definition of a single OpenSRF Method/,
 665                 params => [
 666                         { desc => q/The method to introspect/,
 667                           type => 'string' },
 668                 ],
 669                 return => { desc => q/An object describing the method requested, or an error if it can't be found/,
 670                             type => 'object' }
 671         },
 672 );
 673
 674 sub echo_method {
 675         my $self = shift;
 676         my $client = shift;
 677         my @args = @_;
 678
 679         $client->respond( $_ ) for (@args);
 680         return undef;
 681 }
 682 __PACKAGE__->register_method(
 683         stream => 1,
 684         method => 'echo_method',
 685         argc => 1,
 686         api_name => 'opensrf.system.echo',
 687         signature => {
 688                 desc => q/A test method that will echo back it's arguments in a streaming response/,
 689                 params => [
 690                         { desc => q/One or more arguments to echo back/ }
 691                 ],
 692                 return => { desc => q/A stream of the arguments passed/ }
 693         },
 694 );
 695
 696 sub make_stream_atomic {
 697         my $self = shift;
 698         my $req = shift;
 699         my @args = @_;
 700
 701         (my $m_name = $self->api_name) =~ s/\.atomic$//o;
 702         my @results = $self->method_lookup($m_name)->run(@args);
 703
 704         return \@results;
 705 }
 706
 707
 708 1;
 709
 710