1 package OpenSRF::DomainObject::oilsMessage;
2 use OpenSRF::Utils::JSON;
3 use OpenSRF::AppSession;
4 use OpenSRF::DomainObject::oilsResponse qw/:status/;
5 use OpenSRF::Utils::Logger qw/:level/;
6 use warnings; use strict;
7 use OpenSRF::EX qw/:try/;
9 OpenSRF::Utils::JSON->register_class_hint(hint => 'osrfMessage', name => 'OpenSRF::DomainObject::oilsMessage', type => 'hash');
14 return OpenSRF::Utils::JSON->perl2prettyJSON($self) if ($pretty);
15 return OpenSRF::Utils::JSON->perl2JSON($self);
20 my $class = ref($self) || $self;
22 return bless \%args => $class;
28 OpenSRF::DomainObject::oilsMessage
32 use OpenSRF::DomainObject::oilsMessage;
34 my $msg = OpenSRF::DomainObject::oilsMessage->new( type => 'CONNECT' );
36 $msg->payload( $domain_object );
40 OpenSRF::DomainObject::oilsMessage is used internally to wrap data sent
41 between client and server. It provides the structure needed to authenticate
42 session data, and also provides the logic needed to unwrap session data and
43 pass this information along to the Application Layer.
47 my $log = 'OpenSRF::Utils::Logger';
51 =head2 OpenSRF::DomainObject::oilsMessage->type( [$new_type] )
55 Used to specify the type of message. One of
56 B<CONNECT, REQUEST, RESULT, STATUS, ERROR, or DISCONNECT>.
65 $self->{type} = $val if (defined $val);
69 =head2 OpenSRF::DomainObject::oilsMessage->api_level( [$new_api_level] )
73 Used to specify the api_level of message. Currently, only api_level C<1> is
74 supported. This will be used to check that messages are well-formed, and as
75 a hint to the Application as to which version of a method should fulfill a
85 $self->{api_level} = $val if (defined $val);
86 return $self->{api_level};
89 =head2 OpenSRF::DomainObject::oilsMessage->sender_locale( [$locale] );
93 Sets or gets the current message locale hint. Useful for telling the
94 server how you see the world.
103 $self->{sender_locale} = $val if (defined $val);
104 return $self->{sender_locale};
107 =head2 OpenSRF::DomainObject::oilsMessage->threadTrace( [$new_threadTrace] );
111 Sets or gets the current message sequence identifier, or thread trace number,
112 for a message. Useful as a debugging aid, but that's about it.
121 $self->{threadTrace} = $val if (defined $val);
122 return $self->{threadTrace};
125 =head2 OpenSRF::DomainObject::oilsMessage->update_threadTrace
129 Increments the threadTrace component of a message. This is automatic when
130 using the normal session processing stack.
136 sub update_threadTrace {
138 my $tT = $self->threadTrace;
143 $log->debug("Setting threadTrace to $tT",DEBUG);
145 $self->threadTrace($tT);
150 =head2 OpenSRF::DomainObject::oilsMessage->payload( [$new_payload] )
154 Sets or gets the payload of a message. This should be exactly one object
155 of (sub)type domainObject or domainObjectCollection.
164 $self->{payload} = $val if (defined $val);
165 return $self->{payload};
168 =head2 OpenSRF::DomainObject::oilsMessage->handler( $session_id )
172 Used by the message processing stack to set session state information from the current
173 message, and then sends control (via the payload) to the Application layer.
183 my $mtype = $self->type;
184 my $api_level = $self->api_level || 1;;
185 my $tT = $self->threadTrace;
187 $session->last_message_type($mtype);
188 $session->last_message_api_level($api_level);
189 $session->last_threadTrace($tT);
191 $log->debug(" Received api_level => [$api_level], MType => [$mtype], ".
192 "from [".$session->remote_id."], threadTrace[".$self->threadTrace."]");
195 if ( $session->endpoint == $session->SERVER() ) {
196 $val = $self->do_server( $session, $mtype, $api_level, $tT );
198 } elsif ($session->endpoint == $session->CLIENT()) {
199 $val = $self->do_client( $session, $mtype, $api_level, $tT );
203 return OpenSRF::Application->handler($session, $self->payload);
205 $log->debug("Request was handled internally", DEBUG);
214 # handle server side message processing
216 # !!! Returning 0 means that we don't want to pass ourselves up to the message layer !!!
218 my( $self, $session, $mtype, $api_level, $tT ) = @_;
220 # A Server should never receive STATUS messages. If so, we drop them.
221 # This is to keep STATUS's from dead client sessions from creating new server
222 # sessions which send mangled session exceptions to backends for messages
223 # that they are not aware of any more.
224 if( $mtype eq 'STATUS' ) { return 0; }
227 if ($mtype eq 'DISCONNECT') {
228 $session->disconnect;
233 if ($session->state == $session->CONNECTING()) {
235 if($mtype ne "CONNECT" and $session->stateless) {
236 return 1; #pass the message up the stack
239 # the transport layer thinks this is a new connection. is it?
240 unless ($mtype eq 'CONNECT') {
241 $log->error("Connection seems to be mangled: Got $mtype instead of CONNECT");
243 my $res = OpenSRF::DomainObject::oilsBrokenSession->new(
244 status => "Connection seems to be mangled: Got $mtype instead of CONNECT",
247 $session->status($res);
253 my $res = OpenSRF::DomainObject::oilsConnectStatus->new;
254 $session->status($res);
255 $session->state( $session->CONNECTED );
266 # Handle client side message processing. Return 1 when the the message should be pushed
267 # up to the application layer. return 0 otherwise.
270 my( $self, $session , $mtype, $api_level, $tT) = @_;
273 if ($mtype eq 'STATUS') {
275 if ($self->payload->statusCode == STATUS_OK) {
276 $session->state($session->CONNECTED);
277 $log->debug("We connected successfully to ".$session->app);
281 if ($self->payload->statusCode == STATUS_TIMEOUT) {
282 $session->state( $session->DISCONNECTED );
285 $session->push_resend( $session->app_request($self->threadTrace) );
286 $log->debug("Disconnected because of timeout");
289 } elsif ($self->payload->statusCode == STATUS_REDIRECTED) {
290 $session->state( $session->DISCONNECTED );
293 $session->push_resend( $session->app_request($self->threadTrace) );
294 $log->debug("Disconnected because of redirect", WARN);
297 } elsif ($self->payload->statusCode == STATUS_EXPFAILED) {
298 $session->state( $session->DISCONNECTED );
299 $log->debug("Disconnected because of mangled session", WARN);
301 $session->push_resend( $session->app_request($self->threadTrace) );
304 } elsif ($self->payload->statusCode == STATUS_CONTINUE) {
305 $session->reset_request_timeout($self->threadTrace);
308 } elsif ($self->payload->statusCode == STATUS_COMPLETE) {
309 my $req = $session->app_request($self->threadTrace);
310 $req->complete(1) if ($req);
314 # add more STATUS handling code here (as 'elsif's), for Message layer status stuff
316 #$session->state( $session->DISCONNECTED() );
319 } elsif ($session->state == $session->CONNECTING()) {
320 # This should be changed to check the type of response (is it a connectException?, etc.)
323 if( $self->payload and $self->payload->isa( "ERROR" ) ) {
324 if ($session->raise_remote_errors) {
325 $self->payload->throw();
329 $log->debug("oilsMessage passing to Application: " . $self->type." : ".$session->remote_id );