Package com.tivoli.am.fim.trustserver.sts

Interface STSResponse

All Superinterfaces:
com.tivoli.am.fim.trustserver.sts.STSPrefixResolver, com.tivoli.am.fim.trustserver.sts.STSReqResp
public interface STSResponse extends com.tivoli.am.fim.trustserver.sts.STSReqResp
Used to communicate all the response data to be sent back to the client.
STSResponse implementations allow the modification of member data.
Version:
@VERSION@

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    STSResponse_java_copyright
     
    static final String
    STSResponse_java_sourceCodeID
     

    Fields inherited from interface com.tivoli.am.fim.trustserver.sts.STSPrefixResolver

    STSPrefixResolver_java_copyright, STSPrefixResolver_java_sourceCodeID

  • Method Summary

    Modifier and Type
    Method
    Description
    RequestSecurityTokenResponse
    addRequestSecurityTokenResponse()
    Creates a new WS-Trust RequestedSecurityTokenResponse object with the side effect that a RequestSecurityTokenResponseCollection is created.
    RequestSecurityTokenResponse
    getRequestSecurityTokenResponse()
    Returns the WS-Trust RequestedSecurityTokenResponse object.
    com.tivoli.am.fim.trustserver.types.RequestSecurityTokenResponseCollection
    getRequestSecurityTokenResponseCollection()
    Returns the WS-Trust RequestedSecurityTokenResponseCollection object or null.
    Element
    getSOAPEnvelope()
    Returns the SOAP envelope as a org.w3c.dom.Element to be returned to the client in the response, if null, there was not a SOAP envelope present for this response.
    STSUniversalUser
    getSTSUniversalUser()
    Returns the current com.tivoli.am.fim.trustserver.sts.STSUniversalUser for the response.

    Methods inherited from interface com.tivoli.am.fim.trustserver.sts.STSPrefixResolver

    addNamespaceMapping, createQName, getNamespacePrefix, getNamespacePrefixes, getNamespaceURI, getNamespaceURIs

  • Field Details

  • Method Details

    • getSOAPEnvelope

      Element getSOAPEnvelope()
      Returns the SOAP envelope as a org.w3c.dom.Element to be returned to the client in the response, if null, there was not a SOAP envelope present for this response.
      This method exposes a leaky abstraction and may return null if the response will not be sent over SOAP. In either case, the response message document should be used if the requirement is to create an element in the same response document.
      Returns:
      a org.w3c.dom.Element of the SOAP envelope

    • getRequestSecurityTokenResponse

      RequestSecurityTokenResponse getRequestSecurityTokenResponse()
      Returns the WS-Trust RequestedSecurityTokenResponse object. This method never returns null.
      Returns:
      the RequestedSecurityTokenResponse object

    • getRequestSecurityTokenResponseCollection

      com.tivoli.am.fim.trustserver.types.RequestSecurityTokenResponseCollection getRequestSecurityTokenResponseCollection()
      Returns the WS-Trust RequestedSecurityTokenResponseCollection object or null. To ensure a non-null result use the addRequestSecurityTokenResponse method before invoking this method.
      Returns:
      the RequestedSecurityTokenResponseCollection object

    • addRequestSecurityTokenResponse

      RequestSecurityTokenResponse addRequestSecurityTokenResponse()
      Creates a new WS-Trust RequestedSecurityTokenResponse object with the side effect that a RequestSecurityTokenResponseCollection is created. The result is that there will be at least 2 RequestedSecurityTokenResponse objects: the default plus those added by this method.
      Returns:
      the RequestedSecurityTokenResponse object

    • getSTSUniversalUser

      STSUniversalUser getSTSUniversalUser()
      Returns the current com.tivoli.am.fim.trustserver.sts.STSUniversalUser for the response.
      Returns:
      a com.tivoli.am.fim.trustserver.sts.STSUniversalUser for the current response.