Package com.emc.documentum.rest.security.ticket

# Interface ClientTokenFactory

public interface ClientTokenFactory
A factory to create, encrypt and decrypt client token.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `ClientToken`
  `decryptClientToken(String base64EncryptedToken)`
  Decrypt the REST client token.
  `String`
  `encryptClientToken(ClientToken token)`
  Encrypt the REST client token.
  `ClientToken`
  `newClientToken(String documentumLoginTicket, String username, String domain, Map<ClientToken.TokenField,?> others)`
  Create a new REST client token.

- ## Method Details

  - ### newClientToken

    ClientToken newClientToken(String documentumLoginTicket, String username, String domain, Map<ClientToken.TokenField,?> others)
    Create a new REST client token.
    Parameters:
      `username` - the username for the client token
      `domain` - domain name of the user
      `documentumLoginTicket` - documentum login ticket
      `others` - other fields
    Returns:
      the new ticket

  - ### decryptClientToken

    ClientToken decryptClientToken(String base64EncryptedToken)
    Decrypt the REST client token.
    Parameters:
      `base64EncryptedToken` - the client token in BASE64 encoding string
    Returns:
      the client token in Java structured object

  - ### encryptClientToken

    String encryptClientToken(ClientToken token)
    Encrypt the REST client token.
    Parameters:
      `token` - the client token in Java structured object
    Returns:
      the client token in BASE64 encoding string