Interface WSTrustElementBase

All Known Subinterfaces:
RequestSecurityToken, RequestSecurityTokenResponse, SecondaryParameters
All Known Implementing Classes:
RequestSecurityTokenImpl, RequestSecurityTokenImpl, RequestSecurityTokenResponseImpl, RequestSecurityTokenResponseImpl, SecondaryParametersImpl

public interface WSTrustElementBase
Author:
WS-Trust Implementation Team.
  • Method Details

    • getTokenType

      URI getTokenType()
      Get the type of security token, specified as a URI.
      Returns:
      URI
    • setTokenType

      void setTokenType(URI tokenType)
      Set the type of security token, specified as a URI.
      Parameters:
      tokenType - URI
    • getLifetime

      Lifetime getLifetime()
      Get the desired LifeTime settings for the token if specified, null otherwise
    • setLifetime

      void setLifetime(Lifetime lifetime)
      Set the desired lifetime settings for the requested token
    • getEntropy

      Entropy getEntropy()
      Get the entropy for the requested token
      Returns:
      Entropy
    • setEntropy

      void setEntropy(Entropy entropy)
      Set the entropy for the requested token
      Parameters:
      entropy - Entropy
    • setAppliesTo

      void setAppliesTo(AppliesTo appliesTo)
      Set the desired policy settings for the requested token
      Parameters:
      appliesTo - AppliesTo
    • getAppliesTo

      AppliesTo getAppliesTo()
      Get the desired AppliesTo policy settings for the token if specified, null otherwise
      Returns:
      AppliesTo
    • setOnBehalfOf

      void setOnBehalfOf(OnBehalfOf onBehalfOf)
      Set the value of OnBehalfOf for the requested token
      Parameters:
      onBehalfOf - OnBehalfOf
    • getOnBehalfOf

      OnBehalfOf getOnBehalfOf()
      Get the value of OnBehalfOf for the token if specified, null otherwise
      Returns:
      OnBehalfOf
    • setIssuer

      void setIssuer(Issuer issuer)
      set Issuer of the SecurityToken Presented in the message
    • getIssuer

      Issuer getIssuer()
      get Issuer of the SecurityToken Presented in the Message, null otherwise
    • setRenewable

      void setRenewable(Renewing renew)
      set a <wst:Renewing/> element to make a renewable Issue request
    • getRenewable

      Renewing getRenewable()
      get the <wst:Renewing/> element if present, null otherwise
    • setSignChallenge

      void setSignChallenge(SignChallenge challenge)
      Set a SignChallenge
    • getSignChallenge

      SignChallenge getSignChallenge()
      get SignChallenge element if any, null otherwise
    • setBinaryExchange

      void setBinaryExchange(BinaryExchange challenge)
      set a BinaryExchange
    • getBinaryExchange

      BinaryExchange getBinaryExchange()
      get BinaryExchange element if any, null otherwise
    • setAuthenticationType

      void setAuthenticationType(URI uri)
      set AuthenticationType
    • getAuthenticationType

      URI getAuthenticationType()
      get Authentication Type parameter if set, null otherwise
    • setKeyType

      void setKeyType(URI keytype) throws WSTrustException
      set KeyType parameter
      Throws:
      WSTrustException
    • getKeyType

      URI getKeyType()
      get KeyType Parameter if set, null otherwise
    • setKeySize

      void setKeySize(long size)
      set the KeySize parameter
    • getKeySize

      long getKeySize()
      get the KeySize parameter if specified, 0 otherwise
    • setSignatureAlgorithm

      void setSignatureAlgorithm(URI algorithm)
      set SignatureAlgorithm
    • getSignatureAlgorithm

      URI getSignatureAlgorithm()
      get SignatureAlgorithm value if set, return default otherwise
    • setEncryptionAlgorithm

      void setEncryptionAlgorithm(URI algorithm)
      set EncryptionAlgorithm
    • getEncryptionAlgorithm

      URI getEncryptionAlgorithm()
      get EncryptionAlgorithm value if set, return default otherwise
    • setCanonicalizationAlgorithm

      void setCanonicalizationAlgorithm(URI algorithm)
      set CanonicalizationAlgorithm
    • getCanonicalizationAlgorithm

      URI getCanonicalizationAlgorithm()
      get CanonicalizationAlgorithm value if set, return default otherwise
    • setUseKey

      void setUseKey(UseKey useKey)
      Set the desired useKey settings for the requested token
    • getUseKey

      UseKey getUseKey()
      Get the desired useKey settings for the token if specified, null otherwise
    • setProofEncryption

      void setProofEncryption(ProofEncryption proofEncryption)
      Set the desired proofEncryption settings for the requested token
    • getProofEncryption

      ProofEncryption getProofEncryption()
      Get the desired proofEncryption settings for the token if specified, null otherwise
    • setComputedKeyAlgorithm

      void setComputedKeyAlgorithm(URI algorithm)
      set ComputedKeyAlgorithm
    • getComputedKeyAlgorithm

      URI getComputedKeyAlgorithm()
      get CanonicalizationAlgorithm value if set, return default otherwise
    • setEncryption

      void setEncryption(Encryption enc)
      set Encryption
    • getEncryption

      Encryption getEncryption()
      get Encryption value if set, return null otherwise
    • setSignWith

      void setSignWith(URI algorithm)
      Set the Signature Algorithm to be used with the issued token
    • getSignWith

      URI getSignWith()
      Get the Signature Algorithm to be used with the token if set, null otherwise
    • setEncryptWith

      void setEncryptWith(URI algorithm)
      Set the Encryption Algorithm to be used with the issued token
    • getEncryptWith

      URI getEncryptWith()
      Get the Encryption Algorithm to be used with the token if set, null otherwise
    • setKeyWrapAlgorithm

      void setKeyWrapAlgorithm(URI algorithm)
      set KeyWrapAlgorithm
    • getKeyWrapAlgorithm

      URI getKeyWrapAlgorithm()
      get KeyWrapAlgorithm value if set, return default otherwise
    • setDelegateTo

      void setDelegateTo(DelegateTo to)
      set the Delegate to which the issued token be delegated
    • getDelegateTo

      DelegateTo getDelegateTo()
      get the DelegateTo value if set, null otherwise
    • setForwardable

      void setForwardable(boolean flag)
      Set if the requested token be forwardable
    • getForwardable

      boolean getForwardable()
      Get the value of the Forwardable flag NOTE: default value of this flag is true
    • setDelegatable

      void setDelegatable(boolean flag)
      Set if the requested token be delegatable
    • getDelegatable

      boolean getDelegatable()
      Get the value of the Delegatable flag NOTE: default value of this flag is false
    • setPolicy

      void setPolicy(com.sun.xml.ws.policy.Policy policy)
      Set the desired policy settings for the requested token
    • getPolicy

      com.sun.xml.ws.policy.Policy getPolicy()
      Get the desired policy settings for the token if specified, null otherwise
    • setPolicyReference

      void setPolicyReference(PolicyReference policyRef)
      Set the desired policyReference settings for the requested token
    • getPolicyReference

      PolicyReference getPolicyReference()
      Get the desired policyReference settings for the token if specified, null otherwise
    • getAllowPostdating

      AllowPostdating getAllowPostdating()
      Get the AllowPostdating element for the token if specified, null otherwise NOTE: Although this is an issue with the WSTrust spec, leaving it here for now. This can be removed or modified later depending on the outcome of the issue.
    • setAllowPostdating

      void setAllowPostdating(AllowPostdating allowPostDating)
      Set the desired policyReference settings for the requested token