com.ibm.commerce.subscription.facade.client

Class AbstractSubscriptionFacadeClient

  • Direct Known Subclasses:
    AbstractExternalSubscriptionFacadeClient, SubscriptionFacadeClient

    public abstract class AbstractSubscriptionFacadeClient
extends AbstractBusinessObjectDocumentFacadeClient

    This class provides a set of methods that can be used to communicate with the Subscription facade. This class represents a library of Subscription operations that can be performed. The purpose of this class is to hide the details about constructing the business object document that represents the service request into simple Java methods. The complexity of building the request document and making the request is all managed by this client class of the Subscription facade.

    • Field Detail

      • COPYRIGHT

        public static final java.lang.String COPYRIGHT
        IBM Copyright notice field.
        See Also:
        Constant Field Values

    • Constructor Detail

      • AbstractSubscriptionFacadeClient

        public AbstractSubscriptionFacadeClient()
        Creates an instance of the client to communicate with the Subscription facade.

      • AbstractSubscriptionFacadeClient

        public AbstractSubscriptionFacadeClient(BusinessContextType businessContext,
                                        javax.security.auth.callback.CallbackHandler callbackHandler)
        Creates an instance of the client to communicate with the Subscription facade.
        Parameters:
        businessContext - The default business context to associate with the messages when making requests.
        callbackHandler - Used for authentication purposes so the controller can give the authentication information to the transport when required.

    • Method Detail

      • getSubscription

        public ShowSubscriptionType getSubscription(GetSubscriptionType aGetSubscription)
        This method will communicate with the Subscription facade and send the specified GetSubscription. request.
        Parameters:
        aGetSubscription - The GetSubscription request document.
        Returns:
        The resulting ShowSubscription response document.

      • processSubscription

        public AcknowledgeSubscriptionType processSubscription(ProcessSubscriptionType aProcessSubscription)
        This method will communicate with the Subscription facade and send the specified ProcessSubscription request.
        Parameters:
        aProcessSubscription - The ProcessSubscription request document.
        Returns:
        The resulting AcknowledgeSubscription response document.

      • changeSubscription

        public RespondSubscriptionType changeSubscription(ChangeSubscriptionType aChangeSubscription)
        This method will communicate with the Subscription facade and send the specified ChangeSubscription request.
        Parameters:
        aChangeSubscription - The ChangeSubscription request document.
        Returns:
        The resulting RespondSubscription response document.

      • getSubscription

        public ShowSubscriptionDataAreaType getSubscription(GetType getVerb)
                                             throws SubscriptionException
        This method returns the ShowSubscriptionDataArea when issuing the specified get expression to fetch Subscriptions. This method will be used by other framworks or methods that constructs the get expression.
        Parameters:
        getVerb - The get expression to execute.
        Returns:
        The ShowSubscriptionDataArea response when issuing the get expression.
        Throws:
        SubscriptionException - The SubscriptionException is thrown if error information is found in the specified ShowSubscriptionDataArea. This will represent that there was a problem when performing the operation.

      • getSubscription

        public java.util.List getSubscription(java.lang.String expressionLanguage,
                                      java.lang.String expression)
                               throws SubscriptionException
        This method returns a list of Subscriptions based on the expression specified.
        Parameters:
        expressionLanguage - The expression lanaguage.
        expression - The expression to return a list of Subscriptions.
        Returns:
        The list of Subscriptions that matches the expression specified.
        Throws:
        SubscriptionException - The SubscriptionException is thrown if error information is found in the specified ShowSubscriptionDataArea. This will represent that there was a problem when performing the operation.
Skip navigation links