Package com.sun.identity.liberty.ws.dst

Class DSTClient

  • public class DSTClient
extends Object
    The class DSTClient provides methods for Liberty Data Service Template.

    • Constructor Detail

      • DSTClient

        public DSTClient​(String soapURI,
                 String providerID)
        Constructor The constructor connects to Data Service without WSS token
        Parameters:
        soapURI - URI of the SOAP end point for this Data service instance
        providerID - ID of service provider.

      • DSTClient

        public DSTClient​(SecurityAssertion assertion,
                 String soapURI,
                 String providerID)
        Constructor The constructor connects to Data Service using WSS SAML Token
        Parameters:
        assertion - WSS SAML Token
        soapURI - URI of the SOAP end point for this data service instance
        providerID - ID of service provider.

      • DSTClient

        public DSTClient​(BinarySecurityToken token,
                 String soapURI,
                 String providerID)
        Constructor The constructor connects to the data Service using WSS X509 Token.
        Parameters:
        token - WSS X.509 Certificate Token
        soapURI - URI of the SOAP end point for this Data service instance
        providerID - ID of service provider.

      • DSTClient

        public DSTClient​(String soapURI,
                 String providerID,
                 jakarta.servlet.http.HttpServletRequest httpRequest,
                 jakarta.servlet.http.HttpServletResponse httpResponse)
        Constructor The constructor connects to Data Service without WSS token, the HttpServletRequest and HttpServletResponse object of the current request agent will be used for resource owner interactions if needed.
        Parameters:
        soapURI - URI of the SOAP end point for this Data service instance
        providerID - ID of service provider.
        httpRequest - HttpServletRequest object of current user agent request.
        httpResponse - HttpServletResponse object of current user agent request.

      • DSTClient

        public DSTClient​(SecurityAssertion assertion,
                 String soapURI,
                 String providerID,
                 jakarta.servlet.http.HttpServletRequest httpRequest,
                 jakarta.servlet.http.HttpServletResponse httpResponse)
        Constructor The constructor connects to Data Service with WSS SAML token, the HttpServletRequest and HttpServletResponse object of the current request agent will be used for resource owner interactions if needed.
        Parameters:
        assertion - WSS SAML Token.
        soapURI - URI of the SOAP end point for this Data service instance.
        providerID - ID of service provider.
        httpRequest - HttpServletRequest object of current user agent request.
        httpResponse - HttpServletResponse object of current user agent request.

      • DSTClient

        public DSTClient​(BinarySecurityToken token,
                 String soapURI,
                 String providerID,
                 jakarta.servlet.http.HttpServletRequest httpRequest,
                 jakarta.servlet.http.HttpServletResponse httpResponse)
        Constructor The constructor connects to Data Service with WSS SAML token, the HttpServletRequest and HttpServletResponse object of the current request agent will be used for resource owner interactions if needed.
        Parameters:
        token - WSS X.509 Certificate Token
        soapURI - URI of the SOAP end point for this Data service instance
        providerID - ID of service provider.
        httpRequest - HttpServletRequest object of current user agent request.
        httpResponse - HttpServletResponse object of current user agent.

      • DSTClient

        public DSTClient​(ResourceOffering resourceOffering,
                 String providerID,
                 Object credential,
                 jakarta.servlet.http.HttpServletRequest httpRequest,
                 jakarta.servlet.http.HttpServletResponse httpResponse)
          throws DSTException
        Contructor Creates a data service template client instance. Connects to data Service specified by the resource offering. resourceID, security mechanism and SOAP endpoint defined in the ResourceOffering will be used.
        Parameters:
        resourceOffering - resource offering for this discovery service instance
        providerID - ID of this service provider.
        credential - Credential of WSC
        httpRequest - HttpServletRequest object of current user agent request.
        httpResponse - HttpServletResponse object of current user agent.
        Throws:
        DSTException - if the resourceOffering is not valid

      • DSTClient

        public DSTClient​(ResourceOffering resourceOffering,
                 String providerID,
                 Object credential)
          throws DSTException
        Constructor Creates a data service template client instance. Connects to data Service specified by the resource offering. resourceID, security mechanism and SOAP endpoint defined in the ResourceOffering will be used.
        Parameters:
        resourceOffering - resource offering for this discovery service instance
        providerID - ID of this service provider.
        credential - Credential of WSC
        Throws:
        DSTException - if the resourceOffering is not valid

    • Method Detail

      • setResourceID

        public void setResourceID​(String resourceID)
        Sets the resource ID to be accessed
        Parameters:
        resourceID - resource ID String

      • setResourceID

        public void setResourceID​(EncryptedResourceID encResourceID)
        Sets the encrypted resource ID to be accessed
        Parameters:
        encResourceID - encrypted resource ID

      • setProviderID

        public void setProviderID​(String providerID)
        Sets the provider ID.
        Parameters:
        providerID - Provider ID.

      • setClientCert

        public void setClientCert​(String certAlias)
        Sets the alias for the client certificate if the connection is TLS/SSL with client authentication.
        Parameters:
        certAlias - certificate alias name

      • setSOAPAction

        public void setSOAPAction​(String action)
        Sets SOAP Action such as query or modify
        Parameters:
        action - action for this soap request

      • setClientAuth

        public void setClientAuth​(boolean value)
        Sets the client authentication.
        Parameters:
        value - true value to enable client authentication.

      • setSOAPEndPoint

        public void setSOAPEndPoint​(String endpoint)
        Sets the SOAP Endpoint.
        Parameters:
        endpoint - SOAP Endpoint.

      • setSecurityAssertion

        public void setSecurityAssertion​(SecurityAssertion secAssertion)
        Sets the Security Assertion.
        Parameters:
        secAssertion - Security Assertion.

      • setBinarySecurityToken

        public void setBinarySecurityToken​(BinarySecurityToken binaryToken)
        Sets the binary security token.
        Parameters:
        binaryToken - Binary Security Token.

      • setSecurityMech

        public void setSecurityMech​(String secMech)
        Sets the security mechanism.
        Parameters:
        secMech - security mechanism.

      • getData

        public List getData​(List items)
             throws DSTException,
                    InteractionRedirectException
        Gets data for the specified query items.
        Parameters:
        items - list of DSTQueryItem object
        Returns:
        List of DSTData objects which have one-to-one correspondence to the list of query items. If no response for one of the query item, the corresponding return DSTData object will be null.
        Throws:
        DSTException - if error occurs when trying to get data
        InteractionRedirectException - if user agent is redirected to Web Service Provider (WSP) for resource owner interactions

      • getModifyResponse

        public List getModifyResponse​(List modifies)
                       throws DSTException,
                              InteractionRedirectException
        Performs a list of modifications specified by a list of DSTModify objects (possible on different resource ID).
        Parameters:
        modifies - list of DSTModify objects specifying resource and modifications to be made.
        Returns:
        List of DSTModifyResponse object corresponding to each DSTModify.
        Throws:
        DSTException - if error occurs when trying to modify data
        InteractionRedirectException - if interaction is required.

      • getServiceInstanceUpdateHeader

        public ServiceInstanceUpdateHeader getServiceInstanceUpdateHeader()
        Gets the serviceInstanceUpdate header from the SOAP response message. Applications can make use of this method to check if there is an alternate endpoint or credential available for the service requests.
        Returns:
        ServiceInstanceUpdateHeader from the response message.

      • setWSFVersion

        public void setWSFVersion​(String wsfVersion)
        Sets the web services version.
        Parameters:
        wsfVersion - the web services version that needs to be set.