Interface SoapSTSInstancePublisher

  • All Known Implementing Classes:
    SoapSTSInstancePublisherImpl

    public interface SoapSTSInstancePublisher
    Represents the concerns of publishing Soap STS instances, and retrieving these representations. Publishing a soap-sts instance involves writing its configuration state to the SMS, so it can be obtained by: 1. a GET on the sts publish service, which is performed by the soap-sts deployment context 2. by the token generation service, via the SoapSTSInstanceConfigStore. This interface will be consumed by the SoapSTSPublishServiceRequestHandler.
    • Method Detail

      • publishInstance

        String publishInstance​(SoapSTSInstanceConfig instanceConfig)
                        throws STSPublishException
        Publish the Soap STS instance specified by the instanceConfig parameter. Publishing a Soap STS instance means persisting it to the SMS and exposing it via CREST.
        Parameters:
        instanceConfig - The configuration state for the to-be-published Soap STS instance.
        Returns:
        the urlElement, including the realm, at which the Soap STS instance has been published.
        Throws:
        STSPublishException - if the Soap STS instance could not be published
      • removeInstance

        void removeInstance​(String stsId,
                            String realm)
                     throws STSPublishException
        Remove the Soap STS instance from the SMS, and from the CREST router.
        Parameters:
        stsId - The sts id, obtained from SoapSTSInstanceConfig#getDeploymentSubPath
        realm - The realm in which the Soap STS is to be deployed.
        Throws:
        STSPublishException - if the Soap STS instance could not be removed
      • getPublishedInstances

        List<SoapSTSInstanceConfig> getPublishedInstances()
                                                   throws STSPublishException
        Called to obtain the configuration elements corresponding to previously-published STS instances.
        Returns:
        The SoapSTSInstanceConfig instances corresponding to published STS instances.
        Throws:
        STSPublishException - if exception encountered obtaining persisted instance state
      • getPublishedInstances

        List<SoapSTSInstanceConfig> getPublishedInstances​(String realm)
                                                   throws STSPublishException
        Called to obtain the configuration elements corresponding to previously-published STS instances.
        Parameters:
        realm - The realm for which published sts instances should be obtained.
        Returns:
        The SoapSTSInstanceConfig instances corresponding to published STS instances in the specified realm.
        Throws:
        STSPublishException - if exception encountered obtaining persisted instance state
      • getPublishedInstance

        SoapSTSInstanceConfig getPublishedInstance​(String stsId,
                                                   String realm)
                                            throws STSPublishException
        Called to return the config state corresponding to a specified Soap STS instance
        Parameters:
        stsId - The sts id, obtained from SoapSTSInstanceConfig#getDeploymentSubPath
        realm - The realm in which the Soap STS is to be deployed.
        Returns:
        The SoapSTSInstanceConfig corresponding to this published instance
        Throws:
        STSPublishException - if the published instance state could not be obtained