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

Interface STSRequest

  • public interface STSRequest
    The STSRequest object encapsulates information specific to the current request including data from the requestor via the RequestSecurityToken. In addition, this object provides:
    1. module to module communication via the various attribute methods.
    2. access to the STSSession object which can be used to cache/store objects (like nonces) across multiple requests.
    3. access to services such as the kess service and alias service.
    4. access to partner/endpoint parameters that are specific to this request.
    Version:

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.Object getAttribute​(java.lang.String name)
      Returns the value of the named attribute as an Object, or null if no attribute of the given name exists.
      java.util.Iterator getAttributeNames()
      Returns a java.util.Iterator containing the names of the attributes available to this request.
      java.lang.String getAuditTrailID()
      Get the Audit trail ID This ID should be used on all audit related logging so that audit records for a request may be correlated across different logging destinations and sources.
      STSGroupMembership getRequestGroupMembership()
      Get the instance of the group membership appropriate for the current request to use as configuration to fulfill the request.
      RequestSecurityToken getRequestSecurityToken()
      Returns the WS-Trust RequestSecurityToken as a com.tivoli.am.fim.trustserver.types.RequestSecurityToken object.
      java.lang.Object getServiceHandle​(java.lang.String serviceId)
      Returns a Service handle that belongs to the servideId specified.
      org.w3c.dom.Element getSOAPEnvelope()
      Returns the SOAP envelop as a org.w3c.dom.Element sent in the client's request, if any.
      STSSession getSTSSession()
      Returns a session object to add attribute values that are maintained across multiple requests.
      org.w3c.dom.Element getWsTrustMsg()
      Returns the WS-Trust message as a org.w3c.dom.Element sent in the client's request, if any.
      void setAttribute​(java.lang.String name, java.lang.Object value)
      Stores an attribute in this request.

    • Field Detail

      • STSRequest_java_sourceCodeID

        static final java.lang.String STSRequest_java_sourceCodeID
        See Also:
        Constant Field Values

      • STSRequest_java_copyright

        static final java.lang.String STSRequest_java_copyright

    • Method Detail

      • getSTSSession

        STSSession getSTSSession()
        Returns a session object to add attribute values that are maintained across multiple requests.
        Returns:
        a STSSession object

      • getSOAPEnvelope

        org.w3c.dom.Element getSOAPEnvelope()
        Returns the SOAP envelop as a org.w3c.dom.Element sent in the client's request, if any. This method exposes a leaky abstraction, and may not be available if the request was not sent via SOAP. It is recommended that this method be used only if it can be guaranteed that the request will be sent via SOAP.
        Returns:
        a org.w3c.dom.Element of the SOAP envelope that was sent in the client's request or null.

      • getWsTrustMsg

        org.w3c.dom.Element getWsTrustMsg()
        Returns the WS-Trust message as a org.w3c.dom.Element sent in the client's request, if any. It must be the original unchanged DOM element. This method exposes a leaky abstraction, and may not be available if the request was not sent via SOAP. It is recommended that this method be used only if it can be guaranteed that the request will be sent via SOAP.
        Returns:
        a org.w3c.dom.Element of the SOAP envelope that was sent in the client's request or null.

      • getRequestSecurityToken

        RequestSecurityToken getRequestSecurityToken()
        Returns the WS-Trust RequestSecurityToken as a com.tivoli.am.fim.trustserver.types.RequestSecurityToken object.
        Returns:
        The RequestSecurityToken included with the request.

      • getAttribute

        java.lang.Object getAttribute​(java.lang.String name)
        Returns the value of the named attribute as an Object, or null if no attribute of the given name exists.
        Parameters:
        name - a String specifying the name of the attribute.
        Returns:
        an Object containing the value of the attribute, or null if the attribute does not exist.

      • getAttributeNames

        java.util.Iterator getAttributeNames()
        Returns a java.util.Iterator containing the names of the attributes available to this request. This method returns an empty java.util.Iterator if the request has no attributes available to it.
        Returns:
        a java.util.Interator of strings containing the names of the request's attributes.

      • setAttribute

        void setAttribute​(java.lang.String name,
                  java.lang.Object value)
        Stores an attribute in this request. Attributes are reset between requests.
        Parameters:
        name - a String specifying the name of the attribute.
        value - the object to be stored.

      • getServiceHandle

        java.lang.Object getServiceHandle​(java.lang.String serviceId)
        Returns a Service handle that belongs to the servideId specified.
        Parameters:
        serviceId - the name of the service to obtain.

      • getRequestGroupMembership

        STSGroupMembership getRequestGroupMembership()
        Get the instance of the group membership appropriate for the current request to use as configuration to fulfill the request. This method should be used to retrieve configuration parameters and endpoint/partner policy.
        Returns:
        An STSGroupMembership object.

      • getAuditTrailID

        java.lang.String getAuditTrailID()
        Get the Audit trail ID This ID should be used on all audit related logging so that audit records for a request may be correlated across different logging destinations and sources.