| 1 | # ===================================================================== | ||
| 2 | # Copyright (c) 2002,2003 IBM Corporation | ||
| 3 | # All rights reserved. This program and the accompanying materials | ||
| 4 | # are made available under the terms of the Common Public License v1.0 | ||
| 5 | # which accompanies this distribution, and is available at | ||
| 6 | # http://www.opensource.org/licenses/cpl.php | ||
| 7 | # | ||
| 8 | # ===================================================================== | ||
| 9 | package LS::Service::Fault; | ||
| 10 | |||
| 11 | use Carp qw(:DEFAULT); | ||
| 12 | |||
| 13 | use strict; | ||
| 14 | use warnings; | ||
| 15 | |||
| 16 | use vars qw( $METHODS ); | ||
| 17 | |||
| 18 | use LS; | ||
| 19 | |||
| 20 | use base 'LS::Base'; | ||
| 21 | |||
| 22 | sub BEGIN { | ||
| 23 | |||
| 24 | $METHODS = [ | ||
| 25 | 'message', | ||
| 26 | 'code', | ||
| 27 | 'trace', | ||
| 28 | ]; | ||
| 29 | |||
| 30 | LS::makeAccessorMethods($METHODS, __PACKAGE__); | ||
| 31 | } | ||
| 32 | |||
| 33 | |||
| 34 | # | ||
| 35 | # new( %options ) - | ||
| 36 | # | ||
| 37 | sub new { | ||
| 38 | |||
| 39 | my ($self, %options) = @_; | ||
| 40 | |||
| 41 | unless (ref $self) { | ||
| 42 | |||
| 43 | $self = bless { | ||
| 44 | |||
| 45 | _fault_to_strings=> {}, | ||
| 46 | _fault_to_code=> {}, | ||
| 47 | |||
| 48 | }, $self; | ||
| 49 | |||
| 50 | $self->{'_fault_to_strings'} = { | ||
| 51 | '^(bad|invalid)\s+(soap\s+)?(message|msg)\s+(format)'=> 500, | ||
| 52 | '^(unknown|unrecognized)\s+(method|function|operation)(\s+call)?'=> 500, | ||
| 53 | '^(bad|invalid)\s+(method|function|operation)(\s+call)?'=> 500, | ||
| 54 | '^(malformed|bad|invalid)\s+(lsid)'=> 200, | ||
| 55 | '^(unknown|unrecognized)\s+(lsid)'=> 201, | ||
| 56 | '^data\s+(not\s+|un-?)available'=> 300, | ||
| 57 | '^(data\s+range\s+not\s+valid)'=> 301, | ||
| 58 | '^metadata\s+(not\s+|un-?)available'=> 400, | ||
| 59 | '^metadata\s+format\s+(not\s+|un-?)available'=> 401, | ||
| 60 | '^internal\s+((server|processing)\s+)?error'=> 500, | ||
| 61 | '^(method|function|operation)\s+(not\s+|un-?)(available|implemented)'=> 501, | ||
| 62 | }; | ||
| 63 | |||
| 64 | $self->{'_fault_to_code'} = { | ||
| 65 | 200=> 'Malformed LSID', | ||
| 66 | 201=> 'Unknown LSID', | ||
| 67 | 300=> 'Data not available', | ||
| 68 | 301=> 'Data range not valid', | ||
| 69 | 400=> 'Metadata not available', | ||
| 70 | 401=> 'Metadata format not available', | ||
| 71 | 500=> 'Internal processing error', | ||
| 72 | 501=> 'Method not implemented', | ||
| 73 | |||
| 74 | # Platform error codes | ||
| 75 | }; | ||
| 76 | } | ||
| 77 | |||
| 78 | return $self; | ||
| 79 | } | ||
| 80 | |||
| 81 | |||
| 82 | # | ||
| 83 | # message( $message ) - | ||
| 84 | # | ||
| 85 | |||
| 86 | |||
| 87 | # | ||
| 88 | # code( $code ) - | ||
| 89 | # | ||
| 90 | |||
| 91 | |||
| 92 | # | ||
| 93 | # trace( $trace ) - | ||
| 94 | # | ||
| 95 | |||
| 96 | |||
| 97 | # | ||
| 98 | # fault( $message ) - | ||
| 99 | # | ||
| 100 | sub fault { | ||
| 101 | |||
| 102 | my $self = shift->new(); | ||
| 103 | my $msg = shift; | ||
| 104 | |||
| 105 | unless($msg) { | ||
| 106 | |||
| 107 | $self->code(500); | ||
| 108 | $self->message('Internal Error'); | ||
| 109 | $self->trace(Carp::longmess('No message specified')); | ||
| 110 | |||
| 111 | return $self; | ||
| 112 | } | ||
| 113 | |||
| 114 | $self->code($self->_fault_string_to_code($msg)); | ||
| 115 | |||
| 116 | unless($self->code) { | ||
| 117 | |||
| 118 | $self->code(500); | ||
| 119 | $self->message('Internal Error'); | ||
| 120 | $self->trace(Carp::longmess('Could not resolve message: ' . $msg . ' to a LSID error code')); | ||
| 121 | |||
| 122 | return $self; | ||
| 123 | } | ||
| 124 | |||
| 125 | my $fixed_msg = $self->_code_to_fault_string($self->code()); | ||
| 126 | |||
| 127 | my $fc = ($self->code() < 500) ? 'Client' : 'Server'; | ||
| 128 | |||
| 129 | my $fault = $self->code() . " $fc Error: $fixed_msg"; | ||
| 130 | |||
| 131 | $self->message($fault); | ||
| 132 | $self->trace(Carp::longmess('Stack trace')); | ||
| 133 | |||
| 134 | return $self; | ||
| 135 | } | ||
| 136 | |||
| 137 | # | ||
| 138 | # create( $message ) - | ||
| 139 | # | ||
| 140 | sub create { | ||
| 141 | |||
| 142 | return shift->fault(@_); | ||
| 143 | } | ||
| 144 | |||
| 145 | |||
| 146 | # | ||
| 147 | # clientFault( $message, $errorCode ) - | ||
| 148 | # | ||
| 149 | sub clientFault { | ||
| 150 | |||
| 151 | my $self = shift->new(); | ||
| 152 | my ($msg, $errc) = @_; | ||
| 153 | |||
| 154 | unless ($msg && $errc) { | ||
| 155 | |||
| 156 | $self->code(500); | ||
| 157 | $self->message('Internal Error'); | ||
| 158 | $self->trace(Carp::longmess('Error message and code must be specified')); | ||
| 159 | |||
| 160 | return $self; | ||
| 161 | } | ||
| 162 | |||
| 163 | $self->message($msg); | ||
| 164 | $self->code($errc); | ||
| 165 | |||
| 166 | unless($self->code()) { | ||
| 167 | |||
| 168 | $self->code(500); | ||
| 169 | $self->message('Internal Error'); | ||
| 170 | $self->trace(Carp::longmess('Could not resolve message: ' . $msg . ' to a LSID error code')); | ||
| 171 | |||
| 172 | return $self; | ||
| 173 | } | ||
| 174 | |||
| 175 | my $fault = $self->code() . ' Client Error: ' . $self->message(); | ||
| 176 | |||
| 177 | $self->message($fault); | ||
| 178 | $self->trace(Carp::longmess('Stack trace')); | ||
| 179 | |||
| 180 | return $self; | ||
| 181 | } | ||
| 182 | |||
| 183 | |||
| 184 | # | ||
| 185 | # serverFault( $message, $errorCode ) - | ||
| 186 | # | ||
| 187 | sub serverFault { | ||
| 188 | |||
| 189 | my $self = shift->new(); | ||
| 190 | my ($msg, $errc) = @_; | ||
| 191 | |||
| 192 | unless ($msg && $errc) { | ||
| 193 | |||
| 194 | $self->code(500); | ||
| 195 | $self->message('Internal Error'); | ||
| 196 | $self->trace(Carp::longmess('Error message and code must be specified')); | ||
| 197 | |||
| 198 | return $self; | ||
| 199 | } | ||
| 200 | |||
| 201 | $self->message($msg); | ||
| 202 | $self->code($errc); | ||
| 203 | |||
| 204 | unless($self->code()) { | ||
| 205 | |||
| 206 | $self->code(500); | ||
| 207 | $self->message('Internal Error'); | ||
| 208 | $self->trace(Carp::longmess('Could not resolve message: ' . $msg . ' to a LSID error code')); | ||
| 209 | |||
| 210 | return $self; | ||
| 211 | } | ||
| 212 | |||
| 213 | my $fault = $self->code() . ' Server Error: ' . $self->message(); | ||
| 214 | |||
| 215 | $self->message($fault); | ||
| 216 | $self->trace(Carp::longmess('Stack trace')); | ||
| 217 | |||
| 218 | return $self; | ||
| 219 | } | ||
| 220 | |||
| 221 | |||
| 222 | # | ||
| 223 | # as_string( ) - Returns the string representation of this fault | ||
| 224 | # | ||
| 225 | sub as_string { | ||
| 226 | |||
| 227 | my $self = shift; | ||
| 228 | |||
| 229 | return "Code: " . $self->code() . "\n" . "Message: ". $self->message() . "\n" . "Stack trace: " . $self->trace(); | ||
| 230 | } | ||
| 231 | |||
| 232 | |||
| 233 | # | ||
| 234 | # _fault_string_to_code( $fault ) - | ||
| 235 | # | ||
| 236 | sub _fault_string_to_code { | ||
| 237 | |||
| 238 | my ($self, $fault) = @_; | ||
| 239 | |||
| 240 | return undef unless ($fault); | ||
| 241 | |||
| 242 | $fault=~ s/^\s+//; | ||
| 243 | |||
| 244 | while (my ($ptn, $code) = each(%{ $self->{'_fault_to_strings'} })) { | ||
| 245 | |||
| 246 | return $code if ($fault =~ /$ptn/i); | ||
| 247 | } | ||
| 248 | |||
| 249 | return undef; | ||
| 250 | } | ||
| 251 | |||
| 252 | |||
| 253 | # | ||
| 254 | # _code_to_fault_string( $code ) - | ||
| 255 | # | ||
| 256 | sub _code_to_fault_string { | ||
| 257 | |||
| 258 | my ($self, $code) = @_; | ||
| 259 | |||
| 260 | return undef unless ($code); | ||
| 261 | return undef unless (exists($self->{'_fault_to_code'}->{ $code })); | ||
| 262 | |||
| 263 | return $self->{'_fault_to_code'}->{$code}; | ||
| 264 | } | ||
| 265 | |||
| 266 | 1; | ||
| 267 | |||
| 268 | __END__ |