svn commit: r1054435 [2/2] - in /ofbiz/trunk/applications/prod
Locked
 
|
Modified: ofbiz/trunk/applications/product/src/org/ofbiz/shipment/thirdparty/usps/UspsServices.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/product/src/org/ofbiz/shipment/thirdparty/usps/UspsServices.java?rev=1054435&r1=1054434&r2=1054435&view=diff ============================================================================== --- ofbiz/trunk/applications/product/src/org/ofbiz/shipment/thirdparty/usps/UspsServices.java (original) +++ ofbiz/trunk/applications/product/src/org/ofbiz/shipment/thirdparty/usps/UspsServices.java Sun Jan 2 17:20:48 2011 @@ -24,7 +24,6 @@ import java.io.FileOutputStream; import java.io.IOException; import java.io.OutputStream; import java.math.BigDecimal; -import java.math.MathContext; import java.text.DecimalFormat; import java.util.Collections; import java.util.Iterator; @@ -64,6 +63,7 @@ import org.ofbiz.service.GenericServiceE import org.ofbiz.service.LocalDispatcher; import org.ofbiz.service.ModelService; import org.ofbiz.service.ServiceUtil; +import org.ofbiz.shipment.shipment.ShipmentServices; import org.ofbiz.shipment.shipment.ShipmentWorker; import org.w3c.dom.Document; import org.w3c.dom.Element; @@ -75,7 +75,7 @@ import org.xml.sax.SAXException; public class UspsServices { public final static String module = UspsServices.class.getName(); - public final static String errorResource = "ProductErrorUiLabels"; + public final static String resourceError = "ProductUiLabels"; private static List<String> domesticCountries = FastList.newInstance(); // Countries treated as domestic for rate enquiries @@ -87,14 +87,17 @@ public class UspsServices { } public static Map<String, Object> uspsRateInquire(DispatchContext dctx, Map<String, ? extends Object> context) { - Delegator delegator = dctx.getDelegator(); - + String shipmentGatewayConfigId = (String) context.get("shipmentGatewayConfigId"); + String resource = (String) context.get("configProps"); + Locale locale = (Locale) context.get("locale"); + // check for 0 weight BigDecimal shippableWeight = (BigDecimal) context.get("shippableWeight"); if (shippableWeight.compareTo(BigDecimal.ZERO) == 0) { // TODO: should we return an error, or $0.00 ? - return ServiceUtil.returnFailure("shippableWeight must be greater than 0"); + return ServiceUtil.returnFailure(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsShippableWeightMustGreaterThanZero", locale)); } // get the origination ZIP @@ -115,7 +118,8 @@ public class UspsServices { } } if (UtilValidate.isEmpty(originationZip)) { - return ServiceUtil.returnError("Unable to determine the origination ZIP"); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsUnableDetermineOriginationZip", locale)); } // get the destination ZIP @@ -126,7 +130,8 @@ public class UspsServices { GenericValue shipToAddress = delegator.findByPrimaryKey("PostalAddress", UtilMisc.toMap("contactMechId", shippingContactMechId)); if (shipToAddress != null) { if (!domesticCountries.contains(shipToAddress.getString("countryGeoId"))) { - return ServiceUtil.returnFailure("uspsRateInquire is only valid for US destinations."); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsRateInquiryOnlyInUsDestinations", locale)); } destinationZip = shipToAddress.getString("postalCode"); } @@ -135,7 +140,8 @@ public class UspsServices { } } if (UtilValidate.isEmpty(destinationZip)) { - return ServiceUtil.returnError("Unable to determine the destination ZIP"); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsUnableDetermineDestinationZip", locale)); } // get the service code @@ -145,22 +151,23 @@ public class UspsServices { UtilMisc.toMap("shipmentMethodTypeId", (String) context.get("shipmentMethodTypeId"), "partyId", (String) context.get("carrierPartyId"), "roleTypeId", (String) context.get("carrierRoleTypeId"))); if (carrierShipmentMethod != null) { - serviceCode = carrierShipmentMethod.getString("carrierServiceCode"); + serviceCode = carrierShipmentMethod.getString("carrierServiceCode").toUpperCase(); } } catch (GenericEntityException e) { Debug.logError(e, module); } if (UtilValidate.isEmpty(serviceCode)) { - return ServiceUtil.returnError("Unable to determine the service code"); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsUnableDetermineServiceCode", locale)); } // create the request document - Document requestDocument = createUspsRequestDocument("RateV2Request", true); + Document requestDocument = createUspsRequestDocument("RateV2Request", true, delegator, shipmentGatewayConfigId, resource); // TODO: 70 lb max is valid for Express, Priority and Parcel only - handle other methods BigDecimal maxWeight = new BigDecimal("70"); - String maxWeightStr = UtilProperties.getPropertyValue((String) context.get("serviceConfigProps"), - "shipment.usps.max.estimate.weight", "70"); + String maxWeightStr = getShipmentGatewayConfigValue(delegator, shipmentGatewayConfigId, "maxEstimateWeight", + resource, "shipment.usps.max.estimate.weight", "70"); try { maxWeight = new BigDecimal(maxWeightStr); } catch (NumberFormatException e) { @@ -195,7 +202,7 @@ public class UspsServices { } // (packageWeight % 1) * 16 (Rounded up to 0 dp) BigDecimal weightOunces = packageWeight.remainder(BigDecimal.ONE).multiply(new BigDecimal("16")).setScale(0, BigDecimal.ROUND_CEILING); - + UtilXml.addChildElementValue(packageElement, "Pounds", weightPounds.toPlainString(), requestDocument); UtilXml.addChildElementValue(packageElement, "Ounces", weightOunces.toPlainString(), requestDocument); @@ -209,26 +216,29 @@ public class UspsServices { if ("Parcel".equalsIgnoreCase(serviceCode)) { UtilXml.addChildElementValue(packageElement, "Container", "None", requestDocument); } - UtilXml.addChildElementValue(packageElement, "Size", "Regular", requestDocument); - UtilXml.addChildElementValue(packageElement, "Machinable", "False", requestDocument); + UtilXml.addChildElementValue(packageElement, "Size", "REGULAR", requestDocument); + UtilXml.addChildElementValue(packageElement, "Machinable", "false", requestDocument); } // send the request Document responseDocument = null; try { - responseDocument = sendUspsRequest("RateV2", requestDocument); + responseDocument = sendUspsRequest("RateV2", requestDocument, delegator, shipmentGatewayConfigId, resource, locale); } catch (UspsRequestException e) { Debug.log(e, module); - return ServiceUtil.returnError("Error sending request for USPS Domestic Rate Calculation service: " + e.getMessage()); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsRateDomesticSendingError", UtilMisc.toMap("errorString", e.getMessage()), locale)); } if (responseDocument == null) { - return ServiceUtil.returnError("No rate available at this time"); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentRateNotAvailable", locale)); } List<? extends Element> rates = UtilXml.childElementList(responseDocument.getDocumentElement(), "Package"); if (UtilValidate.isEmpty(rates)) { - return ServiceUtil.returnError("No rate available at this time"); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentRateNotAvailable", locale)); } BigDecimal estimateAmount = BigDecimal.ZERO; @@ -267,13 +277,16 @@ public class UspsServices { * 21 - PostCards */ public static Map<String, Object> uspsInternationalRateInquire(DispatchContext dctx, Map<String, ? extends Object> context) { - Delegator delegator = dctx.getDelegator(); + String shipmentGatewayConfigId = (String) context.get("shipmentGatewayConfigId"); + String resource = (String) context.get("configProps"); + Locale locale = (Locale) context.get("locale"); // check for 0 weight BigDecimal shippableWeight = (BigDecimal) context.get("shippableWeight"); if (shippableWeight.compareTo(BigDecimal.ZERO) == 0) { - return ServiceUtil.returnFailure("shippableWeight must be greater than 0"); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsShippableWeightMustGreaterThanZero", locale)); } // get the destination country @@ -283,7 +296,8 @@ public class UspsServices { try { GenericValue shipToAddress = delegator.findByPrimaryKey("PostalAddress", UtilMisc.toMap("contactMechId", shippingContactMechId)); if (domesticCountries.contains(shipToAddress.get("countryGeoId"))) { - return ServiceUtil.returnError("The USPS International Rate Calculation service is not applicable to US destinations (including Possesions), use uspsRateInquire"); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsRateInternationCannotBeUsedForUsDestinations", locale)); } if (shipToAddress != null && UtilValidate.isNotEmpty(shipToAddress.getString("countryGeoId"))) { GenericValue countryGeo = shipToAddress.getRelatedOne("CountryGeo"); @@ -295,7 +309,8 @@ public class UspsServices { } } if (UtilValidate.isEmpty(destinationCountry)) { - return ServiceUtil.returnError("Unable to determine the destination country"); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsUnableDetermineDestinationCountry", locale)); } // get the service code @@ -311,12 +326,13 @@ public class UspsServices { Debug.logError(e, module); } if (UtilValidate.isEmpty(serviceCode)) { - return ServiceUtil.returnError("Unable to determine the service code"); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsUnableDetermineServiceCode", locale)); } BigDecimal maxWeight = new BigDecimal("70"); - String maxWeightStr = UtilProperties.getPropertyValue((String) context.get("serviceConfigProps"), - "shipment.usps.max.estimate.weight", "70"); + String maxWeightStr = getShipmentGatewayConfigValue(delegator, shipmentGatewayConfigId, "maxEstimateWeight", + resource, "shipment.usps.max.estimate.weight", "70"); try { maxWeight = new BigDecimal(maxWeightStr); } catch (NumberFormatException e) { @@ -329,7 +345,7 @@ public class UspsServices { boolean isOnePackage = packages.size() == 1; // use shippableWeight if there's only one package // create the request document - Document requestDocument = createUspsRequestDocument("IntlRateRequest", false); + Document requestDocument = createUspsRequestDocument("IntlRateRequest", false, delegator, shipmentGatewayConfigId, resource); // TODO: Up to 25 packages can be included per request - handle more than 25 for (ListIterator<Map<String, BigDecimal>> li = packages.listIterator(); li.hasNext();) { @@ -362,19 +378,22 @@ public class UspsServices { // send the request Document responseDocument = null; try { - responseDocument = sendUspsRequest("IntlRate", requestDocument); + responseDocument = sendUspsRequest("IntlRate", requestDocument, delegator, shipmentGatewayConfigId, resource, locale); } catch (UspsRequestException e) { Debug.log(e, module); - return ServiceUtil.returnError("Error sending request for USPS International Rate Calculation service: " + e.getMessage()); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsRateInternationalSendingError", UtilMisc.toMap("errorString", e.getMessage()), locale)); } if (responseDocument == null) { - return ServiceUtil.returnError("No rate available at this time"); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentRateNotAvailable", locale)); } List<? extends Element> packageElements = UtilXml.childElementList(responseDocument.getDocumentElement(), "Package"); if (UtilValidate.isEmpty(packageElements)) { - return ServiceUtil.returnError("No rate available at this time"); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentRateNotAvailable", locale)); } BigDecimal estimateAmount = BigDecimal.ZERO; @@ -383,7 +402,8 @@ public class UspsServices { if (errorElement != null) { String errorDescription = UtilXml.childElementValue(errorElement, "Description"); Debug.log("USPS International Rate Calculation returned a package error: " + errorDescription); - return ServiceUtil.returnError("No rate available at this time"); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentRateNotAvailable", locale)); } List<? extends Element> serviceElements = UtilXml.childElementList(packageElement, "Service"); for (Element serviceElement : serviceElements) { @@ -396,7 +416,8 @@ public class UspsServices { estimateAmount = estimateAmount.add(packageAmount); } catch (NumberFormatException e) { Debug.log("USPS International Rate Calculation returned an unparsable postage amount: " + UtilXml.childElementValue(serviceElement, "Postage")); - return ServiceUtil.returnError("No rate available at this time"); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentRateNotAvailable", locale)); } } } @@ -429,23 +450,29 @@ public class UspsServices { */ public static Map<String, Object> uspsTrackConfirm(DispatchContext dctx, Map<String, ? extends Object> context) { + Delegator delegator = dctx.getDelegator(); + String shipmentGatewayConfigId = (String) context.get("shipmentGatewayConfigId"); + String resource = (String) context.get("configProps"); + Locale locale = (Locale) context.get("locale"); - Document requestDocument = createUspsRequestDocument("TrackRequest", true); + Document requestDocument = createUspsRequestDocument("TrackRequest", true, delegator, shipmentGatewayConfigId, resource); Element trackingElement = UtilXml.addChildElement(requestDocument.getDocumentElement(), "TrackID", requestDocument); trackingElement.setAttribute("ID", (String) context.get("trackingId")); Document responseDocument = null; try { - responseDocument = sendUspsRequest("TrackV2", requestDocument); + responseDocument = sendUspsRequest("TrackV2", requestDocument, delegator, shipmentGatewayConfigId, resource, locale); } catch (UspsRequestException e) { Debug.log(e, module); - return ServiceUtil.returnError("Error sending request for USPS Tracking service: " + e.getMessage()); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsTrackingSendingError", UtilMisc.toMap("errorString", e.getMessage()), locale)); } Element trackInfoElement = UtilXml.firstChildElement(responseDocument.getDocumentElement(), "TrackInfo"); if (trackInfoElement == null) { - return ServiceUtil.returnError("Incomplete response from USPS Tracking service: no TrackInfo element found"); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsTrackingIncompleteResponse", locale)); } Map<String, Object> result = ServiceUtil.returnSuccess(); @@ -499,18 +526,21 @@ public class UspsServices { */ public static Map<String, Object> uspsAddressValidation(DispatchContext dctx, Map<String, ? extends Object> context) { - + Delegator delegator = dctx.getDelegator(); + String shipmentGatewayConfigId = (String) context.get("shipmentGatewayConfigId"); + String resource = (String) context.get("configProps"); String state = (String) context.get("state"); String city = (String) context.get("city"); String zip5 = (String) context.get("zip5"); + Locale locale = (Locale) context.get("locale"); if ((UtilValidate.isEmpty(state) && UtilValidate.isEmpty(city) && UtilValidate.isEmpty(zip5)) || // No state, city or zip5 (UtilValidate.isEmpty(zip5) && (UtilValidate.isEmpty(state) || UtilValidate.isEmpty(city)))) { // Both state and city are required if no zip5 - String errorMessage = UtilProperties.getMessage(errorResource, "ProductUspsAddressValidationStateAndCityOrZipRqd", (Locale) context.get("locale")); - Debug.logError(errorMessage, module); - return ServiceUtil.returnError(errorMessage); + Debug.logError("USPS address validation requires either zip5 or city and state", module); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsAddressValidationStateAndCityOrZipRqd", locale)); } - Document requestDocument = createUspsRequestDocument("AddressValidateRequest", true); + Document requestDocument = createUspsRequestDocument("AddressValidateRequest", true, delegator, shipmentGatewayConfigId, resource); Element addressElement = UtilXml.addChildElement(requestDocument.getDocumentElement(), "Address", requestDocument); addressElement.setAttribute("ID", "0"); @@ -530,21 +560,24 @@ public class UspsServices { Document responseDocument = null; try { - responseDocument = sendUspsRequest("Verify", requestDocument); + responseDocument = sendUspsRequest("Verify", requestDocument, delegator, shipmentGatewayConfigId, resource, locale); } catch (UspsRequestException e) { Debug.log(e, module); - return ServiceUtil.returnFailure("Error sending request for USPS Address Validation service: " + e.getMessage()); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsAddressValidationSendingError", UtilMisc.toMap("errorString", e.getMessage()), locale)); } Element respAddressElement = UtilXml.firstChildElement(responseDocument.getDocumentElement(), "Address"); if (respAddressElement == null) { - return ServiceUtil.returnFailure("Incomplete response from USPS Address Validation service: no Address element found"); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsAddressValidationIncompleteResponse", locale)); } Element respErrorElement = UtilXml.firstChildElement(respAddressElement, "Error"); if (respErrorElement != null) { - return ServiceUtil.returnFailure("The following error was returned by the USPS Address Validation service: " + - UtilXml.childElementValue(respErrorElement, "Description")); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsAddressValidationIncompleteResponse", + UtilMisc.toMap("errorString", UtilXml.childElementValue(respErrorElement, "Description")), locale)); } Map<String, Object> result = ServiceUtil.returnSuccess(); @@ -570,8 +603,6 @@ public class UspsServices { if (returnTextElement != null) { result.put("returnText", UtilXml.elementValue(returnTextElement)); } - - return result; } @@ -598,8 +629,12 @@ public class UspsServices { */ public static Map<String, Object> uspsCityStateLookup(DispatchContext dctx, Map<String, ? extends Object> context) { + Delegator delegator = dctx.getDelegator(); + String shipmentGatewayConfigId = (String) context.get("shipmentGatewayConfigId"); + String resource = (String) context.get("configProps"); + Locale locale = (Locale) context.get("locale"); - Document requestDocument = createUspsRequestDocument("CityStateLookupRequest", true); + Document requestDocument = createUspsRequestDocument("CityStateLookupRequest", true, delegator, shipmentGatewayConfigId, resource); Element zipCodeElement = UtilXml.addChildElement(requestDocument.getDocumentElement(), "ZipCode", requestDocument); zipCodeElement.setAttribute("ID", "0"); @@ -611,33 +646,40 @@ public class UspsServices { Document responseDocument = null; try { - responseDocument = sendUspsRequest("CityStateLookup", requestDocument); + responseDocument = sendUspsRequest("CityStateLookup", requestDocument, delegator, shipmentGatewayConfigId, resource, locale); } catch (UspsRequestException e) { Debug.log(e, module); - return ServiceUtil.returnFailure("Error sending request for USPS City/State Lookup service: " + e.getMessage()); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsCityStateLookupSendingError", + UtilMisc.toMap("errorString", e.getMessage()), locale)); } Element respAddressElement = UtilXml.firstChildElement(responseDocument.getDocumentElement(), "ZipCode"); if (respAddressElement == null) { - return ServiceUtil.returnFailure("Incomplete response from USPS City/State Lookup service: no ZipCode element found"); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsCityStateLookupIncompleteResponse", locale)); } Element respErrorElement = UtilXml.firstChildElement(respAddressElement, "Error"); if (respErrorElement != null) { - return ServiceUtil.returnFailure(UtilXml.childElementValue(respErrorElement, "Description")); + return ServiceUtil.returnFailure(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsCityStateLookupResponseError", + UtilMisc.toMap("errorString", UtilXml.childElementValue(respErrorElement, "Description")), locale)); } Map<String, Object> result = ServiceUtil.returnSuccess(); String city = UtilXml.childElementValue(respAddressElement, "City"); if (UtilValidate.isEmpty(city)) { - return ServiceUtil.returnFailure("Incomplete response from USPS City/State Lookup service: no City element found"); + return ServiceUtil.returnFailure(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsCityStateLookupIncompleteCityElement", locale)); } result.put("city", city); String state = UtilXml.childElementValue(respAddressElement, "State"); if (UtilValidate.isEmpty(state)) { - return ServiceUtil.returnFailure("Incomplete response from USPS City/State Lookup service: no State element found"); + return ServiceUtil.returnFailure(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsCityStateLookupIncompleteStateElement", locale)); } result.put("state", state); @@ -698,13 +740,18 @@ public class UspsServices { } private static Map<String, Object> uspsServiceStandards(DispatchContext dctx, Map<String, ? extends Object> context) { - + Delegator delegator = dctx.getDelegator(); + String shipmentGatewayConfigId = (String) context.get("shipmentGatewayConfigId"); + String resource = (String) context.get("configProps"); String type = (String) context.get("serviceType"); + Locale locale = (Locale) context.get("locale"); if (!type.matches("PriorityMail|StandardB")) { - return ServiceUtil.returnError("Unsupported service type: " + type); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsUnsupporteServiceType", + UtilMisc.toMap("serviceType", type), locale)); } - Document requestDocument = createUspsRequestDocument(type + "Request", true); + Document requestDocument = createUspsRequestDocument(type + "Request", true, delegator, shipmentGatewayConfigId, resource); UtilXml.addChildElementValue(requestDocument.getDocumentElement(), "OriginZip", (String) context.get("originZip"), requestDocument); @@ -713,19 +760,21 @@ public class UspsServices { Document responseDocument = null; try { - responseDocument = sendUspsRequest(type, requestDocument); + responseDocument = sendUspsRequest(type, requestDocument, delegator, shipmentGatewayConfigId, resource, locale); } catch (UspsRequestException e) { Debug.log(e, module); - return ServiceUtil.returnError("Error sending request for USPS " + type + " Service Standards service: " + - e.getMessage()); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsServiceStandardSendingError", + UtilMisc.toMap("serviceType", type, "errorString", e.getMessage()), locale)); } Map<String, Object> result = ServiceUtil.returnSuccess(); String days = UtilXml.childElementValue(responseDocument.getDocumentElement(), "Days"); if (UtilValidate.isEmpty(days)) { - return ServiceUtil.returnError("Incomplete response from USPS " + type + " Service Standards service: " + - "no Days element found"); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsServiceStandardResponseIncompleteDaysElement", + UtilMisc.toMap("serviceType", type), locale)); } result.put("days", days); @@ -780,8 +829,12 @@ public class UspsServices { */ public static Map<String, Object> uspsDomesticRate(DispatchContext dctx, Map<String, ? extends Object> context) { - - Document requestDocument = createUspsRequestDocument("RateRequest", true); + Delegator delegator = dctx.getDelegator(); + String shipmentGatewayConfigId = (String) context.get("shipmentGatewayConfigId"); + String resource = (String) context.get("configProps"); + Locale locale = (Locale) context.get("locale"); + + Document requestDocument = createUspsRequestDocument("RateRequest", true, delegator, shipmentGatewayConfigId, resource); Element packageElement = UtilXml.addChildElement(requestDocument.getDocumentElement(), "Package", requestDocument); packageElement.setAttribute("ID", "0"); @@ -812,34 +865,40 @@ public class UspsServices { Document responseDocument = null; try { - responseDocument = sendUspsRequest("Rate", requestDocument); + responseDocument = sendUspsRequest("Rate", requestDocument, delegator, shipmentGatewayConfigId, resource, locale); } catch (UspsRequestException e) { Debug.log(e, module); - return ServiceUtil.returnError("Error sending request for USPS Domestic Rate Calculation service: " + e.getMessage()); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsRateDomesticSendingError", + UtilMisc.toMap("errorString", e.getMessage()), locale)); } Element respPackageElement = UtilXml.firstChildElement(responseDocument.getDocumentElement(), "Package"); if (respPackageElement == null) { - return ServiceUtil.returnError("Incomplete response from USPS Domestic Rate Calculation service: no Package element found"); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsRateDomesticResponseIncompleteElementPackage", locale)); } Element respErrorElement = UtilXml.firstChildElement(respPackageElement, "Error"); if (respErrorElement != null) { - return ServiceUtil.returnError("The following error was returned by the USPS Domestic Rate Calculation service: " + - UtilXml.childElementValue(respErrorElement, "Description")); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsRateDomesticResponseError", + UtilMisc.toMap("errorString", UtilXml.childElementValue(respErrorElement, "Description")), locale)); } Map<String, Object> result = ServiceUtil.returnSuccess(); String zone = UtilXml.childElementValue(respPackageElement, "Zone"); if (UtilValidate.isEmpty(zone)) { - return ServiceUtil.returnError("Incomplete response from USPS Domestic Rate Calculation service: no Zone element found"); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsRateDomesticResponseIncompleteElementZone", locale)); } result.put("zone", zone); String postage = UtilXml.childElementValue(respPackageElement, "Postage"); if (UtilValidate.isEmpty(postage)) { - return ServiceUtil.returnError("Incomplete response from USPS Domestic Rate Calculation service: no Postage element found"); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsRateDomesticResponseIncompleteElementPostage", locale)); } result.put("postage", postage); @@ -861,78 +920,99 @@ public class UspsServices { /* --- ShipmentRouteSegment services --------------------------------------------------------------------------- */ public static Map<String, Object> uspsUpdateShipmentRateInfo(DispatchContext dctx, Map<String, ? extends Object> context) { - Delegator delegator = dctx.getDelegator(); LocalDispatcher dispatcher = dctx.getDispatcher(); - String shipmentId = (String) context.get("shipmentId"); String shipmentRouteSegmentId = (String) context.get("shipmentRouteSegmentId"); - - // ShipmentRouteSegment identifier - used in error messages - String srsKeyString = "[" + shipmentId + "," + shipmentRouteSegmentId + "]"; + Locale locale = (Locale) context.get("locale"); + + Map<String, Object> shipmentGatewayConfig = ShipmentServices.getShipmentGatewayConfigFromShipment(delegator, shipmentId); + String shipmentGatewayConfigId = (String) shipmentGatewayConfig.get("shipmentGatewayConfigId"); + String resource = (String) shipmentGatewayConfig.get("configProps"); + if (UtilValidate.isEmpty(shipmentGatewayConfigId) && UtilValidate.isEmpty(resource)) { + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsGatewayNotAvailable", locale)); + } try { GenericValue shipmentRouteSegment = delegator.findByPrimaryKey("ShipmentRouteSegment", UtilMisc.toMap("shipmentId", shipmentId, "shipmentRouteSegmentId", shipmentRouteSegmentId)); if (shipmentRouteSegment == null) { - return ServiceUtil.returnError("ShipmentRouteSegment " + srsKeyString + " not found"); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "ProductShipmentRouteSegmentNotFound", + UtilMisc.toMap("shipmentId", shipmentId, "shipmentRouteSegmentId", shipmentRouteSegmentId), locale)); } // ensure the carrier is USPS if (!"USPS".equals(shipmentRouteSegment.getString("carrierPartyId"))) { - return ServiceUtil.returnError("The Carrier for ShipmentRouteSegment " + srsKeyString + ", is not USPS"); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsNotRouteSegmentCarrier", + UtilMisc.toMap("shipmentRouteSegmentId", shipmentRouteSegmentId, "shipmentId", shipmentId), locale)); } // get the origin address GenericValue originAddress = shipmentRouteSegment.getRelatedOne("OriginPostalAddress"); if (originAddress == null) { - return ServiceUtil.returnError("OriginPostalAddress not found for ShipmentRouteSegment [" + - shipmentId + ":" + shipmentRouteSegmentId + "]"); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentRouteSegmentOriginPostalAddressNotFound", + UtilMisc.toMap("shipmentId", shipmentId, "shipmentRouteSegmentId", shipmentRouteSegmentId), locale)); } if (!"USA".equals(originAddress.getString("countryGeoId"))) { - return ServiceUtil.returnError("ShipmentRouteSeqment " + srsKeyString + " does not originate from a US address"); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsRouteSegmentOriginCountryGeoNotInUsa", + UtilMisc.toMap("shipmentId", shipmentId, "shipmentRouteSegmentId", shipmentRouteSegmentId), locale)); } String originZip = originAddress.getString("postalCode"); if (UtilValidate.isEmpty(originZip)) { - return ServiceUtil.returnError("ZIP code is missing from the origin postal address" + - " (contactMechId " + originAddress.getString("contactMechId") + ")"); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsRouteSegmentOriginZipCodeMissing", + UtilMisc.toMap("contactMechId", originAddress.getString("contactMechId")), locale)); } // get the destination address GenericValue destinationAddress = shipmentRouteSegment.getRelatedOne("DestPostalAddress"); if (destinationAddress == null) { - return ServiceUtil.returnError("DestPostalAddress not found for ShipmentRouteSegment " + srsKeyString); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentRouteSegmentDestPostalAddressNotFound", + UtilMisc.toMap("shipmentId", shipmentId, "shipmentRouteSegmentId", shipmentRouteSegmentId), locale)); } if (!"USA".equals(destinationAddress.getString("countryGeoId"))) { - return ServiceUtil.returnError("ShipmentRouteSeqment " + srsKeyString + " is not destined for a US address"); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsRouteSegmentOriginCountryGeoNotInUsa", + UtilMisc.toMap("shipmentId", shipmentId, "shipmentRouteSegmentId", shipmentRouteSegmentId), locale)); } String destinationZip = destinationAddress.getString("postalCode"); if (UtilValidate.isEmpty(destinationZip)) { - return ServiceUtil.returnError("ZIP code is missing from the destination postal address" + - " (contactMechId " + originAddress.getString("contactMechId") + ")"); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsRouteSegmentDestinationZipCodeMissing", + UtilMisc.toMap("contactMechId", destinationAddress.getString("contactMechId")), locale)); } // get the service type from the CarrierShipmentMethod String shipmentMethodTypeId = shipmentRouteSegment.getString("shipmentMethodTypeId"); String partyId = shipmentRouteSegment.getString("carrierPartyId"); - String csmKeystring = "[" + shipmentMethodTypeId + "," + partyId + ",CARRIER]"; - + GenericValue carrierShipmentMethod = delegator.findByPrimaryKey("CarrierShipmentMethod", UtilMisc.toMap("partyId", partyId, "roleTypeId", "CARRIER", "shipmentMethodTypeId", shipmentMethodTypeId)); if (carrierShipmentMethod == null) { - return ServiceUtil.returnError("CarrierShipmentMethod " + csmKeystring + - " not found for ShipmentRouteSegment " + srsKeyString); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsNoCarrierShipmentMethod", + UtilMisc.toMap("carrierPartyId", partyId, "shipmentMethodTypeId", shipmentMethodTypeId), locale)); } String serviceType = carrierShipmentMethod.getString("carrierServiceCode"); if (UtilValidate.isEmpty(serviceType)) { - return ServiceUtil.returnError("carrierServiceCode not found for CarrierShipmentMethod" + csmKeystring); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsNoCarrierServiceCodeFound", + UtilMisc.toMap("carrierPartyId", partyId, "shipmentMethodTypeId", shipmentMethodTypeId), locale)); } // get the packages for this shipment route segment List<GenericValue> shipmentPackageRouteSegList = shipmentRouteSegment.getRelated("ShipmentPackageRouteSeg", null, UtilMisc.toList("+shipmentPackageSeqId")); if (UtilValidate.isEmpty(shipmentPackageRouteSegList)) { - return ServiceUtil.returnError("No packages found for ShipmentRouteSegment " + srsKeyString); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentPackageRouteSegsNotFound", + UtilMisc.toMap("shipmentId", shipmentId, "shipmentRouteSegmentId", shipmentRouteSegmentId), locale)); } BigDecimal actualTransportCost = BigDecimal.ZERO; @@ -949,7 +1029,7 @@ public class UspsServices { // shipmentPackageRouteSeg.getString("shipmentPackageSeqId") + "," + // shipmentPackageRouteSeg.getString("shipmentRouteSegmentId") + "]"; - Document requestDocument = createUspsRequestDocument("RateRequest", true); + Document requestDocument = createUspsRequestDocument("RateRequest", true, delegator, shipmentGatewayConfigId, resource); Element packageElement = UtilXml.addChildElement(requestDocument.getDocumentElement(), "Package", requestDocument); packageElement.setAttribute("ID", "0"); @@ -961,13 +1041,13 @@ public class UspsServices { GenericValue shipmentPackage = null; shipmentPackage = shipmentPackageRouteSeg.getRelatedOne("ShipmentPackage"); - String spKeyString = "[" + shipmentPackage.getString("shipmentId") + "," + - shipmentPackage.getString("shipmentPackageSeqId") + "]"; - // weight elements - Pounds, Ounces String weightStr = shipmentPackage.getString("weight"); if (UtilValidate.isEmpty(weightStr)) { - return ServiceUtil.returnError("weight not found for ShipmentPackage " + spKeyString); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsWeightNotFound", + UtilMisc.toMap("shipmentId", shipmentPackage.getString("shipmentId"), + "shipmentPackageSeqId", shipmentPackage.getString("shipmentPackageSeqId")), locale)); } BigDecimal weight = BigDecimal.ZERO; @@ -987,14 +1067,19 @@ public class UspsServices { try { result = dispatcher.runSync("convertUom", UtilMisc.<String, Object>toMap("uomId", weightUomId, "uomIdTo", "WT_lb", "originalValue", weight)); } catch (GenericServiceException ex) { - return ServiceUtil.returnError(ex.getMessage()); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsWeightConversionError", + UtilMisc.toMap("errorString", ex.getMessage()), locale)); } if (result.get(ModelService.RESPONSE_MESSAGE).equals(ModelService.RESPOND_SUCCESS) && result.get("convertedValue") != null) { weight = weight.multiply((BigDecimal) result.get("convertedValue")); } else { - return ServiceUtil.returnError("Unsupported weightUom [" + weightUomId + "] for ShipmentPackage " + - spKeyString + ", could not find a conversion factor for WT_lb"); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsWeightUnsupported", + UtilMisc.toMap("weightUomId", weightUomId, "shipmentId", shipmentPackage.getString("shipmentId"), + "shipmentPackageSeqId", shipmentPackage.getString("shipmentPackageSeqId"), + "weightUom", "WT_lb"), locale)); } } @@ -1039,31 +1124,32 @@ public class UspsServices { Document responseDocument = null; try { - responseDocument = sendUspsRequest("Rate", requestDocument); + responseDocument = sendUspsRequest("Rate", requestDocument, delegator, shipmentGatewayConfigId, resource, locale); } catch (UspsRequestException e) { Debug.log(e, module); - return ServiceUtil.returnError("Error sending request for USPS Domestic Rate Calculation service: " + - e.getMessage()); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsRateDomesticSendingError", + UtilMisc.toMap("errorString", e.getMessage()), locale)); } Element respPackageElement = UtilXml.firstChildElement(responseDocument.getDocumentElement(), "Package"); if (respPackageElement == null) { - return ServiceUtil.returnError("Incomplete response from USPS Domestic Rate Calculation service: " + - "no Package element found"); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsRateDomesticResponseIncompleteElementPackage", locale)); } Element respErrorElement = UtilXml.firstChildElement(respPackageElement, "Error"); if (respErrorElement != null) { - return ServiceUtil.returnError("The following error was returned by the USPS Domestic Rate Calculation " + - "service for ShipmentPackage " + spKeyString + ": " + - UtilXml.childElementValue(respErrorElement, "Description")); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsRateDomesticResponseError", + UtilMisc.toMap("errorString", UtilXml.childElementValue(respErrorElement, "Description")), locale)); } // update the ShipmentPackageRouteSeg String postageString = UtilXml.childElementValue(respPackageElement, "Postage"); if (UtilValidate.isEmpty(postageString)) { - return ServiceUtil.returnError("Incomplete response from USPS Domestic Rate Calculation service: " + - "missing or empty Postage element"); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsRateDomesticResponseIncompleteElementPostage", locale)); } BigDecimal postage = BigDecimal.ZERO; @@ -1094,8 +1180,9 @@ public class UspsServices { } catch (GenericEntityException gee) { Debug.log(gee, module); - return ServiceUtil.returnError("Error reading or writing shipment data for the USPS " + - "Domestic Rate Calculation service: " + gee.getMessage()); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsRateDomesticReadingError", + UtilMisc.toMap("errorString", gee.getMessage()), locale)); } return ServiceUtil.returnSuccess(); @@ -1137,78 +1224,95 @@ public class UspsServices { */ public static Map<String, Object> uspsDeliveryConfirmation(DispatchContext dctx, Map<String, ? extends Object> context) { - Delegator delegator = dctx.getDelegator(); - String shipmentId = (String) context.get("shipmentId"); String shipmentRouteSegmentId = (String) context.get("shipmentRouteSegmentId"); - - // ShipmentRouteSegment identifier - used in error messages - String srsKeyString = "[" + shipmentId + "," + shipmentRouteSegmentId + "]"; + Locale locale = (Locale) context.get("locale"); + + Map<String, Object> shipmentGatewayConfig = ShipmentServices.getShipmentGatewayConfigFromShipment(delegator, shipmentId); + String shipmentGatewayConfigId = (String) shipmentGatewayConfig.get("shipmentGatewayConfigId"); + String resource = (String) shipmentGatewayConfig.get("configProps"); + if (UtilValidate.isEmpty(shipmentGatewayConfigId) && UtilValidate.isEmpty(resource)) { + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsGatewayNotAvailable", locale)); + } try { GenericValue shipment = delegator.findByPrimaryKey("Shipment", UtilMisc.toMap("shipmentId", shipmentId)); if (shipment == null) { - return ServiceUtil.returnError("Shipment not found with ID " + shipmentId); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "ProductShipmentNotFoundId", locale) + shipmentId); } GenericValue shipmentRouteSegment = delegator.findByPrimaryKey("ShipmentRouteSegment", UtilMisc.toMap("shipmentId", shipmentId, "shipmentRouteSegmentId", shipmentRouteSegmentId)); if (shipmentRouteSegment == null) { - return ServiceUtil.returnError("ShipmentRouteSegment not found with shipmentId " + shipmentId + - " and shipmentRouteSegmentId " + shipmentRouteSegmentId); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "ProductShipmentRouteSegmentNotFound", + UtilMisc.toMap("shipmentId", shipmentId, "shipmentRouteSegmentId", shipmentRouteSegmentId), locale)); } // ensure the carrier is USPS if (!"USPS".equals(shipmentRouteSegment.getString("carrierPartyId"))) { - return ServiceUtil.returnError("The Carrier for ShipmentRouteSegment " + srsKeyString + ", is not USPS"); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsNotRouteSegmentCarrier", + UtilMisc.toMap("shipmentRouteSegmentId", shipmentRouteSegmentId, "shipmentId", shipmentId), locale)); } // get the origin address GenericValue originAddress = shipmentRouteSegment.getRelatedOne("OriginPostalAddress"); if (originAddress == null) { - return ServiceUtil.returnError("OriginPostalAddress not found for ShipmentRouteSegment [" + - shipmentId + ":" + shipmentRouteSegmentId + "]"); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentRouteSegmentOriginPostalAddressNotFound", + UtilMisc.toMap("shipmentId", shipmentId, "shipmentRouteSegmentId", shipmentRouteSegmentId), locale)); } if (!"USA".equals(originAddress.getString("countryGeoId"))) { - return ServiceUtil.returnError("ShipmentRouteSeqment " + srsKeyString + " does not originate from a US address"); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsRouteSegmentOriginCountryGeoNotInUsa", + UtilMisc.toMap("shipmentId", shipmentId, "shipmentRouteSegmentId", shipmentRouteSegmentId), locale)); } - + // get the destination address GenericValue destinationAddress = shipmentRouteSegment.getRelatedOne("DestPostalAddress"); if (destinationAddress == null) { - return ServiceUtil.returnError("DestPostalAddress not found for ShipmentRouteSegment " + srsKeyString); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentRouteSegmentDestPostalAddressNotFound", + UtilMisc.toMap("shipmentId", shipmentId, "shipmentRouteSegmentId", shipmentRouteSegmentId), locale)); } if (!"USA".equals(destinationAddress.getString("countryGeoId"))) { - return ServiceUtil.returnError("ShipmentRouteSeqment " + srsKeyString + " is not destined for a US address"); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsRouteSegmentOriginCountryGeoNotInUsa", + UtilMisc.toMap("shipmentId", shipmentId, "shipmentRouteSegmentId", shipmentRouteSegmentId), locale)); } // get the service type from the CarrierShipmentMethod String shipmentMethodTypeId = shipmentRouteSegment.getString("shipmentMethodTypeId"); String partyId = shipmentRouteSegment.getString("carrierPartyId"); - String csmKeystring = "[" + shipmentMethodTypeId + "," + partyId + ",CARRIER]"; - GenericValue carrierShipmentMethod = delegator.findByPrimaryKey("CarrierShipmentMethod", UtilMisc.toMap("partyId", partyId, "roleTypeId", "CARRIER", "shipmentMethodTypeId", shipmentMethodTypeId)); if (carrierShipmentMethod == null) { - return ServiceUtil.returnError("CarrierShipmentMethod " + csmKeystring + - " not found for ShipmentRouteSegment " + srsKeyString); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsNoCarrierShipmentMethod", + UtilMisc.toMap("carrierPartyId", partyId, "shipmentMethodTypeId", shipmentMethodTypeId), locale)); } String serviceType = carrierShipmentMethod.getString("carrierServiceCode"); if (UtilValidate.isEmpty(serviceType)) { - return ServiceUtil.returnError("carrierServiceCode not found for CarrierShipmentMethod" + csmKeystring); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsUnableDetermineServiceCode", locale)); } // get the packages for this shipment route segment List<GenericValue> shipmentPackageRouteSegList = shipmentRouteSegment.getRelated("ShipmentPackageRouteSeg", null, UtilMisc.toList("+shipmentPackageSeqId")); if (UtilValidate.isEmpty(shipmentPackageRouteSegList)) { - return ServiceUtil.returnError("No packages found for ShipmentRouteSegment " + srsKeyString); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentPackageRouteSegsNotFound", + UtilMisc.toMap("shipmentId", shipmentId, "shipmentRouteSegmentId", shipmentRouteSegmentId), locale)); } for (GenericValue shipmentPackageRouteSeg: shipmentPackageRouteSegList) { - Document requestDocument = createUspsRequestDocument("DeliveryConfirmationV2.0Request", true); + Document requestDocument = createUspsRequestDocument("DeliveryConfirmationV2.0Request", true, delegator, shipmentGatewayConfigId, resource); Element requestElement = requestDocument.getDocumentElement(); UtilXml.addChildElementValue(requestElement, "Option", "3", requestDocument); @@ -1245,13 +1349,14 @@ public class UspsServices { UtilXml.addChildElement(requestElement, "ToZip4", requestDocument); GenericValue shipmentPackage = shipmentPackageRouteSeg.getRelatedOne("ShipmentPackage"); - String spKeyString = "[" + shipmentPackage.getString("shipmentId") + "," + - shipmentPackage.getString("shipmentPackageSeqId") + "]"; - + // WeightInOunces String weightStr = shipmentPackage.getString("weight"); if (UtilValidate.isEmpty(weightStr)) { - return ServiceUtil.returnError("weight not found for ShipmentPackage " + spKeyString); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsWeightNotFound", + UtilMisc.toMap("shipmentId", shipmentPackage.getString("shipmentId"), + "shipmentPackageSeqId", shipmentPackage.getString("shipmentPackageSeqId")), locale)); } BigDecimal weight = BigDecimal.ZERO; @@ -1271,8 +1376,11 @@ public class UspsServices { GenericValue uomConversion = delegator.findByPrimaryKey("UomConversion", UtilMisc.toMap("uomId", weightUomId, "uomIdTo", "WT_oz")); if (uomConversion == null || UtilValidate.isEmpty(uomConversion.getString("conversionFactor"))) { - return ServiceUtil.returnError("Unsupported weightUom [" + weightUomId + "] for ShipmentPackage " + - spKeyString + ", could not find a conversion factor for WT_oz"); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsWeightUnsupported", + UtilMisc.toMap("weightUomId", weightUomId, "shipmentId", shipmentPackage.getString("shipmentId"), + "shipmentPackageSeqId", shipmentPackage.getString("shipmentPackageSeqId"), + "weightUom", "WT_oz"), locale)); } weight = weight.multiply(uomConversion.getBigDecimal("conversionFactor")); } @@ -1286,31 +1394,34 @@ public class UspsServices { Document responseDocument = null; try { - responseDocument = sendUspsRequest("DeliveryConfirmationV2", requestDocument); + responseDocument = sendUspsRequest("DeliveryConfirmationV2", requestDocument, delegator, shipmentGatewayConfigId, resource, locale); } catch (UspsRequestException e) { Debug.log(e, module); - return ServiceUtil.returnError("Error sending request for USPS Delivery Confirmation service: " + - e.getMessage()); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsDeliveryConfirmationSendingError", + UtilMisc.toMap("errorString", e.getMessage()), locale)); } Element responseElement = responseDocument.getDocumentElement(); Element respErrorElement = UtilXml.firstChildElement(responseElement, "Error"); if (respErrorElement != null) { - return ServiceUtil.returnError("The following error was returned by the USPS Delivery Confirmation " + - "service for ShipmentPackage " + spKeyString + ": " + - UtilXml.childElementValue(respErrorElement, "Description")); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsDeliveryConfirmationResponseError", + UtilMisc.toMap("shipmentId", shipmentPackage.getString("shipmentId"), + "shipmentPackageSeqId", shipmentPackage.getString("shipmentPackageSeqId"), + "errorString", UtilXml.childElementValue(respErrorElement, "Description")), locale)); } String labelImageString = UtilXml.childElementValue(responseElement, "DeliveryConfirmationLabel"); if (UtilValidate.isEmpty(labelImageString)) { - return ServiceUtil.returnError("Incomplete response from the USPS Delivery Confirmation service: " + - "missing or empty DeliveryConfirmationLabel element"); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsDeliveryConfirmationResponseIncompleteElementDeliveryConfirmationLabel", locale)); } shipmentPackageRouteSeg.setBytes("labelImage", Base64.base64Decode(labelImageString.getBytes())); String trackingCode = UtilXml.childElementValue(responseElement, "DeliveryConfirmationNumber"); if (UtilValidate.isEmpty(trackingCode)) { - return ServiceUtil.returnError("Incomplete response from the USPS Delivery Confirmation service: " + - "missing or empty DeliveryConfirmationNumber element"); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsDeliveryConfirmationResponsenIncompleteElementDeliveryConfirmationNumber", locale)); } shipmentPackageRouteSeg.set("trackingCode", trackingCode); shipmentPackageRouteSeg.store(); @@ -1318,8 +1429,9 @@ public class UspsServices { } catch (GenericEntityException gee) { Debug.log(gee, module); - return ServiceUtil.returnError("Error reading or writing shipment data for the USPS " + - "Delivery Confirmation service: " + gee.getMessage()); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsDeliveryConfirmationReadingError", + UtilMisc.toMap("errorString", gee.getMessage()), locale)); } return ServiceUtil.returnSuccess(); @@ -1329,11 +1441,9 @@ public class UspsServices { // testing utility service - remove this public static Map<String, Object> uspsDumpShipmentLabelImages(DispatchContext dctx, Map<String, ? extends Object> context) { - Delegator delegator = dctx.getDelegator(); try { - String shipmentId = (String) context.get("shipmentId"); String shipmentRouteSegmentId = (String) context.get("shipmentRouteSegmentId"); @@ -1363,23 +1473,25 @@ public class UspsServices { Debug.log(e, module); return ServiceUtil.returnError(e.getMessage()); } - return ServiceUtil.returnSuccess(); } public static Map<String, Object> uspsPriorityMailInternationalLabel(DispatchContext dctx, Map<String, ? extends Object> context) { Delegator delegator = dctx.getDelegator(); LocalDispatcher dispatcher = dctx.getDispatcher(); - + String shipmentGatewayConfigId = (String) context.get("shipmentGatewayConfigId"); + String resource = (String) context.get("configProps"); GenericValue shipmentRouteSegment = (GenericValue) context.get("shipmentRouteSegment"); + Locale locale = (Locale) context.get("locale"); // Start the document Document requestDocument; boolean certify = false; - if (!"Y".equalsIgnoreCase(UtilProperties.getPropertyValue("shipment.properties", "shipment.usps.test"))) { - requestDocument = createUspsRequestDocument("PriorityMailIntlRequest", false); + String test = getShipmentGatewayConfigValue(delegator, shipmentGatewayConfigId, "test", resource, "shipment.usps.test"); + if (!"Y".equalsIgnoreCase(test)) { + requestDocument = createUspsRequestDocument("PriorityMailIntlRequest", false, delegator, shipmentGatewayConfigId, resource); } else { - requestDocument = createUspsRequestDocument("PriorityMailIntlCertifyRequest", false); + requestDocument = createUspsRequestDocument("PriorityMailIntlCertifyRequest", false, delegator, shipmentGatewayConfigId, resource); certify = true; } Element rootElement = requestDocument.getDocumentElement(); @@ -1406,7 +1518,8 @@ public class UspsServices { Debug.logError(e, module); } if (originAddress == null || originTelecomNumber == null) { - return ServiceUtil.returnError("Unable to request a USPS Priority Mail International Label: ShipmentRouteSegment is missing origin phone or address details"); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsPriorityMailLabelOriginAddressMissing", locale)); } // Origin Info @@ -1538,11 +1651,12 @@ public class UspsServices { Document responseDocument = null; String api = certify ? "PriorityMailIntlCertify" : "PriorityMailIntl"; try { - responseDocument = sendUspsRequest(api, requestDocument); + responseDocument = sendUspsRequest(api, requestDocument, delegator, shipmentGatewayConfigId, resource, locale); } catch (UspsRequestException e) { Debug.log(e, module); - return ServiceUtil.returnError("Error sending request for USPS Priority Mail International service: " + - e.getMessage()); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsPriorityMailLabelSendingError", + UtilMisc.toMap("errorString", e.getMessage()), locale)); } Element responseElement = responseDocument.getDocumentElement(); @@ -1550,14 +1664,14 @@ public class UspsServices { String labelImageString = UtilXml.childElementValue(responseElement, "LabelImage"); if (UtilValidate.isEmpty(labelImageString)) { - return ServiceUtil.returnError("Incomplete response from the USPS Priority Mail International service: " + - "missing or empty LabelImage element"); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsPriorityMailLabelResponseIncompleteElementLabelImage", locale)); } shipmentPackageRouteSeg.setBytes("labelImage", Base64.base64Decode(labelImageString.getBytes())); String trackingCode = UtilXml.childElementValue(responseElement, "BarcodeNumber"); if (UtilValidate.isEmpty(trackingCode)) { - return ServiceUtil.returnError("Incomplete response from the USPS Priority Mail International service: " + - "missing or empty BarcodeNumber element"); + return ServiceUtil.returnError(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsPriorityMailLabelResponseIncompleteElementBarcodeNumber", locale)); } shipmentPackageRouteSeg.set("trackingCode", trackingCode); try { @@ -1570,31 +1684,30 @@ public class UspsServices { return ServiceUtil.returnSuccess(); } - private static Document createUspsRequestDocument(String rootElement, boolean passwordRequired) { - + private static Document createUspsRequestDocument(String rootElement, boolean passwordRequired, Delegator delegator, String shipmentGatewayConfigId, String resource) { Document requestDocument = UtilXml.makeEmptyXmlDocument(rootElement); - Element requestElement = requestDocument.getDocumentElement(); - requestElement.setAttribute("USERID", - UtilProperties.getPropertyValue("shipment.properties", "shipment.usps.access.userid")); + requestElement.setAttribute("USERID", getShipmentGatewayConfigValue(delegator, shipmentGatewayConfigId, + "accessUserId", resource, "shipment.usps.access.userid", "")); if (passwordRequired) { - requestElement.setAttribute("PASSWORD", - UtilProperties.getPropertyValue("shipment.properties", "shipment.usps.access.password")); + requestElement.setAttribute("PASSWORD", getShipmentGatewayConfigValue(delegator, shipmentGatewayConfigId, + "accessPassword", resource, "shipment.usps.access.password", "")); } - return requestDocument; } - private static Document sendUspsRequest(String requestType, Document requestDocument) throws UspsRequestException { + private static Document sendUspsRequest(String requestType, Document requestDocument, Delegator delegator, + String shipmentGatewayConfigId, String resource, Locale locale) throws UspsRequestException { String conUrl = null; List<String> labelRequestTypes = UtilMisc.toList("PriorityMailIntl", "PriorityMailIntlCertify"); if (labelRequestTypes.contains(requestType)) { - conUrl = UtilProperties.getPropertyValue("shipment.properties", "shipment.usps.connect.url.labels"); + conUrl = getShipmentGatewayConfigValue(delegator, shipmentGatewayConfigId, "connectUrlLabels", resource, "shipment.usps.connect.url.labels"); } else { - conUrl = UtilProperties.getPropertyValue("shipment.properties", "shipment.usps.connect.url"); + conUrl = getShipmentGatewayConfigValue(delegator, shipmentGatewayConfigId, "connectUrl", resource, "shipment.usps.connect.url"); } if (UtilValidate.isEmpty(conUrl)) { - throw new UspsRequestException("Connection URL not specified; please check your configuration"); + throw new UspsRequestException(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsConnectUrlIncomplete", locale)); } OutputStream os = new ByteArrayOutputStream(); @@ -1602,14 +1715,18 @@ public class UspsServices { try { UtilXml.writeXmlDocument(requestDocument, os, "UTF-8", true, false, 0); } catch (TransformerException e) { - throw new UspsRequestException("Error serializing requestDocument: " + e.getMessage()); + throw new UspsRequestException( + UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsSerializingError", + UtilMisc.toMap("errorString", e.getMessage()), locale)); } String xmlString = os.toString(); Debug.logInfo("USPS XML request string: " + xmlString, module); - String timeOutStr = UtilProperties.getPropertyValue("shipment.properties", "shipment.usps.connect.timeout", "60"); + String timeOutStr = getShipmentGatewayConfigValue(delegator, shipmentGatewayConfigId, "connectTimeout", + resource, "shipment.usps.connect.timeout", "60"); int timeout = 60; try { timeout = Integer.parseInt(timeOutStr); @@ -1626,7 +1743,9 @@ public class UspsServices { try { responseString = http.get(); } catch (HttpClientException e) { - throw new UspsRequestException("Problem connecting with USPS server", e); + throw new UspsRequestException(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsConnectionProblem", + UtilMisc.toMap("errorString", e), locale)); } Debug.logInfo("USPS response: " + responseString, module); @@ -1639,11 +1758,17 @@ public class UspsServices { try { responseDocument = UtilXml.readXmlDocument(responseString, false); } catch (SAXException se) { - throw new UspsRequestException("Error reading request Document from a String: " + se.getMessage()); + throw new UspsRequestException(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsResponseError", + UtilMisc.toMap("errorString", se.getMessage()), locale)); } catch (ParserConfigurationException pce) { - throw new UspsRequestException("Error reading request Document from a String: " + pce.getMessage()); + throw new UspsRequestException(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsResponseError", + UtilMisc.toMap("errorString", pce.getMessage()), locale)); } catch (IOException xmlReadException) { - throw new UspsRequestException("Error reading request Document from a String: " + xmlReadException.getMessage()); + throw new UspsRequestException(UtilProperties.getMessage(resourceError, + "FacilityShipmentUspsResponseError", + UtilMisc.toMap("errorString", xmlReadException.getMessage()), locale)); } // If a top-level error document is returned, throw exception @@ -1667,6 +1792,39 @@ public class UspsServices { poundsOunces[1] = Integer.valueOf(decimalPounds.remainder(BigDecimal.ONE).multiply(new BigDecimal("16")).setScale(0, BigDecimal.ROUND_CEILING).toPlainString()); return poundsOunces; } + + private static String getShipmentGatewayConfigValue(Delegator delegator, String shipmentGatewayConfigId, String shipmentGatewayConfigParameterName, + String resource, String parameterName) { + String returnValue = ""; + if (UtilValidate.isNotEmpty(shipmentGatewayConfigId)) { + try { + GenericValue usps = delegator.findOne("ShipmentGatewayUsps", UtilMisc.toMap("shipmentGatewayConfigId", shipmentGatewayConfigId), false); + if (UtilValidate.isNotEmpty(usps)) { + Object uspsField = usps.get(shipmentGatewayConfigParameterName); + if (uspsField != null) { + returnValue = uspsField.toString().trim(); + } + } + } catch (GenericEntityException e) { + Debug.logError(e, module); + } + } else { + String value = UtilProperties.getPropertyValue(resource, parameterName); + if (value != null) { + returnValue = value.trim(); + } + } + return returnValue; + } + + private static String getShipmentGatewayConfigValue(Delegator delegator, String shipmentGatewayConfigId, String shipmentGatewayConfigParameterName, + String resource, String parameterName, String defaultValue) { + String returnValue = getShipmentGatewayConfigValue(delegator, shipmentGatewayConfigId, shipmentGatewayConfigParameterName, resource, parameterName); + if (UtilValidate.isEmpty(returnValue)) { + returnValue = defaultValue; + } + return returnValue; + } } @SuppressWarnings("serial") Modified: ofbiz/trunk/applications/product/src/org/ofbiz/shipment/thirdparty/usps/UspsServicesTests.java URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/product/src/org/ofbiz/shipment/thirdparty/usps/UspsServicesTests.java?rev=1054435&r1=1054434&r2=1054435&view=diff ============================================================================== --- ofbiz/trunk/applications/product/src/org/ofbiz/shipment/thirdparty/usps/UspsServicesTests.java (original) +++ ofbiz/trunk/applications/product/src/org/ofbiz/shipment/thirdparty/usps/UspsServicesTests.java Sun Jan 2 17:20:48 2011 @@ -54,7 +54,7 @@ public class UspsServicesTests extends O public void testUspsTrackConfirm() throws Exception { // run the service - Map<String, Object> result = dispatcher.runSync("uspsTrackConfirm", UtilMisc.toMap("trackingId", "EJ958083578US")); + Map<String, Object> result = dispatcher.runSync("uspsTrackConfirm", UtilMisc.toMap("trackingId", "EJ958083578US", "shipmentGatewayConfigId", "USPS_CONFIG", "configProps", "shipment.properties")); // verify the results String responseMessage = (String) result.get(ModelService.RESPONSE_MESSAGE); @@ -85,8 +85,10 @@ public class UspsServicesTests extends O public void testUspsAddressValidation() throws Exception { // run the service - Map<String, Object> result = dispatcher.runSync("uspsAddressValidation", - UtilMisc.toMap("address1", "6406 Ivy Lane", "city", "Greenbelt", "state", "MD")); + Map<String, String> paramInp = UtilMisc.toMap("address1", "6406 Ivy Lane", "city", "Greenbelt", "state", "MD"); + paramInp.put("shipmentGatewayConfigId", "USPS_CONFIG"); + paramInp.put("configProps", "shipment.properties"); + Map<String, Object> result = dispatcher.runSync("uspsAddressValidation", paramInp); // verify the results String responseMessage = (String) result.get(ModelService.RESPONSE_MESSAGE); @@ -117,8 +119,8 @@ public class UspsServicesTests extends O public void testUspsCityStateLookup() throws Exception { // run the service - Map<String, Object> result = dispatcher.runSync("uspsCityStateLookup", UtilMisc.toMap("zip5", "90210")); - + Map<String, Object> result = dispatcher.runSync("uspsCityStateLookup", UtilMisc.toMap("zip5", "90210", "shipmentGatewayConfigId", "USPS_CONFIG", "configProps", "shipment.properties")); + // verify the results String responseMessage = (String) result.get(ModelService.RESPONSE_MESSAGE); Debug.log("[testUspsCityStateLookup] responseMessage: " + responseMessage, module); @@ -136,7 +138,7 @@ public class UspsServicesTests extends O public void testUspsPriorityMailStandard() throws Exception { // run the service - Map<String, Object> result = dispatcher.runSync("uspsPriorityMailStandard", UtilMisc.toMap("originZip", "4", "destinationZip", "4")); + Map<String, Object> result = dispatcher.runSync("uspsPriorityMailStandard", UtilMisc.toMap("originZip", "4", "destinationZip", "4", "shipmentGatewayConfigId", "USPS_CONFIG", "configProps", "shipment.properties")); // verify the results String responseMessage = (String) result.get(ModelService.RESPONSE_MESSAGE); @@ -151,7 +153,7 @@ public class UspsServicesTests extends O public void testUspsPackageServicesStandard() throws Exception { // run the service - Map<String, Object> result = dispatcher.runSync("uspsPackageServicesStandard", UtilMisc.toMap("originZip", "4", "destinationZip", "4")); + Map<String, Object> result = dispatcher.runSync("uspsPackageServicesStandard", UtilMisc.toMap("originZip", "4", "destinationZip", "4", "shipmentGatewayConfigId", "USPS_CONFIG", "configProps", "shipment.properties")); // verify the results String responseMessage = (String) result.get(ModelService.RESPONSE_MESSAGE); @@ -176,6 +178,8 @@ public class UspsServicesTests extends O context.put("container", "None"); context.put("size", "Regular"); context.put("machinable", "False"); + context.put("shipmentGatewayConfigId", "USPS_CONFIG"); + context.put("configProps", "shipment.properties"); // run the service Map<String, Object> result = dispatcher.runSync("uspsDomesticRate", context); Modified: ofbiz/trunk/applications/product/widget/facility/ShipmentGatewayConfigForms.xml URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/product/widget/facility/ShipmentGatewayConfigForms.xml?rev=1054435&r1=1054434&r2=1054435&view=diff ============================================================================== --- ofbiz/trunk/applications/product/widget/facility/ShipmentGatewayConfigForms.xml (original) +++ ofbiz/trunk/applications/product/widget/facility/ShipmentGatewayConfigForms.xml Sun Jan 2 17:20:48 2011 @@ -292,6 +292,12 @@ under the License. <field name="maxEstimateWeight" title="${uiLabelMap.FacilityShipmentUspsMaxEstimateWeight}"> <text size="9" maxlength="9"/> </field> + <field name="test" title="${uiLabelMap.FacilityShipmentUspsTestMode}"> + <drop-down> + <option key="Y" description="${uiLabelMap.CommonYes}"/> + <option key="N" description="${uiLabelMap.CommonNo}"/> + </drop-down> + </field> <field name="submitButton" title="${uiLabelMap.CommonUpdate}" widget-style="smallSubmit"> <submit button-type="button"/> </field> |
«
Return to OFBiz - Commits
|
1 view|%1 views
| Free forum by Nabble | Edit this page |