public class InfrastructureFacadeClient extends AbstractInfrastructureFacadeClient
This class provides common methods that this and other utility class to the Infrastructure facade can use. This class also provides a set of convenient Java API to represent particular Infrastructure operations. This set of Java API also include APIs for Web based requests to transform the name value pair request into the appropriate request documents.
Constructor and Description |
---|
InfrastructureFacadeClient()
Creates an instance of the client to communicate with the Infrastructure facade.
|
InfrastructureFacadeClient(BusinessContextType businessContext, javax.security.auth.callback.CallbackHandler callbackHandler)
Creates an instance of the client to communicate with the Infrastructure facade.
|
Modifier and Type | Method and Description |
---|---|
com.ibm.commerce.infrastructure.facade.datatypes.RespondOnlineStoreType | addDefaultCatalog(java.lang.String storeId, java.lang.String catalogId, java.util.Map<java.lang.String,java.lang.String> customFields)
Creates the default catalog configuration for a store
|
com.ibm.commerce.infrastructure.facade.datatypes.RespondStorePageType | addDefaultStorePageAssociation(com.ibm.commerce.infrastructure.facade.datatypes.ChangeStorePageType aChangeStorePage)
This method will communicate with the StorePage facade to add a default Store page layout association.
|
com.ibm.commerce.infrastructure.facade.datatypes.RespondFolderType | addFolderItem(java.lang.String folderId, java.lang.String[] referenceId, java.lang.String[] folderItemType, java.lang.String[] storeId, java.util.List<java.util.Map> customFieldList)
Add one or more folder items to a folder.
|
com.ibm.commerce.infrastructure.facade.datatypes.RespondOnlineStoreDataAreaType | addSEOProperties(java.lang.String storeId, java.lang.String objectId, java.lang.String pageGroup, java.util.List<com.ibm.commerce.foundation.common.datatypes.SEOPropertiesType> seoPropertiesList)
This method adds a list of SEO Properties for a given object with given page group for a given store.
|
com.ibm.commerce.infrastructure.facade.datatypes.RespondOnlineStoreDataAreaType | addSEOURL(java.lang.String storeId, java.lang.String objectId, java.lang.String usage, java.util.List<com.ibm.commerce.foundation.common.datatypes.SEOURLType> seoURLTypeList)
This method adds a list of SEO URLs for a given object with given usage for a given store.
|
com.ibm.commerce.infrastructure.facade.datatypes.RespondOnlineStoreType | changeDefaultCatalog(java.lang.String store_id, java.lang.String storedefcat_id, java.util.Map<java.lang.String,java.lang.String> customFields)
Changes the default catalog configuration for a store
|
RespondMarketingSpotType | changeFlow(ChangeMarketingSpotType aChangeFlow)
This method will communicate with the MarketingSpot facade and send the specified ChangeMarketingSpot request for changing the flow.
|
com.ibm.commerce.infrastructure.facade.datatypes.RespondOnlineStoreDataAreaType | changeSEOProperties(java.lang.String storeId, java.lang.String[] actions, com.ibm.commerce.foundation.common.datatypes.SEOPropertiesType[] seoPropertiesTypes, java.lang.String[] expressions)
This method changes SEO Properties for a given store with the given actions and XPATH expressions.
|
com.ibm.commerce.infrastructure.facade.datatypes.RespondOnlineStoreDataAreaType | changeSEOProperties(java.lang.String storeId, java.lang.String objectId, java.lang.String pageGroup, java.util.List<com.ibm.commerce.foundation.common.datatypes.SEOPropertiesType> seoPropertiesList, java.lang.String actionCode)
This method changes a list of SEO Properties for a given object with given page group for a given store with the given action code.
|
com.ibm.commerce.infrastructure.facade.datatypes.RespondOnlineStoreDataAreaType | changeSEOURL(java.lang.String storeId, java.lang.String[] actions, com.ibm.commerce.foundation.common.datatypes.SEOURLType[] seoURLTypes, java.lang.String[] expressions)
This method changes SEO URLs for a given store with the given actions and XPATH expressions.
|
com.ibm.commerce.infrastructure.facade.datatypes.RespondOnlineStoreDataAreaType | changeSEOURL(java.lang.String storeId, java.lang.String objectId, java.lang.String usage, java.util.List<com.ibm.commerce.foundation.common.datatypes.SEOURLType> seoURLTypeList, java.lang.String actionCode)
This method changes a list of SEO URLs for a given object with given usage for a given store with the given action code.
|
com.ibm.commerce.infrastructure.facade.datatypes.AcknowledgeOnlineStoreType | closeStore(java.lang.String[] storeIds)
This method composes a Process BOD with an Action of 'Close' and sends the BOD to WebSphere Commerce.
|
com.ibm.commerce.infrastructure.facade.datatypes.AcknowledgeFolderType | createFolder(java.lang.String identifier, java.lang.String usage, java.lang.String description, java.lang.String parentFolderId, java.lang.String storeId, java.util.Map customFieldMap)
Creates a new folder.
|
com.ibm.commerce.infrastructure.facade.datatypes.RespondOnlineStoreType | deleteDefaultCatalog(java.lang.String storeId, java.lang.String storedefcatId)
Deletes the default catalog configuration for the store
|
com.ibm.commerce.infrastructure.facade.datatypes.RespondOnlineStoreDataAreaType | deleteSEOProperties(java.lang.String storeId, java.lang.String objectId, java.lang.String pageGroup, java.util.List<com.ibm.commerce.foundation.common.datatypes.SEOPropertiesType> seoPropertiesList)
This method deletes a list of SEO Properties for a given object with given page group for a given store.
|
com.ibm.commerce.infrastructure.facade.datatypes.RespondOnlineStoreDataAreaType | deleteSEOURL(java.lang.String storeId, java.lang.String objectId, java.lang.String usage, java.util.List<com.ibm.commerce.foundation.common.datatypes.SEOURLType> seoURLTypeList)
This method deletes a list of SEO URLs for a given object with given usage for a given store.
|
ConfigurationType | findConfigurationById(java.lang.String uniqueId)
This method composes a Get BOD with an expression to find a configuration by store ID and sends the BOD to the Infrastructure-Server.
|
OnlineStoreType | findStoreById(java.lang.String storeId, java.lang.String accessProfile)
This method composes a Get BOD with an expression to find a store by ID and sends the BOD to the Infrastructure-Server.
|
java.lang.String | getConfigurationDescription(java.lang.String uniqueId)
This method returns the description of the requested configuration.
|
java.lang.String | getConfigurationLanguageId(java.lang.String uniqueId)
This method returns the description language Id of the requested configuration.
|
java.util.Map | getConfigurationUserData(java.lang.String uniqueId)
This method returns the description language Id of the requested configuration.
|
java.lang.String | getConfigurationValue(java.lang.String uniqueId, java.lang.String configName)
This method returns the value of a configuration attribute found in the requested configuration by store ID.
|
java.lang.String[] | getConfigurationValues(java.lang.String uniqueId, java.lang.String configName)
This method returns the string array of values of a configuration attribute found in the requested configuration by store ID.
|
com.ibm.commerce.infrastructure.facade.datatypes.ShowFolderDataAreaType | getFolderById(java.lang.String folderId, java.lang.String accessProfile)
Gets a folder through folder unique id.
|
com.ibm.commerce.infrastructure.facade.datatypes.RespondFolderType | moveFolder(java.lang.String folderId, java.lang.String parentFolderId)
Moves an existing folder to a new location.
|
com.ibm.commerce.infrastructure.facade.datatypes.AcknowledgeOnlineStoreType | openStore(java.lang.String[] storeIds)
This method composes a Process BOD with an Action of 'Open' and sends the BOD to WebSphere Commerce.
|
com.ibm.commerce.infrastructure.facade.datatypes.RespondFolderType | removeFolderItem(java.lang.String folderId, java.lang.String[] folderItemId)
Remove one or more folder items from a folder.
|
com.ibm.commerce.infrastructure.facade.datatypes.RespondFolderType | removeFolderItem(java.lang.String folderId, java.lang.String[] referenceId, java.lang.String[] folderItemType)
Remove one or more folder items from a folder.
|
void | reset()
Reset the client to the initial state.
|
com.ibm.commerce.infrastructure.facade.datatypes.RespondStorePageType | updateDefaultStorePageAssociation(com.ibm.commerce.infrastructure.facade.datatypes.ChangeStorePageType aChangeStorePage)
This method will communicate with the StorePage facade to update the default Store page layout association.
|
com.ibm.commerce.infrastructure.facade.datatypes.RespondFolderType | updateFolder(java.lang.String folderId, java.lang.String identifier, java.lang.String description, java.util.Map customFieldMap)
Updates an existing folder.
|
com.ibm.commerce.infrastructure.facade.datatypes.RespondOnlineStoreDataAreaType | updateSEOProperties(java.lang.String storeId, java.lang.String objectId, java.lang.String pageGroup, java.util.List<com.ibm.commerce.foundation.common.datatypes.SEOPropertiesType> seoPropertiesList)
This method updates a list of SEO Properties for a given object with given page group for a given store.
|
com.ibm.commerce.infrastructure.facade.datatypes.RespondOnlineStoreDataAreaType | updateSEOURL(java.lang.String storeId, java.lang.String objectId, java.lang.String usage, java.util.List<com.ibm.commerce.foundation.common.datatypes.SEOURLType> seoURLTypeList)
This method updates a list of SEO URLs for a given object with given usage for a given store.
|
public InfrastructureFacadeClient()
public InfrastructureFacadeClient(BusinessContextType businessContext, javax.security.auth.callback.CallbackHandler callbackHandler)
public com.ibm.commerce.infrastructure.facade.datatypes.AcknowledgeOnlineStoreType closeStore(java.lang.String[] storeIds)
public com.ibm.commerce.infrastructure.facade.datatypes.AcknowledgeOnlineStoreType openStore(java.lang.String[] storeIds)
public OnlineStoreType findStoreById(java.lang.String storeId, java.lang.String accessProfile) throws OnlineStoreException
public ConfigurationType findConfigurationById(java.lang.String uniqueId) throws ConfigurationException
public java.lang.String getConfigurationValue(java.lang.String uniqueId, java.lang.String configName) throws ConfigurationException
public java.lang.String[] getConfigurationValues(java.lang.String uniqueId, java.lang.String configName) throws ConfigurationException
public java.lang.String getConfigurationDescription(java.lang.String uniqueId) throws ConfigurationException
public java.lang.String getConfigurationLanguageId(java.lang.String uniqueId) throws ConfigurationException
public java.util.Map getConfigurationUserData(java.lang.String uniqueId) throws ConfigurationException
public void reset()
public RespondMarketingSpotType changeFlow(ChangeMarketingSpotType aChangeFlow)
public com.ibm.commerce.infrastructure.facade.datatypes.RespondStorePageType updateDefaultStorePageAssociation(com.ibm.commerce.infrastructure.facade.datatypes.ChangeStorePageType aChangeStorePage)
public com.ibm.commerce.infrastructure.facade.datatypes.RespondStorePageType addDefaultStorePageAssociation(com.ibm.commerce.infrastructure.facade.datatypes.ChangeStorePageType aChangeStorePage)
public com.ibm.commerce.infrastructure.facade.datatypes.RespondOnlineStoreType addDefaultCatalog(java.lang.String storeId, java.lang.String catalogId, java.util.Map<java.lang.String,java.lang.String> customFields)
public com.ibm.commerce.infrastructure.facade.datatypes.RespondOnlineStoreType changeDefaultCatalog(java.lang.String store_id, java.lang.String storedefcat_id, java.util.Map<java.lang.String,java.lang.String> customFields)
public com.ibm.commerce.infrastructure.facade.datatypes.RespondOnlineStoreType deleteDefaultCatalog(java.lang.String storeId, java.lang.String storedefcatId)
public com.ibm.commerce.infrastructure.facade.datatypes.RespondFolderType removeFolderItem(java.lang.String folderId, java.lang.String[] referenceId, java.lang.String[] folderItemType)
public com.ibm.commerce.infrastructure.facade.datatypes.RespondFolderType removeFolderItem(java.lang.String folderId, java.lang.String[] folderItemId)
public com.ibm.commerce.infrastructure.facade.datatypes.RespondFolderType addFolderItem(java.lang.String folderId, java.lang.String[] referenceId, java.lang.String[] folderItemType, java.lang.String[] storeId, java.util.List<java.util.Map> customFieldList)
public com.ibm.commerce.infrastructure.facade.datatypes.AcknowledgeFolderType createFolder(java.lang.String identifier, java.lang.String usage, java.lang.String description, java.lang.String parentFolderId, java.lang.String storeId, java.util.Map customFieldMap)
public com.ibm.commerce.infrastructure.facade.datatypes.RespondFolderType updateFolder(java.lang.String folderId, java.lang.String identifier, java.lang.String description, java.util.Map customFieldMap)
public com.ibm.commerce.infrastructure.facade.datatypes.RespondFolderType moveFolder(java.lang.String folderId, java.lang.String parentFolderId)
public com.ibm.commerce.infrastructure.facade.datatypes.ShowFolderDataAreaType getFolderById(java.lang.String folderId, java.lang.String accessProfile) throws com.ibm.commerce.infrastructure.facade.client.FolderException
public com.ibm.commerce.infrastructure.facade.datatypes.RespondOnlineStoreDataAreaType addSEOURL(java.lang.String storeId, java.lang.String objectId, java.lang.String usage, java.util.List<com.ibm.commerce.foundation.common.datatypes.SEOURLType> seoURLTypeList) throws OnlineStoreException
public com.ibm.commerce.infrastructure.facade.datatypes.RespondOnlineStoreDataAreaType updateSEOURL(java.lang.String storeId, java.lang.String objectId, java.lang.String usage, java.util.List<com.ibm.commerce.foundation.common.datatypes.SEOURLType> seoURLTypeList) throws OnlineStoreException
public com.ibm.commerce.infrastructure.facade.datatypes.RespondOnlineStoreDataAreaType deleteSEOURL(java.lang.String storeId, java.lang.String objectId, java.lang.String usage, java.util.List<com.ibm.commerce.foundation.common.datatypes.SEOURLType> seoURLTypeList) throws OnlineStoreException
public com.ibm.commerce.infrastructure.facade.datatypes.RespondOnlineStoreDataAreaType changeSEOURL(java.lang.String storeId, java.lang.String objectId, java.lang.String usage, java.util.List<com.ibm.commerce.foundation.common.datatypes.SEOURLType> seoURLTypeList, java.lang.String actionCode) throws OnlineStoreException
public com.ibm.commerce.infrastructure.facade.datatypes.RespondOnlineStoreDataAreaType changeSEOURL(java.lang.String storeId, java.lang.String[] actions, com.ibm.commerce.foundation.common.datatypes.SEOURLType[] seoURLTypes, java.lang.String[] expressions) throws OnlineStoreException
public com.ibm.commerce.infrastructure.facade.datatypes.RespondOnlineStoreDataAreaType addSEOProperties(java.lang.String storeId, java.lang.String objectId, java.lang.String pageGroup, java.util.List<com.ibm.commerce.foundation.common.datatypes.SEOPropertiesType> seoPropertiesList) throws OnlineStoreException
public com.ibm.commerce.infrastructure.facade.datatypes.RespondOnlineStoreDataAreaType updateSEOProperties(java.lang.String storeId, java.lang.String objectId, java.lang.String pageGroup, java.util.List<com.ibm.commerce.foundation.common.datatypes.SEOPropertiesType> seoPropertiesList) throws OnlineStoreException
public com.ibm.commerce.infrastructure.facade.datatypes.RespondOnlineStoreDataAreaType deleteSEOProperties(java.lang.String storeId, java.lang.String objectId, java.lang.String pageGroup, java.util.List<com.ibm.commerce.foundation.common.datatypes.SEOPropertiesType> seoPropertiesList) throws OnlineStoreException
public com.ibm.commerce.infrastructure.facade.datatypes.RespondOnlineStoreDataAreaType changeSEOProperties(java.lang.String storeId, java.lang.String objectId, java.lang.String pageGroup, java.util.List<com.ibm.commerce.foundation.common.datatypes.SEOPropertiesType> seoPropertiesList, java.lang.String actionCode) throws OnlineStoreException
public com.ibm.commerce.infrastructure.facade.datatypes.RespondOnlineStoreDataAreaType changeSEOProperties(java.lang.String storeId, java.lang.String[] actions, com.ibm.commerce.foundation.common.datatypes.SEOPropertiesType[] seoPropertiesTypes, java.lang.String[] expressions) throws OnlineStoreException