com.ibm.commerce.subscription.facade.client

Class AbstractExternalSubscriptionFacadeClient

java.lang.Object

com.ibm.commerce.foundation.client.facade.bod.AbstractBusinessObjectDocumentFacadeClient

com.ibm.commerce.subscription.facade.client.AbstractSubscriptionFacadeClient

com.ibm.commerce.subscription.facade.client.AbstractExternalSubscriptionFacadeClient

Direct Known Subclasses:

ExternalSubscriptionFacadeClient

public abstract class AbstractExternalSubscriptionFacadeClient
extends AbstractSubscriptionFacadeClient

This class provides a set of methods that can be used to communicate with the Subscription facade running on an external system.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM Copyright notice field.

Fields inherited from class com.ibm.commerce.foundation.client.facade.bod.AbstractBusinessObjectDocumentFacadeClient

CHANGE_VERB_ACTION_ADD, CHANGE_VERB_ACTION_CHANGE, CHANGE_VERB_ACTION_CREATE, CHANGE_VERB_ACTION_DELETE, CHANGE_VERB_ACTION_UPDATE

Constructor Summary

Constructors

Constructor and Description
AbstractExternalSubscriptionFacadeClient() Creates an instance of the client to communicate with the ExternalSubscription facade.
AbstractExternalSubscriptionFacadeClient(BusinessContextType businessContext, javax.security.auth.callback.CallbackHandler callbackHandler) Creates an instance of the client to communicate with the ExternalSubscription facade.

Method Summary

Modifier and Type	Method and Description
RespondSubscriptionType	changeSubscription(ChangeSubscriptionType aChangeSubscription) This method will communicate with the ExternalSubscription facade and send the specified ChangeSubscription request.
ShowSubscriptionType	getSubscription(GetSubscriptionType aGetSubscription) This method will communicate with the ExternalSubscription facade and send the specified GetSubscription.
AcknowledgeSubscriptionType	processSubscription(ProcessSubscriptionType aProcessSubscription) This method will communicate with the ExternalSubscription facade and send the specified ProcessSubscription request.

Methods inherited from class com.ibm.commerce.subscription.facade.client.AbstractSubscriptionFacadeClient

getSubscription, getSubscription

Methods inherited from class com.ibm.commerce.foundation.client.facade.bod.AbstractBusinessObjectDocumentFacadeClient

createActionExpression, createChangeVerb, createGetVerb, createGetVerb, createProcessVerb, createSyncVerb

Methods inherited from class java.lang.Object

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

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM Copyright notice field.

See Also:

Constant Field Values

Constructor Detail

AbstractExternalSubscriptionFacadeClient

public AbstractExternalSubscriptionFacadeClient()

Creates an instance of the client to communicate with the ExternalSubscription facade.

AbstractExternalSubscriptionFacadeClient

public AbstractExternalSubscriptionFacadeClient(BusinessContextType businessContext,
                                                javax.security.auth.callback.CallbackHandler callbackHandler)

Creates an instance of the client to communicate with the ExternalSubscription 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 ExternalSubscription facade and send the specified GetSubscription. request.

Overrides:

getSubscription in class AbstractSubscriptionFacadeClient

Parameters:

aGetSubscription - The GetSubscription request document.

Returns:

The resulting ShowSubscription response document.

processSubscription

public AcknowledgeSubscriptionType processSubscription(ProcessSubscriptionType aProcessSubscription)

This method will communicate with the ExternalSubscription facade and send the specified ProcessSubscription request.

Overrides:

processSubscription in class AbstractSubscriptionFacadeClient

Parameters:

aProcessSubscription - The ProcessSubscription request document.

Returns:

The resulting AcknowledgeSubscription response document.

changeSubscription

public RespondSubscriptionType changeSubscription(ChangeSubscriptionType aChangeSubscription)

This method will communicate with the ExternalSubscription facade and send the specified ChangeSubscription request.

Overrides:

changeSubscription in class AbstractSubscriptionFacadeClient

Parameters:

aChangeSubscription - The ChangeSubscription request document.

Returns:

The resulting RespondSubscription response document.