com.ibm.commerce.infrastructure.facade.client
Class AbstractInfrastructureFacadeClient
- java.lang.Object
-
- com.ibm.commerce.foundation.client.facade.bod.AbstractBusinessObjectDocumentFacadeClient
-
- com.ibm.commerce.infrastructure.facade.client.AbstractInfrastructureFacadeClient
-
- Direct Known Subclasses:
- InfrastructureFacadeClient
public abstract class AbstractInfrastructureFacadeClient extends AbstractBusinessObjectDocumentFacadeClient
This class provides a set of methods that can be used to communicate with the Infrastructure facade. This class represents a library of Infrastructure 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 Infrastructure facade.
-
-
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 AbstractInfrastructureFacadeClient()
Creates an instance of the client to communicate with the Infrastructure facade.AbstractInfrastructureFacadeClient(BusinessContextType businessContext, javax.security.auth.callback.CallbackHandler callbackHandler)
Creates an instance of the client to communicate with the Infrastructure facade.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description com.ibm.commerce.infrastructure.facade.datatypes.RespondFolderType
changeFolder(com.ibm.commerce.infrastructure.facade.datatypes.ChangeFolderType aChangeFolder)
This method will communicate with the Folder facade and send the specified ChangeFolder request.com.ibm.commerce.infrastructure.facade.datatypes.RespondOnlineStoreType
changeOnlineStore(com.ibm.commerce.infrastructure.facade.datatypes.ChangeOnlineStoreType aChangeOnlineStore)
This method will communicate with the OnlineStore facade and send the specified ChangeOnlineStore request.com.ibm.commerce.infrastructure.facade.datatypes.RespondPageLayoutType
changePageLayout(com.ibm.commerce.infrastructure.facade.datatypes.ChangePageLayoutType aChangePageLayout)
This method will communicate with the PageLayout facade and send the specified ChangePageLayout request.com.ibm.commerce.infrastructure.facade.datatypes.RespondStorePageType
changeStorePage(com.ibm.commerce.infrastructure.facade.datatypes.ChangeStorePageType aChangeStorePage)
This method will communicate with the StorePage facade and send the specified ChangeStorePage request.ShowConfigurationType
getConfiguration(GetConfigurationType aGetConfiguration)
This method will communicate with the Infrastructure facade and send the specified GetConfiguration.ShowConfigurationDataAreaType
getConfiguration(GetType getVerb)
This method returns theShowConfigurationDataArea
when issuing the specified get expression to fetch Configurations.java.util.List
getConfiguration(java.lang.String expressionLanguage, java.lang.String expression)
This method returns a list of Configurations based on the expression specified.com.ibm.commerce.infrastructure.facade.datatypes.ShowExternalRuleType
getExternalRule(com.ibm.commerce.infrastructure.facade.datatypes.GetExternalRuleType aGetExternalRule)
This method will communicate with the Infrastructure facade and send the specified GetExternalRule.com.ibm.commerce.infrastructure.facade.datatypes.ShowExternalRuleDataAreaType
getExternalRule(GetType getVerb)
This method returns theShowExternalRuleDataArea
when issuing the specified get expression to fetch ExternalRules.java.util.List
getExternalRule(java.lang.String expressionLanguage, java.lang.String expression)
This method returns a list of ExternalRules based on the expression specified.com.ibm.commerce.infrastructure.facade.datatypes.ShowFolderType
getFolder(com.ibm.commerce.infrastructure.facade.datatypes.GetFolderType aGetFolder)
This method will communicate with the Infrastructure facade and send the specified GetFolder.com.ibm.commerce.infrastructure.facade.datatypes.ShowFolderDataAreaType
getFolder(GetType getVerb)
This method returns theShowFolderDataArea
when issuing the specified get expression to fetch Folders.java.util.List
getFolder(java.lang.String expressionLanguage, java.lang.String expression)
This method returns a list of Folders based on the expression specified.ShowOnlineStoreType
getOnlineStore(GetOnlineStoreType aGetOnlineStore)
This method will communicate with the Infrastructure facade and send the specified GetOnlineStore.ShowOnlineStoreDataAreaType
getOnlineStore(GetType getVerb)
This method returns theShowOnlineStoreDataArea
when issuing the specified get expression to fetch OnlineStores.java.util.List
getOnlineStore(java.lang.String expressionLanguage, java.lang.String expression)
This method returns a list of OnlineStores based on the expression specified.com.ibm.commerce.infrastructure.facade.datatypes.ShowPageLayoutType
getPageLayout(com.ibm.commerce.infrastructure.facade.datatypes.GetPageLayoutType aGetPageLayout)
This method will communicate with the Infrastructure facade and send the specified GetPageLayout.com.ibm.commerce.infrastructure.facade.datatypes.ShowPageLayoutDataAreaType
getPageLayout(GetType getVerb)
This method returns theShowPageLayoutDataArea
when issuing the specified get expression to fetch PageLayouts.java.util.List
getPageLayout(java.lang.String expressionLanguage, java.lang.String expression)
This method returns a list of PageLayouts based on the expression specified.com.ibm.commerce.infrastructure.facade.datatypes.ShowStorePageType
getStorePage(com.ibm.commerce.infrastructure.facade.datatypes.GetStorePageType aGetStorePage)
This method will communicate with the Infrastructure facade and send the specified GetStorePage.com.ibm.commerce.infrastructure.facade.datatypes.ShowStorePageDataAreaType
getStorePage(GetType getVerb)
This method returns theShowStorePageDataArea
when issuing the specified get expression to fetch StorePages.java.util.List
getStorePage(java.lang.String expressionLanguage, java.lang.String expression)
This method returns a list of StorePages based on the expression specified.com.ibm.commerce.infrastructure.facade.datatypes.ShowStorePageDataType
getStorePageData(com.ibm.commerce.infrastructure.facade.datatypes.GetStorePageDataType aGetStorePageData)
This method will communicate with the Infrastructure facade and send the specified GetStorePageData.com.ibm.commerce.infrastructure.facade.datatypes.ShowStorePageDataDataAreaType
getStorePageData(GetType getVerb)
This method returns theShowStorePageDataDataArea
when issuing the specified get expression to fetch StorePageDatas.java.util.List
getStorePageData(java.lang.String expressionLanguage, java.lang.String expression)
This method returns a list of StorePageDatas based on the expression specified.com.ibm.commerce.infrastructure.facade.datatypes.AcknowledgeFolderType
processFolder(com.ibm.commerce.infrastructure.facade.datatypes.ProcessFolderType aProcessFolder)
This method will communicate with the Infrastructure facade and send the specified ProcessFolder request.com.ibm.commerce.infrastructure.facade.datatypes.AcknowledgeOnlineStoreType
processOnlineStore(com.ibm.commerce.infrastructure.facade.datatypes.ProcessOnlineStoreType aProcessOnlineStore)
This method will communicate with the Infrastructure facade and send the specified ProcessOnlineStore request.-
Methods inherited from class com.ibm.commerce.foundation.client.facade.bod.AbstractBusinessObjectDocumentFacadeClient
createActionExpression, createChangeVerb, createGetVerb, createGetVerb, createProcessVerb, createSyncVerb
-
-
-
-
Field Detail
-
COPYRIGHT
public static final java.lang.String COPYRIGHT
IBM Copyright notice field.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
AbstractInfrastructureFacadeClient
public AbstractInfrastructureFacadeClient()
Creates an instance of the client to communicate with the Infrastructure facade.
-
AbstractInfrastructureFacadeClient
public AbstractInfrastructureFacadeClient(BusinessContextType businessContext, javax.security.auth.callback.CallbackHandler callbackHandler)
Creates an instance of the client to communicate with the Infrastructure 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
-
getConfiguration
public ShowConfigurationType getConfiguration(GetConfigurationType aGetConfiguration)
This method will communicate with the Infrastructure facade and send the specified GetConfiguration. request.- Parameters:
aGetConfiguration
- The GetConfiguration request document.- Returns:
- The resulting
ShowConfiguration
response document.
-
getConfiguration
public ShowConfigurationDataAreaType getConfiguration(GetType getVerb) throws ConfigurationException
This method returns theShowConfigurationDataArea
when issuing the specified get expression to fetch Configurations. This method will be used by other framworks or methods that constructs the get expression.- Parameters:
getVerb
- The get expression to execute.- Returns:
- The
ShowConfigurationDataArea
response when issuing the get expression. - Throws:
ConfigurationException
- TheConfigurationException
is thrown if error information is found in the specifiedShowConfigurationDataArea
. This will represent that there was a problem when performing the operation.
-
getConfiguration
public java.util.List getConfiguration(java.lang.String expressionLanguage, java.lang.String expression) throws ConfigurationException
This method returns a list of Configurations based on the expression specified.- Parameters:
expressionLanguage
- The expression lanaguage.expression
- The expression to return a list of Configurations.- Returns:
- The list of Configurations that matches the expression specified.
- Throws:
ConfigurationException
- TheConfigurationException
is thrown if error information is found in the specifiedShowConfigurationDataArea
. This will represent that there was a problem when performing the operation.
-
getExternalRule
public com.ibm.commerce.infrastructure.facade.datatypes.ShowExternalRuleType getExternalRule(com.ibm.commerce.infrastructure.facade.datatypes.GetExternalRuleType aGetExternalRule)
This method will communicate with the Infrastructure facade and send the specified GetExternalRule. request.- Parameters:
aGetExternalRule
- The GetExternalRule request document.- Returns:
- The resulting
ShowExternalRule
response document.
-
getExternalRule
public com.ibm.commerce.infrastructure.facade.datatypes.ShowExternalRuleDataAreaType getExternalRule(GetType getVerb) throws com.ibm.commerce.infrastructure.facade.client.ExternalRuleException
This method returns theShowExternalRuleDataArea
when issuing the specified get expression to fetch ExternalRules. This method will be used by other framworks or methods that constructs the get expression.- Parameters:
getVerb
- The get expression to execute.- Returns:
- The
ShowExternalRuleDataArea
response when issuing the get expression. - Throws:
ExternalRuleException
- TheExternalRuleException
is thrown if error information is found in the specifiedShowExternalRuleDataArea
. This will represent that there was a problem when performing the operation.
-
getExternalRule
public java.util.List getExternalRule(java.lang.String expressionLanguage, java.lang.String expression) throws com.ibm.commerce.infrastructure.facade.client.ExternalRuleException
This method returns a list of ExternalRules based on the expression specified.- Parameters:
expressionLanguage
- The expression lanaguage.expression
- The expression to return a list of ExternalRules.- Returns:
- The list of ExternalRules that matches the expression specified.
- Throws:
ExternalRuleException
- TheExternalRuleException
is thrown if error information is found in the specifiedShowExternalRuleDataArea
. This will represent that there was a problem when performing the operation.
-
getOnlineStore
public ShowOnlineStoreType getOnlineStore(GetOnlineStoreType aGetOnlineStore)
This method will communicate with the Infrastructure facade and send the specified GetOnlineStore. request.- Parameters:
aGetOnlineStore
- The GetOnlineStore request document.- Returns:
- The resulting
ShowOnlineStore
response document.
-
processOnlineStore
public com.ibm.commerce.infrastructure.facade.datatypes.AcknowledgeOnlineStoreType processOnlineStore(com.ibm.commerce.infrastructure.facade.datatypes.ProcessOnlineStoreType aProcessOnlineStore)
This method will communicate with the Infrastructure facade and send the specified ProcessOnlineStore request.- Parameters:
aProcessOnlineStore
- The ProcessOnlineStore request document.- Returns:
- The resulting AcknowledgeOnlineStore response document.
-
changeOnlineStore
public com.ibm.commerce.infrastructure.facade.datatypes.RespondOnlineStoreType changeOnlineStore(com.ibm.commerce.infrastructure.facade.datatypes.ChangeOnlineStoreType aChangeOnlineStore)
This method will communicate with the OnlineStore facade and send the specified ChangeOnlineStore request.- Parameters:
aChangeOnlineStore
- The ChangeOnlineStore request document.- Returns:
- The resulting RespondOnlineStore response document.
-
getOnlineStore
public ShowOnlineStoreDataAreaType getOnlineStore(GetType getVerb) throws OnlineStoreException
This method returns theShowOnlineStoreDataArea
when issuing the specified get expression to fetch OnlineStores. This method will be used by other framworks or methods that constructs the get expression.- Parameters:
getVerb
- The get expression to execute.- Returns:
- The
ShowOnlineStoreDataArea
response when issuing the get expression. - Throws:
OnlineStoreException
- TheOnlineStoreException
is thrown if error information is found in the specifiedShowOnlineStoreDataArea
. This will represent that there was a problem when performing the operation.
-
getOnlineStore
public java.util.List getOnlineStore(java.lang.String expressionLanguage, java.lang.String expression) throws OnlineStoreException
This method returns a list of OnlineStores based on the expression specified.- Parameters:
expressionLanguage
- The expression lanaguage.expression
- The expression to return a list of OnlineStores.- Returns:
- The list of OnlineStores that matches the expression specified.
- Throws:
OnlineStoreException
- TheOnlineStoreException
is thrown if error information is found in the specifiedShowOnlineStoreDataArea
. This will represent that there was a problem when performing the operation.
-
getPageLayout
public com.ibm.commerce.infrastructure.facade.datatypes.ShowPageLayoutType getPageLayout(com.ibm.commerce.infrastructure.facade.datatypes.GetPageLayoutType aGetPageLayout)
This method will communicate with the Infrastructure facade and send the specified GetPageLayout. request.- Parameters:
aGetPageLayout
- The GetPageLayout request document.- Returns:
- The resulting
ShowPageLayout
response document.
-
changePageLayout
public com.ibm.commerce.infrastructure.facade.datatypes.RespondPageLayoutType changePageLayout(com.ibm.commerce.infrastructure.facade.datatypes.ChangePageLayoutType aChangePageLayout)
This method will communicate with the PageLayout facade and send the specified ChangePageLayout request.- Parameters:
aChangePageLayout
- The ChangePageLayout request document.- Returns:
- The resulting RespondPageLayout response document.
-
getPageLayout
public com.ibm.commerce.infrastructure.facade.datatypes.ShowPageLayoutDataAreaType getPageLayout(GetType getVerb) throws com.ibm.commerce.infrastructure.facade.client.PageLayoutException
This method returns theShowPageLayoutDataArea
when issuing the specified get expression to fetch PageLayouts. This method will be used by other framworks or methods that constructs the get expression.- Parameters:
getVerb
- The get expression to execute.- Returns:
- The
ShowPageLayoutDataArea
response when issuing the get expression. - Throws:
PageLayoutException
- ThePageLayoutException
is thrown if error information is found in the specifiedShowPageLayoutDataArea
. This will represent that there was a problem when performing the operation.
-
getPageLayout
public java.util.List getPageLayout(java.lang.String expressionLanguage, java.lang.String expression) throws com.ibm.commerce.infrastructure.facade.client.PageLayoutException
This method returns a list of PageLayouts based on the expression specified.- Parameters:
expressionLanguage
- The expression lanaguage.expression
- The expression to return a list of PageLayouts.- Returns:
- The list of PageLayouts that matches the expression specified.
- Throws:
PageLayoutException
- ThePageLayoutException
is thrown if error information is found in the specifiedShowPageLayoutDataArea
. This will represent that there was a problem when performing the operation.
-
getStorePage
public com.ibm.commerce.infrastructure.facade.datatypes.ShowStorePageType getStorePage(com.ibm.commerce.infrastructure.facade.datatypes.GetStorePageType aGetStorePage)
This method will communicate with the Infrastructure facade and send the specified GetStorePage. request.- Parameters:
aGetStorePage
- The GetStorePage request document.- Returns:
- The resulting
ShowStorePage
response document.
-
changeStorePage
public com.ibm.commerce.infrastructure.facade.datatypes.RespondStorePageType changeStorePage(com.ibm.commerce.infrastructure.facade.datatypes.ChangeStorePageType aChangeStorePage)
This method will communicate with the StorePage facade and send the specified ChangeStorePage request.- Parameters:
aChangeStorePage
- The ChangeStorePage request document.- Returns:
- The resulting RespondStorePage response document.
-
getStorePage
public com.ibm.commerce.infrastructure.facade.datatypes.ShowStorePageDataAreaType getStorePage(GetType getVerb) throws com.ibm.commerce.infrastructure.facade.client.StorePageException
This method returns theShowStorePageDataArea
when issuing the specified get expression to fetch StorePages. This method will be used by other framworks or methods that constructs the get expression.- Parameters:
getVerb
- The get expression to execute.- Returns:
- The
ShowStorePageDataArea
response when issuing the get expression. - Throws:
StorePageException
- TheStorePageException
is thrown if error information is found in the specifiedShowStorePageDataArea
. This will represent that there was a problem when performing the operation.
-
getStorePage
public java.util.List getStorePage(java.lang.String expressionLanguage, java.lang.String expression) throws com.ibm.commerce.infrastructure.facade.client.StorePageException
This method returns a list of StorePages based on the expression specified.- Parameters:
expressionLanguage
- The expression lanaguage.expression
- The expression to return a list of StorePages.- Returns:
- The list of StorePages that matches the expression specified.
- Throws:
StorePageException
- TheStorePageException
is thrown if error information is found in the specifiedShowStorePageDataArea
. This will represent that there was a problem when performing the operation.
-
getStorePageData
public com.ibm.commerce.infrastructure.facade.datatypes.ShowStorePageDataType getStorePageData(com.ibm.commerce.infrastructure.facade.datatypes.GetStorePageDataType aGetStorePageData)
This method will communicate with the Infrastructure facade and send the specified GetStorePageData. request.- Parameters:
aGetStorePageData
- The GetStorePageData request document.- Returns:
- The resulting
ShowStorePageData
response document.
-
getStorePageData
public com.ibm.commerce.infrastructure.facade.datatypes.ShowStorePageDataDataAreaType getStorePageData(GetType getVerb) throws com.ibm.commerce.infrastructure.facade.client.StorePageDataException
This method returns theShowStorePageDataDataArea
when issuing the specified get expression to fetch StorePageDatas. This method will be used by other framworks or methods that constructs the get expression.- Parameters:
getVerb
- The get expression to execute.- Returns:
- The
ShowStorePageDataDataArea
response when issuing the get expression. - Throws:
StorePageDataException
- TheStorePageDataException
is thrown if error information is found in the specifiedShowStorePageDataDataArea
. This will represent that there was a problem when performing the operation.
-
getStorePageData
public java.util.List getStorePageData(java.lang.String expressionLanguage, java.lang.String expression) throws com.ibm.commerce.infrastructure.facade.client.StorePageDataException
This method returns a list of StorePageDatas based on the expression specified.- Parameters:
expressionLanguage
- The expression lanaguage.expression
- The expression to return a list of StorePageDatas.- Returns:
- The list of StorePageDatas that matches the expression specified.
- Throws:
StorePageDataException
- TheStorePageDataException
is thrown if error information is found in the specifiedShowStorePageDataDataArea
. This will represent that there was a problem when performing the operation.
-
getFolder
public com.ibm.commerce.infrastructure.facade.datatypes.ShowFolderType getFolder(com.ibm.commerce.infrastructure.facade.datatypes.GetFolderType aGetFolder)
This method will communicate with the Infrastructure facade and send the specified GetFolder. request.- Parameters:
aGetFolder
- The GetFolder request document.- Returns:
- The resulting
ShowFolder
response document.
-
processFolder
public com.ibm.commerce.infrastructure.facade.datatypes.AcknowledgeFolderType processFolder(com.ibm.commerce.infrastructure.facade.datatypes.ProcessFolderType aProcessFolder)
This method will communicate with the Infrastructure facade and send the specified ProcessFolder request.- Parameters:
aProcessFolder
- The ProcessFolder request document.- Returns:
- The resulting AcknowledgeFolder response document.
-
changeFolder
public com.ibm.commerce.infrastructure.facade.datatypes.RespondFolderType changeFolder(com.ibm.commerce.infrastructure.facade.datatypes.ChangeFolderType aChangeFolder)
This method will communicate with the Folder facade and send the specified ChangeFolder request.- Parameters:
aChangeFolder
- The ChangeFolder request document.- Returns:
- The resulting RespondFolder response document.
-
getFolder
public com.ibm.commerce.infrastructure.facade.datatypes.ShowFolderDataAreaType getFolder(GetType getVerb) throws com.ibm.commerce.infrastructure.facade.client.FolderException
This method returns theShowFolderDataArea
when issuing the specified get expression to fetch Folders. This method will be used by other framworks or methods that constructs the get expression.- Parameters:
getVerb
- The get expression to execute.- Returns:
- The
ShowFolderDataArea
response when issuing the get expression. - Throws:
FolderException
- TheFolderException
is thrown if error information is found in the specifiedShowFolderDataArea
. This will represent that there was a problem when performing the operation.
-
getFolder
public java.util.List getFolder(java.lang.String expressionLanguage, java.lang.String expression) throws com.ibm.commerce.infrastructure.facade.client.FolderException
This method returns a list of Folders based on the expression specified.- Parameters:
expressionLanguage
- The expression lanaguage.expression
- The expression to return a list of Folders.- Returns:
- The list of Folders that matches the expression specified.
- Throws:
FolderException
- TheFolderException
is thrown if error information is found in the specifiedShowFolderDataArea
. This will represent that there was a problem when performing the operation.
-
-