Package org.apache.ofbiz.shipment.thirdparty.ups

Class UpsServices

java.lang.Object

org.apache.ofbiz.shipment.thirdparty.ups.UpsServices

public class UpsServices
extends Object

UPS ShipmentServices

Field Summary

Fields

Modifier and Type	Field	Description
static String	dateFormatString
static int	decimals
static MathContext	generalRounding
static String	module
static String	resourceError
static String	resourceOrder
static int	returnServiceCode
static RoundingMode	rounding

Constructor Summary

Constructors

Constructor	Description
UpsServices()

Method Summary

Modifier and Type	Method	Description
static Document	createAccessRequestDocument(Delegator delegator, String shipmentGatewayConfigId, String serviceConfigProps)
static void	handleErrors(Element responseElement, List<Object> errorList, Locale locale)
static Map<String,Object>	handleUpsAddressValidationResponse(Document rateResponseDocument, Locale locale)
static Map<String,Object>	handleUpsAlternateRatesInquireResponse(Document rateResponseDocument, Locale locale)
static Map<String,Object>	handleUpsRateInquireResponse(Document rateResponseDocument, Locale locale)
static Map<String,Object>	handleUpsShipmentAcceptResponse(Document shipmentAcceptResponseDocument, GenericValue shipmentRouteSegment, List<GenericValue> shipmentPackageRouteSegs, Delegator delegator, String shipmentGatewayConfigId, String resource, Map<String,? extends Object> context, Locale locale)
static Map<String,Object>	handleUpsShipmentConfirmResponse(Document shipmentConfirmResponseDocument, GenericValue shipmentRouteSegment, Locale locale)
static Map<String,Object>	handleUpsTrackShipmentResponse(Document trackResponseDocument, GenericValue shipmentRouteSegment, List<GenericValue> shipmentPackageRouteSegs, Locale locale)
static Map<String,Object>	handleUpsVoidShipmentResponse(Document voidShipmentResponseDocument, GenericValue shipmentRouteSegment, Locale locale)
static String	sendUpsRequest(String upsService, String xmlString, String shipmentGatewayConfigId, String resource, Delegator delegator, Locale locale)	Opens a URL to UPS and makes a request.
static Map<String,Object>	upsAddressValidation(DispatchContext dctx, Map<String,? extends Object> context)
static Map<String,Object>	upsEmailReturnLabel(DispatchContext dctx, Map<String,? extends Object> context)
static Map<String,Object>	upsRateInquire(DispatchContext dctx, Map<String,? extends Object> context)
static Map<String,Object>	upsRateInquireByPostalCode(DispatchContext dctx, Map<String,? extends Object> context)
static Map<String,Object>	upsShipmentAccept(DispatchContext dctx, Map<String,? extends Object> context)
static Map<String,Object>	upsShipmentAlternateRatesInquiry(DispatchContext dctx, Map<String,? extends Object> context)
static Map<String,Object>	upsShipmentConfirm(DispatchContext dctx, Map<String,? extends Object> context)
static Map<String,Object>	upsTrackShipment(DispatchContext dctx, Map<String,? extends Object> context)
static Map<String,Object>	upsVoidShipment(DispatchContext dctx, Map<String,? extends Object> context)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

module

public static final String module

decimals

public static final int decimals

rounding

public static final RoundingMode rounding

generalRounding

public static final MathContext generalRounding

returnServiceCode

public static final int returnServiceCode

See Also:

Constant Field Values

dateFormatString

public static final String dateFormatString

See Also:

Constant Field Values

resourceError

public static final String resourceError

See Also:

Constant Field Values

resourceOrder

public static final String resourceOrder

See Also:

Constant Field Values

Constructor Detail

UpsServices

public UpsServices()

Method Detail

upsShipmentConfirm

public static Map<String,Object> upsShipmentConfirm(DispatchContext dctx,
                                                          Map<String,? extends Object> context)

handleUpsShipmentConfirmResponse

