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->threadTrace( [$new_threadTrace] );
93 Sets or gets the current message sequence identifier, or thread trace number,
94 for a message. Useful as a debugging aid, but that's about it.
103 $self->{threadTrace} = $val if (defined $val);
104 return $self->{threadTrace};
107 =head2 OpenSRF::DomainObject::oilsMessage->update_threadTrace
111 Increments the threadTrace component of a message. This is automatic when
112 using the normal session processing stack.
118 sub update_threadTrace {
120 my $tT = $self->threadTrace;
125 $log->debug("Setting threadTrace to $tT",DEBUG);
127 $self->threadTrace($tT);
132 =head2 OpenSRF::DomainObject::oilsMessage->payload( [$new_payload] )
136 Sets or gets the payload of a message. This should be exactly one object
137 of (sub)type domainObject or domainObjectCollection.
146 $self->{payload} = $val if (defined $val);
147 return $self->{payload};
150 =head2 OpenSRF::DomainObject::oilsMessage->handler( $session_id )
154 Used by the message processing stack to set session state information from the current
155 message, and then sends control (via the payload) to the Application layer.
165 my $mtype = $self->type;
166 my $api_level = $self->api_level || 1;;
167 my $tT = $self->threadTrace;
169 $session->last_message_type($mtype);
170 $session->last_message_api_level($api_level);
171 $session->last_threadTrace($tT);
173 $log->debug(" Received api_level => [$api_level], MType => [$mtype], ".
174 "from [".$session->remote_id."], threadTrace[".$self->threadTrace."]");
177 if ( $session->endpoint == $session->SERVER() ) {
178 $val = $self->do_server( $session, $mtype, $api_level, $tT );
180 } elsif ($session->endpoint == $session->CLIENT()) {
181 $val = $self->do_client( $session, $mtype, $api_level, $tT );
185 return OpenSRF::Application->handler($session, $self->payload);
187 $log->debug("Request was handled internally", DEBUG);
196 # handle server side message processing
198 # !!! Returning 0 means that we don't want to pass ourselves up to the message layer !!!
200 my( $self, $session, $mtype, $api_level, $tT ) = @_;
202 # A Server should never receive STATUS messages. If so, we drop them.
203 # This is to keep STATUS's from dead client sessions from creating new server
204 # sessions which send mangled session exceptions to backends for messages
205 # that they are not aware of any more.
206 if( $mtype eq 'STATUS' ) { return 0; }
209 if ($mtype eq 'DISCONNECT') {
210 $session->disconnect;
215 if ($session->state == $session->CONNECTING()) {
217 if($mtype ne "CONNECT" and $session->stateless) {
218 return 1; #pass the message up the stack
221 # the transport layer thinks this is a new connection. is it?
222 unless ($mtype eq 'CONNECT') {
223 $log->error("Connection seems to be mangled: Got $mtype instead of CONNECT");
225 my $res = OpenSRF::DomainObject::oilsBrokenSession->new(
226 status => "Connection seems to be mangled: Got $mtype instead of CONNECT",
229 $session->status($res);
235 my $res = OpenSRF::DomainObject::oilsConnectStatus->new;
236 $session->status($res);
237 $session->state( $session->CONNECTED );
248 # Handle client side message processing. Return 1 when the the message should be pushed
249 # up to the application layer. return 0 otherwise.
252 my( $self, $session , $mtype, $api_level, $tT) = @_;
255 if ($mtype eq 'STATUS') {
257 if ($self->payload->statusCode == STATUS_OK) {
258 $session->state($session->CONNECTED);
259 $log->debug("We connected successfully to ".$session->app);
263 if ($self->payload->statusCode == STATUS_TIMEOUT) {
264 $session->state( $session->DISCONNECTED );
267 $session->push_resend( $session->app_request($self->threadTrace) );
268 $log->debug("Disconnected because of timeout");
271 } elsif ($self->payload->statusCode == STATUS_REDIRECTED) {
272 $session->state( $session->DISCONNECTED );
275 $session->push_resend( $session->app_request($self->threadTrace) );
276 $log->debug("Disconnected because of redirect", WARN);
279 } elsif ($self->payload->statusCode == STATUS_EXPFAILED) {
280 $session->state( $session->DISCONNECTED );
281 $log->debug("Disconnected because of mangled session", WARN);
283 $session->push_resend( $session->app_request($self->threadTrace) );
286 } elsif ($self->payload->statusCode == STATUS_CONTINUE) {
287 $session->reset_request_timeout($self->threadTrace);
290 } elsif ($self->payload->statusCode == STATUS_COMPLETE) {
291 my $req = $session->app_request($self->threadTrace);
292 $req->complete(1) if ($req);
296 # add more STATUS handling code here (as 'elsif's), for Message layer status stuff
298 #$session->state( $session->DISCONNECTED() );
301 } elsif ($session->state == $session->CONNECTING()) {
302 # This should be changed to check the type of response (is it a connectException?, etc.)
305 if( $self->payload and $self->payload->isa( "ERROR" ) ) {
306 if ($session->raise_remote_errors) {
307 $self->payload->throw();
311 $log->debug("oilsMessage passing to Application: " . $self->type." : ".$session->remote_id );