Class ModuleContext


  • public final class ModuleContext
    extends Object
    Information required to perform some module operations.
    Since:
    4.1.0
    • Field Detail

      • idpHome

        @Nonnull
        private String idpHome
        IdP installation root.
      • httpClient

        @Nullable
        private org.apache.http.client.HttpClient httpClient
        HttpClient if needed.
      • messageStream

        @Nullable
        private PrintStream messageStream
        Output stream for sending output to the module consumer.
    • Constructor Detail

      • ModuleContext

        public ModuleContext​(@Nonnull @NotEmpty
                             String home)
        Constructor.
        Parameters:
        home - location of IdP install
      • ModuleContext

        public ModuleContext​(@Nonnull
                             Path home)
        Constructor.
        Parameters:
        home - location of IdP install
    • Method Detail

      • getIdPHome

        @Deprecated(since="4.2",
                    forRemoval=true)
        @Nonnull
        Path getIdPHome()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Gets software installation location.

        Use the String variant to avoid Windows borkage.

        Returns:
        install path
      • getInstallLocation

        @Nonnull
        @NotEmpty
        String getInstallLocation()
        Gets software installation location.
        Returns:
        install path
        Since:
        4.2.0
      • getHttpClient

        @Nullable
        org.apache.http.client.HttpClient getHttpClient()
        Gets an HttpClient instance to use if available.
        Returns:
        HTTP client instance
      • setHttpClient

        public void setHttpClient​(@Nullable
                                  org.apache.http.client.HttpClient client)
        Sets an HttpClient instance to use.
        Parameters:
        client - client to use
      • getHttpClientSecurityParameters

        @Nullable
        HttpClientSecurityParameters getHttpClientSecurityParameters()
        Gets HttpClient security parameters, if any.
        Returns:
        HTTP client security parameters to use
      • setHttpClientSecurityParameters

        public void setHttpClientSecurityParameters​(@Nullable
                                                    HttpClientSecurityParameters params)
        Sets HttpClient security parameters to use.
        Parameters:
        params - security parameters
      • getMessageStream

        @Nullable
        public PrintStream getMessageStream()
        Gets the output stream to receive any instructions or additional information after performing operations.
        Returns:
        output stream, or null
      • setMessageStream

        public void setMessageStream​(@Nullable
                                     PrintStream stream)
        Sets the output stream to receive any instructions or additional information after performing operations.
        Parameters:
        stream - output stream