public static Map<String,Object> handleUpsShipmentConfirmResponse(Document shipmentConfirmResponseDocument,
                                                                        GenericValue shipmentRouteSegment,
                                                                        Locale locale)
                                                                 throws GenericEntityException

Throws:

GenericEntityException

upsShipmentAccept

public static Map<String,Object> upsShipmentAccept(DispatchContext dctx,
                                                         Map<String,? extends Object> context)

handleUpsShipmentAcceptResponse

public static Map<String,Object> handleUpsShipmentAcceptResponse(Document shipmentAcceptResponseDocument,
                                                                       GenericValue shipmentRouteSegment,
                                                                       List<GenericValue> shipmentPackageRouteSegs,
                                                                       Delegator delegator,
                                                                       String shipmentGatewayConfigId,
                                                                       String resource,
                                                                       Map<String,? extends Object> context,
                                                                       Locale locale)
                                                                throws GenericEntityException

Throws:

GenericEntityException

upsVoidShipment

public static Map<String,Object> upsVoidShipment(DispatchContext dctx,
                                                       Map<String,? extends Object> context)

handleUpsVoidShipmentResponse

public static Map<String,Object> handleUpsVoidShipmentResponse(Document voidShipmentResponseDocument,
                                                                     GenericValue shipmentRouteSegment,
                                                                     Locale locale)
                                                              throws GenericEntityException

Throws:

GenericEntityException

upsTrackShipment

public static Map<String,Object> upsTrackShipment(DispatchContext dctx,
                                                        Map<String,? extends Object> context)

handleUpsTrackShipmentResponse

public static Map<String,Object> handleUpsTrackShipmentResponse(Document trackResponseDocument,
                                                                      GenericValue shipmentRouteSegment,
                                                                      List<GenericValue> shipmentPackageRouteSegs,
                                                                      Locale locale)
                                                               throws GenericEntityException

Throws:

GenericEntityException

upsRateInquire

public static Map<String,Object> upsRateInquire(DispatchContext dctx,
                                                      Map<String,? extends Object> context)

handleUpsRateInquireResponse

public static Map<String,Object> handleUpsRateInquireResponse(Document rateResponseDocument,
                                                                    Locale locale)

createAccessRequestDocument

public static Document createAccessRequestDocument(Delegator delegator,
                                                   String shipmentGatewayConfigId,
                                                   String serviceConfigProps)

handleErrors

public static void handleErrors(Element responseElement,
                                List<Object> errorList,
                                Locale locale)

sendUpsRequest

public static String sendUpsRequest(String upsService,
                                    String xmlString,
                                    String shipmentGatewayConfigId,
                                    String resource,
                                    Delegator delegator,
                                    Locale locale)
                             throws org.apache.ofbiz.shipment.thirdparty.ups.UpsConnectException

Opens a URL to UPS and makes a request.

Parameters:

upsService - Name of the UPS service to invoke

xmlString - XML message to send

Returns:

XML string response from UPS

Throws:

org.apache.ofbiz.shipment.thirdparty.ups.UpsConnectException

upsRateInquireByPostalCode

public static Map<String,Object> upsRateInquireByPostalCode(DispatchContext dctx,
                                                                  Map<String,? extends Object> context)

upsAddressValidation

public static Map<String,Object> upsAddressValidation(DispatchContext dctx,
                                                            Map<String,? extends Object> context)

handleUpsAddressValidationResponse

public static Map<String,Object> handleUpsAddressValidationResponse(Document rateResponseDocument,
                                                                          Locale locale)

upsEmailReturnLabel

public static Map<String,Object> upsEmailReturnLabel(DispatchContext dctx,
                                                           Map<String,? extends Object> context)

upsShipmentAlternateRatesInquiry

public static Map<String,Object> upsShipmentAlternateRatesInquiry(DispatchContext dctx,
                                                                        Map<String,? extends Object> context)

handleUpsAlternateRatesInquireResponse

public static Map<String,Object> handleUpsAlternateRatesInquireResponse(Document rateResponseDocument,
                                                                              Locale locale)