public class RqlDataApiClient extends RqlApiClient
The client needs to be initialized with a SecureApiClientConfiguration
object.
For example to create a client with a ticket authentication the following code can be used:
SecureApiClientConfiguration configuration = new SecureApiClientConfiguration(); configuration.setSite("mysite.com"); RqlDataApiClient client = new RqlDataApiClient(configuration); client.authenticate("user_name", "password");
To use digital signatures:
SecureApiClientConfiguration configuration = new SecureApiClientConfiguration(); configuration.setSite("mysite.com"); configuration.setUserName("user_name"); configuration.setSigningKeyPair(keyPair); RqlDataApiClient client = new RqlDataApiClient(configuration);
Constructor and Description |
---|
RqlDataApiClient(SecureApiClientConfiguration configuration)
Constructs a new
RqlDataApiClient and initializes
it with the SecureApiClientConfiguration object. |
Modifier and Type | Method and Description |
---|---|
int |
countEntities(java.lang.String appName,
java.lang.String entity,
java.lang.String filter)
Counts entities of an app.
|
int |
countEntities(java.lang.String appName,
java.lang.String entity,
java.lang.String filter,
java.lang.String contextStoreId)
Counts entities of an app.
|
CountInvalidStoresResponse |
countInvalidStores(CountInvalidStoresRequest request)
Counts the # of invalid stores based on the app name in the CountInvalidStoresRequest
|
int |
countQueueData(java.lang.String queueName,
java.lang.String filter)
Counts the # of stores in the specified queue that match the filter.
|
int |
countQueueData(java.lang.String queueName,
java.lang.String filter,
java.lang.String contextStoreId)
Counts the # of stores in the specified queue that match the filter.
|
CountStoresResponse |
countStores(CountStoresRequest request) |
CreateLoginTokenResponse |
createLoginToken(CreateLoginToken request)
Creates a login token that be be used to log a user in via a token.
|
java.lang.String |
createStore(java.lang.String appName)
Creates a store.
|
java.lang.String |
createStore(java.lang.String appName,
java.lang.String batchId)
Creates a store as part of a batch.
|
java.lang.String |
createTransactionsBatch(java.lang.String appName,
BatchAction batchAction,
java.lang.String firstStoreId,
java.lang.String description)
Creates a Batch Id value that may be used with other Data and Import API methods that accept a batchId parameter.
|
DeleteInvalidStoresResponse |
deleteInvalidStores(DeleteInvalidStoresRequest request)
Deletes invalid stores and returns a count of the number of deleted stores.
|
java.lang.String |
deleteStore(java.lang.String storeId)
Deletes a store and its transactions and entities.
|
java.lang.String |
deleteStore(java.lang.String storeId,
java.lang.String batchId)
Deletes a store and its transactions and entities.
|
void |
endTransactionsBatch(java.lang.String batchId)
A method to call when you are done with batch processing for a given batchId.
|
java.lang.String |
evaluateExpression(java.lang.String storeId,
java.lang.String storeXml,
java.lang.String xpathExpression)
Evaluates an xpath expression against store xml or the store referenced by the storeId provided by the caller.
|
java.lang.String |
evaluateExpression(java.lang.String storeId,
java.lang.String storeXml,
java.lang.String contextXPath,
java.lang.String xpathExpression)
Evaluates an xpath expression against store xml or the store referenced by the storeId provided by the caller.
|
EvaluateRuleEngineResponse |
evaluateRuleEngineRule(java.lang.String storeXml,
java.lang.String ruleXml)
Evaluates a Rule Engine rule by applying the rule contained in
ruleXml to the store xml contained in storeXml and returning
the changed store xml in the response along with any transactions. |
EvaluateRuleEngineResponse |
evaluateRuleEngineRules(java.lang.String storeXml,
java.lang.String ruleSetQueueName,
java.lang.String ruleSetQueueFilter,
java.lang.String rulesQueueName,
java.lang.String rulesQueueFilter)
Evaluates a Rule Engine rule set by applying the rule set or collection to the store xml provided in the request, and returning
the changed store xml in the response along with any transactions.
|
java.lang.String |
forceDeleteStore(java.lang.String appId,
java.lang.String storeId)
Deletes a store and its transactions and entities.
|
java.lang.String |
forceDeleteStore(java.lang.String appId,
java.lang.String storeId,
java.lang.String batchId)
Deletes a store and its transactions and entities.
|
java.io.InputStream |
getArtifact(java.lang.String artifactId)
Downloads an artifact.
|
java.lang.String |
getStore(java.lang.String storeId)
Gets a store.
|
byte[] |
getStore(java.lang.String storeId,
boolean isCompressed)
Gets a store.
|
java.util.Map<java.lang.String,java.lang.String> |
getStoreProperties(java.lang.String storeId,
java.lang.String... propertyNames)
Gets a collection of the store property names and values.
|
java.util.Map<java.lang.String,java.lang.String> |
getStoreProperty(java.lang.String storeId,
java.lang.String propertyName)
Gets a value of the store property.
|
GetTransactionResponse |
getTransaction(java.lang.String storeId,
java.lang.String transactionId)
Gets a store transaction.
|
ListInvalidStoreIdsResponse |
listInvalidStores(ListInvalidStoreIdsRequest request)
Lists the store ids of invalid stores based on the app name in the ListInvalidStoreIdsRequest
|
ListStoreIdsResponse |
listStoreIds(ListStoreIdsRequest request)
Lists the store ids based on a query parameters provided in the ListStoreIdsRequest
|
java.util.List<TransactionInfo> |
listTransactions(java.lang.String storeId)
Lists store transactions.
|
void |
publishApps(java.util.List<java.lang.String> appNames,
StoreOperation storeOperation)
Executes various publishing operations on an app.
|
java.lang.String |
publishStore(java.lang.String storeId,
StoreOperation storeOperation)
Executes various publishing operations on a store.
|
java.lang.String |
putArtifact(java.lang.String filePath)
Uploads an artifact.
|
java.lang.String |
putArtifact(java.lang.String filePath,
java.util.Map<java.lang.String,java.lang.String> properties)
Uploads an artifact.
|
java.lang.String |
putArtifact(java.lang.String filePath,
java.lang.String artifactId)
Uploads an artifact, allowing you to specify the artifact Id.
|
java.lang.String |
putStore(java.lang.String storeId,
java.lang.String storeXml)
Updates a store.
|
java.lang.String |
putStore(java.lang.String storeId,
java.lang.String storeXml,
StoreOperation storeOperation)
Deprecated.
This method will be deleted as soon as possible.
Use the overload that includes batchId instead.
|
java.lang.String |
putStore(java.lang.String storeId,
java.lang.String storeXml,
java.lang.String batchId,
StoreOperation storeOperation)
Updates a store.
|
java.lang.String |
putStoreProperties(java.lang.String storeId,
java.util.Map<java.lang.String,java.lang.String> properties,
StoreOperation storeOperation)
Updates store properties.
|
java.lang.String |
putStoreProperties(java.lang.String storeId,
java.lang.String batchId,
java.util.Map<java.lang.String,java.lang.String> properties,
StoreOperation storeOperation)
Updates store properties as part of a batch.
|
java.lang.String |
putStoreProperty(java.lang.String storeId,
java.lang.String propertyName,
java.lang.String propertyValue,
StoreOperation storeOperation)
Sets a store property.
|
java.lang.String |
putStoreProperty(java.lang.String storeId,
java.lang.String batchId,
java.lang.String propertyName,
java.lang.String propertyValue,
StoreOperation storeOperation)
Sets a store property as part of a batch
|
PutTransactionResponse |
putTransaction(java.lang.String storeId,
boolean isXml,
java.lang.String targetExpression,
java.lang.String transactionType,
java.lang.String valueExpression,
StoreOperation storeOperation)
Creates and executes a store transaction
|
PutTransactionResponse |
putTransaction(java.lang.String storeId,
boolean isXml,
java.lang.String batchId,
java.lang.String targetExpression,
java.lang.String transactionType,
java.lang.String valueExpression,
StoreOperation storeOperation)
Creates and executes a store transaction as part of a batch.
|
PutTransactionResponse |
putTransaction(java.lang.String storeId,
java.lang.String transactionXml,
boolean isXml,
java.lang.String targetExpression,
java.lang.String transactionType,
java.lang.String valueExpression,
StoreOperation storeOperation)
Deprecated.
This method is deprecated because the transactionXml param is no longer used.
This method will be deleted in a future release of the Sdk.
|
PutTransactionsResponse |
putTransactions(java.lang.String storeId,
java.util.List<TransactionBatchInfo> transactions,
StoreOperation storeOperation) |
PutTransactionsResponse |
putTransactions(java.lang.String storeId,
java.lang.String batchId,
java.util.List<TransactionBatchInfo> transactions,
StoreOperation storeOperation) |
java.util.List<java.lang.String> |
queryStore(java.lang.String storeId,
java.lang.String query)
Executes an XPath query on the store.
|
java.lang.String |
rebuildStore(java.lang.String storeId)
Rebuilds a store by replaying all of its transactions.
|
java.lang.String |
rollBackTransactionsBatch(java.lang.String batchId)
A method to call to roll back a batch of transactions based on a given batchId
|
SelectedEntities |
selectEntities(java.lang.String appName,
java.lang.String entity,
java.util.List<java.lang.String> properties,
java.lang.String filter,
int pageIndex,
int pageSize)
Selects entities of an app.
|
SelectedEntities |
selectEntities(java.lang.String appName,
java.lang.String entity,
java.util.List<java.lang.String> properties,
java.lang.String filter,
int pageIndex,
int pageSize,
java.lang.String contextStoreId)
Selects entities of an app.
|
SelectedEntities |
selectEntities(java.lang.String appName,
java.lang.String entity,
java.lang.String filter,
int pageIndex,
int pageSize)
Selects entities of an app.
|
SelectedEntitiesWithAggregation |
selectEntitiesWithAggregation(java.lang.String appName,
java.lang.String entity,
java.util.List<java.lang.String> properties,
java.lang.String filter,
java.util.Map<java.lang.String,AggregateFunction> aggregateProperties,
int pageIndex,
int pageSize)
Selects entities of an app applying aggregate functions.
|
SelectQueueDataResponse |
selectQueueData(SelectQueueDataRequest request)
Selects entities from a Queue
|
java.lang.Boolean |
storeExists(java.lang.String storeId)
Checks if a store exists, returning true if so.
|
getCustomSiteSettings, getSiteConfiguration, setCustomSiteSetting, setCustomSiteSettings
authenticate, getTicketExpirationDate
public RqlDataApiClient(SecureApiClientConfiguration configuration)
RqlDataApiClient
and initializes
it with the SecureApiClientConfiguration
object.configuration
- A configuration object for the API client.public java.lang.String createStore(java.lang.String appName) throws javax.xml.soap.SOAPException
appName
- The app name.javax.xml.soap.SOAPException
public java.lang.String createStore(java.lang.String appName, java.lang.String batchId) throws javax.xml.soap.SOAPException
appName
- The app name.batchId
- A batch Id that may be used to rollback all operations performed against this batch id.javax.xml.soap.SOAPException
public java.lang.String deleteStore(java.lang.String storeId) throws javax.xml.soap.SOAPException
storeId
- The store id.javax.xml.soap.SOAPException
public java.lang.String deleteStore(java.lang.String storeId, java.lang.String batchId) throws javax.xml.soap.SOAPException
storeId
- The store id.batchId
- A batch Id that may be used to rollback all operations performed against this batch id.javax.xml.soap.SOAPException
public java.lang.String forceDeleteStore(java.lang.String appId, java.lang.String storeId, java.lang.String batchId) throws javax.xml.soap.SOAPException
appId
- The app idstoreId
- The store id. (that ius not fully qualified)batchId
- A batch Id that may be used to rollback all operations performed against this batch id.javax.xml.soap.SOAPException
public java.lang.String forceDeleteStore(java.lang.String appId, java.lang.String storeId) throws javax.xml.soap.SOAPException
appId
- The app idstoreId
- The store id. (that ius not fully qualified)javax.xml.soap.SOAPException
public java.io.InputStream getArtifact(java.lang.String artifactId) throws java.io.IOException, RqlApiException
artifactId
- The artifact id.java.io.IOException
RqlApiException
public java.lang.Boolean storeExists(java.lang.String storeId) throws javax.xml.soap.SOAPException
storeId
- The store Id to test for.javax.xml.soap.SOAPException
public java.lang.String getStore(java.lang.String storeId) throws javax.xml.soap.SOAPException
storeId
- The store id.javax.xml.soap.SOAPException
public byte[] getStore(java.lang.String storeId, boolean isCompressed) throws javax.xml.soap.SOAPException
storeId
- The store id.isCompressed
- If true returns a store in compressed (gzip) format. Otherwise returns store xml as UTF-8 encoded byte array.javax.xml.soap.SOAPException
public java.util.Map<java.lang.String,java.lang.String> getStoreProperty(java.lang.String storeId, java.lang.String propertyName) throws javax.xml.soap.SOAPException
storeId
- The store id.propertyName
- The name of a property.javax.xml.soap.SOAPException
public java.util.Map<java.lang.String,java.lang.String> getStoreProperties(java.lang.String storeId, java.lang.String... propertyNames) throws javax.xml.soap.SOAPException
storeId
- The store id.propertyNames
- A list of property names.javax.xml.soap.SOAPException
public GetTransactionResponse getTransaction(java.lang.String storeId, java.lang.String transactionId) throws javax.xml.soap.SOAPException
storeId
- The store id.transactionId
- The transaction id.GetTransactionResponse
object.javax.xml.soap.SOAPException
public java.util.List<TransactionInfo> listTransactions(java.lang.String storeId) throws javax.xml.soap.SOAPException
storeId
- The store id.javax.xml.soap.SOAPException
public void publishApps(java.util.List<java.lang.String> appNames, StoreOperation storeOperation) throws javax.xml.soap.SOAPException, java.lang.IllegalArgumentException
appNames
- A comma-separated list of apps.storeOperation
- The publishing operation.javax.xml.soap.SOAPException
java.lang.IllegalArgumentException
public java.lang.String publishStore(java.lang.String storeId, StoreOperation storeOperation) throws javax.xml.soap.SOAPException, java.lang.IllegalArgumentException
storeId
- The store id.storeOperation
- The publishing operation.javax.xml.soap.SOAPException
java.lang.IllegalArgumentException
public java.lang.String putArtifact(java.lang.String filePath) throws java.io.IOException, RqlApiException
filePath
- The full path to a file.java.io.IOException
RqlApiException
public java.lang.String putArtifact(java.lang.String filePath, java.lang.String artifactId) throws java.io.IOException, RqlApiException
filePath
- The full path to a file1artifactId
- The artifact id to use when uploading the artifact. Any existing artifact with this Id is overwritten. If blank, a new artifact id is generatedjava.io.IOException
RqlApiException
public java.lang.String putArtifact(java.lang.String filePath, java.util.Map<java.lang.String,java.lang.String> properties) throws java.io.IOException, RqlApiException
filePath
- The full path to a file.properties
- A collection of artifact properties. Supported property key names are: ContentType, ContentLength, OriginalFileName, OriginalPath, and Id.
Id is the artifact Id. If the Id property is not specified, a new artifact id is generated.java.io.IOException
RqlApiException
public java.lang.String putStore(java.lang.String storeId, java.lang.String storeXml) throws javax.xml.soap.SOAPException
storeId
- The store id.storeXml
- The raw xml of the store.javax.xml.soap.SOAPException
@Deprecated public java.lang.String putStore(java.lang.String storeId, java.lang.String storeXml, StoreOperation storeOperation) throws javax.xml.soap.SOAPException, java.lang.IllegalArgumentException
storeId
- The store id.storeXml
- The raw xml of the store.storeOperation
- The publishing operation for the store.javax.xml.soap.SOAPException
java.lang.IllegalArgumentException
public java.lang.String putStore(java.lang.String storeId, java.lang.String storeXml, java.lang.String batchId, StoreOperation storeOperation) throws javax.xml.soap.SOAPException, java.lang.IllegalArgumentException
storeId
- The store id.storeXml
- The raw xml of the store.batchId
- A batch Id that may be used to rollback all operations performed against this batch id.storeOperation
- The publishing operation for the store.javax.xml.soap.SOAPException
java.lang.IllegalArgumentException
public java.lang.String putStoreProperty(java.lang.String storeId, java.lang.String propertyName, java.lang.String propertyValue, StoreOperation storeOperation) throws javax.xml.soap.SOAPException, java.lang.IllegalArgumentException
storeId
- The store id.propertyName
- Property name.propertyValue
- Property value.storeOperation
- The publishing operation for the store.javax.xml.soap.SOAPException
java.lang.IllegalArgumentException
public java.lang.String putStoreProperty(java.lang.String storeId, java.lang.String batchId, java.lang.String propertyName, java.lang.String propertyValue, StoreOperation storeOperation) throws javax.xml.soap.SOAPException, java.lang.IllegalArgumentException
storeId
- The store id.batchId
- A batch Id that may be used to rollback all operations performed against this batch id.propertyName
- Property name.propertyValue
- Property value.storeOperation
- The publishing operation for the store.javax.xml.soap.SOAPException
java.lang.IllegalArgumentException
public java.lang.String putStoreProperties(java.lang.String storeId, java.util.Map<java.lang.String,java.lang.String> properties, StoreOperation storeOperation) throws javax.xml.soap.SOAPException, java.lang.IllegalArgumentException
storeId
- The store id.properties
- storeOperation
- The publishing operation for the store.javax.xml.soap.SOAPException
java.lang.IllegalArgumentException
public java.lang.String putStoreProperties(java.lang.String storeId, java.lang.String batchId, java.util.Map<java.lang.String,java.lang.String> properties, StoreOperation storeOperation) throws javax.xml.soap.SOAPException, java.lang.IllegalArgumentException
storeId
- The store id.batchId
- A batch Id that may be used to rollback all operations performed against this batch id.properties
- storeOperation
- The publishing operation for the store.javax.xml.soap.SOAPException
java.lang.IllegalArgumentException
@Deprecated public PutTransactionResponse putTransaction(java.lang.String storeId, java.lang.String transactionXml, boolean isXml, java.lang.String targetExpression, java.lang.String transactionType, java.lang.String valueExpression, StoreOperation storeOperation) throws javax.xml.soap.SOAPException, java.lang.IllegalArgumentException
storeId
- The store id.transactionXml
- The raw xml of the transaction.isXml
- targetExpression
- transactionType
- valueExpression
- storeOperation
- The publishing operation to be applied to the store.PutTransactionResponse
object.javax.xml.soap.SOAPException
java.lang.IllegalArgumentException
public PutTransactionResponse putTransaction(java.lang.String storeId, boolean isXml, java.lang.String targetExpression, java.lang.String transactionType, java.lang.String valueExpression, StoreOperation storeOperation) throws javax.xml.soap.SOAPException, java.lang.IllegalArgumentException
storeId
- The store id.isXml
- targetExpression
- transactionType
- valueExpression
- storeOperation
- The publishing operation to be applied to the store.PutTransactionResponse
object.javax.xml.soap.SOAPException
java.lang.IllegalArgumentException
public PutTransactionResponse putTransaction(java.lang.String storeId, boolean isXml, java.lang.String batchId, java.lang.String targetExpression, java.lang.String transactionType, java.lang.String valueExpression, StoreOperation storeOperation) throws javax.xml.soap.SOAPException, java.lang.IllegalArgumentException
storeId
- The store id.isXml
- batchId
- A batch Id that may be used to rollback all operations performed against this batch id.targetExpression
- transactionType
- valueExpression
- storeOperation
- The publishing operation to be applied to the store.PutTransactionResponse
object.javax.xml.soap.SOAPException
java.lang.IllegalArgumentException
public PutTransactionsResponse putTransactions(java.lang.String storeId, java.lang.String batchId, java.util.List<TransactionBatchInfo> transactions, StoreOperation storeOperation) throws javax.xml.soap.SOAPException, java.lang.IllegalArgumentException
javax.xml.soap.SOAPException
java.lang.IllegalArgumentException
public PutTransactionsResponse putTransactions(java.lang.String storeId, java.util.List<TransactionBatchInfo> transactions, StoreOperation storeOperation) throws javax.xml.soap.SOAPException, java.lang.IllegalArgumentException
javax.xml.soap.SOAPException
java.lang.IllegalArgumentException
public java.util.List<java.lang.String> queryStore(java.lang.String storeId, java.lang.String query) throws javax.xml.soap.SOAPException
storeId
- The store id.query
- An XPath query.javax.xml.soap.SOAPException
public java.lang.String rebuildStore(java.lang.String storeId) throws javax.xml.soap.SOAPException
storeId
- The store id.javax.xml.soap.SOAPException
public SelectedEntities selectEntities(java.lang.String appName, java.lang.String entity, java.lang.String filter, int pageIndex, int pageSize) throws javax.xml.soap.SOAPException
This method is paged.
appName
- The name of an app.entity
- The name of the entity.filter
- The entity selection filter.pageIndex
- The page index.pageSize
- The number of records on the page.javax.xml.soap.SOAPException
public SelectedEntities selectEntities(java.lang.String appName, java.lang.String entity, java.util.List<java.lang.String> properties, java.lang.String filter, int pageIndex, int pageSize) throws javax.xml.soap.SOAPException
This method is paged.
appName
- The name of an app.entity
- The name of the entity.properties
- Entity properties.filter
- The entity selection filter.pageIndex
- The page index.pageSize
- The number of records on the page.javax.xml.soap.SOAPException
public SelectedEntities selectEntities(java.lang.String appName, java.lang.String entity, java.util.List<java.lang.String> properties, java.lang.String filter, int pageIndex, int pageSize, java.lang.String contextStoreId) throws javax.xml.soap.SOAPException
This method is paged.
appName
- The name of an app.entity
- The name of the entity.properties
- Entity properties.filter
- The entity selection filter.pageIndex
- The page index.pageSize
- The number of records on the page.contextStoreId
- The query will occur with this store id as the current context store. Useful in Analyze Queue scenarios w/ context sensitive filters.javax.xml.soap.SOAPException
public SelectedEntitiesWithAggregation selectEntitiesWithAggregation(java.lang.String appName, java.lang.String entity, java.util.List<java.lang.String> properties, java.lang.String filter, java.util.Map<java.lang.String,AggregateFunction> aggregateProperties, int pageIndex, int pageSize) throws javax.xml.soap.SOAPException
This method is paged.
appName
- The name of an app.entity
- The name of the entity.properties
- Entity properties.filter
- The entity selection filter.aggregateProperties
- A map of entity property names and corresponding aggregate functions.pageIndex
- The page index.pageSize
- The number of records on the page.javax.xml.soap.SOAPException
public SelectQueueDataResponse selectQueueData(SelectQueueDataRequest request) throws javax.xml.soap.SOAPException
request
- javax.xml.soap.SOAPException
public int countEntities(java.lang.String appName, java.lang.String entity, java.lang.String filter) throws javax.xml.soap.SOAPException
This method is paged.
appName
- The name of an app.entity
- The name of the entity.filter
- The entity selection filter.javax.xml.soap.SOAPException
public int countEntities(java.lang.String appName, java.lang.String entity, java.lang.String filter, java.lang.String contextStoreId) throws javax.xml.soap.SOAPException
This method is paged.
appName
- The name of an app.entity
- The name of the entity.filter
- The entity selection filter.contextStoreId
- The query will occur with this store id as the current context store. Useful in Analyze Queue scenarios w/ context sensitive filters.javax.xml.soap.SOAPException
public int countQueueData(java.lang.String queueName, java.lang.String filter) throws javax.xml.soap.SOAPException
queueName
- Name of the queue. Should be in the form of AppName.QueueName
This supports analyze queuesfilter
- Queue filter. Optional.javax.xml.soap.SOAPException
public int countQueueData(java.lang.String queueName, java.lang.String filter, java.lang.String contextStoreId) throws javax.xml.soap.SOAPException
queueName
- Name of the queue. Should be in the form of AppName.QueueName
This supports analyze queuesfilter
- Queue filter. Optional.contextStoreId
- If the results are evaluated in the context of another store(e.g. queue in scope), indicate the store id.javax.xml.soap.SOAPException
public java.lang.String createTransactionsBatch(java.lang.String appName, BatchAction batchAction, java.lang.String firstStoreId, java.lang.String description) throws javax.xml.soap.SOAPException
appName
- The name of an app.batchAction
- The type of batch action being created. See BatchAction
firstStoreId
- description
- javax.xml.soap.SOAPException
createStore(String, String)
,
deleteStore(String, String)
,
putStore(String, String)
,
putStore(String, String, String, StoreOperation)
,
RqlImportApiClient.importEntity(ImportEntityInfo)
,
ImportEntityInfo
public void endTransactionsBatch(java.lang.String batchId) throws javax.xml.soap.SOAPException
batchId
- A batch id previously generated by @see #createTransactionsBatchjavax.xml.soap.SOAPException
public java.lang.String rollBackTransactionsBatch(java.lang.String batchId) throws javax.xml.soap.SOAPException
batchId
- A batch id previously generated by @see #createTransactionsBatchjavax.xml.soap.SOAPException
public java.lang.String evaluateExpression(java.lang.String storeId, java.lang.String storeXml, java.lang.String contextXPath, java.lang.String xpathExpression) throws javax.xml.soap.SOAPException
Note: the storeId or the storeXml must be specified. You can't specify both, and you can't leave them both storeId and storeXml as null.
This API allows you to do what is possible in the "Expression Evaluator" app.
storeId
- If specified, the xpath expression is applied against the store referenced by the storeId. Must be specified if storeXml is null.storeXml
- Contains complete store xml that the xpath expression will be applied against. Must be specified if storeId is null.contextXPath
- An XPath selector to set the context for the XPath in @see xpathExpression. May be used against the storeXml
or the storeId
. If blank, defaults to /store/*[1]xpathExpression
- A valid XPath expression, including Rql extension methods.javax.xml.soap.SOAPException
public java.lang.String evaluateExpression(java.lang.String storeId, java.lang.String storeXml, java.lang.String xpathExpression) throws javax.xml.soap.SOAPException
Note: the storeId or the storeXml must be specified. You can't specify both, and you can't leave them both storeId and storeXml as null.
This API allows you to do what is possible in the "Expression Evaluator" app.
This overload of the API assumes the contextXPath is /store/*[1]
storeId
- If specified, the xpath expression is applied against the store referenced by the storeId. Must be specified if storeXml is null.storeXml
- Contains complete store xml that the xpath expression will be applied against. Must be specified if storeId is null.xpathExpression
- A valid XPath expression, including Rql extension methods.javax.xml.soap.SOAPException
public EvaluateRuleEngineResponse evaluateRuleEngineRules(java.lang.String storeXml, java.lang.String ruleSetQueueName, java.lang.String ruleSetQueueFilter, java.lang.String rulesQueueName, java.lang.String rulesQueueFilter) throws javax.xml.soap.SOAPException
storeXml
- REQUIRED - The store XML that the rule or rule set(s) will be applied to. The changed version of this store will be returned
in the result along with the transactions applied to the store.
The storeXml must be for store XML from an app that is valid on the target site.
ruleSetQueueName
- The fully qualified name of the queue containing the Rule Set(s) that the rule collection will be executing in.
This may be null if only using a collection of rules and not a rule set.ruleSetQueueFilter
- A SQL filter to specify which rule set(s) to load from the ruleSetQueueName
rulesQueueName
- REQUIRED - The fully qualified queue name containing the rule or rules that are to be applied to the specified store xml.
The queue specified here must have a published column named Rule_Set and which has values linked to the queue specified in the
ruleSetQueueName by store Id of the rule set.
In other words, My_Rules_Library.Active_Rules.Rule_Set must have values that match My_RuleSet_Library.Active_RuleSets.StoreId,
where the My_RuleSet_Queue.Active_RulesSets.StoreId is the store Id for the rule set returned by the ruleSetQueueName ruleSetQueueFilter.rulesQueueFilter
- A SQL filter to specify which rules to load from the rulesQueueName
javax.xml.soap.SOAPException
public EvaluateRuleEngineResponse evaluateRuleEngineRule(java.lang.String storeXml, java.lang.String ruleXml) throws javax.xml.soap.SOAPException
ruleXml
to the store xml contained in storeXml
and returning
the changed store xml in the response along with any transactions.storeXml
- The store XML that the rule or rule set(s) will be applied to. The changed version of this store will be returned
in the result along with the transactions applied to the store.
The storeXml must be for store XML from an app that is valid on the target site.
ruleXml
- a String containing rule store XML to be evaluated by the rule engine.
The ruleXml must be for store XML from an app that is valid on the target site.
javax.xml.soap.SOAPException
public CreateLoginTokenResponse createLoginToken(CreateLoginToken request) throws javax.xml.soap.SOAPException
request
- - The request parameter, containing the details of the token request, such as the user id, target & re-authentication urls, and session duration.CreateLoginTokenResponse
, containing the token key, and a token consumption url.javax.xml.soap.SOAPException
CreateLoginToken
,
CreateLoginTokenResponse
,
CreateLoginTokenResponse.getTokenLoginUrl()
public ListStoreIdsResponse listStoreIds(ListStoreIdsRequest request) throws javax.xml.soap.SOAPException
request
- javax.xml.soap.SOAPException
public CountStoresResponse countStores(CountStoresRequest request) throws javax.xml.soap.SOAPException
javax.xml.soap.SOAPException
public CountInvalidStoresResponse countInvalidStores(CountInvalidStoresRequest request) throws javax.xml.soap.SOAPException
request
- javax.xml.soap.SOAPException
public ListInvalidStoreIdsResponse listInvalidStores(ListInvalidStoreIdsRequest request) throws javax.xml.soap.SOAPException
request
- javax.xml.soap.SOAPException
public DeleteInvalidStoresResponse deleteInvalidStores(DeleteInvalidStoresRequest request) throws javax.xml.soap.SOAPException
request
- javax.xml.soap.SOAPException