Package org.identityconnectors.framework.common.objects

Class BatchToken

java.lang.Object
org.identityconnectors.framework.common.objects.BatchToken
public class BatchToken extends Object
Encapsulates zero or more tokens resulting from submission of a set of batched operations to an external resource via a connector. tokens is a List of Strings representing the tokens used by the resource (or generated by the connector if the resource does not use tokens). These tokens are opaque to the application. If a follow-up queryBatch() call is required to fetch the results of an executeBatch() or additional results following another queryBatch() then this BatchToken should contain queryRequired == true. If false then the application need not issue another queryBatch() command; All results are returned with the command that returned this BatchToken. If results will be returned asynchronous to the return of this BatchToken then asynchronousResults should be true. If false then the expectation is that this BatchToken represents the final data returned by the connector.

  • Constructor Details

    • BatchToken

      public BatchToken()

    • BatchToken

      public BatchToken(String token)

  • Method Details

    • addToken

      public void addToken(String token)

    • removeToken

      public void removeToken(String token)

    • getTokens

      public List<String> getTokens()

    • hasToken

      public boolean hasToken(String token)

    • isQueryRequired

      public boolean isQueryRequired()

    • setQueryRequired

      public void setQueryRequired(boolean queryRequired)

    • hasAsynchronousResults

      public boolean hasAsynchronousResults()

    • setAsynchronousResults

      public void setAsynchronousResults(boolean asynchronousResults)

    • returnsResults

      public boolean returnsResults()

    • setReturnsResults

      public void setReturnsResults(boolean returnsResults)