Field Detail

• COPYRIGHT

  public static final java.lang.String COPYRIGHT
  

  IBM copyright notice field.

  See Also:

  Constant Field Values

Constructor Detail

• TsToken

  public TsToken()
  

  The TsToken object contains all aspects of token management.

Method Detail

• findToken

  public com.ibm.commerce.telesales.services.ws.ActivityToken findToken(ServiceContext sC)
  

  Finds the token associated with the user for this send request in a runAsID table entry.

  Parameters:

  sC - the ServiceContext associated with this request

  Returns:

  the token if found; null if not found

• findTSRToken

  public com.ibm.commerce.telesales.services.ws.ActivityToken findTSRToken(ServiceContext sC)
  

  Finds the token associated with this user's CSR. One of the main purposes for finding a CSR's token is to use it on the clone() method to acquire a customer's token. (Or another token for the CSR for a different store).

  Parameters:

  sC - the ServiceContext associated with this send operation

  Returns:

  the token if succeeded; null if not found

• saveToken

  public boolean saveToken(com.ibm.commerce.telesales.services.ws.ActivityToken token,
                  ServiceContext sC)
  

  Saves the token in a runAsTable entry associated with a specific runAsId. This method is called when the CSR logs on (thus starting a conversation). And only once for the first request that is associated with a user communicating to the server. The runAsTable entry is a TokenContext object in which the token is placed.

  Parameters:

  token - the token to save

  sC - the ServiceContext associated with this action

  Returns:

  clone() if succeeded; false if a failure occurred

• releaseToken

  public java.util.Hashtable releaseToken(ServiceContext sC)
  

  Releases the token for a specified customer; that is, the customer's entry in CSR's runAsTable is removed. If a releaseToken() is issued for a CSR, then all the customers' entries in CSR's runAsTable are removed. An array of tokens is returned to the caller so that the associated conversations with the server can be stopped using the stopConversation() method of TsConversation.

  Parameters:

  sC - the ServiceContext associated with this request

  Returns:

  a hashtable of activity tokens

• getTSRToken

  public com.ibm.commerce.telesales.services.ws.ActivityToken getTSRToken(java.lang.String memberId)
  

  Returns the CSR's logon token. It is used to retrieve a CSR's logon token from the internal hashtables associated with the memberId input parameter. Currently called either from findTSRToken() or by Single Sign-On logic.

  Parameters:

  memberId - the CSR's memberId

  Returns:

  the CSR's logon activity token

• setTSREntries

  public void setTSREntries(ServiceContext sC)
  

  Sets the memberId keys for the CSR entries in the hashtables. After logon, the CSR entries in the hashtables have the CSR's userid as the key. This is because the CSR's memberId is not yet known to the services plugin. On a subsequent request BOD, the CSR's memberId is passed to the services plugin through the ServiceContext. The hashtables can then be updated using this method such that the userid keys are replaced with the memberId keys.

  Parameters:

  sC - the ServiceContext associated with this request

• replaceTSRToken

  public boolean replaceTSRToken(ServiceContext sC,
                        com.ibm.commerce.telesales.services.ws.ActivityToken newTsrToken)
  

  Replaces the token associated with the CSR with a new CSR token. This is called when the CSR token has expired. The CSR token is the basis for requesting the customer tokens. So it needs to be valid if a request for a customer token is to succeed.

  Parameters:

  sC - the ServiceContext associated with this request

  newTsrToken - the new CSR token the will replace the expired one

  Returns:

  true if replacement was a success; false if replacement could not be done