Interface BinarySecret

All Superinterfaces:
XMLStructure
All Known Implementing Classes:
BinarySecretImpl, BinarySecretImpl

public interface BinarySecret extends XMLStructure
Author:
WS-Trust Implementation Team
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    Predefined constants for the Type of BinarySecret desired in the Security Token Values for the wst:BinarySecret/@Type parameter
    static final String
     
    static final String
     
  • Method Summary

    Modifier and Type
    Method
    Description
    Gets a map that contains attributes that aren't bound to any typed property on this class.
    byte[]
    Gets the decoded value or the raw bytes of the binary secret.
    Gets the encoded value of the binary secret.
    Gets the value of the type property.
    void
    setRawValue(byte[] rawText)
    Sets the value of the binary secret as raw bytes.
    void
    setTextValue(String encodedText)
    Sets the value of the Binary Secret element.
    void
    Sets the value of the type property indicating the type of secret being encoded.

    Methods inherited from interface javax.xml.crypto.XMLStructure

    isFeatureSupported
  • Field Details

  • Method Details

    • getOtherAttributes

      Map<QName,String> getOtherAttributes()
      Gets a map that contains attributes that aren't bound to any typed property on this class.

      the map is keyed by the name of the attribute and the value is the string value of the attribute. the map returned by this method is live, and you can add new attribute by updating the map directly. Because of this design, there's no setter.

      Returns:
      always non-null
    • getType

      String getType()
      Gets the value of the type property. This is a URI that indicates the type of secret being encoded.
      Returns:
      String
    • getRawValue

      byte[] getRawValue()
      Gets the decoded value or the raw bytes of the binary secret.
      Returns:
      possible object is byte[]
    • getTextValue

      String getTextValue()
      Gets the encoded value of the binary secret. This represents the base64 encoded BinarySecret.
      Returns:
      String
      See Also:
    • setType

      void setType(String type)
      Sets the value of the type property indicating the type of secret being encoded.
      Parameters:
      type - String
    • setTextValue

      void setTextValue(String encodedText)
      Sets the value of the Binary Secret element. This is the base64 encoded value of the raw BinarySecret.
      Parameters:
      encodedText - String
    • setRawValue

      void setRawValue(byte[] rawText)
      Sets the value of the binary secret as raw bytes. The value that appears in the element will be encoded appropriately.
      Parameters:
      rawText - allowed object is byte[]